@sprucelabs/spruce-file-utils 18.0.0 → 18.0.2

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 (5) hide show
  1. package/build/.spruce/schemas/schemas.types.d.ts +274 -188
  2. package/build/errors/SpruceError.js +3 -0
  3. package/build/esm/.spruce/schemas/schemas.types.d.ts +274 -188
  4. package/build/esm/errors/SpruceError.js +3 -0
  5. package/package.json +1 -1
package/build/.spruce/schemas/schemas.types.d.ts CHANGED
@@ -474,6 +474,39 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
474
474
  interface RegisterDashboardCardsResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Heartwood.v2021_02_11.RegisterDashboardCardsResponsePayloadSchema> {
475
475
  }
476
476
  }
477
+ namespace SpruceSchemas.Heartwood.v2021_02_11 {
478
+ interface RegisterSkillViewsEmitTargetAndPayload {
479
+ /** Source. */
480
+ 'source'?: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSource | undefined | null;
481
+ 'payload': SpruceSchemas.Heartwood.v2021_02_11.RegisterSkillViewsEmitPayload;
482
+ }
483
+ interface RegisterSkillViewsEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
484
+ id: 'registerSkillViewsEmitTargetAndPayload';
485
+ version: 'v2021_02_11';
486
+ namespace: 'Heartwood';
487
+ name: '';
488
+ fields: {
489
+ /** Source. */
490
+ 'source': {
491
+ label: 'Source';
492
+ type: 'schema';
493
+ options: {
494
+ schema: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSourceSchema;
495
+ };
496
+ };
497
+ /** . */
498
+ 'payload': {
499
+ type: 'schema';
500
+ isRequired: true;
501
+ options: {
502
+ schema: SpruceSchemas.Heartwood.v2021_02_11.RegisterSkillViewsEmitPayloadSchema;
503
+ };
504
+ };
505
+ };
506
+ }
507
+ interface RegisterSkillViewsEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Heartwood.v2021_02_11.RegisterSkillViewsEmitTargetAndPayloadSchema> {
508
+ }
509
+ }
477
510
  namespace SpruceSchemas.Heartwood.v2021_02_11 {
478
511
  interface RegisterSkillViewsEmitPayload {
479
512
  'ids': string[];
@@ -516,39 +549,6 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
516
549
  interface RegisterSkillViewsEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Heartwood.v2021_02_11.RegisterSkillViewsEmitPayloadSchema> {
517
550
  }
518
551
  }
519
- namespace SpruceSchemas.Heartwood.v2021_02_11 {
520
- interface RegisterSkillViewsEmitTargetAndPayload {
521
- /** Source. */
522
- 'source'?: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSource | undefined | null;
523
- 'payload': SpruceSchemas.Heartwood.v2021_02_11.RegisterSkillViewsEmitPayload;
524
- }
525
- interface RegisterSkillViewsEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
526
- id: 'registerSkillViewsEmitTargetAndPayload';
527
- version: 'v2021_02_11';
528
- namespace: 'Heartwood';
529
- name: '';
530
- fields: {
531
- /** Source. */
532
- 'source': {
533
- label: 'Source';
534
- type: 'schema';
535
- options: {
536
- schema: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSourceSchema;
537
- };
538
- };
539
- /** . */
540
- 'payload': {
541
- type: 'schema';
542
- isRequired: true;
543
- options: {
544
- schema: SpruceSchemas.Heartwood.v2021_02_11.RegisterSkillViewsEmitPayloadSchema;
545
- };
546
- };
547
- };
548
- }
549
- interface RegisterSkillViewsEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Heartwood.v2021_02_11.RegisterSkillViewsEmitTargetAndPayloadSchema> {
550
- }
551
- }
552
552
  namespace SpruceSchemas.Heartwood.v2021_02_11 {
553
553
  interface RegisterSkillViewsResponsePayload {
554
554
  /** . Views that were registered. Will match the number of ids you sent. */
@@ -593,6 +593,48 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
593
593
  interface UpsertThemeEmitTargetEntity extends SchemaEntity<SpruceSchemas.Heartwood.v2021_02_11.UpsertThemeEmitTargetSchema> {
594
594
  }
595
595
  }
596
+ namespace SpruceSchemas.Heartwood.v2021_02_11 {
597
+ interface UpsertThemeEmitTargetAndPayload {
598
+ /** Source. */
599
+ 'source'?: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSource | undefined | null;
600
+ 'target': SpruceSchemas.Heartwood.v2021_02_11.UpsertThemeEmitTarget;
601
+ 'payload': SpruceSchemas.Heartwood.v2021_02_11.UpsertThemeEmitPayload;
602
+ }
603
+ interface UpsertThemeEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
604
+ id: 'upsertThemeEmitTargetAndPayload';
605
+ version: 'v2021_02_11';
606
+ namespace: 'Heartwood';
607
+ name: '';
608
+ fields: {
609
+ /** Source. */
610
+ 'source': {
611
+ label: 'Source';
612
+ type: 'schema';
613
+ options: {
614
+ schema: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSourceSchema;
615
+ };
616
+ };
617
+ /** . */
618
+ 'target': {
619
+ type: 'schema';
620
+ isRequired: true;
621
+ options: {
622
+ schema: SpruceSchemas.Heartwood.v2021_02_11.UpsertThemeEmitTargetSchema;
623
+ };
624
+ };
625
+ /** . */
626
+ 'payload': {
627
+ type: 'schema';
628
+ isRequired: true;
629
+ options: {
630
+ schema: SpruceSchemas.Heartwood.v2021_02_11.UpsertThemeEmitPayloadSchema;
631
+ };
632
+ };
633
+ };
634
+ }
635
+ interface UpsertThemeEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Heartwood.v2021_02_11.UpsertThemeEmitTargetAndPayloadSchema> {
636
+ }
637
+ }
596
638
  namespace SpruceSchemas.Heartwood.v2021_02_11 {
597
639
  interface Theme {
598
640
  'slug': string;
@@ -653,48 +695,6 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
653
695
  interface UpsertThemeEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Heartwood.v2021_02_11.UpsertThemeEmitPayloadSchema> {
654
696
  }
655
697
  }
656
- namespace SpruceSchemas.Heartwood.v2021_02_11 {
657
- interface UpsertThemeEmitTargetAndPayload {
658
- /** Source. */
659
- 'source'?: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSource | undefined | null;
660
- 'target': SpruceSchemas.Heartwood.v2021_02_11.UpsertThemeEmitTarget;
661
- 'payload': SpruceSchemas.Heartwood.v2021_02_11.UpsertThemeEmitPayload;
662
- }
663
- interface UpsertThemeEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
664
- id: 'upsertThemeEmitTargetAndPayload';
665
- version: 'v2021_02_11';
666
- namespace: 'Heartwood';
667
- name: '';
668
- fields: {
669
- /** Source. */
670
- 'source': {
671
- label: 'Source';
672
- type: 'schema';
673
- options: {
674
- schema: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSourceSchema;
675
- };
676
- };
677
- /** . */
678
- 'target': {
679
- type: 'schema';
680
- isRequired: true;
681
- options: {
682
- schema: SpruceSchemas.Heartwood.v2021_02_11.UpsertThemeEmitTargetSchema;
683
- };
684
- };
685
- /** . */
686
- 'payload': {
687
- type: 'schema';
688
- isRequired: true;
689
- options: {
690
- schema: SpruceSchemas.Heartwood.v2021_02_11.UpsertThemeEmitPayloadSchema;
691
- };
692
- };
693
- };
694
- }
695
- interface UpsertThemeEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Heartwood.v2021_02_11.UpsertThemeEmitTargetAndPayloadSchema> {
696
- }
697
- }
698
698
  namespace SpruceSchemas.Heartwood.v2021_02_11 {
699
699
  interface UpsertThemeResponsePayload {
700
700
  'theme': SpruceSchemas.Heartwood.v2021_02_11.Theme;
@@ -835,11 +835,11 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
835
835
  }
836
836
  }
