@wix/auto_sdk_online-programs_quizzes 1.0.17 → 1.0.19

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.
@@ -202,27 +202,31 @@ interface CloneQuizResponse {
202
202
  /** Cloned quiz */
203
203
  quiz?: Quiz;
204
204
  }
205
- interface BulkCreateQuizRequest {
205
+ interface BulkCreateQuizzesRequest {
206
206
  /**
207
- * Quizzes to be created
207
+ * Quiz definitions to create.
208
208
  * @minSize 1
209
209
  * @maxSize 30
210
210
  */
211
211
  quizzes: Quiz[];
212
- /** When set, items will be returned on successful create */
212
+ /**
213
+ * Whether to return the created quizzes in the response.
214
+ *
215
+ * Default: `false`
216
+ */
213
217
  returnEntity?: boolean;
214
218
  }
215
- interface BulkCreateQuizResponse {
216
- /** Created quizzes with metadata */
217
- results?: V1BulkQuizResult[];
218
- }
219
- interface V1BulkQuizResult {
220
- /** Metadata for the processed quiz. */
221
- itemMetadata?: CommonItemMetadata;
222
- /** Processed quiz. Empty when `return_entity` is `false`. */
223
- item?: Quiz;
219
+ interface BulkCreateQuizzesResponse {
220
+ /**
221
+ * Results of the bulk create operation.
222
+ * @minSize 1
223
+ * @maxSize 30
224
+ */
225
+ results?: BulkCreateQuizzesResponseBulkQuizResult[];
226
+ /** Metadata about the bulk create operation. */
227
+ bulkActionMetadata?: BulkActionMetadata;
224
228
  }
225
- interface CommonItemMetadata {
229
+ interface ItemMetadata {
226
230
  /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
227
231
  _id?: string | null;
228
232
  /** Index of the item within the request array. Allows for correlation between request and response items. */
@@ -240,6 +244,20 @@ interface ApplicationError {
240
244
  /** Data related to the error. */
241
245
  data?: Record<string, any> | null;
242
246
  }
247
+ interface BulkCreateQuizzesResponseBulkQuizResult {
248
+ /** Metadata for the individual create operation. */
249
+ itemMetadata?: ItemMetadata;
250
+ /** Created quiz. Empty when `return_entity` is `false`. */
251
+ item?: Quiz;
252
+ }
253
+ interface BulkActionMetadata {
254
+ /** Number of items that were successfully processed. */
255
+ totalSuccesses?: number;
256
+ /** Number of items that couldn't be processed. */
257
+ totalFailures?: number;
258
+ /** Number of failures without details because detailed failure threshold was exceeded. */
259
+ undetailedFailures?: number;
260
+ }
243
261
  interface BulkCloneQuizzesRequest {
244
262
  /**
245
263
  * IDs of the quizzes to clone.
@@ -261,30 +279,12 @@ interface BulkCloneQuizzesResponse {
261
279
  /** Metadata about the bulk operation. */
262
280
  bulkActionMetadata?: BulkActionMetadata;
263
281
  }
264
- interface ItemMetadata {
265
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
266
- _id?: string | null;
267
- /** Index of the item within the request array. Allows for correlation between request and response items. */
268
- originalIndex?: number;
269
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
270
- success?: boolean;
271
- /** Details about the error in case of failure. */
272
- error?: ApplicationError;
273
- }
274
282
  interface BulkQuizResult {
275
283
  /** Metadata for the cloned quiz. */
276
284
  itemMetadata?: ItemMetadata;
277
285
  /** Cloned quiz. Empty when `return_entity` is `false`. */
278
286
  item?: Quiz;
279
287
  }
280
- interface BulkActionMetadata {
281
- /** Number of items that were successfully processed. */
282
- totalSuccesses?: number;
283
- /** Number of items that couldn't be processed. */
284
- totalFailures?: number;
285
- /** Number of failures without details because detailed failure threshold was exceeded. */
286
- undetailedFailures?: number;
287
- }
288
288
  interface GetQuizRequest {
289
289
  /**
290
290
  * ID of the quiz
@@ -307,6 +307,29 @@ interface DeleteQuizResponse {
307
307
  /** Deleted quiz */
308
308
  quiz?: Quiz;
309
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
+ }
310
333
  interface BulkDeleteQuizRequest {
311
334
  /**
312
335
  * IDs of quizzes to delete
@@ -326,6 +349,22 @@ interface BulkDeleteQuizResponse {
326
349
  /** Metadata about the bulk operation. */
327
350
  bulkActionMetadata?: CommonBulkActionMetadata;
328
351
  }
352
+ interface V1BulkQuizResult {
353
+ /** Metadata for the processed quiz. */
354
+ itemMetadata?: CommonItemMetadata;
355
+ /** Processed quiz. Empty when `return_entity` is `false`. */
356
+ item?: Quiz;
357
+ }
358
+ interface CommonItemMetadata {
359
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
360
+ _id?: string | null;
361
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
362
+ originalIndex?: number;
363
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
364
+ success?: boolean;
365
+ /** Details about the error in case of failure. */
366
+ error?: ApplicationError;
367
+ }
329
368
  interface CommonBulkActionMetadata {
330
369
  /** Number of items that were successfully processed. */
331
370
  totalSuccesses?: number;
@@ -516,9 +555,10 @@ declare function createQuiz(quiz: NonNullablePaths<Quiz, `fields` | `fields.${nu
516
555
  */
517
556
  declare function cloneQuiz(quizId: string): Promise<NonNullablePaths<CloneQuizResponse, `quiz.fields` | `quiz.fields.${number}._id`, 5>>;
518
557
  /**
519
- * Creates quizzes
520
- * @param quizzes - Quizzes to be created
558
+ * Creates up to 30 quiz definitions in a single API call.
559
+ * @param quizzes - Quiz definitions to create.
521
560
  * @public
561
+ * @documentationMaturity preview
522
562
  * @requiredField quizzes
523
563
  * @requiredField quizzes.fields
524
564
  * @requiredField quizzes.fields.FieldType
@@ -527,13 +567,16 @@ declare function cloneQuiz(quizId: string): Promise<NonNullablePaths<CloneQuizRe
527
567
  * @requiredField quizzes.fields._id
528
568
  * @requiredField quizzes.fields.question
529
569
  * @requiredField quizzes.fields.target
530
- * @permissionId QUIZZES.CREATE_QUIZ
531
- * @applicableIdentity APP
532
- * @fqn wix.achievements.quizzes.v1.QuizService.BulkCreateQuiz
570
+ * @permissionId achievements:quizzes:v1:quiz:bulk_create_quizzes
571
+ * @fqn wix.achievements.quizzes.v1.QuizService.BulkCreateQuizzes
533
572
  */
534
- declare function bulkCreateQuiz(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>>;
535
- interface BulkCreateQuizOptions {
536
- /** When set, items will be returned on successful create */
573
+ declare function bulkCreateQuizzes(quizzes: NonNullablePaths<Quiz, `fields` | `fields.${number}._id` | `fields.${number}.multiChoice.options` | `fields.${number}.question` | `fields.${number}.singleChoice.options` | `fields.${number}.target`, 5>[], options?: BulkCreateQuizzesOptions): Promise<NonNullablePaths<BulkCreateQuizzesResponse, `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>>;
574
+ interface BulkCreateQuizzesOptions {
575
+ /**
576
+ * Whether to return the created quizzes in the response.
577
+ *
578
+ * Default: `false`
579
+ */
537
580
  returnEntity?: boolean;
538
581
  }
539
582
  /**
@@ -558,7 +601,20 @@ declare function getQuiz(quizId: string): Promise<NonNullablePaths<Quiz, `fields
558
601
  */
559
602
  declare function deleteQuiz(quizId: string): Promise<NonNullablePaths<DeleteQuizResponse, `quiz.fields` | `quiz.fields.${number}._id`, 5>>;
560
603
  /**
561
- * Deletes quizzes in a bulk
604
+ * Permanently deletes up to 100 quiz definitions.
605
+ *
606
+ * This operation doesn't check whether Online Programs steps reference the quizzes. Callers must remove or verify those references before deleting.
607
+ * @param quizIds - IDs of the quizzes to delete.
608
+ * @public
609
+ * @documentationMaturity preview
610
+ * @requiredField quizIds
611
+ * @permissionId achievements:quizzes:v1:quiz:bulk_delete_quizzes
612
+ * @applicableIdentity APP
613
+ * @fqn wix.achievements.quizzes.v1.QuizService.BulkDeleteQuizzes
614
+ */
615
+ 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>>;
616
+ /**
617
+ * Deprecated. Use `BulkDeleteQuizzes`.
562
618
  * @param quizIds - IDs of quizzes to delete
563
619
  * @public
564
620
  * @documentationMaturity preview
@@ -566,7 +622,10 @@ declare function deleteQuiz(quizId: string): Promise<NonNullablePaths<DeleteQuiz
566
622
  * @permissionId QUIZZES.DELETE_QUIZ
567
623
  * @applicableIdentity APP
568
624
  * @fqn wix.achievements.quizzes.v1.QuizService.BulkDeleteQuiz
625
+ * @deprecated
626
+ * @replacedBy wix.achievements.quizzes.v1.QuizService.BulkDeleteQuizzes
627
+ * @targetRemovalDate 2027-09-02
569
628
  */
570
629
  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>>;
571
630
 
572
- export { type AccountInfo, type ActionEvent, type ApplicationError, type BulkActionMetadata, type BulkCloneQuizzesRequest, type BulkCloneQuizzesResponse, type BulkCreateQuizOptions, type BulkCreateQuizRequest, type BulkCreateQuizResponse, type BulkDeleteQuizRequest, type BulkDeleteQuizResponse, 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, cloneQuiz, createQuiz, deleteQuiz, getQuiz };
631
+ export { type AccountInfo, type ActionEvent, type ApplicationError, type BulkActionMetadata, type BulkCloneQuizzesRequest, type BulkCloneQuizzesResponse, type BulkCreateQuizzesOptions, type BulkCreateQuizzesRequest, type BulkCreateQuizzesResponse, type BulkCreateQuizzesResponseBulkQuizResult, 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, bulkCreateQuizzes, 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, GetQuizRequest as GetQuizRequest$1, GetQuizResponse as GetQuizResponse$1, DeleteQuizRequest as DeleteQuizRequest$1, DeleteQuizResponse as DeleteQuizResponse$1, BulkDeleteQuizRequest as BulkDeleteQuizRequest$1, BulkDeleteQuizResponse as BulkDeleteQuizResponse$1 } from './index.typings.js';
1
+ import { CreateQuizRequest as CreateQuizRequest$1, CreateQuizResponse as CreateQuizResponse$1, CloneQuizRequest as CloneQuizRequest$1, CloneQuizResponse as CloneQuizResponse$1, BulkCreateQuizzesRequest as BulkCreateQuizzesRequest$1, BulkCreateQuizzesResponse as BulkCreateQuizzesResponse$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 {
@@ -203,27 +203,31 @@ interface CloneQuizResponse {
203
203
  /** Cloned quiz */
204
204
  quiz?: Quiz;
205
205
  }
206
- interface BulkCreateQuizRequest {
206
+ interface BulkCreateQuizzesRequest {
207
207
  /**
208
- * Quizzes to be created
208
+ * Quiz definitions to create.
209
209
  * @minSize 1
210
210
  * @maxSize 30
211
211
  */
212
212
  quizzes: Quiz[];
213
- /** When set, items will be returned on successful create */
213
+ /**
214
+ * Whether to return the created quizzes in the response.
215
+ *
216
+ * Default: `false`
217
+ */
214
218
  returnEntity?: boolean;
215
219
  }
216
- interface BulkCreateQuizResponse {
217
- /** Created quizzes with metadata */
218
- results?: V1BulkQuizResult[];
219
- }
220
- interface V1BulkQuizResult {
221
- /** Metadata for the processed quiz. */
222
- itemMetadata?: CommonItemMetadata;
223
- /** Processed quiz. Empty when `return_entity` is `false`. */
224
- item?: Quiz;
220
+ interface BulkCreateQuizzesResponse {
221
+ /**
222
+ * Results of the bulk create operation.
223
+ * @minSize 1
224
+ * @maxSize 30
225
+ */
226
+ results?: BulkCreateQuizzesResponseBulkQuizResult[];
227
+ /** Metadata about the bulk create operation. */
228
+ bulkActionMetadata?: BulkActionMetadata;
225
229
  }
226
- interface CommonItemMetadata {
230
+ interface ItemMetadata {
227
231
  /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
228
232
  id?: string | null;
229
233
  /** Index of the item within the request array. Allows for correlation between request and response items. */
@@ -241,6 +245,20 @@ interface ApplicationError {
241
245
  /** Data related to the error. */
242
246
  data?: Record<string, any> | null;
243
247
  }
248
+ interface BulkCreateQuizzesResponseBulkQuizResult {
249
+ /** Metadata for the individual create operation. */
250
+ itemMetadata?: ItemMetadata;
251
+ /** Created quiz. Empty when `return_entity` is `false`. */
252
+ item?: Quiz;
253
+ }
254
+ interface BulkActionMetadata {
255
+ /** Number of items that were successfully processed. */
256
+ totalSuccesses?: number;
257
+ /** Number of items that couldn't be processed. */
258
+ totalFailures?: number;
259
+ /** Number of failures without details because detailed failure threshold was exceeded. */
260
+ undetailedFailures?: number;
261
+ }
244
262
  interface BulkCloneQuizzesRequest {
245
263
  /**
246
264
  * IDs of the quizzes to clone.
@@ -262,30 +280,12 @@ interface BulkCloneQuizzesResponse {
262
280
  /** Metadata about the bulk operation. */
263
281
  bulkActionMetadata?: BulkActionMetadata;
264
282
  }
265
- interface ItemMetadata {
266
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
267
- id?: string | null;
268
- /** Index of the item within the request array. Allows for correlation between request and response items. */
269
- originalIndex?: number;
270
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
271
- success?: boolean;
272
- /** Details about the error in case of failure. */
273
- error?: ApplicationError;
274
- }
275
283
  interface BulkQuizResult {
276
284
  /** Metadata for the cloned quiz. */
277
285
  itemMetadata?: ItemMetadata;
278
286
  /** Cloned quiz. Empty when `return_entity` is `false`. */
279
287
  item?: Quiz;
280
288
  }
281
- interface BulkActionMetadata {
282
- /** Number of items that were successfully processed. */
283
- totalSuccesses?: number;
284
- /** Number of items that couldn't be processed. */
285
- totalFailures?: number;
286
- /** Number of failures without details because detailed failure threshold was exceeded. */
287
- undetailedFailures?: number;
288
- }
289
289
  interface GetQuizRequest {
290
290
  /**
291
291
  * ID of the quiz
@@ -308,6 +308,29 @@ interface DeleteQuizResponse {
308
308
  /** Deleted quiz */
309
309
  quiz?: Quiz;
310
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
+ }
311
334
  interface BulkDeleteQuizRequest {
312
335
  /**
313
336
  * IDs of quizzes to delete
@@ -327,6 +350,22 @@ interface BulkDeleteQuizResponse {
327
350
  /** Metadata about the bulk operation. */
328
351
  bulkActionMetadata?: CommonBulkActionMetadata;
329
352
  }
353
+ interface V1BulkQuizResult {
354
+ /** Metadata for the processed quiz. */
355
+ itemMetadata?: CommonItemMetadata;
356
+ /** Processed quiz. Empty when `return_entity` is `false`. */
357
+ item?: Quiz;
358
+ }
359
+ interface CommonItemMetadata {
360
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
361
+ id?: string | null;
362
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
363
+ originalIndex?: number;
364
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
365
+ success?: boolean;
366
+ /** Details about the error in case of failure. */
367
+ error?: ApplicationError;
368
+ }
330
369
  interface CommonBulkActionMetadata {
331
370
  /** Number of items that were successfully processed. */
332
371
  totalSuccesses?: number;
@@ -547,13 +586,14 @@ declare function createQuiz(): __PublicMethodMetaInfo<'POST', {}, CreateQuizRequ
547
586
  declare function cloneQuiz(): __PublicMethodMetaInfo<'POST', {
548
587
  quizId: string;
549
588
  }, CloneQuizRequest$1, CloneQuizRequest, CloneQuizResponse$1, CloneQuizResponse>;
550
- declare function bulkCreateQuiz(): __PublicMethodMetaInfo<'POST', {}, BulkCreateQuizRequest$1, BulkCreateQuizRequest, BulkCreateQuizResponse$1, BulkCreateQuizResponse>;
589
+ declare function bulkCreateQuizzes(): __PublicMethodMetaInfo<'POST', {}, BulkCreateQuizzesRequest$1, BulkCreateQuizzesRequest, BulkCreateQuizzesResponse$1, BulkCreateQuizzesResponse>;
551
590
  declare function getQuiz(): __PublicMethodMetaInfo<'GET', {
552
591
  quizId: string;
553
592
  }, GetQuizRequest$1, GetQuizRequest, GetQuizResponse$1, GetQuizResponse>;
554
593
  declare function deleteQuiz(): __PublicMethodMetaInfo<'DELETE', {
555
594
  quizId: string;
556
595
  }, DeleteQuizRequest$1, DeleteQuizRequest, DeleteQuizResponse$1, DeleteQuizResponse>;
596
+ declare function bulkDeleteQuizzes(): __PublicMethodMetaInfo<'POST', {}, BulkDeleteQuizzesRequest$1, BulkDeleteQuizzesRequest, BulkDeleteQuizzesResponse$1, BulkDeleteQuizzesResponse>;
557
597
  declare function bulkDeleteQuiz(): __PublicMethodMetaInfo<'POST', {}, BulkDeleteQuizRequest$1, BulkDeleteQuizRequest, BulkDeleteQuizResponse$1, BulkDeleteQuizResponse>;
558
598
 
559
- 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 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, cloneQuiz, createQuiz, deleteQuiz, getQuiz };
599
+ 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 BulkCreateQuizzesRequest as BulkCreateQuizzesRequestOriginal, type BulkCreateQuizzesResponseBulkQuizResult as BulkCreateQuizzesResponseBulkQuizResultOriginal, type BulkCreateQuizzesResponse as BulkCreateQuizzesResponseOriginal, 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, bulkCreateQuizzes, 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, DeleteQuizResponse, BulkDeleteQuizResponse } from './index.typings.mjs';
3
- export { AccountInfo, ActionEvent, ApplicationError, BulkActionMetadata, BulkCloneQuizzesRequest, BulkCloneQuizzesResponse, BulkCreateQuizRequest, BulkDeleteQuizRequest, 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';
2
+ import { Quiz, CloneQuizResponse, BulkCreateQuizzesOptions, BulkCreateQuizzesResponse, DeleteQuizResponse, BulkDeleteQuizzesResponse, BulkDeleteQuizResponse } from './index.typings.mjs';
3
+ export { AccountInfo, ActionEvent, ApplicationError, BulkActionMetadata, BulkCloneQuizzesRequest, BulkCloneQuizzesResponse, BulkCreateQuizzesRequest, BulkCreateQuizzesResponseBulkQuizResult, 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 {
@@ -19,13 +19,13 @@ interface CloneQuizSignature {
19
19
  */
20
20
  (quizId: string): Promise<NonNullablePaths<CloneQuizResponse, `quiz.fields` | `quiz.fields.${number}._id`, 5>>;
21
21
  }
22
- declare function bulkCreateQuiz$1(httpClient: HttpClient): BulkCreateQuizSignature;
23
- interface BulkCreateQuizSignature {
22
+ declare function bulkCreateQuizzes$1(httpClient: HttpClient): BulkCreateQuizzesSignature;
23
+ interface BulkCreateQuizzesSignature {
24
24
  /**
25
- * Creates quizzes
26
- * @param - Quizzes to be created
25
+ * Creates up to 30 quiz definitions in a single API call.
26
+ * @param - Quiz definitions to create.
27
27
  */
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>>;
28
+ (quizzes: NonNullablePaths<Quiz, `fields` | `fields.${number}._id` | `fields.${number}.multiChoice.options` | `fields.${number}.question` | `fields.${number}.singleChoice.options` | `fields.${number}.target`, 5>[], options?: BulkCreateQuizzesOptions): Promise<NonNullablePaths<BulkCreateQuizzesResponse, `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>>;
29
29
  }
30
30
  declare function getQuiz$1(httpClient: HttpClient): GetQuizSignature;
31
31
  interface GetQuizSignature {
@@ -44,20 +44,32 @@ interface DeleteQuizSignature {
44
44
  */
45
45
  (quizId: string): Promise<NonNullablePaths<DeleteQuizResponse, `quiz.fields` | `quiz.fields.${number}._id`, 5>>;
46
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
+ }
47
57
  declare function bulkDeleteQuiz$1(httpClient: HttpClient): BulkDeleteQuizSignature;
48
58
  interface BulkDeleteQuizSignature {
49
59
  /**
50
- * Deletes quizzes in a bulk
60
+ * Deprecated. Use `BulkDeleteQuizzes`.
51
61
  * @param - IDs of quizzes to delete
62
+ * @deprecated
52
63
  */
53
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>>;
54
65
  }
55
66
 
56
67
  declare const createQuiz: MaybeContext<BuildRESTFunction<typeof createQuiz$1> & typeof createQuiz$1>;
57
68
  declare const cloneQuiz: MaybeContext<BuildRESTFunction<typeof cloneQuiz$1> & typeof cloneQuiz$1>;
58
- declare const bulkCreateQuiz: MaybeContext<BuildRESTFunction<typeof bulkCreateQuiz$1> & typeof bulkCreateQuiz$1>;
69
+ declare const bulkCreateQuizzes: MaybeContext<BuildRESTFunction<typeof bulkCreateQuizzes$1> & typeof bulkCreateQuizzes$1>;
59
70
  declare const getQuiz: MaybeContext<BuildRESTFunction<typeof getQuiz$1> & typeof getQuiz$1>;
60
71
  declare const deleteQuiz: MaybeContext<BuildRESTFunction<typeof deleteQuiz$1> & typeof deleteQuiz$1>;
72
+ declare const bulkDeleteQuizzes: MaybeContext<BuildRESTFunction<typeof bulkDeleteQuizzes$1> & typeof bulkDeleteQuizzes$1>;
61
73
  declare const bulkDeleteQuiz: MaybeContext<BuildRESTFunction<typeof bulkDeleteQuiz$1> & typeof bulkDeleteQuiz$1>;
62
74
 
63
- export { BulkCreateQuizOptions, BulkCreateQuizResponse, BulkDeleteQuizResponse, CloneQuizResponse, DeleteQuizResponse, Quiz, bulkCreateQuiz, bulkDeleteQuiz, cloneQuiz, createQuiz, deleteQuiz, getQuiz };
75
+ export { BulkCreateQuizzesOptions, BulkCreateQuizzesResponse, BulkDeleteQuizResponse, BulkDeleteQuizzesResponse, CloneQuizResponse, DeleteQuizResponse, Quiz, bulkCreateQuizzes, bulkDeleteQuiz, bulkDeleteQuizzes, cloneQuiz, createQuiz, deleteQuiz, getQuiz };