@sprucelabs/spruce-file-utils 18.6.6 → 18.6.8

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