@iblai/iblai-api 4.243.2-ai → 4.245.0-ai

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.
Files changed (49) hide show
  1. package/dist/index.cjs.js +594 -1
  2. package/dist/index.cjs.js.map +1 -1
  3. package/dist/index.esm.js +595 -2
  4. package/dist/index.esm.js.map +1 -1
  5. package/dist/index.umd.js +594 -1
  6. package/dist/index.umd.js.map +1 -1
  7. package/dist/types/index.d.ts +17 -0
  8. package/dist/types/models/DemographicsFieldDefinition.d.ts +45 -0
  9. package/dist/types/models/DemographicsFieldDefinitionWrite.d.ts +42 -0
  10. package/dist/types/models/DisabilityStatusEnum.d.ts +10 -0
  11. package/dist/types/models/EthnicityEnum.d.ts +22 -0
  12. package/dist/types/models/FeedbackModeEnum.d.ts +10 -0
  13. package/dist/types/models/FieldDefinitionImport.d.ts +4 -0
  14. package/dist/types/models/FieldTypeEnum.d.ts +16 -0
  15. package/dist/types/models/GenderEnum.d.ts +14 -0
  16. package/dist/types/models/GraderCriterion.d.ts +15 -0
  17. package/dist/types/models/GradingModeEnum.d.ts +8 -0
  18. package/dist/types/models/MentorGraderConfig.d.ts +24 -0
  19. package/dist/types/models/PaginatedGraderCriterionList.d.ts +7 -0
  20. package/dist/types/models/PatchedDemographicsFieldDefinitionWrite.d.ts +42 -0
  21. package/dist/types/models/PatchedGraderCriterion.d.ts +15 -0
  22. package/dist/types/models/PatchedMentorGraderConfig.d.ts +24 -0
  23. package/dist/types/models/UserDemographicsResponse.d.ts +58 -0
  24. package/dist/types/models/UserDemographicsWrite.d.ts +58 -0
  25. package/dist/types/services/AiMentorService.d.ts +127 -0
  26. package/dist/types/services/CoreService.d.ts +107 -0
  27. package/package.json +1 -1
  28. package/sdk_schema.yml +1346 -1
  29. package/src/core/OpenAPI.ts +1 -1
  30. package/src/index.ts +17 -0
  31. package/src/models/DemographicsFieldDefinition.ts +50 -0
  32. package/src/models/DemographicsFieldDefinitionWrite.ts +47 -0
  33. package/src/models/DisabilityStatusEnum.ts +14 -0
  34. package/src/models/EthnicityEnum.ts +26 -0
  35. package/src/models/FeedbackModeEnum.ts +14 -0
  36. package/src/models/FieldDefinitionImport.ts +9 -0
  37. package/src/models/FieldTypeEnum.ts +20 -0
  38. package/src/models/GenderEnum.ts +18 -0
  39. package/src/models/GraderCriterion.ts +20 -0
  40. package/src/models/GradingModeEnum.ts +12 -0
  41. package/src/models/MentorGraderConfig.ts +29 -0
  42. package/src/models/PaginatedGraderCriterionList.ts +12 -0
  43. package/src/models/PatchedDemographicsFieldDefinitionWrite.ts +47 -0
  44. package/src/models/PatchedGraderCriterion.ts +20 -0
  45. package/src/models/PatchedMentorGraderConfig.ts +29 -0
  46. package/src/models/UserDemographicsResponse.ts +63 -0
  47. package/src/models/UserDemographicsWrite.ts +63 -0
  48. package/src/services/AiMentorService.ts +328 -0
  49. package/src/services/CoreService.ts +250 -0
package/dist/index.cjs.js CHANGED
@@ -110,7 +110,7 @@ class CancelablePromise {
110
110
 
111
111
  const OpenAPI = {
112
112
  BASE: 'https://base.manager.iblai.app',
113
- VERSION: '4.243.2-ai-plus',
113
+ VERSION: '4.245.0-ai-plus',
114
114
  WITH_CREDENTIALS: false,
115
115
  CREDENTIALS: 'include',
116
116
  TOKEN: undefined,
@@ -425,6 +425,22 @@ exports.DeployStateEnum = void 0;
425
425
  DeployStateEnum["FAILED"] = "failed";
426
426
  })(exports.DeployStateEnum || (exports.DeployStateEnum = {}));
427
427
 