837
837
  namespace SpruceSchemas.Files.v2022_05_13 {
838
- interface GetSettingsStatusEmitTarget {
838
+ interface GetLocalSettingsEmitTarget {
839
839
  'organizationId': string;
840
840
  }
841
- interface GetSettingsStatusEmitTargetSchema extends SpruceSchema.Schema {
842
- id: 'getSettingsStatusEmitTarget';
841
+ interface GetLocalSettingsEmitTargetSchema extends SpruceSchema.Schema {
842
+ id: 'getLocalSettingsEmitTarget';
843
843
  version: 'v2022_05_13';
844
844
  namespace: 'Files';
845
845
  name: '';
@@ -852,17 +852,17 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
852
852
  };
853
853
  };
854
854
  }
855
- interface GetSettingsStatusEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTargetSchema> {
855
+ interface GetLocalSettingsEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetLocalSettingsEmitTargetSchema> {
856
856
  }
857
857
  }
858
858
  namespace SpruceSchemas.Files.v2022_05_13 {
859
- interface GetSettingsStatusEmitTargetAndPayload {
859
+ interface GetLocalSettingsEmitTargetAndPayload {
860
860
  /** Source. */
861
861
  'source'?: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSource | undefined | null;
862
- 'target': SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTarget;
862
+ 'target': SpruceSchemas.Files.v2022_05_13.GetLocalSettingsEmitTarget;
863
863
  }
864
- interface GetSettingsStatusEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
865
- id: 'getSettingsStatusEmitTargetAndPayload';
864
+ interface GetLocalSettingsEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
865
+ id: 'getLocalSettingsEmitTargetAndPayload';
866
866
  version: 'v2022_05_13';
867
867
  namespace: 'Files';
868
868
  name: '';
@@ -880,41 +880,52 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
880
880
  type: 'schema';
881
881
  isRequired: true;
882
882
  options: {
883
- schema: SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTargetSchema;
883
+ schema: SpruceSchemas.Files.v2022_05_13.GetLocalSettingsEmitTargetSchema;
884
884
  };
885
885
  };
886
886
  };
887
887
  }
