@sprucelabs/spruce-file-utils 18.0.16 → 18.1.0

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 +227 -227
  2. package/build/esm/.spruce/schemas/schemas.types.d.ts +227 -227
  3. package/build/esm/uploading/S3UploadStrategy.js +3 -1
  4. package/build/uploading/S3UploadStrategy.js +3 -1
  5. package/package.json +1 -1
package/build/.spruce/schemas/schemas.types.d.ts CHANGED
@@ -719,11 +719,11 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
719
719
  }
720
720
  }
721
721
  namespace SpruceSchemas.Files.v2022_05_13 {
722
- interface SaveLocalSettingsEmitTarget {
722
+ interface GetSettingsStatusEmitTarget {
723
723
  'organizationId': string;
724
724
  }
725
- interface SaveLocalSettingsEmitTargetSchema extends SpruceSchema.Schema {
726
- id: 'saveLocalSettingsEmitTarget';
725
+ interface GetSettingsStatusEmitTargetSchema extends SpruceSchema.Schema {
726
+ id: 'getSettingsStatusEmitTarget';
727
727
  version: 'v2022_05_13';
728
728
  namespace: 'Files';
729
729
  name: '';
@@ -736,50 +736,17 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
736
736
  };
737
737
  };
738
738
  }
739
- interface SaveLocalSettingsEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveLocalSettingsEmitTargetSchema> {
740
- }
741
- }
742
- namespace SpruceSchemas.Files.v2022_05_13 {
743
- interface SaveLocalSettingsEmitPayload {
744
- /** Local Upload Directory. */
745
- 'localUploadDir': string;
746
- /** File Host URL. */
747
- 'fileHostUrl': string;
748
- }
749
- interface SaveLocalSettingsEmitPayloadSchema extends SpruceSchema.Schema {
750
- id: 'saveLocalSettingsEmitPayload';
751
- version: 'v2022_05_13';
752
- namespace: 'Files';
753
- name: '';
754
- fields: {
755
- /** Local Upload Directory. */
756
- 'localUploadDir': {
757
- label: 'Local Upload Directory';
758
- type: 'text';
759
- isRequired: true;
760
- options: undefined;
761
- };
762
- /** File Host URL. */
763
- 'fileHostUrl': {
764
- label: 'File Host URL';
765
- type: 'text';
766
- isRequired: true;
767
- options: undefined;
768
- };
769
- };
770
- }
771
- interface SaveLocalSettingsEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveLocalSettingsEmitPayloadSchema> {
739
+ interface GetSettingsStatusEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTargetSchema> {
772
740
  }
773
741
  }
774
742
  namespace SpruceSchemas.Files.v2022_05_13 {
775
- interface SaveLocalSettingsEmitTargetAndPayload {
743
+ interface GetSettingsStatusEmitTargetAndPayload {
776
744
  /** Source. */
777
745
  'source'?: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSource | undefined | null;
778
- 'target': SpruceSchemas.Files.v2022_05_13.SaveLocalSettingsEmitTarget;
779
- 'payload': SpruceSchemas.Files.v2022_05_13.SaveLocalSettingsEmitPayload;
746
+ 'target': SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTarget;
780
747
  }
781
- interface SaveLocalSettingsEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
782
- id: 'saveLocalSettingsEmitTargetAndPayload';
748
+ interface GetSettingsStatusEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
749
+ id: 'getSettingsStatusEmitTargetAndPayload';
783
750
  version: 'v2022_05_13';
784
751
  namespace: 'Files';
785
752
  name: '';
@@ -797,49 +764,41 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
797
764
  type: 'schema';
798
765
  isRequired: true;
799
766
  options: {
800
- schema: SpruceSchemas.Files.v2022_05_13.SaveLocalSettingsEmitTargetSchema;
801
- };
802
- };
803
- /** . */
804
- 'payload': {
805
- type: 'schema';
806
- isRequired: true;
807
- options: {
808
- schema: SpruceSchemas.Files.v2022_05_13.SaveLocalSettingsEmitPayloadSchema;
767
+ schema: SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTargetSchema;
809
768
  };
810
769
  };
811
770
  };
812
771
  }
813
- interface SaveLocalSettingsEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveLocalSettingsEmitTargetAndPayloadSchema> {
772
+ interface GetSettingsStatusEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTargetAndPayloadSchema> {
814
773
  }
815
774
  }