428
+ /* generated using openapi-typescript-codegen -- do not edit */
429
+ /* istanbul ignore file */
430
+ /* tslint:disable */
431
+ /* eslint-disable */
432
+ /**
433
+ * * `yes` - Yes
434
+ * * `no` - No
435
+ * * `prefer_not_to_say` - Prefer not to say
436
+ */
437
+ exports.DisabilityStatusEnum = void 0;
438
+ (function (DisabilityStatusEnum) {
439
+ DisabilityStatusEnum["YES"] = "yes";
440
+ DisabilityStatusEnum["NO"] = "no";
441
+ DisabilityStatusEnum["PREFER_NOT_TO_SAY"] = "prefer_not_to_say";
442
+ })(exports.DisabilityStatusEnum || (exports.DisabilityStatusEnum = {}));
443
+
428
444
  /* generated using openapi-typescript-codegen -- do not edit */
429
445
  /* istanbul ignore file */
430
446
  /* tslint:disable */
@@ -455,6 +471,72 @@ exports.EntityTypeEnum = void 0;
455
471
  EntityTypeEnum["GLOBAL"] = "global";
456
472
  })(exports.EntityTypeEnum || (exports.EntityTypeEnum = {}));
457
473
 
474
+ /* generated using openapi-typescript-codegen -- do not edit */
475
+ /* istanbul ignore file */
476
+ /* tslint:disable */
477
+ /* eslint-disable */
478
+ /**
479
+ * * `american_indian_alaska_native` - American Indian or Alaska Native
480
+ * * `asian` - Asian
481
+ * * `black_african_american` - Black or African American
482
+ * * `hispanic_latino` - Hispanic or Latino
483
+ * * `native_hawaiian_pacific_islander` - Native Hawaiian or Other Pacific Islander
484
+ * * `white` - White
485
+ * * `two_or_more` - Two or more races
486
+ * * `prefer_not_to_say` - Prefer not to say
487
+ * * `other` - Other
488
+ */
489
+ exports.EthnicityEnum = void 0;
490
+ (function (EthnicityEnum) {
491
+ EthnicityEnum["AMERICAN_INDIAN_ALASKA_NATIVE"] = "american_indian_alaska_native";
492
+ EthnicityEnum["ASIAN"] = "asian";
493
+ EthnicityEnum["BLACK_AFRICAN_AMERICAN"] = "black_african_american";
494
+ EthnicityEnum["HISPANIC_LATINO"] = "hispanic_latino";
495
+ EthnicityEnum["NATIVE_HAWAIIAN_PACIFIC_ISLANDER"] = "native_hawaiian_pacific_islander";
496
+ EthnicityEnum["WHITE"] = "white";
497
+ EthnicityEnum["TWO_OR_MORE"] = "two_or_more";
498
+ EthnicityEnum["PREFER_NOT_TO_SAY"] = "prefer_not_to_say";
499
+ EthnicityEnum["OTHER"] = "other";
500
+ })(exports.EthnicityEnum || (exports.EthnicityEnum = {}));
501
+
502
+ /* generated using openapi-typescript-codegen -- do not edit */
503
+ /* istanbul ignore file */
504
+ /* tslint:disable */
505
+ /* eslint-disable */
506
+ /**
507
+ * * `overall` - overall
508
+ * * `per_criteria` - per_criteria
509
+ * * `both` - both
510
+ */
511
+ exports.FeedbackModeEnum = void 0;
512
+ (function (FeedbackModeEnum) {
513
+ FeedbackModeEnum["OVERALL"] = "overall";
514
+ FeedbackModeEnum["PER_CRITERIA"] = "per_criteria";
515
+ FeedbackModeEnum["BOTH"] = "both";
516
+ })(exports.FeedbackModeEnum || (exports.FeedbackModeEnum = {}));
517
+
518
+ /* generated using openapi-typescript-codegen -- do not edit */
519
+ /* istanbul ignore file */
520
+ /* tslint:disable */
521
+ /* eslint-disable */
522
+ /**
523
+ * * `text` - Text
524
+ * * `number` - Number
525
+ * * `date` - Date
526
+ * * `boolean` - Boolean
527
+ * * `select` - Select
528
+ * * `multi_select` - Multi-select
529
+ */
530
+ exports.FieldTypeEnum = void 0;
531
+ (function (FieldTypeEnum) {
532
+ FieldTypeEnum["TEXT"] = "text";
533
+ FieldTypeEnum["NUMBER"] = "number";
534
+ FieldTypeEnum["DATE"] = "date";
535
+ FieldTypeEnum["BOOLEAN"] = "boolean";
536
+ FieldTypeEnum["SELECT"] = "select";
537
+ FieldTypeEnum["MULTI_SELECT"] = "multi_select";
538
+ })(exports.FieldTypeEnum || (exports.FieldTypeEnum = {}));
539
+
458
540
  /* generated using openapi-typescript-codegen -- do not edit */
