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