816
775
  namespace SpruceSchemas.Files.v2022_05_13 {
817
- interface SaveLocalSettingsResponsePayload {
818
- 'wasSuccessful': boolean;
776
+ interface GetSettingsStatusResponsePayload {
777
+ 'didConfigureFileUploads': boolean;
819
778
  }
820
- interface SaveLocalSettingsResponsePayloadSchema extends SpruceSchema.Schema {
821
- id: 'saveLocalSettingsResponsePayload';
779
+ interface GetSettingsStatusResponsePayloadSchema extends SpruceSchema.Schema {
780
+ id: 'getSettingsStatusResponsePayload';
822
781
  version: 'v2022_05_13';
823
782
  namespace: 'Files';
824
783
  name: '';
825
784
  fields: {
826
785
  /** . */
827
- 'wasSuccessful': {
786
+ 'didConfigureFileUploads': {
828
787
  type: 'boolean';
829
788
  isRequired: true;
830
789
  options: undefined;
831
790
  };
832
791
  };
833
792
  }
834
- interface SaveLocalSettingsResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveLocalSettingsResponsePayloadSchema> {
793
+ interface GetSettingsStatusResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusResponsePayloadSchema> {
835
794
  }
836
795
  }
837
796
  namespace SpruceSchemas.Files.v2022_05_13 {
838
- interface GetLocalSettingsEmitTarget {
797
+ interface SaveSettingsEmitTarget {
839
798
  'organizationId': string;
840
799
  }
841
- interface GetLocalSettingsEmitTargetSchema extends SpruceSchema.Schema {
842
- id: 'getLocalSettingsEmitTarget';
800
+ interface SaveSettingsEmitTargetSchema extends SpruceSchema.Schema {
801
+ id: 'saveSettingsEmitTarget';
843
802
  version: 'v2022_05_13';
844
803
  namespace: 'Files';
845
804
  name: '';
@@ -852,17 +811,53 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
852
811
  };
853
812
  };
854
813
  }
855
- interface GetLocalSettingsEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetLocalSettingsEmitTargetSchema> {
814
+ interface SaveSettingsEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetSchema> {
856
815
  }
857
816
  }
858
817
  namespace SpruceSchemas.Files.v2022_05_13 {
859
- interface GetLocalSettingsEmitTargetAndPayload {
818
+ interface SaveSettingsEmitPayload {
819
+ 'awsAccessKeyId': string;
820
+ 'awsSecretAccessKey': string;
821
+ 'awsS3Bucket': string;
822
+ }
823
+ interface SaveSettingsEmitPayloadSchema extends SpruceSchema.Schema {
824
+ id: 'saveSettingsEmitPayload';
825
+ version: 'v2022_05_13';
826
+ namespace: 'Files';
827
+ name: '';
828
+ fields: {
829
+ /** . */
830
+ 'awsAccessKeyId': {
831
+ type: 'id';
832
+ isRequired: true;
833
+ options: undefined;
834
+ };
835
+ /** . */
836
+ 'awsSecretAccessKey': {
837
+ type: 'text';
838
+ isRequired: true;
839
+ options: undefined;
840
+ };
841
+ /** . */
842
+ 'awsS3Bucket': {
843
+ type: 'text';
844
+ isRequired: true;
845
+ options: undefined;
846
+ };
847
+ };
848
+ }
849
+ interface SaveSettingsEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayloadSchema> {
850
+ }
851
+ }
852
+ namespace SpruceSchemas.Files.v2022_05_13 {
853
+ interface SaveSettingsEmitTargetAndPayload {
860
854
  /** Source. */
861
855
  'source'?: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSource | undefined | null;
862
- 'target': SpruceSchemas.Files.v2022_05_13.GetLocalSettingsEmitTarget;
856
+ 'target': SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTarget;
857
+ 'payload': SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayload;
863
858
  }
864
- interface GetLocalSettingsEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
865
- id: 'getLocalSettingsEmitTargetAndPayload';
859
+ interface SaveSettingsEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
860
+ id: 'saveSettingsEmitTargetAndPayload';
866
861
  version: 'v2022_05_13';
867
862
  namespace: 'Files';
868
863
  name: '';
@@ -880,75 +875,134 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
880
875
  type: 'schema';
881
876
  isRequired: true;
882
877
  options: {
883
- schema: SpruceSchemas.Files.v2022_05_13.GetLocalSettingsEmitTargetSchema;
878
+ schema: SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetSchema;
879
+ };
880
+ };
881
+ /** . */
882
+ 'payload': {
883
+ type: 'schema';
884
+ isRequired: true;
885
+ options: {
886
+ schema: SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayloadSchema;
884
887
  };
885
888
  };
886
889
  };
887
890
  }
888
- interface GetLocalSettingsEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetLocalSettingsEmitTargetAndPayloadSchema> {
891
+ interface SaveSettingsEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetAndPayloadSchema> {
889
892
  }
890
893
  }
891
894
  namespace SpruceSchemas.Files.v2022_05_13 {
892
- interface GetLocalSettingsResponsePayload {
893
- /** Local Upload Directory. */
894
- 'localUploadDir': string;
895
- /** File Host URL. */
896
- 'fileHostUrl': string;
895
+ interface SaveSettingsResponsePayload {
896
+ 'wasSuccessful': boolean;
897
897
  }
898
- interface GetLocalSettingsResponsePayloadSchema extends SpruceSchema.Schema {
899
- id: 'getLocalSettingsResponsePayload';
898
+ interface SaveSettingsResponsePayloadSchema extends SpruceSchema.Schema {
899
+ id: 'saveSettingsResponsePayload';
900
900
  version: 'v2022_05_13';
901
901
  namespace: 'Files';
902
902
  name: '';
903
903
  fields: {
904
- /** Local Upload Directory. */
905
- 'localUploadDir': {
906
- label: 'Local Upload Directory';
907
- type: 'text';
904
+ /** . */
905
+ 'wasSuccessful': {
906
+ type: 'boolean';
908
907
  isRequired: true;
909
908
  options: undefined;
910
909
  };
911
- /** File Host URL. */
912
- 'fileHostUrl': {
913
- label: 'File Host URL';
910
+ };
911
+ }
912
+ interface SaveSettingsResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsResponsePayloadSchema> {
913
+ }
914
+ }
915
+ namespace SpruceSchemas.Files.v2022_05_13 {
916
+ interface GetUploadEndpointResponsePayload {
917
+ /** . The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client. */
918
+ 'restEndpointUrl'?: string | undefined | null;
919
+ }
920
+ interface GetUploadEndpointResponsePayloadSchema extends SpruceSchema.Schema {
921
+ id: 'getUploadEndpointResponsePayload';
922
+ version: 'v2022_05_13';
923
+ namespace: 'Files';
924
+ name: '';
925
+ fields: {
926
+ /** . The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client. */
927
+ 'restEndpointUrl': {
914
928
  type: 'text';
915
- isRequired: true;
929
+ hint: 'The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client.';
916
930
  options: undefined;
917
931
  };
918
932
  };
919
933
  }
920
- interface GetLocalSettingsResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetLocalSettingsResponsePayloadSchema> {
934
+ interface GetUploadEndpointResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetUploadEndpointResponsePayloadSchema> {
921
935
  }
922
936
  }
923
937
  namespace SpruceSchemas.Files.v2022_05_13 {
924
- interface GetSettingsStatusEmitTarget {
925
- 'organizationId': string;
938
+ interface UploadEmitTarget {
939
+ 'locationId'?: string | undefined | null;
940
+ 'organizationId'?: string | undefined | null;
941
+ 'filePersonId'?: string | undefined | null;
926
942
  }
927
- interface GetSettingsStatusEmitTargetSchema extends SpruceSchema.Schema {
928
- id: 'getSettingsStatusEmitTarget';
943
+ interface UploadEmitTargetSchema extends SpruceSchema.Schema {
944
+ id: 'uploadEmitTarget';
929
945
  version: 'v2022_05_13';
930
946
  namespace: 'Files';
931
947
  name: '';
932
948
  fields: {
949
+ /** . */
950
+ 'locationId': {
951
+ type: 'id';
952
+ options: undefined;
953
+ };
933
954
  /** . */
934
955
  'organizationId': {
935
956
  type: 'id';
957
+ options: undefined;
958
+ };
959
+ /** . */
960
+ 'filePersonId': {
961
+ type: 'text';
962
+ options: undefined;
963
+ };
964
+ };
965
+ }
966
+ interface UploadEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema> {
967
+ }
968
+ }
969
+ namespace SpruceSchemas.Files.v2022_05_13 {
970
+ interface UploadEmitPayload {
971
+ 'base64Body': string;
972
+ 'name': string;
973
+ }
974
+ interface UploadEmitPayloadSchema extends SpruceSchema.Schema {
975
+ id: 'uploadEmitPayload';
976
+ version: 'v2022_05_13';
977
+ namespace: 'Files';
978
+ name: '';
979
+ fields: {
980
+ /** . */
981
+ 'base64Body': {
982
+ type: 'text';
983
+ isRequired: true;
984
+ options: undefined;
985
+ };
986
+ /** . */
987
+ 'name': {
988
+ type: 'text';
936
989
  isRequired: true;
937
990
  options: undefined;
938
991
  };
939
992
  };
940
993
  }
941
- interface GetSettingsStatusEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTargetSchema> {
994
+ interface UploadEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema> {
942
995
  }
943
996
  }
944
997
  namespace SpruceSchemas.Files.v2022_05_13 {
945
- interface GetSettingsStatusEmitTargetAndPayload {
998
+ interface UploadEmitTargetAndPayload {
946
999
  /** Source. */
947
1000
  'source'?: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSource | undefined | null;
948
- 'target': SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTarget;
1001
+ 'target'?: SpruceSchemas.Files.v2022_05_13.UploadEmitTarget | undefined | null;
1002
+ 'payload': SpruceSchemas.Files.v2022_05_13.UploadEmitPayload;
949
1003
  }
950
- interface GetSettingsStatusEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
951
- id: 'getSettingsStatusEmitTargetAndPayload';
1004
+ interface UploadEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
1005
+ id: 'uploadEmitTargetAndPayload';
952
1006
  version: 'v2022_05_13';
953
1007
  namespace: 'Files';
954
1008
  name: '';
@@ -963,44 +1017,53 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
963
1017
  };
964
1018
  /** . */
965
1019
  'target': {
1020
+ type: 'schema';
1021
+ options: {
1022
+ schema: SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema;
1023
+ };
1024
+ };
1025
+ /** . */
1026
+ 'payload': {
966
1027
  type: 'schema';
967
1028
  isRequired: true;
968
1029
  options: {
969
- schema: SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTargetSchema;
1030
+ schema: SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema;
970
1031
  };
971
1032
  };
972
1033
  };
973
1034
  }
974
- interface GetSettingsStatusEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTargetAndPayloadSchema> {
1035
+ interface UploadEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetAndPayloadSchema> {
975
1036
  }
976
1037
  }
977
1038
  namespace SpruceSchemas.Files.v2022_05_13 {
978
- interface GetSettingsStatusResponsePayload {
979
- 'didConfigureFileUploads': boolean;
1039
+ interface UploadResponsePayload {
1040
+ 'file': SpruceSchemas.Files.v2022_05_13.UploadedFile;
980
1041
  }
981
- interface GetSettingsStatusResponsePayloadSchema extends SpruceSchema.Schema {
982
- id: 'getSettingsStatusResponsePayload';
1042
+ interface UploadResponsePayloadSchema extends SpruceSchema.Schema {
1043
+ id: 'uploadResponsePayload';
983
1044
  version: 'v2022_05_13';
984
1045
  namespace: 'Files';
985
1046
  name: '';
986
1047
  fields: {
987
1048
  /** . */
988
- 'didConfigureFileUploads': {
989
- type: 'boolean';
1049
+ 'file': {
1050
+ type: 'schema';
990
1051
  isRequired: true;
991
- options: undefined;
1052
+ options: {
1053
+ schema: SpruceSchemas.Files.v2022_05_13.UploadedFileSchema;
1054
+ };
992
1055
  };
993
1056
  };
994
1057
  }
995
- interface GetSettingsStatusResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusResponsePayloadSchema> {
1058
+ interface UploadResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadResponsePayloadSchema> {
996
1059
  }
997
1060
  }
998
1061
  namespace SpruceSchemas.Files.v2022_05_13 {
999
- interface SaveSettingsEmitTarget {
1062
+ interface GetLocalSettingsEmitTarget {
1000
1063
  'organizationId': string;
1001
1064
  }
1002
- interface SaveSettingsEmitTargetSchema extends SpruceSchema.Schema {
1003
- id: 'saveSettingsEmitTarget';
1065
+ interface GetLocalSettingsEmitTargetSchema extends SpruceSchema.Schema {
1066
+ id: 'getLocalSettingsEmitTarget';
1004
1067
  version: 'v2022_05_13';
1005
1068
  namespace: 'Files';
1006
1069
  name: '';
@@ -1013,53 +1076,49 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1013
1076
  };
1014
1077
  };
1015
1078
  }
1016
- interface SaveSettingsEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetSchema> {
1079
+ interface GetLocalSettingsEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetLocalSettingsEmitTargetSchema> {
1017
1080
  }
1018
1081
  }
1019
1082
  namespace SpruceSchemas.Files.v2022_05_13 {
1020
- interface SaveSettingsEmitPayload {
1021
- 'awsAccessKeyId': string;
1022
- 'awsSecretAccessKey': string;
1023
- 'awsS3Bucket': string;
1083
+ interface GetLocalSettingsResponsePayload {
1084
+ /** Local Upload Directory. */
1085
+ 'localUploadDir': string;
1086
+ /** File Host URL. */
1087
+ 'fileHostUrl': string;
1024
1088
  }
1025
- interface SaveSettingsEmitPayloadSchema extends SpruceSchema.Schema {
1026
- id: 'saveSettingsEmitPayload';
1089
+ interface GetLocalSettingsResponsePayloadSchema extends SpruceSchema.Schema {
1090
+ id: 'getLocalSettingsResponsePayload';
1027
1091
  version: 'v2022_05_13';
1028
1092
  namespace: 'Files';
1029
1093
  name: '';
1030
1094
  fields: {
1031
- /** . */
1032
- 'awsAccessKeyId': {
1033
- type: 'id';
1034
- isRequired: true;
1035
- options: undefined;
1036
- };
1037
- /** . */
1038
- 'awsSecretAccessKey': {
1095
+ /** Local Upload Directory. */
1096
+ 'localUploadDir': {
1097
+ label: 'Local Upload Directory';
1039
1098
  type: 'text';
1040
1099
  isRequired: true;
1041
1100
  options: undefined;
1042
1101
  };
1043
- /** . */
1044
- 'awsS3Bucket': {
1102
+ /** File Host URL. */
1103
+ 'fileHostUrl': {
1104
+ label: 'File Host URL';
1045
1105
  type: 'text';
1046
1106
  isRequired: true;
1047
1107
  options: undefined;
1048
1108
  };
1049
1109
  };
1050
1110
  }
1051
- interface SaveSettingsEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayloadSchema> {
1111
+ interface GetLocalSettingsResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetLocalSettingsResponsePayloadSchema> {
1052
1112
  }
1053
1113
  }
1054
1114
  namespace SpruceSchemas.Files.v2022_05_13 {
1055
- interface SaveSettingsEmitTargetAndPayload {
1115
+ interface GetLocalSettingsEmitTargetAndPayload {
1056
1116
  /** Source. */
1057
1117
  'source'?: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSource | undefined | null;
1058
- 'target': SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTarget;
1059
- 'payload': SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayload;
1118
+ 'target': SpruceSchemas.Files.v2022_05_13.GetLocalSettingsEmitTarget;
1060
1119
  }
1061
- interface SaveSettingsEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
1062
- id: 'saveSettingsEmitTargetAndPayload';
1120
+ interface GetLocalSettingsEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
1121
+ id: 'getLocalSettingsEmitTargetAndPayload';
1063
1122
  version: 'v2022_05_13';
1064
1123
  namespace: 'Files';
1065
1124
  name: '';
@@ -1077,112 +1136,76 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1077
1136
  type: 'schema';
1078
1137
  isRequired: true;
1079
1138
  options: {
1080
- schema: SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetSchema;
1081
- };
1082
- };
1083
- /** . */
1084
- 'payload': {
1085
- type: 'schema';
1086
- isRequired: true;
1087
- options: {
1088
- schema: SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayloadSchema;
1139
+ schema: SpruceSchemas.Files.v2022_05_13.GetLocalSettingsEmitTargetSchema;
1089
1140
  };
1090
1141
  };
1091
1142
  };
1092
1143
  }
1093
- interface SaveSettingsEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetAndPayloadSchema> {
1094
- }
1095
- }
1096
- namespace SpruceSchemas.Files.v2022_05_13 {
1097
- interface SaveSettingsResponsePayload {
1098
- 'wasSuccessful': boolean;
1099
- }
1100
- interface SaveSettingsResponsePayloadSchema extends SpruceSchema.Schema {
1101
- id: 'saveSettingsResponsePayload';
1102
- version: 'v2022_05_13';
1103
- namespace: 'Files';
1104
- name: '';
1105
- fields: {
1106
- /** . */
1107
- 'wasSuccessful': {
1108
- type: 'boolean';
1109
- isRequired: true;
1110
- options: undefined;
1111
- };
1112
- };
1113
- }
1114
- interface SaveSettingsResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsResponsePayloadSchema> {
1144
+ interface GetLocalSettingsEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetLocalSettingsEmitTargetAndPayloadSchema> {
1115
1145
  }
1116
1146
  }
1117
1147
  namespace SpruceSchemas.Files.v2022_05_13 {
1118
- interface UploadEmitTarget {
1119
- 'locationId'?: string | undefined | null;
1120
- 'organizationId'?: string | undefined | null;
1121
- 'filePersonId'?: string | undefined | null;
1148
+ interface SaveLocalSettingsEmitTarget {
1149
+ 'organizationId': string;
1122
1150
  }
1123
- interface UploadEmitTargetSchema extends SpruceSchema.Schema {
1124
- id: 'uploadEmitTarget';
1151
+ interface SaveLocalSettingsEmitTargetSchema extends SpruceSchema.Schema {
1152
+ id: 'saveLocalSettingsEmitTarget';
1125
1153
  version: 'v2022_05_13';
1126
1154
  namespace: 'Files';
1127
1155
  name: '';
1128
1156
  fields: {
1129
- /** . */
1130
- 'locationId': {
1131
- type: 'id';
1132
- options: undefined;
1133
- };
1134
1157
  /** . */
1135
1158
  'organizationId': {
1136
1159
  type: 'id';
1137
- options: undefined;
1138
- };
1139
- /** . */
1140
- 'filePersonId': {
1141
- type: 'text';
1160
+ isRequired: true;
1142
1161
  options: undefined;
1143
1162
  };
1144
1163
  };
1145
1164
  }
1146
- interface UploadEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema> {
1165
+ interface SaveLocalSettingsEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveLocalSettingsEmitTargetSchema> {
1147
1166
  }
1148
1167
  }
1149
1168
  namespace SpruceSchemas.Files.v2022_05_13 {
1150
- interface UploadEmitPayload {
1151
- 'base64Body': string;
1152
- 'name': string;
1169
+ interface SaveLocalSettingsEmitPayload {
1170
+ /** Local Upload Directory. */
1171
+ 'localUploadDir': string;
1172
+ /** File Host URL. */
1173
+ 'fileHostUrl': string;
1153
1174
  }
1154
- interface UploadEmitPayloadSchema extends SpruceSchema.Schema {
1155
- id: 'uploadEmitPayload';
1175
+ interface SaveLocalSettingsEmitPayloadSchema extends SpruceSchema.Schema {
1176
+ id: 'saveLocalSettingsEmitPayload';
1156
1177
  version: 'v2022_05_13';
1157
1178
  namespace: 'Files';
1158
1179
  name: '';
1159
1180
  fields: {
1160
- /** . */
1161
- 'base64Body': {
1181
+ /** Local Upload Directory. */
1182
+ 'localUploadDir': {
1183
+ label: 'Local Upload Directory';
1162
1184
  type: 'text';
1163
1185
  isRequired: true;
1164
1186
  options: undefined;
1165
1187
  };
1166
- /** . */
1167
- 'name': {
1188
+ /** File Host URL. */
1189
+ 'fileHostUrl': {
1190
+ label: 'File Host URL';
1168
1191
  type: 'text';
1169
1192
  isRequired: true;
1170
1193
  options: undefined;
1171
1194
  };
1172
1195
  };
1173
1196
  }
1174
- interface UploadEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema> {
1197
+ interface SaveLocalSettingsEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveLocalSettingsEmitPayloadSchema> {
1175
1198
  }
1176
1199
  }
1177
1200
  namespace SpruceSchemas.Files.v2022_05_13 {
1178
- interface UploadEmitTargetAndPayload {
1201
+ interface SaveLocalSettingsEmitTargetAndPayload {
1179
1202
  /** Source. */
1180
1203
  'source'?: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSource | undefined | null;
1181
- 'target'?: SpruceSchemas.Files.v2022_05_13.UploadEmitTarget | undefined | null;
1182
- 'payload': SpruceSchemas.Files.v2022_05_13.UploadEmitPayload;
1204
+ 'target': SpruceSchemas.Files.v2022_05_13.SaveLocalSettingsEmitTarget;
1205
+ 'payload': SpruceSchemas.Files.v2022_05_13.SaveLocalSettingsEmitPayload;
1183
1206
  }
1184
- interface UploadEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
1185
- id: 'uploadEmitTargetAndPayload';
1207
+ interface SaveLocalSettingsEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
1208
+ id: 'saveLocalSettingsEmitTargetAndPayload';
1186
1209
  version: 'v2022_05_13';
1187
1210
  namespace: 'Files';
1188
1211
  name: '';
@@ -1198,8 +1221,9 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1198
1221
  /** . */
1199
1222
  'target': {
1200
1223
  type: 'schema';
1224
+ isRequired: true;
1201
1225
  options: {
1202
- schema: SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema;
1226
+ schema: SpruceSchemas.Files.v2022_05_13.SaveLocalSettingsEmitTargetSchema;
1203
1227
  };
1204
1228
  };
1205
1229
  /** . */
@@ -1207,34 +1231,33 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1207
1231
  type: 'schema';
1208
1232
  isRequired: true;
1209
1233
  options: {
1210
- schema: SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema;
1234
+ schema: SpruceSchemas.Files.v2022_05_13.SaveLocalSettingsEmitPayloadSchema;
1211
1235
  };
1212
1236
  };
1213
1237
  };
1214
1238
  }
1215
- interface UploadEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetAndPayloadSchema> {
1239
+ interface SaveLocalSettingsEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveLocalSettingsEmitTargetAndPayloadSchema> {
1216
1240
  }
1217
1241
  }
1218
1242
  namespace SpruceSchemas.Files.v2022_05_13 {
1219
- interface GetUploadEndpointResponsePayload {
1220
- /** . The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client. */
1221
- 'restEndpointUrl'?: string | undefined | null;
1243
+ interface SaveLocalSettingsResponsePayload {
1244
+ 'wasSuccessful': boolean;
1222
1245
  }
1223
- interface GetUploadEndpointResponsePayloadSchema extends SpruceSchema.Schema {
1224
- id: 'getUploadEndpointResponsePayload';
1246
+ interface SaveLocalSettingsResponsePayloadSchema extends SpruceSchema.Schema {
1247
+ id: 'saveLocalSettingsResponsePayload';
1225
1248
  version: 'v2022_05_13';
1226
1249
  namespace: 'Files';
1227
1250
  name: '';
1228
1251
  fields: {
1229
- /** . The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client. */
1230
- 'restEndpointUrl': {
1231
- type: 'text';
1232
- 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;
1233
1256
  options: undefined;
1234
1257
  };
1235
1258
  };
1236
1259
  }
1237
- interface GetUploadEndpointResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetUploadEndpointResponsePayloadSchema> {
1260
+ interface SaveLocalSettingsResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveLocalSettingsResponsePayloadSchema> {
1238
1261
  }
1239
1262
  }
1240
1263
  namespace SpruceSchemas.Files.v2022_05_13 {
@@ -1279,29 +1302,6 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1279
1302
  interface UploadedFileEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadedFileSchema> {
1280
1303
  }
1281
1304
  }
1282
- namespace SpruceSchemas.Files.v2022_05_13 {
1283
- interface UploadResponsePayload {
1284
- 'file': SpruceSchemas.Files.v2022_05_13.UploadedFile;
1285
- }
1286
- interface UploadResponsePayloadSchema extends SpruceSchema.Schema {
1287
- id: 'uploadResponsePayload';
1288
- version: 'v2022_05_13';
1289
- namespace: 'Files';
1290
- name: '';
1291
- fields: {
1292
- /** . */
1293
- 'file': {
1294
- type: 'schema';
1295
- isRequired: true;
1296
- options: {
1297
- schema: SpruceSchemas.Files.v2022_05_13.UploadedFileSchema;
1298
- };
1299
- };
1300
- };
1301
- }
1302
- interface UploadResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadResponsePayloadSchema> {
1303
- }
1304
- }
1305
1305
  namespace SpruceSchemas.Files.v2022_05_13 {
1306
1306
  interface SettingsTarget {
1307
1307
  'organizationId': string;