459
541
  /* istanbul ignore file */
460
542
  /* tslint:disable */
@@ -487,6 +569,26 @@ exports.FlowTypeEnum = void 0;
487
569
  FlowTypeEnum["SUBSCRIPTION_CANCEL"] = "subscription_cancel";
488
570
  })(exports.FlowTypeEnum || (exports.FlowTypeEnum = {}));
489
571
 
572
+ /* generated using openapi-typescript-codegen -- do not edit */
573
+ /* istanbul ignore file */
574
+ /* tslint:disable */
575
+ /* eslint-disable */
576
+ /**
577
+ * * `male` - Male
578
+ * * `female` - Female
579
+ * * `non_binary` - Non-binary
580
+ * * `prefer_not_to_say` - Prefer not to say
581
+ * * `other` - Other
582
+ */
583
+ exports.GenderEnum = void 0;
584
+ (function (GenderEnum) {
585
+ GenderEnum["MALE"] = "male";
586
+ GenderEnum["FEMALE"] = "female";
587
+ GenderEnum["NON_BINARY"] = "non_binary";
588
+ GenderEnum["PREFER_NOT_TO_SAY"] = "prefer_not_to_say";
589
+ GenderEnum["OTHER"] = "other";
590
+ })(exports.GenderEnum || (exports.GenderEnum = {}));
591
+
490
592
  /* generated using openapi-typescript-codegen -- do not edit */
491
593
  /* istanbul ignore file */
492
594
  /* tslint:disable */
@@ -501,6 +603,20 @@ exports.GooglePayAccountResponseStatusEnum = void 0;
501
603
  GooglePayAccountResponseStatusEnum["ACCOUNT_PENDING"] = "ACCOUNT_PENDING";
502
604
  })(exports.GooglePayAccountResponseStatusEnum || (exports.GooglePayAccountResponseStatusEnum = {}));
503
605
 
606
+ /* generated using openapi-typescript-codegen -- do not edit */
607
+ /* istanbul ignore file */
608
+ /* tslint:disable */
609
+ /* eslint-disable */
610
+ /**
611
+ * * `submission` - Submission
612
+ * * `conversation` - Conversation
613
+ */
614
+ exports.GradingModeEnum = void 0;
615
+ (function (GradingModeEnum) {
616
+ GradingModeEnum["SUBMISSION"] = "submission";
617
+ GradingModeEnum["CONVERSATION"] = "conversation";
618
+ })(exports.GradingModeEnum || (exports.GradingModeEnum = {}));
619
+
504
620
  /* generated using openapi-typescript-codegen -- do not edit */
505
621
  /* istanbul ignore file */
506
622
  /* tslint:disable */
@@ -14724,6 +14840,277 @@ class AiMentorService {
14724
14840
  mediaType: 'application/json'
14725
14841
  });
14726
14842
  }
