@spaciv/sdk 0.1.9 → 0.1.11
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/.openapi-generator/FILES +1 -0
- package/README.md +2 -2
- package/dist/apis/ContributionsApi.d.ts +4 -4
- package/dist/apis/ContributionsApi.js +2 -2
- package/dist/apis/DataCollectionApi.d.ts +12 -12
- package/dist/apis/DataCollectionApi.js +6 -6
- package/dist/esm/apis/ContributionsApi.d.ts +4 -4
- package/dist/esm/apis/ContributionsApi.js +2 -2
- package/dist/esm/apis/DataCollectionApi.d.ts +12 -12
- package/dist/esm/apis/DataCollectionApi.js +6 -6
- package/dist/esm/models/DatacollectionBody.d.ts +13 -0
- package/dist/esm/models/DatacollectionBody.js +5 -0
- package/dist/esm/models/DatacollectionChangelogBody.d.ts +13 -0
- package/dist/esm/models/DatacollectionChangelogBody.js +9 -0
- package/dist/esm/models/DatacollectionContributor.d.ts +38 -0
- package/dist/esm/models/DatacollectionContributor.js +47 -0
- package/dist/esm/models/GetDatacollectionRes.d.ts +6 -0
- package/dist/esm/models/GetDatacollectionRes.js +2 -0
- package/dist/esm/models/index.d.ts +1 -0
- package/dist/esm/models/index.js +1 -0
- package/dist/models/DatacollectionBody.d.ts +13 -0
- package/dist/models/DatacollectionBody.js +5 -0
- package/dist/models/DatacollectionChangelogBody.d.ts +13 -0
- package/dist/models/DatacollectionChangelogBody.js +9 -0
- package/dist/models/DatacollectionContributor.d.ts +38 -0
- package/dist/models/DatacollectionContributor.js +54 -0
- package/dist/models/GetDatacollectionRes.d.ts +6 -0
- package/dist/models/GetDatacollectionRes.js +2 -0
- package/dist/models/index.d.ts +1 -0
- package/dist/models/index.js +1 -0
- package/package.json +1 -1
- package/src/apis/ContributionsApi.ts +4 -4
- package/src/apis/DataCollectionApi.ts +12 -12
- package/src/models/DatacollectionBody.ts +23 -0
- package/src/models/DatacollectionChangelogBody.ts +25 -0
- package/src/models/DatacollectionContributor.ts +75 -0
- package/src/models/GetDatacollectionRes.ts +8 -0
- package/src/models/index.ts +1 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -182,6 +182,7 @@ src/models/DatacollectionAuthenticationOneOf2.ts
|
|
|
182
182
|
src/models/DatacollectionAuthenticationOneOf3.ts
|
|
183
183
|
src/models/DatacollectionBody.ts
|
|
184
184
|
src/models/DatacollectionChangelogBody.ts
|
|
185
|
+
src/models/DatacollectionContributor.ts
|
|
185
186
|
src/models/DatasetAddResponseBody.ts
|
|
186
187
|
src/models/DatasetChangelogBody.ts
|
|
187
188
|
src/models/DatasetChangelogData.ts
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @spaciv/sdk@0.1.
|
|
1
|
+
## @spaciv/sdk@0.1.11
|
|
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.11 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -31,7 +31,7 @@ export interface ContributionsApiGetDataCollectionsContributionRequest {
|
|
|
31
31
|
*/
|
|
32
32
|
export interface ContributionsApiInterface {
|
|
33
33
|
/**
|
|
34
|
-
* Saves the contributor\'s answers and state for a survey contribution. The body carries the current node, answer data, and completion status; for identified surveys, the server records the contributor\'s anonymisation
|
|
34
|
+
* Saves the contributor\'s answers and state for a survey contribution. The body carries the current node, answer data, and completion status; for identified surveys, the server records the contributor\'s anonymisation nodes when the contribution is completed, from the survey\'s contributor list or, if none was ever uploaded, from the object group named by its authentication mode, and returns `404` if the contribution ID is unknown. Requires the *Edit contribution* permission.
|
|
35
35
|
* @summary Save a contribution
|
|
36
36
|
* @param {string} id
|
|
37
37
|
* @param {string} [datacollectionId] The survey the contribution belongs to. Required when submitting on behalf of an anonymous or public contributor whose contribution ID differs from the survey ID.
|
|
@@ -42,7 +42,7 @@ export interface ContributionsApiInterface {
|
|
|
42
42
|
*/
|
|
43
43
|
createDataCollectionsContributionRaw(requestParameters: ContributionsApiCreateDataCollectionsContributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
44
44
|
/**
|
|
45
|
-
* Saves the contributor\'s answers and state for a survey contribution. The body carries the current node, answer data, and completion status; for identified surveys, the server records the contributor\'s anonymisation
|
|
45
|
+
* Saves the contributor\'s answers and state for a survey contribution. The body carries the current node, answer data, and completion status; for identified surveys, the server records the contributor\'s anonymisation nodes when the contribution is completed, from the survey\'s contributor list or, if none was ever uploaded, from the object group named by its authentication mode, and returns `404` if the contribution ID is unknown. Requires the *Edit contribution* permission.
|
|
46
46
|
* Save a contribution
|
|
47
47
|
*/
|
|
48
48
|
createDataCollectionsContribution(requestParameters: ContributionsApiCreateDataCollectionsContributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
@@ -81,12 +81,12 @@ export interface ContributionsApiInterface {
|
|
|
81
81
|
*/
|
|
82
82
|
export declare class ContributionsApi extends runtime.BaseAPI implements ContributionsApiInterface {
|
|
83
83
|
/**
|
|
84
|
-
* Saves the contributor\'s answers and state for a survey contribution. The body carries the current node, answer data, and completion status; for identified surveys, the server records the contributor\'s anonymisation
|
|
84
|
+
* Saves the contributor\'s answers and state for a survey contribution. The body carries the current node, answer data, and completion status; for identified surveys, the server records the contributor\'s anonymisation nodes when the contribution is completed, from the survey\'s contributor list or, if none was ever uploaded, from the object group named by its authentication mode, and returns `404` if the contribution ID is unknown. Requires the *Edit contribution* permission.
|
|
85
85
|
* Save a contribution
|
|
86
86
|
*/
|
|
87
87
|
createDataCollectionsContributionRaw(requestParameters: ContributionsApiCreateDataCollectionsContributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
88
88
|
/**
|
|
89
|
-
* Saves the contributor\'s answers and state for a survey contribution. The body carries the current node, answer data, and completion status; for identified surveys, the server records the contributor\'s anonymisation
|
|
89
|
+
* Saves the contributor\'s answers and state for a survey contribution. The body carries the current node, answer data, and completion status; for identified surveys, the server records the contributor\'s anonymisation nodes when the contribution is completed, from the survey\'s contributor list or, if none was ever uploaded, from the object group named by its authentication mode, and returns `404` if the contribution ID is unknown. Requires the *Edit contribution* permission.
|
|
90
90
|
* Save a contribution
|
|
91
91
|
*/
|
|
92
92
|
createDataCollectionsContribution(requestParameters: ContributionsApiCreateDataCollectionsContributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
@@ -30,7 +30,7 @@ const index_1 = require("../models/index");
|
|
|
30
30
|
*/
|
|
31
31
|
class ContributionsApi extends runtime.BaseAPI {
|
|
32
32
|
/**
|
|
33
|
-
* Saves the contributor\'s answers and state for a survey contribution. The body carries the current node, answer data, and completion status; for identified surveys, the server records the contributor\'s anonymisation
|
|
33
|
+
* Saves the contributor\'s answers and state for a survey contribution. The body carries the current node, answer data, and completion status; for identified surveys, the server records the contributor\'s anonymisation nodes when the contribution is completed, from the survey\'s contributor list or, if none was ever uploaded, from the object group named by its authentication mode, and returns `404` if the contribution ID is unknown. Requires the *Edit contribution* permission.
|
|
34
34
|
* Save a contribution
|
|
35
35
|
*/
|
|
36
36
|
createDataCollectionsContributionRaw(requestParameters, initOverrides) {
|
|
@@ -64,7 +64,7 @@ class ContributionsApi extends runtime.BaseAPI {
|
|
|
64
64
|
});
|
|
65
65
|
}
|
|
66
66
|
/**
|
|
67
|
-
* Saves the contributor\'s answers and state for a survey contribution. The body carries the current node, answer data, and completion status; for identified surveys, the server records the contributor\'s anonymisation
|
|
67
|
+
* Saves the contributor\'s answers and state for a survey contribution. The body carries the current node, answer data, and completion status; for identified surveys, the server records the contributor\'s anonymisation nodes when the contribution is completed, from the survey\'s contributor list or, if none was ever uploaded, from the object group named by its authentication mode, and returns `404` if the contribution ID is unknown. Requires the *Edit contribution* permission.
|
|
68
68
|
* Save a contribution
|
|
69
69
|
*/
|
|
70
70
|
createDataCollectionsContribution(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* permission.
|
|
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. For an email or preferred-channel survey whose contributors were never uploaded, `legacyContributors` counts the contributors it takes from the object group named by its authentication mode.
|
|
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* permission.
|
|
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. For an email or preferred-channel survey whose contributors were never uploaded, `legacyContributors` counts the contributors it takes from the object group named by its authentication mode.
|
|
78
78
|
* Get a data collection survey
|
|
79
79
|
*/
|
|
80
80
|
get(requestParameters: DataCollectionApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDatacollectionRes>;
|
|
@@ -120,7 +120,7 @@ export interface DataCollectionApiInterface {
|
|
|
120
120
|
*/
|
|
121
121
|
list(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDatacollectionListRes>;
|
|
122
122
|
/**
|
|
123
|
-
* Returns every
|
|
123
|
+
* Returns every contributor of an email or preferred-channel survey, each with their current contribution state and contact details: the survey\'s uploaded contributors or, if none were ever uploaded, the users in the object group named by its authentication mode. Anonymous and public surveys have no contributor list and return an empty list. Requires the *View crowd modelling* permission.
|
|
124
124
|
* @summary List contributors for a survey
|
|
125
125
|
* @param {string} id
|
|
126
126
|
* @param {*} [options] Override http request option.
|
|
@@ -129,12 +129,12 @@ export interface DataCollectionApiInterface {
|
|
|
129
129
|
*/
|
|
130
130
|
listContributorsRaw(requestParameters: DataCollectionApiListContributorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContributionListRes>>;
|
|
131
131
|
/**
|
|
132
|
-
* Returns every
|
|
132
|
+
* Returns every contributor of an email or preferred-channel survey, each with their current contribution state and contact details: the survey\'s uploaded contributors or, if none were ever uploaded, the users in the object group named by its authentication mode. Anonymous and public surveys have no contributor list and return an empty list. Requires the *View crowd modelling* permission.
|
|
133
133
|
* List contributors for a survey
|
|
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.
|
|
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.
|
|
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* permission.
|
|
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. For an email or preferred-channel survey whose contributors were never uploaded, `legacyContributors` counts the contributors it takes from the object group named by its authentication mode.
|
|
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* permission.
|
|
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. For an email or preferred-channel survey whose contributors were never uploaded, `legacyContributors` counts the contributors it takes from the object group named by its authentication mode.
|
|
183
183
|
* Get a data collection survey
|
|
184
184
|
*/
|
|
185
185
|
get(requestParameters: DataCollectionApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDatacollectionRes>;
|
|
@@ -214,22 +214,22 @@ export declare class DataCollectionApi extends runtime.BaseAPI implements DataCo
|
|
|
214
214
|
*/
|
|
215
215
|
list(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDatacollectionListRes>;
|
|
216
216
|
/**
|
|
217
|
-
* Returns every
|
|
217
|
+
* Returns every contributor of an email or preferred-channel survey, each with their current contribution state and contact details: the survey\'s uploaded contributors or, if none were ever uploaded, the users in the object group named by its authentication mode. Anonymous and public surveys have no contributor list and return an empty list. Requires the *View crowd modelling* permission.
|
|
218
218
|
* List contributors for a survey
|
|
219
219
|
*/
|
|
220
220
|
listContributorsRaw(requestParameters: DataCollectionApiListContributorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContributionListRes>>;
|
|
221
221
|
/**
|
|
222
|
-
* Returns every
|
|
222
|
+
* Returns every contributor of an email or preferred-channel survey, each with their current contribution state and contact details: the survey\'s uploaded contributors or, if none were ever uploaded, the users in the object group named by its authentication mode. Anonymous and public surveys have no contributor list and return an empty list. Requires the *View crowd modelling* permission.
|
|
223
223
|
* List contributors for a survey
|
|
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.
|
|
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.
|
|
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* permission.
|
|
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. For an email or preferred-channel survey whose contributors were never uploaded, `legacyContributors` counts the contributors it takes from the object group named by its authentication mode.
|
|
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* permission.
|
|
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. For an email or preferred-channel survey whose contributors were never uploaded, `legacyContributors` counts the contributors it takes from the object group named by its authentication mode.
|
|
137
137
|
* Get a data collection survey
|
|
138
138
|
*/
|
|
139
139
|
get(requestParameters, initOverrides) {
|
|
@@ -266,7 +266,7 @@ class DataCollectionApi extends runtime.BaseAPI {
|
|
|
266
266
|
});
|
|
267
267
|
}
|
|
268
268
|
/**
|
|
269
|
-
* Returns every
|
|
269
|
+
* Returns every contributor of an email or preferred-channel survey, each with their current contribution state and contact details: the survey\'s uploaded contributors or, if none were ever uploaded, the users in the object group named by its authentication mode. Anonymous and public surveys have no contributor list and return an empty list. Requires the *View crowd modelling* permission.
|
|
270
270
|
* List contributors for a survey
|
|
271
271
|
*/
|
|
272
272
|
listContributorsRaw(requestParameters, initOverrides) {
|
|
@@ -295,7 +295,7 @@ class DataCollectionApi extends runtime.BaseAPI {
|
|
|
295
295
|
});
|
|
296
296
|
}
|
|
297
297
|
/**
|
|
298
|
-
* Returns every
|
|
298
|
+
* Returns every contributor of an email or preferred-channel survey, each with their current contribution state and contact details: the survey\'s uploaded contributors or, if none were ever uploaded, the users in the object group named by its authentication mode. Anonymous and public surveys have no contributor list and return an empty list. Requires the *View crowd modelling* permission.
|
|
299
299
|
* List contributors for a survey
|
|
300
300
|
*/
|
|
301
301
|
listContributors(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.
|
|
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.
|
|
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) {
|
|
@@ -31,7 +31,7 @@ export interface ContributionsApiGetDataCollectionsContributionRequest {
|
|
|
31
31
|
*/
|
|
32
32
|
export interface ContributionsApiInterface {
|
|
33
33
|
/**
|
|
34
|
-
* Saves the contributor\'s answers and state for a survey contribution. The body carries the current node, answer data, and completion status; for identified surveys, the server records the contributor\'s anonymisation
|
|
34
|
+
* Saves the contributor\'s answers and state for a survey contribution. The body carries the current node, answer data, and completion status; for identified surveys, the server records the contributor\'s anonymisation nodes when the contribution is completed, from the survey\'s contributor list or, if none was ever uploaded, from the object group named by its authentication mode, and returns `404` if the contribution ID is unknown. Requires the *Edit contribution* permission.
|
|
35
35
|
* @summary Save a contribution
|
|
36
36
|
* @param {string} id
|
|
37
37
|
* @param {string} [datacollectionId] The survey the contribution belongs to. Required when submitting on behalf of an anonymous or public contributor whose contribution ID differs from the survey ID.
|
|
@@ -42,7 +42,7 @@ export interface ContributionsApiInterface {
|
|
|
42
42
|
*/
|
|
43
43
|
createDataCollectionsContributionRaw(requestParameters: ContributionsApiCreateDataCollectionsContributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
44
44
|
/**
|
|
45
|
-
* Saves the contributor\'s answers and state for a survey contribution. The body carries the current node, answer data, and completion status; for identified surveys, the server records the contributor\'s anonymisation
|
|
45
|
+
* Saves the contributor\'s answers and state for a survey contribution. The body carries the current node, answer data, and completion status; for identified surveys, the server records the contributor\'s anonymisation nodes when the contribution is completed, from the survey\'s contributor list or, if none was ever uploaded, from the object group named by its authentication mode, and returns `404` if the contribution ID is unknown. Requires the *Edit contribution* permission.
|
|
46
46
|
* Save a contribution
|
|
47
47
|
*/
|
|
48
48
|
createDataCollectionsContribution(requestParameters: ContributionsApiCreateDataCollectionsContributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
@@ -81,12 +81,12 @@ export interface ContributionsApiInterface {
|
|
|
81
81
|
*/
|
|
82
82
|
export declare class ContributionsApi extends runtime.BaseAPI implements ContributionsApiInterface {
|
|
83
83
|
/**
|
|
84
|
-
* Saves the contributor\'s answers and state for a survey contribution. The body carries the current node, answer data, and completion status; for identified surveys, the server records the contributor\'s anonymisation
|
|
84
|
+
* Saves the contributor\'s answers and state for a survey contribution. The body carries the current node, answer data, and completion status; for identified surveys, the server records the contributor\'s anonymisation nodes when the contribution is completed, from the survey\'s contributor list or, if none was ever uploaded, from the object group named by its authentication mode, and returns `404` if the contribution ID is unknown. Requires the *Edit contribution* permission.
|
|
85
85
|
* Save a contribution
|
|
86
86
|
*/
|
|
87
87
|
createDataCollectionsContributionRaw(requestParameters: ContributionsApiCreateDataCollectionsContributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
88
88
|
/**
|
|
89
|
-
* Saves the contributor\'s answers and state for a survey contribution. The body carries the current node, answer data, and completion status; for identified surveys, the server records the contributor\'s anonymisation
|
|
89
|
+
* Saves the contributor\'s answers and state for a survey contribution. The body carries the current node, answer data, and completion status; for identified surveys, the server records the contributor\'s anonymisation nodes when the contribution is completed, from the survey\'s contributor list or, if none was ever uploaded, from the object group named by its authentication mode, and returns `404` if the contribution ID is unknown. Requires the *Edit contribution* permission.
|
|
90
90
|
* Save a contribution
|
|
91
91
|
*/
|
|
92
92
|
createDataCollectionsContribution(requestParameters: ContributionsApiCreateDataCollectionsContributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
@@ -27,7 +27,7 @@ import { ContributionPostToJSON, GetContributionResFromJSON, } from '../models/i
|
|
|
27
27
|
*/
|
|
28
28
|
export class ContributionsApi extends runtime.BaseAPI {
|
|
29
29
|
/**
|
|
30
|
-
* Saves the contributor\'s answers and state for a survey contribution. The body carries the current node, answer data, and completion status; for identified surveys, the server records the contributor\'s anonymisation
|
|
30
|
+
* Saves the contributor\'s answers and state for a survey contribution. The body carries the current node, answer data, and completion status; for identified surveys, the server records the contributor\'s anonymisation nodes when the contribution is completed, from the survey\'s contributor list or, if none was ever uploaded, from the object group named by its authentication mode, and returns `404` if the contribution ID is unknown. Requires the *Edit contribution* permission.
|
|
31
31
|
* Save a contribution
|
|
32
32
|
*/
|
|
33
33
|
createDataCollectionsContributionRaw(requestParameters, initOverrides) {
|
|
@@ -61,7 +61,7 @@ export class ContributionsApi extends runtime.BaseAPI {
|
|
|
61
61
|
});
|
|
62
62
|
}
|
|
63
63
|
/**
|
|
64
|
-
* Saves the contributor\'s answers and state for a survey contribution. The body carries the current node, answer data, and completion status; for identified surveys, the server records the contributor\'s anonymisation
|
|
64
|
+
* Saves the contributor\'s answers and state for a survey contribution. The body carries the current node, answer data, and completion status; for identified surveys, the server records the contributor\'s anonymisation nodes when the contribution is completed, from the survey\'s contributor list or, if none was ever uploaded, from the object group named by its authentication mode, and returns `404` if the contribution ID is unknown. Requires the *Edit contribution* permission.
|
|
65
65
|
* Save a contribution
|
|
66
66
|
*/
|
|
67
67
|
createDataCollectionsContribution(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* permission.
|
|
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. For an email or preferred-channel survey whose contributors were never uploaded, `legacyContributors` counts the contributors it takes from the object group named by its authentication mode.
|
|
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* permission.
|
|
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. For an email or preferred-channel survey whose contributors were never uploaded, `legacyContributors` counts the contributors it takes from the object group named by its authentication mode.
|
|
78
78
|
* Get a data collection survey
|
|
79
79
|
*/
|
|
80
80
|
get(requestParameters: DataCollectionApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDatacollectionRes>;
|
|
@@ -120,7 +120,7 @@ export interface DataCollectionApiInterface {
|
|
|
120
120
|
*/
|
|
121
121
|
list(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDatacollectionListRes>;
|
|
122
122
|
/**
|
|
123
|
-
* Returns every
|
|
123
|
+
* Returns every contributor of an email or preferred-channel survey, each with their current contribution state and contact details: the survey\'s uploaded contributors or, if none were ever uploaded, the users in the object group named by its authentication mode. Anonymous and public surveys have no contributor list and return an empty list. Requires the *View crowd modelling* permission.
|
|
124
124
|
* @summary List contributors for a survey
|
|
125
125
|
* @param {string} id
|
|
126
126
|
* @param {*} [options] Override http request option.
|
|
@@ -129,12 +129,12 @@ export interface DataCollectionApiInterface {
|
|
|
129
129
|
*/
|
|
130
130
|
listContributorsRaw(requestParameters: DataCollectionApiListContributorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContributionListRes>>;
|
|
131
131
|
/**
|
|
132
|
-
* Returns every
|
|
132
|
+
* Returns every contributor of an email or preferred-channel survey, each with their current contribution state and contact details: the survey\'s uploaded contributors or, if none were ever uploaded, the users in the object group named by its authentication mode. Anonymous and public surveys have no contributor list and return an empty list. Requires the *View crowd modelling* permission.
|
|
133
133
|
* List contributors for a survey
|
|
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.
|
|
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.
|
|
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* permission.
|
|
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. For an email or preferred-channel survey whose contributors were never uploaded, `legacyContributors` counts the contributors it takes from the object group named by its authentication mode.
|
|
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* permission.
|
|
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. For an email or preferred-channel survey whose contributors were never uploaded, `legacyContributors` counts the contributors it takes from the object group named by its authentication mode.
|
|
183
183
|
* Get a data collection survey
|
|
184
184
|
*/
|
|
185
185
|
get(requestParameters: DataCollectionApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDatacollectionRes>;
|
|
@@ -214,22 +214,22 @@ export declare class DataCollectionApi extends runtime.BaseAPI implements DataCo
|
|
|
214
214
|
*/
|
|
215
215
|
list(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDatacollectionListRes>;
|
|
216
216
|
/**
|
|
217
|
-
* Returns every
|
|
217
|
+
* Returns every contributor of an email or preferred-channel survey, each with their current contribution state and contact details: the survey\'s uploaded contributors or, if none were ever uploaded, the users in the object group named by its authentication mode. Anonymous and public surveys have no contributor list and return an empty list. Requires the *View crowd modelling* permission.
|
|
218
218
|
* List contributors for a survey
|
|
219
219
|
*/
|
|
220
220
|
listContributorsRaw(requestParameters: DataCollectionApiListContributorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContributionListRes>>;
|
|
221
221
|
/**
|
|
222
|
-
* Returns every
|
|
222
|
+
* Returns every contributor of an email or preferred-channel survey, each with their current contribution state and contact details: the survey\'s uploaded contributors or, if none were ever uploaded, the users in the object group named by its authentication mode. Anonymous and public surveys have no contributor list and return an empty list. Requires the *View crowd modelling* permission.
|
|
223
223
|
* List contributors for a survey
|
|
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.
|
|
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.
|
|
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* permission.
|
|
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. For an email or preferred-channel survey whose contributors were never uploaded, `legacyContributors` counts the contributors it takes from the object group named by its authentication mode.
|
|
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* permission.
|
|
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. For an email or preferred-channel survey whose contributors were never uploaded, `legacyContributors` counts the contributors it takes from the object group named by its authentication mode.
|
|
134
134
|
* Get a data collection survey
|
|
135
135
|
*/
|
|
136
136
|
get(requestParameters, initOverrides) {
|
|
@@ -263,7 +263,7 @@ export class DataCollectionApi extends runtime.BaseAPI {
|
|
|
263
263
|
});
|
|
264
264
|
}
|
|
265
265
|
/**
|
|
266
|
-
* Returns every
|
|
266
|
+
* Returns every contributor of an email or preferred-channel survey, each with their current contribution state and contact details: the survey\'s uploaded contributors or, if none were ever uploaded, the users in the object group named by its authentication mode. Anonymous and public surveys have no contributor list and return an empty list. Requires the *View crowd modelling* permission.
|
|
267
267
|
* List contributors for a survey
|
|
268
268
|
*/
|
|
269
269
|
listContributorsRaw(requestParameters, initOverrides) {
|
|
@@ -292,7 +292,7 @@ export class DataCollectionApi extends runtime.BaseAPI {
|
|
|
292
292
|
});
|
|
293
293
|
}
|
|
294
294
|
/**
|
|
295
|
-
* Returns every
|
|
295
|
+
* Returns every contributor of an email or preferred-channel survey, each with their current contribution state and contact details: the survey\'s uploaded contributors or, if none were ever uploaded, the users in the object group named by its authentication mode. Anonymous and public surveys have no contributor list and return an empty list. Requires the *View crowd modelling* permission.
|
|
296
296
|
* List contributors for a survey
|
|
297
297
|
*/
|
|
298
298
|
listContributors(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.
|
|
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.
|
|
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) {
|
|
@@ -10,6 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import type { DatacollectionAuthentication } from './DatacollectionAuthentication';
|
|
13
|
+
import type { DatacollectionContributor } from './DatacollectionContributor';
|
|
13
14
|
import type { Step } from './Step';
|
|
14
15
|
/**
|
|
15
16
|
*
|
|
@@ -29,6 +30,12 @@ export interface DatacollectionBody {
|
|
|
29
30
|
* @memberof DatacollectionBody
|
|
30
31
|
*/
|
|
31
32
|
authenticationMode?: DatacollectionAuthentication;
|
|
33
|
+
/**
|
|
34
|
+
*
|
|
35
|
+
* @type {boolean}
|
|
36
|
+
* @memberof DatacollectionBody
|
|
37
|
+
*/
|
|
38
|
+
clearContributors?: boolean;
|
|
32
39
|
/**
|
|
33
40
|
*
|
|
34
41
|
* @type {boolean}
|
|
@@ -41,6 +48,12 @@ export interface DatacollectionBody {
|
|
|
41
48
|
* @memberof DatacollectionBody
|
|
42
49
|
*/
|
|
43
50
|
completeMessage?: string;
|
|
51
|
+
/**
|
|
52
|
+
*
|
|
53
|
+
* @type {Array<DatacollectionContributor>}
|
|
54
|
+
* @memberof DatacollectionBody
|
|
55
|
+
*/
|
|
56
|
+
contributors?: Array<DatacollectionContributor>;
|
|
44
57
|
/**
|
|
45
58
|
*
|
|
46
59
|
* @type {boolean}
|
|
@@ -12,6 +12,7 @@
|
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
14
|
import { DatacollectionAuthenticationFromJSON, DatacollectionAuthenticationToJSON, } from './DatacollectionAuthentication';
|
|
15
|
+
import { DatacollectionContributorFromJSON, DatacollectionContributorToJSON, } from './DatacollectionContributor';
|
|
15
16
|
import { StepFromJSON, StepToJSON, } from './Step';
|
|
16
17
|
/**
|
|
17
18
|
* Check if a given object implements the DatacollectionBody interface.
|
|
@@ -37,8 +38,10 @@ export function DatacollectionBodyFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
37
38
|
return {
|
|
38
39
|
'anonymisationProperty': json['anonymisationProperty'] == null ? undefined : json['anonymisationProperty'],
|
|
39
40
|
'authenticationMode': json['authenticationMode'] == null ? undefined : DatacollectionAuthenticationFromJSON(json['authenticationMode']),
|
|
41
|
+
'clearContributors': json['clearContributors'] == null ? undefined : json['clearContributors'],
|
|
40
42
|
'clearSteps': json['clearSteps'],
|
|
41
43
|
'completeMessage': json['completeMessage'] == null ? undefined : json['completeMessage'],
|
|
44
|
+
'contributors': json['contributors'] == null ? undefined : (json['contributors'].map(DatacollectionContributorFromJSON)),
|
|
42
45
|
'delete': json['delete'],
|
|
43
46
|
'description': json['description'] == null ? undefined : json['description'],
|
|
44
47
|
'end': json['end'] == null ? undefined : json['end'],
|
|
@@ -63,8 +66,10 @@ export function DatacollectionBodyToJSONTyped(value, ignoreDiscriminator = false
|
|
|
63
66
|
return {
|
|
64
67
|
'anonymisationProperty': value['anonymisationProperty'],
|
|
65
68
|
'authenticationMode': DatacollectionAuthenticationToJSON(value['authenticationMode']),
|
|
69
|
+
'clearContributors': value['clearContributors'],
|
|
66
70
|
'clearSteps': value['clearSteps'],
|
|
67
71
|
'completeMessage': value['completeMessage'],
|
|
72
|
+
'contributors': value['contributors'] == null ? undefined : (value['contributors'].map(DatacollectionContributorToJSON)),
|
|
68
73
|
'delete': value['delete'],
|
|
69
74
|
'description': value['description'],
|
|
70
75
|
'end': value['end'],
|
|
@@ -10,6 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import type { DatacollectionAuthentication } from './DatacollectionAuthentication';
|
|
13
|
+
import type { DatacollectionContributor } from './DatacollectionContributor';
|
|
13
14
|
import type { Step } from './Step';
|
|
14
15
|
/**
|
|
15
16
|
*
|
|
@@ -35,6 +36,18 @@ export interface DatacollectionChangelogBody {
|
|
|
35
36
|
* @memberof DatacollectionChangelogBody
|
|
36
37
|
*/
|
|
37
38
|
completeMessage: string;
|
|
39
|
+
/**
|
|
40
|
+
*
|
|
41
|
+
* @type {Array<DatacollectionContributor>}
|
|
42
|
+
* @memberof DatacollectionChangelogBody
|
|
43
|
+
*/
|
|
44
|
+
contributors: Array<DatacollectionContributor>;
|
|
45
|
+
/**
|
|
46
|
+
*
|
|
47
|
+
* @type {boolean}
|
|
48
|
+
* @memberof DatacollectionChangelogBody
|
|
49
|
+
*/
|
|
50
|
+
contributorsUploaded: boolean;
|
|
38
51
|
/**
|
|
39
52
|
*
|
|
40
53
|
* @type {string}
|