@wix/auto_sdk_online-programs_quizzes 1.0.16 → 1.0.18
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/build/cjs/index.d.ts +16 -13
- package/build/cjs/index.js +47 -70
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +48 -58
- package/build/cjs/index.typings.js +39 -61
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +34 -40
- package/build/cjs/meta.js +40 -56
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +16 -13
- package/build/es/index.mjs +46 -69
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +48 -58
- package/build/es/index.typings.mjs +38 -60
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +34 -40
- package/build/es/meta.mjs +39 -55
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +16 -13
- package/build/internal/cjs/index.typings.d.ts +48 -63
- package/build/internal/cjs/meta.d.ts +34 -45
- package/build/internal/es/index.d.mts +16 -13
- package/build/internal/es/index.typings.d.mts +48 -63
- package/build/internal/es/meta.d.mts +34 -45
- package/package.json +2 -2
|
@@ -285,35 +285,6 @@ interface BulkActionMetadata {
|
|
|
285
285
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
286
286
|
undetailedFailures?: number;
|
|
287
287
|
}
|
|
288
|
-
interface BulkCloneQuizRequest {
|
|
289
|
-
/**
|
|
290
|
-
* IDs of the quizzes to clone.
|
|
291
|
-
* @minSize 1
|
|
292
|
-
* @maxSize 30
|
|
293
|
-
* @format GUID
|
|
294
|
-
*/
|
|
295
|
-
quizIds: string[];
|
|
296
|
-
/**
|
|
297
|
-
* Whether to return the cloned quizzes in the response.
|
|
298
|
-
*
|
|
299
|
-
* Default: `false`
|
|
300
|
-
*/
|
|
301
|
-
returnEntity?: boolean;
|
|
302
|
-
}
|
|
303
|
-
interface BulkCloneQuizResponse {
|
|
304
|
-
/** Results of the bulk clone operation, including cloned quizzes and metadata. */
|
|
305
|
-
results?: V1BulkQuizResult[];
|
|
306
|
-
/** Metadata about the bulk operation. */
|
|
307
|
-
bulkActionMetadata?: CommonBulkActionMetadata;
|
|
308
|
-
}
|
|
309
|
-
interface CommonBulkActionMetadata {
|
|
310
|
-
/** Number of items that were successfully processed. */
|
|
311
|
-
totalSuccesses?: number;
|
|
312
|
-
/** Number of items that couldn't be processed. */
|
|
313
|
-
totalFailures?: number;
|
|
314
|
-
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
315
|
-
undetailedFailures?: number;
|
|
316
|
-
}
|
|
317
288
|
interface GetQuizRequest {
|
|
318
289
|
/**
|
|
319
290
|
* ID of the quiz
|
|
@@ -325,19 +296,6 @@ interface GetQuizResponse {
|
|
|
325
296
|
/** Requested quiz */
|
|
326
297
|
quiz?: Quiz;
|
|
327
298
|
}
|
|
328
|
-
interface UpdateQuizRequest {
|
|
329
|
-
/** Quiz to be updated. Maybe partial */
|
|
330
|
-
quiz?: Quiz;
|
|
331
|
-
/**
|
|
332
|
-
* Explicit list of fields to update
|
|
333
|
-
* @internal
|
|
334
|
-
*/
|
|
335
|
-
mask?: string[];
|
|
336
|
-
}
|
|
337
|
-
interface UpdateQuizResponse {
|
|
338
|
-
/** Updated quiz */
|
|
339
|
-
quiz?: Quiz;
|
|
340
|
-
}
|
|
341
299
|
interface DeleteQuizRequest {
|
|
342
300
|
/**
|
|
343
301
|
* ID of quiz
|
|
@@ -349,6 +307,29 @@ interface DeleteQuizResponse {
|
|
|
349
307
|
/** Deleted quiz */
|
|
350
308
|
quiz?: Quiz;
|
|
351
309
|
}
|
|
310
|
+
interface BulkDeleteQuizzesRequest {
|
|
311
|
+
/**
|
|
312
|
+
* IDs of the quizzes to delete.
|
|
313
|
+
* @minSize 1
|
|
314
|
+
* @maxSize 100
|
|
315
|
+
* @format GUID
|
|
316
|
+
*/
|
|
317
|
+
quizIds: string[];
|
|
318
|
+
}
|
|
319
|
+
interface BulkDeleteQuizzesResponse {
|
|
320
|
+
/**
|
|
321
|
+
* Results of the bulk delete operation.
|
|
322
|
+
* @minSize 1
|
|
323
|
+
* @maxSize 100
|
|
324
|
+
*/
|
|
325
|
+
results?: BulkDeleteQuizzesResponseBulkQuizResult[];
|
|
326
|
+
/** Metadata about the bulk delete operation. */
|
|
327
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
328
|
+
}
|
|
329
|
+
interface BulkDeleteQuizzesResponseBulkQuizResult {
|
|
330
|
+
/** Metadata for the individual delete operation. */
|
|
331
|
+
itemMetadata?: ItemMetadata;
|
|
332
|
+
}
|
|
352
333
|
interface BulkDeleteQuizRequest {
|
|
353
334
|
/**
|
|
354
335
|
* IDs of quizzes to delete
|
|
@@ -368,6 +349,14 @@ interface BulkDeleteQuizResponse {
|
|
|
368
349
|
/** Metadata about the bulk operation. */
|
|
369
350
|
bulkActionMetadata?: CommonBulkActionMetadata;
|
|
370
351
|
}
|
|
352
|
+
interface CommonBulkActionMetadata {
|
|
353
|
+
/** Number of items that were successfully processed. */
|
|
354
|
+
totalSuccesses?: number;
|
|
355
|
+
/** Number of items that couldn't be processed. */
|
|
356
|
+
totalFailures?: number;
|
|
357
|
+
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
358
|
+
undetailedFailures?: number;
|
|
359
|
+
}
|
|
371
360
|
interface DomainEvent extends DomainEventBodyOneOf {
|
|
372
361
|
createdEvent?: EntityCreatedEvent;
|
|
373
362
|
updatedEvent?: EntityUpdatedEvent;
|
|
@@ -570,25 +559,6 @@ interface BulkCreateQuizOptions {
|
|
|
570
559
|
/** When set, items will be returned on successful create */
|
|
571
560
|
returnEntity?: boolean;
|
|
572
561
|
}
|
|
573
|
-
/**
|
|
574
|
-
* Clones quizzes.
|
|
575
|
-
* @param quizIds - IDs of the quizzes to clone.
|
|
576
|
-
* @public
|
|
577
|
-
* @documentationMaturity preview
|
|
578
|
-
* @requiredField quizIds
|
|
579
|
-
* @permissionId QUIZZES.CREATE_QUIZ
|
|
580
|
-
* @applicableIdentity APP
|
|
581
|
-
* @fqn wix.achievements.quizzes.v1.QuizService.BulkCloneQuiz
|
|
582
|
-
*/
|
|
583
|
-
declare function bulkCloneQuiz(quizIds: string[], options?: BulkCloneQuizOptions): Promise<NonNullablePaths<BulkCloneQuizResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
|
|
584
|
-
interface BulkCloneQuizOptions {
|
|
585
|
-
/**
|
|
586
|
-
* Whether to return the cloned quizzes in the response.
|
|
587
|
-
*
|
|
588
|
-
* Default: `false`
|
|
589
|
-
*/
|
|
590
|
-
returnEntity?: boolean;
|
|
591
|
-
}
|
|
592
562
|
/**
|
|
593
563
|
* Reads quiz by ID
|
|
594
564
|
* @param quizId - ID of the quiz
|
|
@@ -611,7 +581,19 @@ declare function getQuiz(quizId: string): Promise<NonNullablePaths<Quiz, `fields
|
|
|
611
581
|
*/
|
|
612
582
|
declare function deleteQuiz(quizId: string): Promise<NonNullablePaths<DeleteQuizResponse, `quiz.fields` | `quiz.fields.${number}._id`, 5>>;
|
|
613
583
|
/**
|
|
614
|
-
*
|
|
584
|
+
* Permanently deletes up to 100 quiz definitions.
|
|
585
|
+
*
|
|
586
|
+
* This operation doesn't check whether Online Programs steps reference the quizzes. Callers must remove or verify those references before deleting.
|
|
587
|
+
* @param quizIds - IDs of the quizzes to delete.
|
|
588
|
+
* @public
|
|
589
|
+
* @documentationMaturity preview
|
|
590
|
+
* @requiredField quizIds
|
|
591
|
+
* @permissionId achievements:quizzes:v1:quiz:bulk_delete_quizzes
|
|
592
|
+
* @fqn wix.achievements.quizzes.v1.QuizService.BulkDeleteQuizzes
|
|
593
|
+
*/
|
|
594
|
+
declare function bulkDeleteQuizzes(quizIds: string[]): Promise<NonNullablePaths<BulkDeleteQuizzesResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
|
|
595
|
+
/**
|
|
596
|
+
* Deprecated. Use `BulkDeleteQuizzes`.
|
|
615
597
|
* @param quizIds - IDs of quizzes to delete
|
|
616
598
|
* @public
|
|
617
599
|
* @documentationMaturity preview
|
|
@@ -619,7 +601,10 @@ declare function deleteQuiz(quizId: string): Promise<NonNullablePaths<DeleteQuiz
|
|
|
619
601
|
* @permissionId QUIZZES.DELETE_QUIZ
|
|
620
602
|
* @applicableIdentity APP
|
|
621
603
|
* @fqn wix.achievements.quizzes.v1.QuizService.BulkDeleteQuiz
|
|
604
|
+
* @deprecated
|
|
605
|
+
* @replacedBy wix.achievements.quizzes.v1.QuizService.BulkDeleteQuizzes
|
|
606
|
+
* @targetRemovalDate 2027-09-02
|
|
622
607
|
*/
|
|
623
608
|
declare function bulkDeleteQuiz(quizIds: string[]): Promise<NonNullablePaths<BulkDeleteQuizResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
|
|
624
609
|
|
|
625
|
-
export { type AccountInfo, type ActionEvent, type ApplicationError, type BulkActionMetadata, type
|
|
610
|
+
export { type AccountInfo, type ActionEvent, type ApplicationError, type BulkActionMetadata, type BulkCloneQuizzesRequest, type BulkCloneQuizzesResponse, type BulkCreateQuizOptions, type BulkCreateQuizRequest, type BulkCreateQuizResponse, type BulkDeleteQuizRequest, type BulkDeleteQuizResponse, type BulkDeleteQuizzesRequest, type BulkDeleteQuizzesResponse, type BulkDeleteQuizzesResponseBulkQuizResult, type BulkQuizResult, type CloneQuizRequest, type CloneQuizResponse, type CommonBulkActionMetadata, type CommonItemMetadata, type CreateQuizRequest, type CreateQuizResponse, type DeleteQuizRequest, type DeleteQuizResponse, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, FileFormat, type FileFormatWithLiterals, type FileUploadField, type GetQuizRequest, type GetQuizResponse, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, type LongTextField, type MessageEnvelope, type MultiChoiceField, type NumericField, type Quiz, type QuizField, type QuizFieldFieldTypeOneOf, type QuizSettings, type RestoreInfo, type ShortTextField, type SingleChoiceField, type V1BulkQuizResult, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkCreateQuiz, bulkDeleteQuiz, bulkDeleteQuizzes, cloneQuiz, createQuiz, deleteQuiz, getQuiz };
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { CreateQuizRequest as CreateQuizRequest$1, CreateQuizResponse as CreateQuizResponse$1, CloneQuizRequest as CloneQuizRequest$1, CloneQuizResponse as CloneQuizResponse$1, BulkCreateQuizRequest as BulkCreateQuizRequest$1, BulkCreateQuizResponse as BulkCreateQuizResponse$1,
|
|
1
|
+
import { CreateQuizRequest as CreateQuizRequest$1, CreateQuizResponse as CreateQuizResponse$1, CloneQuizRequest as CloneQuizRequest$1, CloneQuizResponse as CloneQuizResponse$1, BulkCreateQuizRequest as BulkCreateQuizRequest$1, BulkCreateQuizResponse as BulkCreateQuizResponse$1, GetQuizRequest as GetQuizRequest$1, GetQuizResponse as GetQuizResponse$1, DeleteQuizRequest as DeleteQuizRequest$1, DeleteQuizResponse as DeleteQuizResponse$1, BulkDeleteQuizzesRequest as BulkDeleteQuizzesRequest$1, BulkDeleteQuizzesResponse as BulkDeleteQuizzesResponse$1, BulkDeleteQuizRequest as BulkDeleteQuizRequest$1, BulkDeleteQuizResponse as BulkDeleteQuizResponse$1 } from './index.typings.js';
|
|
2
2
|
import '@wix/sdk-types';
|
|
3
3
|
|
|
4
4
|
interface Quiz {
|
|
@@ -286,35 +286,6 @@ interface BulkActionMetadata {
|
|
|
286
286
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
287
287
|
undetailedFailures?: number;
|
|
288
288
|
}
|
|
289
|
-
interface BulkCloneQuizRequest {
|
|
290
|
-
/**
|
|
291
|
-
* IDs of the quizzes to clone.
|
|
292
|
-
* @minSize 1
|
|
293
|
-
* @maxSize 30
|
|
294
|
-
* @format GUID
|
|
295
|
-
*/
|
|
296
|
-
quizIds: string[];
|
|
297
|
-
/**
|
|
298
|
-
* Whether to return the cloned quizzes in the response.
|
|
299
|
-
*
|
|
300
|
-
* Default: `false`
|
|
301
|
-
*/
|
|
302
|
-
returnEntity?: boolean;
|
|
303
|
-
}
|
|
304
|
-
interface BulkCloneQuizResponse {
|
|
305
|
-
/** Results of the bulk clone operation, including cloned quizzes and metadata. */
|
|
306
|
-
results?: V1BulkQuizResult[];
|
|
307
|
-
/** Metadata about the bulk operation. */
|
|
308
|
-
bulkActionMetadata?: CommonBulkActionMetadata;
|
|
309
|
-
}
|
|
310
|
-
interface CommonBulkActionMetadata {
|
|
311
|
-
/** Number of items that were successfully processed. */
|
|
312
|
-
totalSuccesses?: number;
|
|
313
|
-
/** Number of items that couldn't be processed. */
|
|
314
|
-
totalFailures?: number;
|
|
315
|
-
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
316
|
-
undetailedFailures?: number;
|
|
317
|
-
}
|
|
318
289
|
interface GetQuizRequest {
|
|
319
290
|
/**
|
|
320
291
|
* ID of the quiz
|
|
@@ -326,19 +297,6 @@ interface GetQuizResponse {
|
|
|
326
297
|
/** Requested quiz */
|
|
327
298
|
quiz?: Quiz;
|
|
328
299
|
}
|
|
329
|
-
interface UpdateQuizRequest {
|
|
330
|
-
/** Quiz to be updated. Maybe partial */
|
|
331
|
-
quiz?: Quiz;
|
|
332
|
-
/**
|
|
333
|
-
* Explicit list of fields to update
|
|
334
|
-
* @internal
|
|
335
|
-
*/
|
|
336
|
-
mask?: string[];
|
|
337
|
-
}
|
|
338
|
-
interface UpdateQuizResponse {
|
|
339
|
-
/** Updated quiz */
|
|
340
|
-
quiz?: Quiz;
|
|
341
|
-
}
|
|
342
300
|
interface DeleteQuizRequest {
|
|
343
301
|
/**
|
|
344
302
|
* ID of quiz
|
|
@@ -350,6 +308,29 @@ interface DeleteQuizResponse {
|
|
|
350
308
|
/** Deleted quiz */
|
|
351
309
|
quiz?: Quiz;
|
|
352
310
|
}
|
|
311
|
+
interface BulkDeleteQuizzesRequest {
|
|
312
|
+
/**
|
|
313
|
+
* IDs of the quizzes to delete.
|
|
314
|
+
* @minSize 1
|
|
315
|
+
* @maxSize 100
|
|
316
|
+
* @format GUID
|
|
317
|
+
*/
|
|
318
|
+
quizIds: string[];
|
|
319
|
+
}
|
|
320
|
+
interface BulkDeleteQuizzesResponse {
|
|
321
|
+
/**
|
|
322
|
+
* Results of the bulk delete operation.
|
|
323
|
+
* @minSize 1
|
|
324
|
+
* @maxSize 100
|
|
325
|
+
*/
|
|
326
|
+
results?: BulkDeleteQuizzesResponseBulkQuizResult[];
|
|
327
|
+
/** Metadata about the bulk delete operation. */
|
|
328
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
329
|
+
}
|
|
330
|
+
interface BulkDeleteQuizzesResponseBulkQuizResult {
|
|
331
|
+
/** Metadata for the individual delete operation. */
|
|
332
|
+
itemMetadata?: ItemMetadata;
|
|
333
|
+
}
|
|
353
334
|
interface BulkDeleteQuizRequest {
|
|
354
335
|
/**
|
|
355
336
|
* IDs of quizzes to delete
|
|
@@ -369,6 +350,14 @@ interface BulkDeleteQuizResponse {
|
|
|
369
350
|
/** Metadata about the bulk operation. */
|
|
370
351
|
bulkActionMetadata?: CommonBulkActionMetadata;
|
|
371
352
|
}
|
|
353
|
+
interface CommonBulkActionMetadata {
|
|
354
|
+
/** Number of items that were successfully processed. */
|
|
355
|
+
totalSuccesses?: number;
|
|
356
|
+
/** Number of items that couldn't be processed. */
|
|
357
|
+
totalFailures?: number;
|
|
358
|
+
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
359
|
+
undetailedFailures?: number;
|
|
360
|
+
}
|
|
372
361
|
interface DomainEvent extends DomainEventBodyOneOf {
|
|
373
362
|
createdEvent?: EntityCreatedEvent;
|
|
374
363
|
updatedEvent?: EntityUpdatedEvent;
|
|
@@ -582,13 +571,13 @@ declare function cloneQuiz(): __PublicMethodMetaInfo<'POST', {
|
|
|
582
571
|
quizId: string;
|
|
583
572
|
}, CloneQuizRequest$1, CloneQuizRequest, CloneQuizResponse$1, CloneQuizResponse>;
|
|
584
573
|
declare function bulkCreateQuiz(): __PublicMethodMetaInfo<'POST', {}, BulkCreateQuizRequest$1, BulkCreateQuizRequest, BulkCreateQuizResponse$1, BulkCreateQuizResponse>;
|
|
585
|
-
declare function bulkCloneQuiz(): __PublicMethodMetaInfo<'POST', {}, BulkCloneQuizRequest$1, BulkCloneQuizRequest, BulkCloneQuizResponse$1, BulkCloneQuizResponse>;
|
|
586
574
|
declare function getQuiz(): __PublicMethodMetaInfo<'GET', {
|
|
587
575
|
quizId: string;
|
|
588
576
|
}, GetQuizRequest$1, GetQuizRequest, GetQuizResponse$1, GetQuizResponse>;
|
|
589
577
|
declare function deleteQuiz(): __PublicMethodMetaInfo<'DELETE', {
|
|
590
578
|
quizId: string;
|
|
591
579
|
}, DeleteQuizRequest$1, DeleteQuizRequest, DeleteQuizResponse$1, DeleteQuizResponse>;
|
|
580
|
+
declare function bulkDeleteQuizzes(): __PublicMethodMetaInfo<'POST', {}, BulkDeleteQuizzesRequest$1, BulkDeleteQuizzesRequest, BulkDeleteQuizzesResponse$1, BulkDeleteQuizzesResponse>;
|
|
592
581
|
declare function bulkDeleteQuiz(): __PublicMethodMetaInfo<'POST', {}, BulkDeleteQuizRequest$1, BulkDeleteQuizRequest, BulkDeleteQuizResponse$1, BulkDeleteQuizResponse>;
|
|
593
582
|
|
|
594
|
-
export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type ApplicationError as ApplicationErrorOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type
|
|
583
|
+
export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type ApplicationError as ApplicationErrorOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkCloneQuizzesRequest as BulkCloneQuizzesRequestOriginal, type BulkCloneQuizzesResponse as BulkCloneQuizzesResponseOriginal, type BulkCreateQuizRequest as BulkCreateQuizRequestOriginal, type BulkCreateQuizResponse as BulkCreateQuizResponseOriginal, type BulkDeleteQuizRequest as BulkDeleteQuizRequestOriginal, type BulkDeleteQuizResponse as BulkDeleteQuizResponseOriginal, type BulkDeleteQuizzesRequest as BulkDeleteQuizzesRequestOriginal, type BulkDeleteQuizzesResponseBulkQuizResult as BulkDeleteQuizzesResponseBulkQuizResultOriginal, type BulkDeleteQuizzesResponse as BulkDeleteQuizzesResponseOriginal, type BulkQuizResult as BulkQuizResultOriginal, type CloneQuizRequest as CloneQuizRequestOriginal, type CloneQuizResponse as CloneQuizResponseOriginal, type CommonBulkActionMetadata as CommonBulkActionMetadataOriginal, type CommonItemMetadata as CommonItemMetadataOriginal, type CreateQuizRequest as CreateQuizRequestOriginal, type CreateQuizResponse as CreateQuizResponseOriginal, type DeleteQuizRequest as DeleteQuizRequestOriginal, type DeleteQuizResponse as DeleteQuizResponseOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, FileFormat as FileFormatOriginal, type FileFormatWithLiterals as FileFormatWithLiteralsOriginal, type FileUploadField as FileUploadFieldOriginal, type GetQuizRequest as GetQuizRequestOriginal, type GetQuizResponse as GetQuizResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type ItemMetadata as ItemMetadataOriginal, type LongTextField as LongTextFieldOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MultiChoiceField as MultiChoiceFieldOriginal, type NumericField as NumericFieldOriginal, type QuizFieldFieldTypeOneOf as QuizFieldFieldTypeOneOfOriginal, type QuizField as QuizFieldOriginal, type Quiz as QuizOriginal, type QuizSettings as QuizSettingsOriginal, type RestoreInfo as RestoreInfoOriginal, type ShortTextField as ShortTextFieldOriginal, type SingleChoiceField as SingleChoiceFieldOriginal, type V1BulkQuizResult as V1BulkQuizResultOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, bulkCreateQuiz, bulkDeleteQuiz, bulkDeleteQuizzes, cloneQuiz, createQuiz, deleteQuiz, getQuiz };
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
|
|
2
|
-
import { Quiz, CloneQuizResponse, BulkCreateQuizOptions, BulkCreateQuizResponse,
|
|
3
|
-
export { AccountInfo, ActionEvent, ApplicationError, BulkActionMetadata,
|
|
2
|
+
import { Quiz, CloneQuizResponse, BulkCreateQuizOptions, BulkCreateQuizResponse, DeleteQuizResponse, BulkDeleteQuizzesResponse, BulkDeleteQuizResponse } from './index.typings.mjs';
|
|
3
|
+
export { AccountInfo, ActionEvent, ApplicationError, BulkActionMetadata, BulkCloneQuizzesRequest, BulkCloneQuizzesResponse, BulkCreateQuizRequest, BulkDeleteQuizRequest, BulkDeleteQuizzesRequest, BulkDeleteQuizzesResponseBulkQuizResult, BulkQuizResult, CloneQuizRequest, CommonBulkActionMetadata, CommonItemMetadata, CreateQuizRequest, CreateQuizResponse, DeleteQuizRequest, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, FileFormat, FileFormatWithLiterals, FileUploadField, GetQuizRequest, GetQuizResponse, IdentificationData, IdentificationDataIdOneOf, ItemMetadata, LongTextField, MessageEnvelope, MultiChoiceField, NumericField, QuizField, QuizFieldFieldTypeOneOf, QuizSettings, RestoreInfo, ShortTextField, SingleChoiceField, V1BulkQuizResult, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.mjs';
|
|
4
4
|
|
|
5
5
|
declare function createQuiz$1(httpClient: HttpClient): CreateQuizSignature;
|
|
6
6
|
interface CreateQuizSignature {
|
|
@@ -27,14 +27,6 @@ interface BulkCreateQuizSignature {
|
|
|
27
27
|
*/
|
|
28
28
|
(quizzes: NonNullablePaths<Quiz, `fields` | `fields.${number}._id` | `fields.${number}.multiChoice.options` | `fields.${number}.question` | `fields.${number}.singleChoice.options` | `fields.${number}.target`, 5>[], options?: BulkCreateQuizOptions): Promise<NonNullablePaths<BulkCreateQuizResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description`, 6>>;
|
|
29
29
|
}
|
|
30
|
-
declare function bulkCloneQuiz$1(httpClient: HttpClient): BulkCloneQuizSignature;
|
|
31
|
-
interface BulkCloneQuizSignature {
|
|
32
|
-
/**
|
|
33
|
-
* Clones quizzes.
|
|
34
|
-
* @param - IDs of the quizzes to clone.
|
|
35
|
-
*/
|
|
36
|
-
(quizIds: string[], options?: BulkCloneQuizOptions): Promise<NonNullablePaths<BulkCloneQuizResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
|
|
37
|
-
}
|
|
38
30
|
declare function getQuiz$1(httpClient: HttpClient): GetQuizSignature;
|
|
39
31
|
interface GetQuizSignature {
|
|
40
32
|
/**
|
|
@@ -52,11 +44,22 @@ interface DeleteQuizSignature {
|
|
|
52
44
|
*/
|
|
53
45
|
(quizId: string): Promise<NonNullablePaths<DeleteQuizResponse, `quiz.fields` | `quiz.fields.${number}._id`, 5>>;
|
|
54
46
|
}
|
|
47
|
+
declare function bulkDeleteQuizzes$1(httpClient: HttpClient): BulkDeleteQuizzesSignature;
|
|
48
|
+
interface BulkDeleteQuizzesSignature {
|
|
49
|
+
/**
|
|
50
|
+
* Permanently deletes up to 100 quiz definitions.
|
|
51
|
+
*
|
|
52
|
+
* This operation doesn't check whether Online Programs steps reference the quizzes. Callers must remove or verify those references before deleting.
|
|
53
|
+
* @param - IDs of the quizzes to delete.
|
|
54
|
+
*/
|
|
55
|
+
(quizIds: string[]): Promise<NonNullablePaths<BulkDeleteQuizzesResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
|
|
56
|
+
}
|
|
55
57
|
declare function bulkDeleteQuiz$1(httpClient: HttpClient): BulkDeleteQuizSignature;
|
|
56
58
|
interface BulkDeleteQuizSignature {
|
|
57
59
|
/**
|
|
58
|
-
*
|
|
60
|
+
* Deprecated. Use `BulkDeleteQuizzes`.
|
|
59
61
|
* @param - IDs of quizzes to delete
|
|
62
|
+
* @deprecated
|
|
60
63
|
*/
|
|
61
64
|
(quizIds: string[]): Promise<NonNullablePaths<BulkDeleteQuizResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
|
|
62
65
|
}
|
|
@@ -64,9 +67,9 @@ interface BulkDeleteQuizSignature {
|
|
|
64
67
|
declare const createQuiz: MaybeContext<BuildRESTFunction<typeof createQuiz$1> & typeof createQuiz$1>;
|
|
65
68
|
declare const cloneQuiz: MaybeContext<BuildRESTFunction<typeof cloneQuiz$1> & typeof cloneQuiz$1>;
|
|
66
69
|
declare const bulkCreateQuiz: MaybeContext<BuildRESTFunction<typeof bulkCreateQuiz$1> & typeof bulkCreateQuiz$1>;
|
|
67
|
-
declare const bulkCloneQuiz: MaybeContext<BuildRESTFunction<typeof bulkCloneQuiz$1> & typeof bulkCloneQuiz$1>;
|
|
68
70
|
declare const getQuiz: MaybeContext<BuildRESTFunction<typeof getQuiz$1> & typeof getQuiz$1>;
|
|
69
71
|
declare const deleteQuiz: MaybeContext<BuildRESTFunction<typeof deleteQuiz$1> & typeof deleteQuiz$1>;
|
|
72
|
+
declare const bulkDeleteQuizzes: MaybeContext<BuildRESTFunction<typeof bulkDeleteQuizzes$1> & typeof bulkDeleteQuizzes$1>;
|
|
70
73
|
declare const bulkDeleteQuiz: MaybeContext<BuildRESTFunction<typeof bulkDeleteQuiz$1> & typeof bulkDeleteQuiz$1>;
|
|
71
74
|
|
|
72
|
-
export {
|
|
75
|
+
export { BulkCreateQuizOptions, BulkCreateQuizResponse, BulkDeleteQuizResponse, BulkDeleteQuizzesResponse, CloneQuizResponse, DeleteQuizResponse, Quiz, bulkCreateQuiz, bulkDeleteQuiz, bulkDeleteQuizzes, cloneQuiz, createQuiz, deleteQuiz, getQuiz };
|
|
@@ -285,35 +285,6 @@ interface BulkActionMetadata {
|
|
|
285
285
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
286
286
|
undetailedFailures?: number;
|
|
287
287
|
}
|
|
288
|
-
interface BulkCloneQuizRequest {
|
|
289
|
-
/**
|
|
290
|
-
* IDs of the quizzes to clone.
|
|
291
|
-
* @minSize 1
|
|
292
|
-
* @maxSize 30
|
|
293
|
-
* @format GUID
|
|
294
|
-
*/
|
|
295
|
-
quizIds: string[];
|
|
296
|
-
/**
|
|
297
|
-
* Whether to return the cloned quizzes in the response.
|
|
298
|
-
*
|
|
299
|
-
* Default: `false`
|
|
300
|
-
*/
|
|
301
|
-
returnEntity?: boolean;
|
|
302
|
-
}
|
|
303
|
-
interface BulkCloneQuizResponse {
|
|
304
|
-
/** Results of the bulk clone operation, including cloned quizzes and metadata. */
|
|
305
|
-
results?: V1BulkQuizResult[];
|
|
306
|
-
/** Metadata about the bulk operation. */
|
|
307
|
-
bulkActionMetadata?: CommonBulkActionMetadata;
|
|
308
|
-
}
|
|
309
|
-
interface CommonBulkActionMetadata {
|
|
310
|
-
/** Number of items that were successfully processed. */
|
|
311
|
-
totalSuccesses?: number;
|
|
312
|
-
/** Number of items that couldn't be processed. */
|
|
313
|
-
totalFailures?: number;
|
|
314
|
-
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
315
|
-
undetailedFailures?: number;
|
|
316
|
-
}
|
|
317
288
|
interface GetQuizRequest {
|
|
318
289
|
/**
|
|
319
290
|
* ID of the quiz
|
|
@@ -325,19 +296,6 @@ interface GetQuizResponse {
|
|
|
325
296
|
/** Requested quiz */
|
|
326
297
|
quiz?: Quiz;
|
|
327
298
|
}
|
|
328
|
-
interface UpdateQuizRequest {
|
|
329
|
-
/** Quiz to be updated. Maybe partial */
|
|
330
|
-
quiz?: Quiz;
|
|
331
|
-
/**
|
|
332
|
-
* Explicit list of fields to update
|
|
333
|
-
* @internal
|
|
334
|
-
*/
|
|
335
|
-
mask?: string[];
|
|
336
|
-
}
|
|
337
|
-
interface UpdateQuizResponse {
|
|
338
|
-
/** Updated quiz */
|
|
339
|
-
quiz?: Quiz;
|
|
340
|
-
}
|
|
341
299
|
interface DeleteQuizRequest {
|
|
342
300
|
/**
|
|
343
301
|
* ID of quiz
|
|
@@ -349,6 +307,29 @@ interface DeleteQuizResponse {
|
|
|
349
307
|
/** Deleted quiz */
|
|
350
308
|
quiz?: Quiz;
|
|
351
309
|
}
|
|
310
|
+
interface BulkDeleteQuizzesRequest {
|
|
311
|
+
/**
|
|
312
|
+
* IDs of the quizzes to delete.
|
|
313
|
+
* @minSize 1
|
|
314
|
+
* @maxSize 100
|
|
315
|
+
* @format GUID
|
|
316
|
+
*/
|
|
317
|
+
quizIds: string[];
|
|
318
|
+
}
|
|
319
|
+
interface BulkDeleteQuizzesResponse {
|
|
320
|
+
/**
|
|
321
|
+
* Results of the bulk delete operation.
|
|
322
|
+
* @minSize 1
|
|
323
|
+
* @maxSize 100
|
|
324
|
+
*/
|
|
325
|
+
results?: BulkDeleteQuizzesResponseBulkQuizResult[];
|
|
326
|
+
/** Metadata about the bulk delete operation. */
|
|
327
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
328
|
+
}
|
|
329
|
+
interface BulkDeleteQuizzesResponseBulkQuizResult {
|
|
330
|
+
/** Metadata for the individual delete operation. */
|
|
331
|
+
itemMetadata?: ItemMetadata;
|
|
332
|
+
}
|
|
352
333
|
interface BulkDeleteQuizRequest {
|
|
353
334
|
/**
|
|
354
335
|
* IDs of quizzes to delete
|
|
@@ -368,6 +349,14 @@ interface BulkDeleteQuizResponse {
|
|
|
368
349
|
/** Metadata about the bulk operation. */
|
|
369
350
|
bulkActionMetadata?: CommonBulkActionMetadata;
|
|
370
351
|
}
|
|
352
|
+
interface CommonBulkActionMetadata {
|
|
353
|
+
/** Number of items that were successfully processed. */
|
|
354
|
+
totalSuccesses?: number;
|
|
355
|
+
/** Number of items that couldn't be processed. */
|
|
356
|
+
totalFailures?: number;
|
|
357
|
+
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
358
|
+
undetailedFailures?: number;
|
|
359
|
+
}
|
|
371
360
|
interface DomainEvent extends DomainEventBodyOneOf {
|
|
372
361
|
createdEvent?: EntityCreatedEvent;
|
|
373
362
|
updatedEvent?: EntityUpdatedEvent;
|
|
@@ -570,25 +559,6 @@ interface BulkCreateQuizOptions {
|
|
|
570
559
|
/** When set, items will be returned on successful create */
|
|
571
560
|
returnEntity?: boolean;
|
|
572
561
|
}
|
|
573
|
-
/**
|
|
574
|
-
* Clones quizzes.
|
|
575
|
-
* @param quizIds - IDs of the quizzes to clone.
|
|
576
|
-
* @public
|
|
577
|
-
* @documentationMaturity preview
|
|
578
|
-
* @requiredField quizIds
|
|
579
|
-
* @permissionId QUIZZES.CREATE_QUIZ
|
|
580
|
-
* @applicableIdentity APP
|
|
581
|
-
* @fqn wix.achievements.quizzes.v1.QuizService.BulkCloneQuiz
|
|
582
|
-
*/
|
|
583
|
-
declare function bulkCloneQuiz(quizIds: string[], options?: BulkCloneQuizOptions): Promise<NonNullablePaths<BulkCloneQuizResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
|
|
584
|
-
interface BulkCloneQuizOptions {
|
|
585
|
-
/**
|
|
586
|
-
* Whether to return the cloned quizzes in the response.
|
|
587
|
-
*
|
|
588
|
-
* Default: `false`
|
|
589
|
-
*/
|
|
590
|
-
returnEntity?: boolean;
|
|
591
|
-
}
|
|
592
562
|
/**
|
|
593
563
|
* Reads quiz by ID
|
|
594
564
|
* @param quizId - ID of the quiz
|
|
@@ -611,7 +581,19 @@ declare function getQuiz(quizId: string): Promise<NonNullablePaths<Quiz, `fields
|
|
|
611
581
|
*/
|
|
612
582
|
declare function deleteQuiz(quizId: string): Promise<NonNullablePaths<DeleteQuizResponse, `quiz.fields` | `quiz.fields.${number}._id`, 5>>;
|
|
613
583
|
/**
|
|
614
|
-
*
|
|
584
|
+
* Permanently deletes up to 100 quiz definitions.
|
|
585
|
+
*
|
|
586
|
+
* This operation doesn't check whether Online Programs steps reference the quizzes. Callers must remove or verify those references before deleting.
|
|
587
|
+
* @param quizIds - IDs of the quizzes to delete.
|
|
588
|
+
* @public
|
|
589
|
+
* @documentationMaturity preview
|
|
590
|
+
* @requiredField quizIds
|
|
591
|
+
* @permissionId achievements:quizzes:v1:quiz:bulk_delete_quizzes
|
|
592
|
+
* @fqn wix.achievements.quizzes.v1.QuizService.BulkDeleteQuizzes
|
|
593
|
+
*/
|
|
594
|
+
declare function bulkDeleteQuizzes(quizIds: string[]): Promise<NonNullablePaths<BulkDeleteQuizzesResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
|
|
595
|
+
/**
|
|
596
|
+
* Deprecated. Use `BulkDeleteQuizzes`.
|
|
615
597
|
* @param quizIds - IDs of quizzes to delete
|
|
616
598
|
* @public
|
|
617
599
|
* @documentationMaturity preview
|
|
@@ -619,7 +601,10 @@ declare function deleteQuiz(quizId: string): Promise<NonNullablePaths<DeleteQuiz
|
|
|
619
601
|
* @permissionId QUIZZES.DELETE_QUIZ
|
|
620
602
|
* @applicableIdentity APP
|
|
621
603
|
* @fqn wix.achievements.quizzes.v1.QuizService.BulkDeleteQuiz
|
|
604
|
+
* @deprecated
|
|
605
|
+
* @replacedBy wix.achievements.quizzes.v1.QuizService.BulkDeleteQuizzes
|
|
606
|
+
* @targetRemovalDate 2027-09-02
|
|
622
607
|
*/
|
|
623
608
|
declare function bulkDeleteQuiz(quizIds: string[]): Promise<NonNullablePaths<BulkDeleteQuizResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
|
|
624
609
|
|
|
625
|
-
export { type AccountInfo, type ActionEvent, type ApplicationError, type BulkActionMetadata, type
|
|
610
|
+
export { type AccountInfo, type ActionEvent, type ApplicationError, type BulkActionMetadata, type BulkCloneQuizzesRequest, type BulkCloneQuizzesResponse, type BulkCreateQuizOptions, type BulkCreateQuizRequest, type BulkCreateQuizResponse, type BulkDeleteQuizRequest, type BulkDeleteQuizResponse, type BulkDeleteQuizzesRequest, type BulkDeleteQuizzesResponse, type BulkDeleteQuizzesResponseBulkQuizResult, type BulkQuizResult, type CloneQuizRequest, type CloneQuizResponse, type CommonBulkActionMetadata, type CommonItemMetadata, type CreateQuizRequest, type CreateQuizResponse, type DeleteQuizRequest, type DeleteQuizResponse, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, FileFormat, type FileFormatWithLiterals, type FileUploadField, type GetQuizRequest, type GetQuizResponse, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, type LongTextField, type MessageEnvelope, type MultiChoiceField, type NumericField, type Quiz, type QuizField, type QuizFieldFieldTypeOneOf, type QuizSettings, type RestoreInfo, type ShortTextField, type SingleChoiceField, type V1BulkQuizResult, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkCreateQuiz, bulkDeleteQuiz, bulkDeleteQuizzes, cloneQuiz, createQuiz, deleteQuiz, getQuiz };
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { CreateQuizRequest as CreateQuizRequest$1, CreateQuizResponse as CreateQuizResponse$1, CloneQuizRequest as CloneQuizRequest$1, CloneQuizResponse as CloneQuizResponse$1, BulkCreateQuizRequest as BulkCreateQuizRequest$1, BulkCreateQuizResponse as BulkCreateQuizResponse$1,
|
|
1
|
+
import { CreateQuizRequest as CreateQuizRequest$1, CreateQuizResponse as CreateQuizResponse$1, CloneQuizRequest as CloneQuizRequest$1, CloneQuizResponse as CloneQuizResponse$1, BulkCreateQuizRequest as BulkCreateQuizRequest$1, BulkCreateQuizResponse as BulkCreateQuizResponse$1, GetQuizRequest as GetQuizRequest$1, GetQuizResponse as GetQuizResponse$1, DeleteQuizRequest as DeleteQuizRequest$1, DeleteQuizResponse as DeleteQuizResponse$1, BulkDeleteQuizzesRequest as BulkDeleteQuizzesRequest$1, BulkDeleteQuizzesResponse as BulkDeleteQuizzesResponse$1, BulkDeleteQuizRequest as BulkDeleteQuizRequest$1, BulkDeleteQuizResponse as BulkDeleteQuizResponse$1 } from './index.typings.mjs';
|
|
2
2
|
import '@wix/sdk-types';
|
|
3
3
|
|
|
4
4
|
interface Quiz {
|
|
@@ -286,35 +286,6 @@ interface BulkActionMetadata {
|
|
|
286
286
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
287
287
|
undetailedFailures?: number;
|
|
288
288
|
}
|
|
289
|
-
interface BulkCloneQuizRequest {
|
|
290
|
-
/**
|
|
291
|
-
* IDs of the quizzes to clone.
|
|
292
|
-
* @minSize 1
|
|
293
|
-
* @maxSize 30
|
|
294
|
-
* @format GUID
|
|
295
|
-
*/
|
|
296
|
-
quizIds: string[];
|
|
297
|
-
/**
|
|
298
|
-
* Whether to return the cloned quizzes in the response.
|
|
299
|
-
*
|
|
300
|
-
* Default: `false`
|
|
301
|
-
*/
|
|
302
|
-
returnEntity?: boolean;
|
|
303
|
-
}
|
|
304
|
-
interface BulkCloneQuizResponse {
|
|
305
|
-
/** Results of the bulk clone operation, including cloned quizzes and metadata. */
|
|
306
|
-
results?: V1BulkQuizResult[];
|
|
307
|
-
/** Metadata about the bulk operation. */
|
|
308
|
-
bulkActionMetadata?: CommonBulkActionMetadata;
|
|
309
|
-
}
|
|
310
|
-
interface CommonBulkActionMetadata {
|
|
311
|
-
/** Number of items that were successfully processed. */
|
|
312
|
-
totalSuccesses?: number;
|
|
313
|
-
/** Number of items that couldn't be processed. */
|
|
314
|
-
totalFailures?: number;
|
|
315
|
-
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
316
|
-
undetailedFailures?: number;
|
|
317
|
-
}
|
|
318
289
|
interface GetQuizRequest {
|
|
319
290
|
/**
|
|
320
291
|
* ID of the quiz
|
|
@@ -326,19 +297,6 @@ interface GetQuizResponse {
|
|
|
326
297
|
/** Requested quiz */
|
|
327
298
|
quiz?: Quiz;
|
|
328
299
|
}
|
|
329
|
-
interface UpdateQuizRequest {
|
|
330
|
-
/** Quiz to be updated. Maybe partial */
|
|
331
|
-
quiz?: Quiz;
|
|
332
|
-
/**
|
|
333
|
-
* Explicit list of fields to update
|
|
334
|
-
* @internal
|
|
335
|
-
*/
|
|
336
|
-
mask?: string[];
|
|
337
|
-
}
|
|
338
|
-
interface UpdateQuizResponse {
|
|
339
|
-
/** Updated quiz */
|
|
340
|
-
quiz?: Quiz;
|
|
341
|
-
}
|
|
342
300
|
interface DeleteQuizRequest {
|
|
343
301
|
/**
|
|
344
302
|
* ID of quiz
|
|
@@ -350,6 +308,29 @@ interface DeleteQuizResponse {
|
|
|
350
308
|
/** Deleted quiz */
|
|
351
309
|
quiz?: Quiz;
|
|
352
310
|
}
|
|
311
|
+
interface BulkDeleteQuizzesRequest {
|
|
312
|
+
/**
|
|
313
|
+
* IDs of the quizzes to delete.
|
|
314
|
+
* @minSize 1
|
|
315
|
+
* @maxSize 100
|
|
316
|
+
* @format GUID
|
|
317
|
+
*/
|
|
318
|
+
quizIds: string[];
|
|
319
|
+
}
|
|
320
|
+
interface BulkDeleteQuizzesResponse {
|
|
321
|
+
/**
|
|
322
|
+
* Results of the bulk delete operation.
|
|
323
|
+
* @minSize 1
|
|
324
|
+
* @maxSize 100
|
|
325
|
+
*/
|
|
326
|
+
results?: BulkDeleteQuizzesResponseBulkQuizResult[];
|
|
327
|
+
/** Metadata about the bulk delete operation. */
|
|
328
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
329
|
+
}
|
|
330
|
+
interface BulkDeleteQuizzesResponseBulkQuizResult {
|
|
331
|
+
/** Metadata for the individual delete operation. */
|
|
332
|
+
itemMetadata?: ItemMetadata;
|
|
333
|
+
}
|
|
353
334
|
interface BulkDeleteQuizRequest {
|
|
354
335
|
/**
|
|
355
336
|
* IDs of quizzes to delete
|
|
@@ -369,6 +350,14 @@ interface BulkDeleteQuizResponse {
|
|
|
369
350
|
/** Metadata about the bulk operation. */
|
|
370
351
|
bulkActionMetadata?: CommonBulkActionMetadata;
|
|
371
352
|
}
|
|
353
|
+
interface CommonBulkActionMetadata {
|
|
354
|
+
/** Number of items that were successfully processed. */
|
|
355
|
+
totalSuccesses?: number;
|
|
356
|
+
/** Number of items that couldn't be processed. */
|
|
357
|
+
totalFailures?: number;
|
|
358
|
+
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
359
|
+
undetailedFailures?: number;
|
|
360
|
+
}
|
|
372
361
|
interface DomainEvent extends DomainEventBodyOneOf {
|
|
373
362
|
createdEvent?: EntityCreatedEvent;
|
|
374
363
|
updatedEvent?: EntityUpdatedEvent;
|
|
@@ -582,13 +571,13 @@ declare function cloneQuiz(): __PublicMethodMetaInfo<'POST', {
|
|
|
582
571
|
quizId: string;
|
|
583
572
|
}, CloneQuizRequest$1, CloneQuizRequest, CloneQuizResponse$1, CloneQuizResponse>;
|
|
584
573
|
declare function bulkCreateQuiz(): __PublicMethodMetaInfo<'POST', {}, BulkCreateQuizRequest$1, BulkCreateQuizRequest, BulkCreateQuizResponse$1, BulkCreateQuizResponse>;
|
|
585
|
-
declare function bulkCloneQuiz(): __PublicMethodMetaInfo<'POST', {}, BulkCloneQuizRequest$1, BulkCloneQuizRequest, BulkCloneQuizResponse$1, BulkCloneQuizResponse>;
|
|
586
574
|
declare function getQuiz(): __PublicMethodMetaInfo<'GET', {
|
|
587
575
|
quizId: string;
|
|
588
576
|
}, GetQuizRequest$1, GetQuizRequest, GetQuizResponse$1, GetQuizResponse>;
|
|
589
577
|
declare function deleteQuiz(): __PublicMethodMetaInfo<'DELETE', {
|
|
590
578
|
quizId: string;
|
|
591
579
|
}, DeleteQuizRequest$1, DeleteQuizRequest, DeleteQuizResponse$1, DeleteQuizResponse>;
|
|
580
|
+
declare function bulkDeleteQuizzes(): __PublicMethodMetaInfo<'POST', {}, BulkDeleteQuizzesRequest$1, BulkDeleteQuizzesRequest, BulkDeleteQuizzesResponse$1, BulkDeleteQuizzesResponse>;
|
|
592
581
|
declare function bulkDeleteQuiz(): __PublicMethodMetaInfo<'POST', {}, BulkDeleteQuizRequest$1, BulkDeleteQuizRequest, BulkDeleteQuizResponse$1, BulkDeleteQuizResponse>;
|
|
593
582
|
|
|
594
|
-
export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type ApplicationError as ApplicationErrorOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type
|
|
583
|
+
export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type ApplicationError as ApplicationErrorOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkCloneQuizzesRequest as BulkCloneQuizzesRequestOriginal, type BulkCloneQuizzesResponse as BulkCloneQuizzesResponseOriginal, type BulkCreateQuizRequest as BulkCreateQuizRequestOriginal, type BulkCreateQuizResponse as BulkCreateQuizResponseOriginal, type BulkDeleteQuizRequest as BulkDeleteQuizRequestOriginal, type BulkDeleteQuizResponse as BulkDeleteQuizResponseOriginal, type BulkDeleteQuizzesRequest as BulkDeleteQuizzesRequestOriginal, type BulkDeleteQuizzesResponseBulkQuizResult as BulkDeleteQuizzesResponseBulkQuizResultOriginal, type BulkDeleteQuizzesResponse as BulkDeleteQuizzesResponseOriginal, type BulkQuizResult as BulkQuizResultOriginal, type CloneQuizRequest as CloneQuizRequestOriginal, type CloneQuizResponse as CloneQuizResponseOriginal, type CommonBulkActionMetadata as CommonBulkActionMetadataOriginal, type CommonItemMetadata as CommonItemMetadataOriginal, type CreateQuizRequest as CreateQuizRequestOriginal, type CreateQuizResponse as CreateQuizResponseOriginal, type DeleteQuizRequest as DeleteQuizRequestOriginal, type DeleteQuizResponse as DeleteQuizResponseOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, FileFormat as FileFormatOriginal, type FileFormatWithLiterals as FileFormatWithLiteralsOriginal, type FileUploadField as FileUploadFieldOriginal, type GetQuizRequest as GetQuizRequestOriginal, type GetQuizResponse as GetQuizResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type ItemMetadata as ItemMetadataOriginal, type LongTextField as LongTextFieldOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MultiChoiceField as MultiChoiceFieldOriginal, type NumericField as NumericFieldOriginal, type QuizFieldFieldTypeOneOf as QuizFieldFieldTypeOneOfOriginal, type QuizField as QuizFieldOriginal, type Quiz as QuizOriginal, type QuizSettings as QuizSettingsOriginal, type RestoreInfo as RestoreInfoOriginal, type ShortTextField as ShortTextFieldOriginal, type SingleChoiceField as SingleChoiceFieldOriginal, type V1BulkQuizResult as V1BulkQuizResultOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, bulkCreateQuiz, bulkDeleteQuiz, bulkDeleteQuizzes, cloneQuiz, createQuiz, deleteQuiz, getQuiz };
|