14843
+ /**
14844
+ * Retrieve mentor grader configuration
14845
+ * Return the mentor's grader configuration.
14846
+ * @returns MentorGraderConfig
14847
+ * @throws ApiError
14848
+ */
14849
+ static aiMentorOrgsMentorsGraderConfigRetrieve({
14850
+ mentorUniqueId,
14851
+ org
14852
+ }) {
14853
+ return request(OpenAPI, {
14854
+ method: 'GET',
14855
+ url: '/api/ai-mentor/orgs/{org}/mentors/{mentor_unique_id}/grader-config/',
14856
+ path: {
14857
+ 'mentor_unique_id': mentorUniqueId,
14858
+ 'org': org
14859
+ },
14860
+ errors: {
14861
+ 403: `Permission Denied`,
14862
+ 404: `Mentor or grader config not found`
14863
+ }
14864
+ });
14865
+ }
14866
+ /**
14867
+ * Create mentor grader configuration
14868
+ * Create the grader configuration for a mentor. Fails with 400 if a configuration already exists (the resource is 1:1 with the mentor). Criteria are added separately via the nested `criteria/` endpoints.
14869
+ * @returns MentorGraderConfig
14870
+ * @throws ApiError
14871
+ */
14872
+ static aiMentorOrgsMentorsGraderConfigCreate({
14873
+ mentorUniqueId,
14874
+ org,
14875
+ requestBody
14876
+ }) {
14877
+ return request(OpenAPI, {
14878
+ method: 'POST',
14879
+ url: '/api/ai-mentor/orgs/{org}/mentors/{mentor_unique_id}/grader-config/',
14880
+ path: {
14881
+ 'mentor_unique_id': mentorUniqueId,
14882
+ 'org': org
14883
+ },
14884
+ body: requestBody,
14885
+ mediaType: 'application/json',
14886
+ errors: {
14887
+ 400: `Invalid data, or grader config already exists for this mentor`,
14888
+ 403: `Permission Denied`,
14889
+ 404: `Mentor not found`
14890
+ }
14891
+ });
14892
+ }
14893
+ /**
14894
+ * Replace mentor grader configuration
14895
+ * Replace all writable fields on the grader configuration.
14896
+ * @returns MentorGraderConfig
14897
+ * @throws ApiError
14898
+ */
14899
+ static aiMentorOrgsMentorsGraderConfigUpdate({
14900
+ mentorUniqueId,
14901
+ org,
14902
+ requestBody
14903
+ }) {
14904
+ return request(OpenAPI, {
14905
+ method: 'PUT',
14906
+ url: '/api/ai-mentor/orgs/{org}/mentors/{mentor_unique_id}/grader-config/',
14907
+ path: {
14908
+ 'mentor_unique_id': mentorUniqueId,
14909
+ 'org': org
14910
+ },
14911
+ body: requestBody,
14912
+ mediaType: 'application/json',
14913
+ errors: {
14914
+ 400: `Invalid data`,
14915
+ 403: `Permission Denied`,
14916
+ 404: `Mentor or grader config not found`
14917
+ }
14918
+ });
14919
+ }
14920
+ /**
14921
+ * Partially update mentor grader configuration
14922
+ * Update one or more writable fields on the grader configuration.
14923
+ * @returns MentorGraderConfig
14924
+ * @throws ApiError
14925
+ */
14926
+ static aiMentorOrgsMentorsGraderConfigPartialUpdate({
14927
+ mentorUniqueId,
14928
+ org,
14929
+ requestBody
14930
+ }) {
14931
+ return request(OpenAPI, {
14932
+ method: 'PATCH',
14933
+ url: '/api/ai-mentor/orgs/{org}/mentors/{mentor_unique_id}/grader-config/',
14934
+ path: {
14935
+ 'mentor_unique_id': mentorUniqueId,
14936
+ 'org': org
14937
+ },
14938
+ body: requestBody,
14939
+ mediaType: 'application/json',
14940
+ errors: {
14941
+ 400: `Invalid data`,
14942
+ 403: `Permission Denied`,
14943
+ 404: `Mentor or grader config not found`
14944
+ }
14945
+ });
14946
+ }
14947
+ /**
14948
+ * List grader criteria
14949
+ * List the criteria attached to the mentor's grader configuration. Supports `search` against the criterion `name` field.
14950
+ * @returns PaginatedGraderCriterionList
14951
+ * @throws ApiError
14952
+ */
14953
+ static aiMentorOrgsMentorsGraderConfigCriteriaList({
14954
+ mentorUniqueId,
14955
+ org,
14956
+ limit,
14957
+ offset,
14958
+ search
14959
+ }) {
14960
+ return request(OpenAPI, {
14961
+ method: 'GET',
14962
+ url: '/api/ai-mentor/orgs/{org}/mentors/{mentor_unique_id}/grader-config/criteria/',
14963
+ path: {
14964
+ 'mentor_unique_id': mentorUniqueId,
14965
+ 'org': org
14966
+ },
14967
+ query: {
14968
+ 'limit': limit,
14969
+ 'offset': offset,
14970
+ 'search': search
14971
+ },
14972
+ errors: {
14973
+ 403: `Permission Denied`,
14974
+ 404: `Mentor or grader config not found`
14975
+ }
14976
+ });
14977
+ }
14978
+ /**
14979
+ * Create grader criterion
14980
+ * Add a criterion to the mentor's grader configuration. `points` must be a positive float; the overall score is computed as earned points / total possible points (no sum-to-1 invariant).
14981
+ * @returns GraderCriterion
14982
+ * @throws ApiError
14983
+ */
14984
+ static aiMentorOrgsMentorsGraderConfigCriteriaCreate({
14985
+ mentorUniqueId,
14986
+ org,
14987
+ requestBody
14988
+ }) {
14989
+ return request(OpenAPI, {
14990
+ method: 'POST',
14991
+ url: '/api/ai-mentor/orgs/{org}/mentors/{mentor_unique_id}/grader-config/criteria/',
14992
+ path: {
14993
+ 'mentor_unique_id': mentorUniqueId,
14994
+ 'org': org
14995
+ },
14996
+ body: requestBody,
14997
+ mediaType: 'application/json',
14998
+ errors: {
14999
+ 400: `Invalid data`,
15000
+ 403: `Permission Denied`,
15001
+ 404: `Mentor or grader config not found`
15002
+ }
15003
+ });
15004
+ }
15005
+ /**
15006
+ * Retrieve grader criterion
15007
+ * Retrieve a single criterion by id.
15008
+ * @returns GraderCriterion
15009
+ * @throws ApiError
15010
+ */
15011
+ static aiMentorOrgsMentorsGraderConfigCriteriaRetrieve({
15012
+ id,
15013
+ mentorUniqueId,
15014
+ org
15015
+ }) {
15016
+ return request(OpenAPI, {
15017
+ method: 'GET',
15018
+ url: '/api/ai-mentor/orgs/{org}/mentors/{mentor_unique_id}/grader-config/criteria/{id}/',
15019
+ path: {
15020
+ 'id': id,
15021
+ 'mentor_unique_id': mentorUniqueId,
15022
+ 'org': org
15023
+ },
15024
+ errors: {
15025
+ 403: `Permission Denied`,
15026
+ 404: `Mentor, grader config, or criterion not found`
15027
+ }
15028
+ });
15029
+ }
15030
+ /**
15031
+ * Replace grader criterion
15032
+ * Replace all writable fields on a criterion.
15033
+ * @returns GraderCriterion
15034
+ * @throws ApiError
15035
+ */
15036
+ static aiMentorOrgsMentorsGraderConfigCriteriaUpdate({
15037
+ id,
15038
+ mentorUniqueId,
15039
+ org,
15040
+ requestBody
15041
+ }) {
15042
+ return request(OpenAPI, {
15043
+ method: 'PUT',
15044
+ url: '/api/ai-mentor/orgs/{org}/mentors/{mentor_unique_id}/grader-config/criteria/{id}/',
15045
+ path: {
15046
+ 'id': id,
15047
+ 'mentor_unique_id': mentorUniqueId,
15048
+ 'org': org
15049
+ },
15050
+ body: requestBody,
15051
+ mediaType: 'application/json',
15052
+ errors: {
15053
+ 400: `Invalid data`,
15054
+ 403: `Permission Denied`,
15055
+ 404: `Mentor, grader config, or criterion not found`
15056
+ }
15057
+ });
15058
+ }
15059
+ /**
15060
+ * Partially update grader criterion
15061
+ * Update one or more writable fields on a criterion.
15062
+ * @returns GraderCriterion
15063
+ * @throws ApiError
15064
+ */
15065
+ static aiMentorOrgsMentorsGraderConfigCriteriaPartialUpdate({
15066
+ id,
15067
+ mentorUniqueId,
15068
+ org,
15069
+ requestBody
15070
+ }) {
15071
+ return request(OpenAPI, {
15072
+ method: 'PATCH',
15073
+ url: '/api/ai-mentor/orgs/{org}/mentors/{mentor_unique_id}/grader-config/criteria/{id}/',
15074
+ path: {
15075
+ 'id': id,
15076
+ 'mentor_unique_id': mentorUniqueId,
15077
+ 'org': org
15078
+ },
15079
+ body: requestBody,
15080
+ mediaType: 'application/json',
15081
+ errors: {
15082
+ 400: `Invalid data`,
15083
+ 403: `Permission Denied`,
15084
+ 404: `Mentor, grader config, or criterion not found`
15085
+ }
15086
+ });
15087
+ }
15088
+ /**
15089
+ * Delete grader criterion
15090
+ * Delete a criterion. Refuses with 400 if it is the only remaining criterion on the config — a config with zero criteria cannot grade.
15091
+ * @returns void
15092
+ * @throws ApiError
15093
+ */
15094
+ static aiMentorOrgsMentorsGraderConfigCriteriaDestroy({
15095
+ id,
15096
+ mentorUniqueId,
15097
+ org
15098
+ }) {
15099
+ return request(OpenAPI, {
15100
+ method: 'DELETE',
15101
+ url: '/api/ai-mentor/orgs/{org}/mentors/{mentor_unique_id}/grader-config/criteria/{id}/',
15102
+ path: {
15103
+ 'id': id,
15104
+ 'mentor_unique_id': mentorUniqueId,
15105
+ 'org': org
15106
+ },
15107
+ errors: {
15108
+ 400: `Cannot delete the last criterion — a grader config must have at least one`,
15109
+ 403: `Permission Denied`,
15110
+ 404: `Mentor, grader config, or criterion not found`
15111
+ }
15112
+ });
15113
+ }
14727
15114
  /**
14728
15115
  * Grant LTI Mentor Access
14729
15116
  * Grants a user Student type access to a mentor that is lti accessible.
@@ -38890,6 +39277,212 @@ class CoreService {
38890
39277
  mediaType: 'application/json'
38891
39278
  });
38892
39279
  }
39280
+ /**
39281
+ * Retrieve demographics for a user. Self-access or platform admin required.
39282
+ * @returns UserDemographicsResponse
39283
+ * @throws ApiError
39284
+ */
39285
+ static corePlatformsDemographicsRetrieve({
39286
+ platformKey,
39287
+ username
39288
+ }) {
39289
+ return request(OpenAPI, {
39290
+ method: 'GET',
39291
+ url: '/api/core/platforms/{platform_key}/{username}/demographics/',
39292
+ path: {
39293
+ 'platform_key': platformKey,
39294
+ 'username': username
39295
+ }
39296
+ });
39297
+ }
39298
+ /**
39299
+ * Create or update demographics for a user. Self-access or platform admin required.
39300
+ * @returns UserDemographicsResponse
39301
+ * @throws ApiError
39302
+ */
39303
+ static corePlatformsDemographicsUpdate({
39304
+ platformKey,
39305
+ username,
39306
+ requestBody
39307
+ }) {
39308
+ return request(OpenAPI, {
39309
+ method: 'PUT',
39310
+ url: '/api/core/platforms/{platform_key}/{username}/demographics/',
39311
+ path: {
39312
+ 'platform_key': platformKey,
39313
+ 'username': username
39314
+ },
39315
+ body: requestBody,
39316
+ mediaType: 'application/json'
39317
+ });
39318
+ }
39319
+ /**
39320
+ * Delete demographics for a user. Self-access or platform admin required.
39321
+ * @returns void
39322
+ * @throws ApiError
39323
+ */
39324
+ static corePlatformsDemographicsDestroy({
39325
+ platformKey,
39326
+ username
39327
+ }) {
39328
+ return request(OpenAPI, {
39329
+ method: 'DELETE',
39330
+ url: '/api/core/platforms/{platform_key}/{username}/demographics/',
39331
+ path: {
39332
+ 'platform_key': platformKey,
39333
+ 'username': username
39334
+ }
39335
+ });
39336
+ }
39337
+ /**
39338
+ * @returns DemographicsFieldDefinition
39339
+ * @throws ApiError
39340
+ */
39341
+ static corePlatformsDemographicsFieldsList({
39342
+ platformKey
39343
+ }) {
39344
+ return request(OpenAPI, {
39345
+ method: 'GET',
39346
+ url: '/api/core/platforms/{platform_key}/demographics/fields/',
39347
+ path: {
39348
+ 'platform_key': platformKey
39349
+ }
39350
+ });
39351
+ }
39352
+ /**
39353
+ * Create a custom demographics field definition for the platform.
39354
+ * @returns DemographicsFieldDefinition
39355
+ * @throws ApiError
39356
+ */
39357
+ static corePlatformsDemographicsFieldsCreate({
39358
+ platformKey,
39359
+ requestBody
39360
+ }) {
39361
+ return request(OpenAPI, {
39362
+ method: 'POST',
39363
+ url: '/api/core/platforms/{platform_key}/demographics/fields/',
39364
+ path: {
39365
+ 'platform_key': platformKey
39366
+ },
39367
+ body: requestBody,
39368
+ mediaType: 'application/json'
39369
+ });
39370
+ }
39371
+ /**
39372
+ * @returns DemographicsFieldDefinition
39373
+ * @throws ApiError
39374
+ */
39375
+ static corePlatformsDemographicsFieldsRetrieve({
39376
+ platformKey,
39377
+ slug
39378
+ }) {
39379
+ return request(OpenAPI, {
39380
+ method: 'GET',
39381
+ url: '/api/core/platforms/{platform_key}/demographics/fields/{slug}/',
39382
+ path: {
39383
+ 'platform_key': platformKey,
39384
+ 'slug': slug
39385
+ }
39386
+ });
39387
+ }
39388
+ /**
39389
+ * Update a custom demographics field definition.
39390
+ * @returns DemographicsFieldDefinition
39391
+ * @throws ApiError
39392
+ */
39393
+ static corePlatformsDemographicsFieldsUpdate({
39394
+ platformKey,
39395
+ slug,
39396
+ requestBody
39397
+ }) {
39398
+ return request(OpenAPI, {
39399
+ method: 'PUT',
39400
+ url: '/api/core/platforms/{platform_key}/demographics/fields/{slug}/',
39401
+ path: {
39402
+ 'platform_key': platformKey,
39403
+ 'slug': slug
39404
+ },
39405
+ body: requestBody,
39406
+ mediaType: 'application/json'
39407
+ });
39408
+ }
39409
+ /**
39410
+ * Partially update a custom demographics field definition.
39411
+ * @returns DemographicsFieldDefinition
39412
+ * @throws ApiError
39413
+ */
39414
+ static corePlatformsDemographicsFieldsPartialUpdate({
39415
+ platformKey,
39416
+ slug,
39417
+ requestBody
39418
+ }) {
39419
+ return request(OpenAPI, {
39420
+ method: 'PATCH',
39421
+ url: '/api/core/platforms/{platform_key}/demographics/fields/{slug}/',
39422
+ path: {
39423
+ 'platform_key': platformKey,
39424
+ 'slug': slug
39425
+ },
39426
+ body: requestBody,
39427
+ mediaType: 'application/json'
39428
+ });
39429
+ }
39430
+ /**
39431
+ * @returns void
39432
+ * @throws ApiError
39433
+ */
39434
+ static corePlatformsDemographicsFieldsDestroy({
39435
+ platformKey,
39436
+ slug
39437
+ }) {
39438
+ return request(OpenAPI, {
39439
+ method: 'DELETE',
39440
+ url: '/api/core/platforms/{platform_key}/demographics/fields/{slug}/',
39441
+ path: {
39442
+ 'platform_key': platformKey,
39443
+ 'slug': slug
39444
+ }
39445
+ });
39446
+ }
39447
+ /**
39448
+ * Export all field definitions for the platform as JSON or CSV.
39449
+ * @returns DemographicsFieldDefinition
39450
+ * @throws ApiError
39451
+ */
39452
+ static corePlatformsDemographicsFieldsExportList({
39453
+ platformKey,
39454
+ exportFormat = 'json'
39455
+ }) {
39456
+ return request(OpenAPI, {
39457
+ method: 'GET',
39458
+ url: '/api/core/platforms/{platform_key}/demographics/fields/export/',
39459
+ path: {
39460
+ 'platform_key': platformKey
39461
+ },
39462
+ query: {
39463
+ 'export_format': exportFormat
39464
+ }
39465
+ });
39466
+ }
39467
+ /**
39468
+ * Import field definitions from JSON or CSV file. Returns 207 on partial success.
39469
+ * @returns any No response body
39470
+ * @throws ApiError
39471
+ */
39472
+ static corePlatformsDemographicsFieldsImportCreate({
39473
+ platformKey,
39474
+ requestBody
39475
+ }) {
39476
+ return request(OpenAPI, {
39477
+ method: 'POST',
39478
+ url: '/api/core/platforms/{platform_key}/demographics/fields/import/',
39479
+ path: {
39480
+ 'platform_key': platformKey
39481
+ },
39482
+ body: requestBody,
39483
+ mediaType: 'application/json'
39484
+ });
39485
+ }
38893
39486
  /**
38894
39487
  * Shared functionality for platform public image asset views.
38895
39488
  * @returns PlatformPublicImageAsset