@spaciv/sdk 0.1.9 → 0.1.10

package/.openapi-generator/FILES

@@ -182,6 +182,7 @@ src/models/DatacollectionAuthenticationOneOf2.ts
 src/models/DatacollectionAuthenticationOneOf3.ts
 src/models/DatacollectionBody.ts
 src/models/DatacollectionChangelogBody.ts
+src/models/DatacollectionContributor.ts
 src/models/DatasetAddResponseBody.ts
 src/models/DatasetChangelogBody.ts
 src/models/DatasetChangelogData.ts

package/README.md

@@ -1,4 +1,4 @@
-## @spaciv/sdk@0.1.9
+## @spaciv/sdk@0.1.10
 
 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:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @spaciv/sdk@0.1.9 --save
+npm install @spaciv/sdk@0.1.10 --save
 ```
 
 _unPublished (not recommended):_

package/dist/apis/ContributionsApi.d.ts

@@ -31,7 +31,7 @@ export interface ContributionsApiGetDataCollectionsContributionRequest {
  */
 export interface ContributionsApiInterface {
     /**
-     * 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 membership when the contribution is completed and returns `404` if the contribution ID is unknown. Requires the *Edit contribution* permission.
+     * 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.
      * @summary Save a contribution
      * @param {string} id
      * @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 {
      */
     createDataCollectionsContributionRaw(requestParameters: ContributionsApiCreateDataCollectionsContributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
     /**
-     * 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 membership when the contribution is completed and returns `404` if the contribution ID is unknown. Requires the *Edit contribution* permission.
+     * 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.
      * Save a contribution
      */
     createDataCollectionsContribution(requestParameters: ContributionsApiCreateDataCollectionsContributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
@@ -81,12 +81,12 @@ export interface ContributionsApiInterface {
  */
 export declare class ContributionsApi extends runtime.BaseAPI implements ContributionsApiInterface {
     /**
-     * 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 membership when the contribution is completed and returns `404` if the contribution ID is unknown. Requires the *Edit contribution* permission.
+     * 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.
      * Save a contribution
      */
     createDataCollectionsContributionRaw(requestParameters: ContributionsApiCreateDataCollectionsContributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
     /**
-     * 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 membership when the contribution is completed and returns `404` if the contribution ID is unknown. Requires the *Edit contribution* permission.
+     * 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.
      * Save a contribution
      */
     createDataCollectionsContribution(requestParameters: ContributionsApiCreateDataCollectionsContributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;

package/dist/apis/ContributionsApi.js

@@ -30,7 +30,7 @@ const index_1 = require("../models/index");
  */
 class ContributionsApi extends runtime.BaseAPI {
     /**
-     * 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 membership when the contribution is completed and returns `404` if the contribution ID is unknown. Requires the *Edit contribution* permission.
+     * 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.
      * Save a contribution
      */
     createDataCollectionsContributionRaw(requestParameters, initOverrides) {
@@ -64,7 +64,7 @@ class ContributionsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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 membership when the contribution is completed and returns `404` if the contribution ID is unknown. Requires the *Edit contribution* permission.
+     * 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.
      * Save a contribution
      */
     createDataCollectionsContribution(requestParameters, initOverrides) {

package/dist/apis/DataCollectionApi.d.ts

@@ -65,7 +65,7 @@ export interface DataCollectionApiInterface {
      */
     delete(requestParameters: DataCollectionApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
     /**
-     * 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.
+     * 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.
      * @summary Get a data collection survey
      * @param {string} id
      * @param {*} [options] Override http request option.
@@ -74,7 +74,7 @@ export interface DataCollectionApiInterface {
      */
     getRaw(requestParameters: DataCollectionApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetDatacollectionRes>>;
     /**
-     * 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.
+     * 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.
      * Get a data collection survey
      */
     get(requestParameters: DataCollectionApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDatacollectionRes>;
@@ -120,7 +120,7 @@ export interface DataCollectionApiInterface {
      */
     list(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDatacollectionListRes>;
     /**
-     * Returns every invited contributor for the survey, each with their current contribution state and contact details. For email-authenticated surveys the list is derived from the configured audience (object group or dataset); for anonymous and public surveys it reflects submitted contributions. Requires the *View crowd modelling* permission.
+     * 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.
      * @summary List contributors for a survey
      * @param {string} id
      * @param {*} [options] Override http request option.
@@ -129,12 +129,12 @@ export interface DataCollectionApiInterface {
      */
     listContributorsRaw(requestParameters: DataCollectionApiListContributorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContributionListRes>>;
     /**
-     * Returns every invited contributor for the survey, each with their current contribution state and contact details. For email-authenticated surveys the list is derived from the configured audience (object group or dataset); for anonymous and public surveys it reflects submitted contributions. Requires the *View crowd modelling* permission.
+     * 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.
      * List contributors for a survey
      */
     listContributors(requestParameters: DataCollectionApiListContributorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContributionListRes>;
     /**
-     * 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.
+     * 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 either requires the *Upload data collection contributors* permission as well, and 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.
      * @summary Update a data collection survey
      * @param {string} id
      * @param {DatacollectionBody} [datacollectionBody]
@@ -144,7 +144,7 @@ export interface DataCollectionApiInterface {
      */
     updateRaw(requestParameters: DataCollectionApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
     /**
-     * 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.
+     * 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 either requires the *Upload data collection contributors* permission as well, and 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.
      * Update a data collection survey
      */
     update(requestParameters: DataCollectionApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
@@ -174,12 +174,12 @@ export declare class DataCollectionApi extends runtime.BaseAPI implements DataCo
      */
     delete(requestParameters: DataCollectionApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
     /**
-     * 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.
+     * 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.
      * Get a data collection survey
      */
     getRaw(requestParameters: DataCollectionApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetDatacollectionRes>>;
     /**
-     * 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.
+     * 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.
      * Get a data collection survey
      */
     get(requestParameters: DataCollectionApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDatacollectionRes>;
@@ -214,22 +214,22 @@ export declare class DataCollectionApi extends runtime.BaseAPI implements DataCo
      */
     list(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDatacollectionListRes>;
     /**
-     * Returns every invited contributor for the survey, each with their current contribution state and contact details. For email-authenticated surveys the list is derived from the configured audience (object group or dataset); for anonymous and public surveys it reflects submitted contributions. Requires the *View crowd modelling* permission.
+     * 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.
      * List contributors for a survey
      */
     listContributorsRaw(requestParameters: DataCollectionApiListContributorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContributionListRes>>;
     /**
-     * Returns every invited contributor for the survey, each with their current contribution state and contact details. For email-authenticated surveys the list is derived from the configured audience (object group or dataset); for anonymous and public surveys it reflects submitted contributions. Requires the *View crowd modelling* permission.
+     * 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.
      * List contributors for a survey
      */
     listContributors(requestParameters: DataCollectionApiListContributorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContributionListRes>;
     /**
-     * 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.
+     * 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 either requires the *Upload data collection contributors* permission as well, and 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.
      * Update a data collection survey
      */
     updateRaw(requestParameters: DataCollectionApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
     /**
-     * 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.
+     * 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 either requires the *Upload data collection contributors* permission as well, and 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.
      * Update a data collection survey
      */
     update(requestParameters: DataCollectionApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;

package/dist/apis/DataCollectionApi.js

@@ -104,7 +104,7 @@ class DataCollectionApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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.
+     * 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.
      * Get a data collection survey
      */
     getRaw(requestParameters, initOverrides) {
@@ -133,7 +133,7 @@ class DataCollectionApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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.
+     * 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.
      * Get a data collection survey
      */
     get(requestParameters, initOverrides) {
@@ -266,7 +266,7 @@ class DataCollectionApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Returns every invited contributor for the survey, each with their current contribution state and contact details. For email-authenticated surveys the list is derived from the configured audience (object group or dataset); for anonymous and public surveys it reflects submitted contributions. Requires the *View crowd modelling* permission.
+     * 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.
      * List contributors for a survey
      */
     listContributorsRaw(requestParameters, initOverrides) {
@@ -295,7 +295,7 @@ class DataCollectionApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Returns every invited contributor for the survey, each with their current contribution state and contact details. For email-authenticated surveys the list is derived from the configured audience (object group or dataset); for anonymous and public surveys it reflects submitted contributions. Requires the *View crowd modelling* permission.
+     * 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.
      * List contributors for a survey
      */
     listContributors(requestParameters, initOverrides) {
@@ -305,7 +305,7 @@ class DataCollectionApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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.
+     * 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 either requires the *Upload data collection contributors* permission as well, and 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.
      * Update a data collection survey
      */
     updateRaw(requestParameters, initOverrides) {
@@ -336,7 +336,7 @@ class DataCollectionApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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.
+     * 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 either requires the *Upload data collection contributors* permission as well, and 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.
      * Update a data collection survey
      */
     update(requestParameters, initOverrides) {

package/dist/esm/apis/ContributionsApi.d.ts

@@ -31,7 +31,7 @@ export interface ContributionsApiGetDataCollectionsContributionRequest {
  */
 export interface ContributionsApiInterface {
     /**
-     * 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 membership when the contribution is completed and returns `404` if the contribution ID is unknown. Requires the *Edit contribution* permission.
+     * 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.
      * @summary Save a contribution
      * @param {string} id
      * @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 {
      */
     createDataCollectionsContributionRaw(requestParameters: ContributionsApiCreateDataCollectionsContributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
     /**
-     * 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 membership when the contribution is completed and returns `404` if the contribution ID is unknown. Requires the *Edit contribution* permission.
+     * 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.
      * Save a contribution
      */
     createDataCollectionsContribution(requestParameters: ContributionsApiCreateDataCollectionsContributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
@@ -81,12 +81,12 @@ export interface ContributionsApiInterface {
  */
 export declare class ContributionsApi extends runtime.BaseAPI implements ContributionsApiInterface {
     /**
-     * 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 membership when the contribution is completed and returns `404` if the contribution ID is unknown. Requires the *Edit contribution* permission.
+     * 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.
      * Save a contribution
      */
     createDataCollectionsContributionRaw(requestParameters: ContributionsApiCreateDataCollectionsContributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
     /**
-     * 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 membership when the contribution is completed and returns `404` if the contribution ID is unknown. Requires the *Edit contribution* permission.
+     * 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.
      * Save a contribution
      */
     createDataCollectionsContribution(requestParameters: ContributionsApiCreateDataCollectionsContributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;

package/dist/esm/apis/ContributionsApi.js

@@ -27,7 +27,7 @@ import { ContributionPostToJSON, GetContributionResFromJSON, } from '../models/i
  */
 export class ContributionsApi extends runtime.BaseAPI {
     /**
-     * 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 membership when the contribution is completed and returns `404` if the contribution ID is unknown. Requires the *Edit contribution* permission.
+     * 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.
      * Save a contribution
      */
     createDataCollectionsContributionRaw(requestParameters, initOverrides) {
@@ -61,7 +61,7 @@ export class ContributionsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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 membership when the contribution is completed and returns `404` if the contribution ID is unknown. Requires the *Edit contribution* permission.
+     * 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.
      * Save a contribution
      */
     createDataCollectionsContribution(requestParameters, initOverrides) {

package/dist/esm/apis/DataCollectionApi.d.ts

@@ -65,7 +65,7 @@ export interface DataCollectionApiInterface {
      */
     delete(requestParameters: DataCollectionApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
     /**
-     * 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.
+     * 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.
      * @summary Get a data collection survey
      * @param {string} id
      * @param {*} [options] Override http request option.
@@ -74,7 +74,7 @@ export interface DataCollectionApiInterface {
      */
     getRaw(requestParameters: DataCollectionApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetDatacollectionRes>>;
     /**
-     * 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.
+     * 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.
      * Get a data collection survey
      */
     get(requestParameters: DataCollectionApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDatacollectionRes>;
@@ -120,7 +120,7 @@ export interface DataCollectionApiInterface {
      */
     list(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDatacollectionListRes>;
     /**
-     * Returns every invited contributor for the survey, each with their current contribution state and contact details. For email-authenticated surveys the list is derived from the configured audience (object group or dataset); for anonymous and public surveys it reflects submitted contributions. Requires the *View crowd modelling* permission.
+     * 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.
      * @summary List contributors for a survey
      * @param {string} id
      * @param {*} [options] Override http request option.
@@ -129,12 +129,12 @@ export interface DataCollectionApiInterface {
      */
     listContributorsRaw(requestParameters: DataCollectionApiListContributorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContributionListRes>>;
     /**
-     * Returns every invited contributor for the survey, each with their current contribution state and contact details. For email-authenticated surveys the list is derived from the configured audience (object group or dataset); for anonymous and public surveys it reflects submitted contributions. Requires the *View crowd modelling* permission.
+     * 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.
      * List contributors for a survey
      */
     listContributors(requestParameters: DataCollectionApiListContributorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContributionListRes>;
     /**
-     * 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.
+     * 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 either requires the *Upload data collection contributors* permission as well, and 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.
      * @summary Update a data collection survey
      * @param {string} id
      * @param {DatacollectionBody} [datacollectionBody]
@@ -144,7 +144,7 @@ export interface DataCollectionApiInterface {
      */
     updateRaw(requestParameters: DataCollectionApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
     /**
-     * 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.
+     * 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 either requires the *Upload data collection contributors* permission as well, and 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.
      * Update a data collection survey
      */
     update(requestParameters: DataCollectionApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
@@ -174,12 +174,12 @@ export declare class DataCollectionApi extends runtime.BaseAPI implements DataCo
      */
     delete(requestParameters: DataCollectionApiDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
     /**
-     * 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.
+     * 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.
      * Get a data collection survey
      */
     getRaw(requestParameters: DataCollectionApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetDatacollectionRes>>;
     /**
-     * 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.
+     * 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.
      * Get a data collection survey
      */
     get(requestParameters: DataCollectionApiGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDatacollectionRes>;
@@ -214,22 +214,22 @@ export declare class DataCollectionApi extends runtime.BaseAPI implements DataCo
      */
     list(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDatacollectionListRes>;
     /**
-     * Returns every invited contributor for the survey, each with their current contribution state and contact details. For email-authenticated surveys the list is derived from the configured audience (object group or dataset); for anonymous and public surveys it reflects submitted contributions. Requires the *View crowd modelling* permission.
+     * 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.
      * List contributors for a survey
      */
     listContributorsRaw(requestParameters: DataCollectionApiListContributorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContributionListRes>>;
     /**
-     * Returns every invited contributor for the survey, each with their current contribution state and contact details. For email-authenticated surveys the list is derived from the configured audience (object group or dataset); for anonymous and public surveys it reflects submitted contributions. Requires the *View crowd modelling* permission.
+     * 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.
      * List contributors for a survey
      */
     listContributors(requestParameters: DataCollectionApiListContributorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContributionListRes>;
     /**
-     * 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.
+     * 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 either requires the *Upload data collection contributors* permission as well, and 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.
      * Update a data collection survey
      */
     updateRaw(requestParameters: DataCollectionApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
     /**
-     * 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.
+     * 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 either requires the *Upload data collection contributors* permission as well, and 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.
      * Update a data collection survey
      */
     update(requestParameters: DataCollectionApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;

package/dist/esm/apis/DataCollectionApi.js

@@ -101,7 +101,7 @@ export class DataCollectionApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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.
+     * 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.
      * Get a data collection survey
      */
     getRaw(requestParameters, initOverrides) {
@@ -130,7 +130,7 @@ export class DataCollectionApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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.
+     * 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.
      * Get a data collection survey
      */
     get(requestParameters, initOverrides) {
@@ -263,7 +263,7 @@ export class DataCollectionApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Returns every invited contributor for the survey, each with their current contribution state and contact details. For email-authenticated surveys the list is derived from the configured audience (object group or dataset); for anonymous and public surveys it reflects submitted contributions. Requires the *View crowd modelling* permission.
+     * 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.
      * List contributors for a survey
      */
     listContributorsRaw(requestParameters, initOverrides) {
@@ -292,7 +292,7 @@ export class DataCollectionApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Returns every invited contributor for the survey, each with their current contribution state and contact details. For email-authenticated surveys the list is derived from the configured audience (object group or dataset); for anonymous and public surveys it reflects submitted contributions. Requires the *View crowd modelling* permission.
+     * 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.
      * List contributors for a survey
      */
     listContributors(requestParameters, initOverrides) {
@@ -302,7 +302,7 @@ export class DataCollectionApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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.
+     * 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 either requires the *Upload data collection contributors* permission as well, and 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.
      * Update a data collection survey
      */
     updateRaw(requestParameters, initOverrides) {
@@ -333,7 +333,7 @@ export class DataCollectionApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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.
+     * 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 either requires the *Upload data collection contributors* permission as well, and 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.
      * Update a data collection survey
      */
     update(requestParameters, initOverrides) {

package/dist/esm/models/DatacollectionBody.d.ts

@@ -10,6 +10,7 @@
  * Do not edit the class manually.
  */
 import type { DatacollectionAuthentication } from './DatacollectionAuthentication';
+import type { DatacollectionContributor } from './DatacollectionContributor';
 import type { Step } from './Step';
 /**
  *
@@ -29,6 +30,12 @@ export interface DatacollectionBody {
      * @memberof DatacollectionBody
      */
     authenticationMode?: DatacollectionAuthentication;
+    /**
+     *
+     * @type {boolean}
+     * @memberof DatacollectionBody
+     */
+    clearContributors?: boolean;
     /**
      *
      * @type {boolean}
@@ -41,6 +48,12 @@ export interface DatacollectionBody {
      * @memberof DatacollectionBody
      */
     completeMessage?: string;
+    /**
+     *
+     * @type {Array<DatacollectionContributor>}
+     * @memberof DatacollectionBody
+     */
+    contributors?: Array<DatacollectionContributor>;
     /**
      *
      * @type {boolean}

package/dist/esm/models/DatacollectionBody.js

@@ -12,6 +12,7 @@
  * Do not edit the class manually.
  */
 import { DatacollectionAuthenticationFromJSON, DatacollectionAuthenticationToJSON, } from './DatacollectionAuthentication';
+import { DatacollectionContributorFromJSON, DatacollectionContributorToJSON, } from './DatacollectionContributor';
 import { StepFromJSON, StepToJSON, } from './Step';
 /**
  * Check if a given object implements the DatacollectionBody interface.
@@ -37,8 +38,10 @@ export function DatacollectionBodyFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'anonymisationProperty': json['anonymisationProperty'] == null ? undefined : json['anonymisationProperty'],
         'authenticationMode': json['authenticationMode'] == null ? undefined : DatacollectionAuthenticationFromJSON(json['authenticationMode']),
+        'clearContributors': json['clearContributors'] == null ? undefined : json['clearContributors'],
         'clearSteps': json['clearSteps'],
         'completeMessage': json['completeMessage'] == null ? undefined : json['completeMessage'],
+        'contributors': json['contributors'] == null ? undefined : (json['contributors'].map(DatacollectionContributorFromJSON)),
         'delete': json['delete'],
         'description': json['description'] == null ? undefined : json['description'],
         'end': json['end'] == null ? undefined : json['end'],
@@ -63,8 +66,10 @@ export function DatacollectionBodyToJSONTyped(value, ignoreDiscriminator = false
     return {
         'anonymisationProperty': value['anonymisationProperty'],
         'authenticationMode': DatacollectionAuthenticationToJSON(value['authenticationMode']),
+        'clearContributors': value['clearContributors'],
         'clearSteps': value['clearSteps'],
         'completeMessage': value['completeMessage'],
+        'contributors': value['contributors'] == null ? undefined : (value['contributors'].map(DatacollectionContributorToJSON)),
         'delete': value['delete'],
         'description': value['description'],
         'end': value['end'],

package/dist/esm/models/DatacollectionChangelogBody.d.ts

@@ -10,6 +10,7 @@
  * Do not edit the class manually.
  */
 import type { DatacollectionAuthentication } from './DatacollectionAuthentication';
+import type { DatacollectionContributor } from './DatacollectionContributor';
 import type { Step } from './Step';
 /**
  *
@@ -35,6 +36,18 @@ export interface DatacollectionChangelogBody {
      * @memberof DatacollectionChangelogBody
      */
     completeMessage: string;
+    /**
+     *
+     * @type {Array<DatacollectionContributor>}
+     * @memberof DatacollectionChangelogBody
+     */
+    contributors: Array<DatacollectionContributor>;
+    /**
+     *
+     * @type {boolean}
+     * @memberof DatacollectionChangelogBody
+     */
+    contributorsUploaded: boolean;
     /**
      *
      * @type {string}