888
- interface GetSettingsStatusEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTargetAndPayloadSchema> {
888
+ interface GetLocalSettingsEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetLocalSettingsEmitTargetAndPayloadSchema> {
889
889
  }
890
890
  }
891
891
  namespace SpruceSchemas.Files.v2022_05_13 {
892
- interface GetSettingsStatusResponsePayload {
893
- 'didSupplyS3Creds': boolean;
892
+ interface GetLocalSettingsResponsePayload {
893
+ /** Local Upload Directory. */
894
+ 'localUploadDir': string;
895
+ /** File Host URL. */
896
+ 'fileHostUrl': string;
894
897
  }
895
- interface GetSettingsStatusResponsePayloadSchema extends SpruceSchema.Schema {
896
- id: 'getSettingsStatusResponsePayload';
898
+ interface GetLocalSettingsResponsePayloadSchema extends SpruceSchema.Schema {
899
+ id: 'getLocalSettingsResponsePayload';
897
900
  version: 'v2022_05_13';
898
901
  namespace: 'Files';
899
902
  name: '';
900
903
  fields: {
901
- /** . */
902
- 'didSupplyS3Creds': {
903
- type: 'boolean';
904
+ /** Local Upload Directory. */
905
+ 'localUploadDir': {
906
+ label: 'Local Upload Directory';
907
+ type: 'text';
908
+ isRequired: true;
909
+ options: undefined;
910
+ };
911
+ /** File Host URL. */
912
+ 'fileHostUrl': {
913
+ label: 'File Host URL';
914
+ type: 'text';
904
915
  isRequired: true;
905
916
  options: undefined;
906
917
  };
907
918
  };
908
919
  }
909
- interface GetSettingsStatusResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusResponsePayloadSchema> {
920
+ interface GetLocalSettingsResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetLocalSettingsResponsePayloadSchema> {
910
921
  }
911
922
  }
912
923
  namespace SpruceSchemas.Files.v2022_05_13 {
913
- interface SaveSettingsEmitTarget {
924
+ interface GetSettingsStatusEmitTarget {
914
925
  'organizationId': string;
915
926
  }
916
- interface SaveSettingsEmitTargetSchema extends SpruceSchema.Schema {
917
- id: 'saveSettingsEmitTarget';
927
+ interface GetSettingsStatusEmitTargetSchema extends SpruceSchema.Schema {
928
+ id: 'getSettingsStatusEmitTarget';
918
929
  version: 'v2022_05_13';
919
930
  namespace: 'Files';
920
931
  name: '';
@@ -927,53 +938,99 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
927
938
  };
928
939
  };
929
940
  }
930
- interface SaveSettingsEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetSchema> {
941
+ interface GetSettingsStatusEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTargetSchema> {
931
942
  }
932
943
  }
933
944
  namespace SpruceSchemas.Files.v2022_05_13 {
934
- interface SaveSettingsEmitPayload {
935
- 'awsAccessKeyId': string;
936
- 'awsSecretAccessKey': string;
937
- 'awsS3Bucket': string;
945
+ interface GetSettingsStatusResponsePayload {
946
+ 'didConfigureFileUploads': boolean;
938
947
  }
939
- interface SaveSettingsEmitPayloadSchema extends SpruceSchema.Schema {
940
- id: 'saveSettingsEmitPayload';
948
+ interface GetSettingsStatusResponsePayloadSchema extends SpruceSchema.Schema {
949
+ id: 'getSettingsStatusResponsePayload';
941
950
  version: 'v2022_05_13';
942
951
  namespace: 'Files';
943
952
  name: '';
944
953
  fields: {
945
954
  /** . */
946
- 'awsAccessKeyId': {
947
- type: 'id';
955
+ 'didConfigureFileUploads': {
956
+ type: 'boolean';
948
957
  isRequired: true;
949
958
  options: undefined;
950
959
  };
960
+ };
961
+ }
962
+ interface GetSettingsStatusResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusResponsePayloadSchema> {
963
+ }
964
+ }
965
+ namespace SpruceSchemas.Files.v2022_05_13 {
966
+ interface UploadEmitTarget {
967
+ 'locationId'?: string | undefined | null;
968
+ 'organizationId'?: string | undefined | null;
969
+ 'filePersonId'?: string | undefined | null;
970
+ }
971
+ interface UploadEmitTargetSchema extends SpruceSchema.Schema {
972
+ id: 'uploadEmitTarget';
973
+ version: 'v2022_05_13';
974
+ namespace: 'Files';
975
+ name: '';
976
+ fields: {
951
977
  /** . */
952
- 'awsSecretAccessKey': {
978
+ 'locationId': {
979
+ type: 'id';
980
+ options: undefined;
981
+ };
982
+ /** . */
983
+ 'organizationId': {
984
+ type: 'id';
985
+ options: undefined;
986
+ };
987
+ /** . */
988
+ 'filePersonId': {
989
+ type: 'text';
990
+ options: undefined;
991
+ };
992
+ };
993
+ }
994
+ interface UploadEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema> {
995
+ }
996
+ }
997
+ namespace SpruceSchemas.Files.v2022_05_13 {
998
+ interface UploadEmitPayload {
999
+ 'base64Body': string;
1000
+ 'name': string;
1001
+ }
1002
+ interface UploadEmitPayloadSchema extends SpruceSchema.Schema {
1003
+ id: 'uploadEmitPayload';
1004
+ version: 'v2022_05_13';
1005
+ namespace: 'Files';
1006
+ name: '';
1007
+ fields: {
1008
+ /** . */
1009
+ 'base64Body': {
953
1010
  type: 'text';
954
1011
  isRequired: true;
955
1012
  options: undefined;
956
1013
  };
957
1014
  /** . */
958
- 'awsS3Bucket': {
1015
+ 'name': {
959
1016
  type: 'text';
960
1017
  isRequired: true;
961
1018
  options: undefined;
962
1019
  };
963
1020
  };
964
1021
  }
965
- interface SaveSettingsEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayloadSchema> {
1022
+ interface UploadEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema> {
966
1023
  }
967
1024
  }
968
1025
  namespace SpruceSchemas.Files.v2022_05_13 {
969
- interface SaveSettingsEmitTargetAndPayload {
1026
+ interface UploadEmitTargetAndPayload {
970
1027
  /** Source. */
971
1028
  'source'?: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSource | undefined | null;
972
- 'target': SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTarget;
973
- 'payload': SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayload;
1029
+ 'target'?: SpruceSchemas.Files.v2022_05_13.UploadEmitTarget | undefined | null;
1030
+ 'payload': SpruceSchemas.Files.v2022_05_13.UploadEmitPayload;
974
1031
  }
975
- interface SaveSettingsEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
976
- id: 'saveSettingsEmitTargetAndPayload';
1032
+ interface UploadEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
1033
+ id: 'uploadEmitTargetAndPayload';
977
1034
  version: 'v2022_05_13';
978
1035
  namespace: 'Files';
979
1036
  name: '';
@@ -989,9 +1046,8 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
989
1046
  /** . */
990
1047
  'target': {
991
1048
  type: 'schema';
992
- isRequired: true;
993
1049
  options: {
994
- schema: SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetSchema;
1050
+ schema: SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema;
995
1051
  };
996
1052
  };
997
1053
  /** . */
@@ -999,104 +1055,157 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
999
1055
  type: 'schema';
1000
1056
  isRequired: true;
1001
1057
  options: {
1002
- schema: SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayloadSchema;
1058
+ schema: SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema;
1003
1059
  };
1004
1060
  };
1005
1061
  };
1006
1062
  }
1007
- interface SaveSettingsEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetAndPayloadSchema> {
1063
+ interface UploadEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetAndPayloadSchema> {
1008
1064
  }
1009
1065
  }
1010
1066
  namespace SpruceSchemas.Files.v2022_05_13 {
1011
- interface SaveSettingsResponsePayload {
1012
- 'wasSuccessful': boolean;
1067
+ interface UploadResponsePayload {
1068
+ 'file': SpruceSchemas.Files.v2022_05_13.UploadedFile;
1013
1069
  }
1014
- interface SaveSettingsResponsePayloadSchema extends SpruceSchema.Schema {
1015
- id: 'saveSettingsResponsePayload';
1070
+ interface UploadResponsePayloadSchema extends SpruceSchema.Schema {
1071
+ id: 'uploadResponsePayload';
1016
1072
  version: 'v2022_05_13';
1017
1073
  namespace: 'Files';
1018
1074
  name: '';
1019
1075
  fields: {
1020
1076
  /** . */
1021
- 'wasSuccessful': {
1022
- type: 'boolean';
1077
+ 'file': {
1078
+ type: 'schema';
1023
1079
  isRequired: true;
1080
+ options: {
1081
+ schema: SpruceSchemas.Files.v2022_05_13.UploadedFileSchema;
1082
+ };
1083
+ };
1084
+ };
1085
+ }
1086
+ interface UploadResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadResponsePayloadSchema> {
1087
+ }
1088
+ }
1089
+ namespace SpruceSchemas.Files.v2022_05_13 {
1090
+ interface GetUploadEndpointResponsePayload {
1091
+ /** . The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client. */
1092
+ 'restEndpointUrl'?: string | undefined | null;
1093
+ }
1094
+ interface GetUploadEndpointResponsePayloadSchema extends SpruceSchema.Schema {
1095
+ id: 'getUploadEndpointResponsePayload';
1096
+ version: 'v2022_05_13';
1097
+ namespace: 'Files';
1098
+ name: '';
1099
+ fields: {
1100
+ /** . The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client. */
1101
+ 'restEndpointUrl': {
1102
+ type: 'text';
1103
+ hint: 'The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client.';
1024
1104
  options: undefined;
1025
1105
  };
1026
1106
  };
1027
1107
  }
1028
- interface SaveSettingsResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsResponsePayloadSchema> {
1108
+ interface GetUploadEndpointResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetUploadEndpointResponsePayloadSchema> {
1029
1109
  }
1030
1110
  }
1031
1111
  namespace SpruceSchemas.Files.v2022_05_13 {
1032
- interface UploadEmitTarget {
1033
- 'locationId'?: string | undefined | null;
1034
- 'organizationId'?: string | undefined | null;
1035
- 'filePersonId'?: string | undefined | null;
1112
+ interface GetSettingsStatusEmitTargetAndPayload {
1113
+ /** Source. */
1114
+ 'source'?: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSource | undefined | null;
1115
+ 'target': SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTarget;
1036
1116
  }
1037
- interface UploadEmitTargetSchema extends SpruceSchema.Schema {
1038
- id: 'uploadEmitTarget';
1117
+ interface GetSettingsStatusEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
1118
+ id: 'getSettingsStatusEmitTargetAndPayload';
1039
1119
  version: 'v2022_05_13';
1040
1120
  namespace: 'Files';
1041
1121
  name: '';
1042
1122
  fields: {
1123
+ /** Source. */
1124
+ 'source': {
1125
+ label: 'Source';
1126
+ type: 'schema';
1127
+ options: {
1128
+ schema: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSourceSchema;
1129
+ };
1130
+ };
1043
1131
  /** . */
1044
- 'locationId': {
1045
- type: 'id';
1046
- options: undefined;
1132
+ 'target': {
1133
+ type: 'schema';
1134
+ isRequired: true;
1135
+ options: {
1136
+ schema: SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTargetSchema;
1137
+ };
1047
1138
  };
1139
+ };
1140
+ }
1141
+ interface GetSettingsStatusEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTargetAndPayloadSchema> {
1142
+ }
1143
+ }
1144
+ namespace SpruceSchemas.Files.v2022_05_13 {
1145
+ interface SaveSettingsEmitTarget {
1146
+ 'organizationId': string;
1147
+ }
1148
+ interface SaveSettingsEmitTargetSchema extends SpruceSchema.Schema {
1149
+ id: 'saveSettingsEmitTarget';
1150
+ version: 'v2022_05_13';
1151
+ namespace: 'Files';
1152
+ name: '';
1153
+ fields: {
1048
1154
  /** . */
1049
1155
  'organizationId': {
1050
1156
  type: 'id';
1051
- options: undefined;
1052
- };
1053
- /** . */
1054
- 'filePersonId': {
1055
- type: 'text';
1157
+ isRequired: true;
1056
1158
  options: undefined;
1057
1159
  };
1058
1160
  };
1059
1161
  }
1060
- interface UploadEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema> {
1162
+ interface SaveSettingsEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetSchema> {
1061
1163
  }
1062
1164
  }
1063
1165
  namespace SpruceSchemas.Files.v2022_05_13 {
1064
- interface UploadEmitPayload {
1065
- 'base64Body': string;
1066
- 'name': string;
1166
+ interface SaveSettingsEmitPayload {
1167
+ 'awsAccessKeyId': string;
1168
+ 'awsSecretAccessKey': string;
1169
+ 'awsS3Bucket': string;
1067
1170
  }
1068
- interface UploadEmitPayloadSchema extends SpruceSchema.Schema {
1069
- id: 'uploadEmitPayload';
1171
+ interface SaveSettingsEmitPayloadSchema extends SpruceSchema.Schema {
1172
+ id: 'saveSettingsEmitPayload';
1070
1173
  version: 'v2022_05_13';
1071
1174
  namespace: 'Files';
1072
1175
  name: '';
1073
1176
  fields: {
1074
1177
  /** . */
1075
- 'base64Body': {
1178
+ 'awsAccessKeyId': {
1179
+ type: 'id';
1180
+ isRequired: true;
1181
+ options: undefined;
1182
+ };
1183
+ /** . */
1184
+ 'awsSecretAccessKey': {
1076
1185
  type: 'text';
1077
1186
  isRequired: true;
1078
1187
  options: undefined;
1079
1188
  };
1080
1189
  /** . */
1081
- 'name': {
1190
+ 'awsS3Bucket': {
1082
1191
  type: 'text';
1083
1192
  isRequired: true;
1084
1193
  options: undefined;
1085
1194
  };
1086
1195
  };
1087
1196
  }
1088
- interface UploadEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema> {
1197
+ interface SaveSettingsEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayloadSchema> {
1089
1198
  }
1090
1199
  }
1091
1200
  namespace SpruceSchemas.Files.v2022_05_13 {
1092
- interface UploadEmitTargetAndPayload {
1201
+ interface SaveSettingsEmitTargetAndPayload {
1093
1202
  /** Source. */
1094
1203
  'source'?: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSource | undefined | null;
1095
- 'target'?: SpruceSchemas.Files.v2022_05_13.UploadEmitTarget | undefined | null;
1096
- 'payload': SpruceSchemas.Files.v2022_05_13.UploadEmitPayload;
1204
+ 'target': SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTarget;
1205
+ 'payload': SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayload;
1097
1206
  }
1098
- interface UploadEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
1099
- id: 'uploadEmitTargetAndPayload';
1207
+ interface SaveSettingsEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
1208
+ id: 'saveSettingsEmitTargetAndPayload';
1100
1209
  version: 'v2022_05_13';
1101
1210
  namespace: 'Files';
1102
1211
  name: '';
@@ -1112,8 +1221,9 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1112
1221
  /** . */
1113
1222
  'target': {
1114
1223
  type: 'schema';
1224
+ isRequired: true;
1115
1225
  options: {
1116
- schema: SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema;
1226
+ schema: SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetSchema;
1117
1227
  };
1118
1228
  };
1119
1229
  /** . */
@@ -1121,34 +1231,33 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1121
1231
  type: 'schema';
1122
1232
  isRequired: true;
1123
1233
  options: {
1124
- schema: SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema;
1234
+ schema: SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayloadSchema;
1125
1235
  };
1126
1236
  };
1127
1237
  };
1128
1238
  }
1129
- interface UploadEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetAndPayloadSchema> {
1239
+ interface SaveSettingsEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetAndPayloadSchema> {
1130
1240
  }
1131
1241
  }
1132
1242
  namespace SpruceSchemas.Files.v2022_05_13 {
1133
- interface GetUploadEndpointResponsePayload {
1134
- /** . The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client. */
1135
- 'restEndpointUrl'?: string | undefined | null;
1243
+ interface SaveSettingsResponsePayload {
1244
+ 'wasSuccessful': boolean;
1136
1245
  }
1137
- interface GetUploadEndpointResponsePayloadSchema extends SpruceSchema.Schema {
1138
- id: 'getUploadEndpointResponsePayload';
1246
+ interface SaveSettingsResponsePayloadSchema extends SpruceSchema.Schema {
1247
+ id: 'saveSettingsResponsePayload';
1139
1248
  version: 'v2022_05_13';
1140
1249
  namespace: 'Files';
1141
1250
  name: '';
1142
1251
  fields: {
1143
- /** . The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client. */
1144
- 'restEndpointUrl': {
1145
- type: 'text';
1146
- hint: 'The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client.';
1252
+ /** . */
1253
+ 'wasSuccessful': {
1254
+ type: 'boolean';
1255
+ isRequired: true;
1147
1256
  options: undefined;
1148
1257
  };
1149
1258
  };
1150
1259
  }
1151
- interface GetUploadEndpointResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetUploadEndpointResponsePayloadSchema> {
1260
+ interface SaveSettingsResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsResponsePayloadSchema> {
1152
1261
  }
1153
1262
  }
1154
1263
  namespace SpruceSchemas.Files.v2022_05_13 {
@@ -1193,29 +1302,6 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1193
1302
  interface UploadedFileEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadedFileSchema> {
1194
1303
  }
1195
1304
  }
1196
- namespace SpruceSchemas.Files.v2022_05_13 {
1197
- interface UploadResponsePayload {
1198
- 'file': SpruceSchemas.Files.v2022_05_13.UploadedFile;
1199
- }
1200
- interface UploadResponsePayloadSchema extends SpruceSchema.Schema {
1201
- id: 'uploadResponsePayload';
1202
- version: 'v2022_05_13';
1203
- namespace: 'Files';
1204
- name: '';
1205
- fields: {
1206
- /** . */
1207
- 'file': {
1208
- type: 'schema';
1209
- isRequired: true;
1210
- options: {
1211
- schema: SpruceSchemas.Files.v2022_05_13.UploadedFileSchema;
1212
- };
1213
- };
1214
- };
1215
- }
1216
- interface UploadResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadResponsePayloadSchema> {
1217
- }
1218
- }
1219
1305
  namespace SpruceSchemas.Files.v2022_05_13 {
1220
1306
  interface SettingsTarget {
1221
1307
  'organizationId': string;