@sprucelabs/spruce-file-utils 18.1.0 → 18.1.1

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.
@@ -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,38 @@ 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> {
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': {
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.';
930
- options: undefined;
931
- };
932
- };
933
- }
934
- interface GetUploadEndpointResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetUploadEndpointResponsePayloadSchema> {
920
+ interface SaveLocalSettingsResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveLocalSettingsResponsePayloadSchema> {
935
921
  }
936
922
  }
937
923
  namespace SpruceSchemas.Files.v2022_05_13 {
938
- interface UploadEmitTarget {
939
- 'locationId'?: string | undefined | null;
940
- 'organizationId'?: string | undefined | null;
941
- 'filePersonId'?: string | undefined | null;
924
+ interface GetSettingsStatusEmitTarget {
925
+ 'organizationId': string;
942
926
  }
943
- interface UploadEmitTargetSchema extends SpruceSchema.Schema {
944
- id: 'uploadEmitTarget';
927
+ interface GetSettingsStatusEmitTargetSchema extends SpruceSchema.Schema {
928
+ id: 'getSettingsStatusEmitTarget';
945
929
  version: 'v2022_05_13';
946
930
  namespace: 'Files';
947
931
  name: '';
948
932
  fields: {
949
- /** . */
950
- 'locationId': {
951
- type: 'id';
952
- options: undefined;
953
- };
954
933
  /** . */
955
934
  'organizationId': {
956
935
  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';
989
936
  isRequired: true;
990
937
  options: undefined;
991
938
  };
992
939
  };
993
940
  }
994
- interface UploadEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema> {
941
+ interface GetSettingsStatusEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTargetSchema> {
995
942
  }
996
943
  }
997
944
  namespace SpruceSchemas.Files.v2022_05_13 {
998
- interface UploadEmitTargetAndPayload {
945
+ interface GetSettingsStatusEmitTargetAndPayload {
999
946
  /** Source. */
1000
947
  '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;
948
+ 'target': SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTarget;
1003
949
  }
1004
- interface UploadEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
1005
- id: 'uploadEmitTargetAndPayload';
950
+ interface GetSettingsStatusEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
951
+ id: 'getSettingsStatusEmitTargetAndPayload';
1006
952
  version: 'v2022_05_13';
1007
953
  namespace: 'Files';
1008
954
  name: '';
@@ -1017,53 +963,44 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1017
963
  };
1018
964
  /** . */
1019
965
  'target': {
1020
- type: 'schema';
1021
- options: {
1022
- schema: SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema;
1023
- };
1024
- };
1025
- /** . */
1026
- 'payload': {
1027
966
  type: 'schema';
1028
967
  isRequired: true;
1029
968
  options: {
1030
- schema: SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema;
969
+ schema: SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTargetSchema;
1031
970
  };
1032
971
  };
1033
972
  };
1034
973
  }
1035
- interface UploadEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetAndPayloadSchema> {
974
+ interface GetSettingsStatusEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTargetAndPayloadSchema> {
1036
975
  }
1037
976
  }
1038
977
  namespace SpruceSchemas.Files.v2022_05_13 {
1039
- interface UploadResponsePayload {
1040
- 'file': SpruceSchemas.Files.v2022_05_13.UploadedFile;
978
+ interface GetSettingsStatusResponsePayload {
979
+ 'didConfigureFileUploads': boolean;
1041
980
  }
1042
- interface UploadResponsePayloadSchema extends SpruceSchema.Schema {
1043
- id: 'uploadResponsePayload';
981
+ interface GetSettingsStatusResponsePayloadSchema extends SpruceSchema.Schema {
982
+ id: 'getSettingsStatusResponsePayload';
1044
983
  version: 'v2022_05_13';
1045
984
  namespace: 'Files';
1046
985
  name: '';
1047
986
  fields: {
1048
987
  /** . */
1049
- 'file': {
1050
- type: 'schema';
988
+ 'didConfigureFileUploads': {
989
+ type: 'boolean';
1051
990
  isRequired: true;
1052
- options: {
1053
- schema: SpruceSchemas.Files.v2022_05_13.UploadedFileSchema;
1054
- };
991
+ options: undefined;
1055
992
  };
1056
993
  };
1057
994
  }
1058
- interface UploadResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadResponsePayloadSchema> {
995
+ interface GetSettingsStatusResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusResponsePayloadSchema> {
1059
996
  }
1060
997
  }
1061
998
  namespace SpruceSchemas.Files.v2022_05_13 {
1062
- interface GetLocalSettingsEmitTarget {
999
+ interface SaveSettingsEmitTarget {
1063
1000
  'organizationId': string;
1064
1001
  }
1065
- interface GetLocalSettingsEmitTargetSchema extends SpruceSchema.Schema {
1066
- id: 'getLocalSettingsEmitTarget';
1002
+ interface SaveSettingsEmitTargetSchema extends SpruceSchema.Schema {
1003
+ id: 'saveSettingsEmitTarget';
1067
1004
  version: 'v2022_05_13';
1068
1005
  namespace: 'Files';
1069
1006
  name: '';
@@ -1076,49 +1013,53 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1076
1013
  };
1077
1014
  };
1078
1015
  }
1079
- interface GetLocalSettingsEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetLocalSettingsEmitTargetSchema> {
1016
+ interface SaveSettingsEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetSchema> {
1080
1017
  }
1081
1018
  }
1082
1019
  namespace SpruceSchemas.Files.v2022_05_13 {
1083
- interface GetLocalSettingsResponsePayload {
1084
- /** Local Upload Directory. */
1085
- 'localUploadDir': string;
1086
- /** File Host URL. */
1087
- 'fileHostUrl': string;
1020
+ interface SaveSettingsEmitPayload {
1021
+ 'awsAccessKeyId': string;
1022
+ 'awsSecretAccessKey': string;
1023
+ 'awsS3Bucket': string;
1088
1024
  }
1089
- interface GetLocalSettingsResponsePayloadSchema extends SpruceSchema.Schema {
1090
- id: 'getLocalSettingsResponsePayload';
1025
+ interface SaveSettingsEmitPayloadSchema extends SpruceSchema.Schema {
1026
+ id: 'saveSettingsEmitPayload';
1091
1027
  version: 'v2022_05_13';
1092
1028
  namespace: 'Files';
1093
1029
  name: '';
1094
1030
  fields: {
1095
- /** Local Upload Directory. */
1096
- 'localUploadDir': {
1097
- label: 'Local Upload Directory';
1031
+ /** . */
1032
+ 'awsAccessKeyId': {
1033
+ type: 'id';
1034
+ isRequired: true;
1035
+ options: undefined;
1036
+ };
1037
+ /** . */
1038
+ 'awsSecretAccessKey': {
1098
1039
  type: 'text';
1099
1040
  isRequired: true;
1100
1041
  options: undefined;
1101
1042
  };
1102
- /** File Host URL. */
1103
- 'fileHostUrl': {
1104
- label: 'File Host URL';
1043
+ /** . */
1044
+ 'awsS3Bucket': {
1105
1045
  type: 'text';
1106
1046
  isRequired: true;
1107
1047
  options: undefined;
1108
1048
  };
1109
1049
  };
1110
1050
  }
1111
- interface GetLocalSettingsResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetLocalSettingsResponsePayloadSchema> {
1051
+ interface SaveSettingsEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayloadSchema> {
1112
1052
  }
1113
1053
  }
1114
1054
  namespace SpruceSchemas.Files.v2022_05_13 {
1115
- interface GetLocalSettingsEmitTargetAndPayload {
1055
+ interface SaveSettingsEmitTargetAndPayload {
1116
1056
  /** Source. */
1117
1057
  'source'?: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSource | undefined | null;
1118
- 'target': SpruceSchemas.Files.v2022_05_13.GetLocalSettingsEmitTarget;
1058
+ 'target': SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTarget;
1059
+ 'payload': SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayload;
1119
1060
  }
1120
- interface GetLocalSettingsEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
1121
- id: 'getLocalSettingsEmitTargetAndPayload';
1061
+ interface SaveSettingsEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
1062
+ id: 'saveSettingsEmitTargetAndPayload';
1122
1063
  version: 'v2022_05_13';
1123
1064
  namespace: 'Files';
1124
1065
  name: '';
@@ -1136,76 +1077,112 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1136
1077
  type: 'schema';
1137
1078
  isRequired: true;
1138
1079
  options: {
1139
- schema: SpruceSchemas.Files.v2022_05_13.GetLocalSettingsEmitTargetSchema;
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;
1140
1089
  };
1141
1090
  };
1142
1091
  };
1143
1092
  }
1144
- interface GetLocalSettingsEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetLocalSettingsEmitTargetAndPayloadSchema> {
1093
+ interface SaveSettingsEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetAndPayloadSchema> {
1145
1094
  }
1146
1095
  }
1147
1096
  namespace SpruceSchemas.Files.v2022_05_13 {
1148
- interface SaveLocalSettingsEmitTarget {
1149
- 'organizationId': string;
1097
+ interface SaveSettingsResponsePayload {
1098
+ 'wasSuccessful': boolean;
1150
1099
  }
1151
- interface SaveLocalSettingsEmitTargetSchema extends SpruceSchema.Schema {
1152
- id: 'saveLocalSettingsEmitTarget';
1100
+ interface SaveSettingsResponsePayloadSchema extends SpruceSchema.Schema {
1101
+ id: 'saveSettingsResponsePayload';
1153
1102
  version: 'v2022_05_13';
1154
1103
  namespace: 'Files';
1155
1104
  name: '';
1156
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> {
1115
+ }
1116
+ }
1117
+ namespace SpruceSchemas.Files.v2022_05_13 {
1118
+ interface UploadEmitTarget {
1119
+ 'locationId'?: string | undefined | null;
1120
+ 'organizationId'?: string | undefined | null;
1121
+ 'filePersonId'?: string | undefined | null;
1122
+ }
1123
+ interface UploadEmitTargetSchema extends SpruceSchema.Schema {
1124
+ id: 'uploadEmitTarget';
1125
+ version: 'v2022_05_13';
1126
+ namespace: 'Files';
1127
+ name: '';
1128
+ fields: {
1129
+ /** . */
1130
+ 'locationId': {
1131
+ type: 'id';
1132
+ options: undefined;
1133
+ };
1157
1134
  /** . */
1158
1135
  'organizationId': {
1159
1136
  type: 'id';
1160
- isRequired: true;
1137
+ options: undefined;
1138
+ };
1139
+ /** . */
1140
+ 'filePersonId': {
1141
+ type: 'text';
1161
1142
  options: undefined;
1162
1143
  };
1163
1144
  };
1164
1145
  }
1165
- interface SaveLocalSettingsEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveLocalSettingsEmitTargetSchema> {
1146
+ interface UploadEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema> {
1166
1147
  }
1167
1148
  }
1168
1149
  namespace SpruceSchemas.Files.v2022_05_13 {
1169
- interface SaveLocalSettingsEmitPayload {
1170
- /** Local Upload Directory. */
1171
- 'localUploadDir': string;
1172
- /** File Host URL. */
1173
- 'fileHostUrl': string;
1150
+ interface UploadEmitPayload {
1151
+ 'base64Body': string;
1152
+ 'name': string;
1174
1153
  }
1175
- interface SaveLocalSettingsEmitPayloadSchema extends SpruceSchema.Schema {
1176
- id: 'saveLocalSettingsEmitPayload';
1154
+ interface UploadEmitPayloadSchema extends SpruceSchema.Schema {
1155
+ id: 'uploadEmitPayload';
1177
1156
  version: 'v2022_05_13';
1178
1157
  namespace: 'Files';
1179
1158
  name: '';
1180
1159
  fields: {
1181
- /** Local Upload Directory. */
1182
- 'localUploadDir': {
1183
- label: 'Local Upload Directory';
1160
+ /** . */
1161
+ 'base64Body': {
1184
1162
  type: 'text';
1185
1163
  isRequired: true;
1186
1164
  options: undefined;
1187
1165
  };
1188
- /** File Host URL. */
1189
- 'fileHostUrl': {
1190
- label: 'File Host URL';
1166
+ /** . */
1167
+ 'name': {
1191
1168
  type: 'text';
1192
1169
  isRequired: true;
1193
1170
  options: undefined;
1194
1171
  };
1195
1172
  };
1196
1173
  }
1197
- interface SaveLocalSettingsEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveLocalSettingsEmitPayloadSchema> {
1174
+ interface UploadEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema> {
1198
1175
  }
1199
1176
  }
1200
1177
  namespace SpruceSchemas.Files.v2022_05_13 {
1201
- interface SaveLocalSettingsEmitTargetAndPayload {
1178
+ interface UploadEmitTargetAndPayload {
1202
1179
  /** Source. */
1203
1180
  '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;
1181
+ 'target'?: SpruceSchemas.Files.v2022_05_13.UploadEmitTarget | undefined | null;
1182
+ 'payload': SpruceSchemas.Files.v2022_05_13.UploadEmitPayload;
1206
1183
  }
1207
- interface SaveLocalSettingsEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
1208
- id: 'saveLocalSettingsEmitTargetAndPayload';
1184
+ interface UploadEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
1185
+ id: 'uploadEmitTargetAndPayload';
1209
1186
  version: 'v2022_05_13';
1210
1187
  namespace: 'Files';
1211
1188
  name: '';
@@ -1221,9 +1198,8 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1221
1198
  /** . */
1222
1199
  'target': {
1223
1200
  type: 'schema';
1224
- isRequired: true;
1225
1201
  options: {
1226
- schema: SpruceSchemas.Files.v2022_05_13.SaveLocalSettingsEmitTargetSchema;
1202
+ schema: SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema;
1227
1203
  };
1228
1204
  };
1229
1205
  /** . */
@@ -1231,33 +1207,34 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1231
1207
  type: 'schema';
1232
1208
  isRequired: true;
1233
1209
  options: {
1234
- schema: SpruceSchemas.Files.v2022_05_13.SaveLocalSettingsEmitPayloadSchema;
1210
+ schema: SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema;
1235
1211
  };
1236
1212
  };
1237
1213
  };
1238
1214
  }
1239
- interface SaveLocalSettingsEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveLocalSettingsEmitTargetAndPayloadSchema> {
1215
+ interface UploadEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetAndPayloadSchema> {
1240
1216
  }
1241
1217
  }
1242
1218
  namespace SpruceSchemas.Files.v2022_05_13 {
1243
- interface SaveLocalSettingsResponsePayload {
1244
- 'wasSuccessful': boolean;
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;
1245
1222
  }
1246
- interface SaveLocalSettingsResponsePayloadSchema extends SpruceSchema.Schema {
1247
- id: 'saveLocalSettingsResponsePayload';
1223
+ interface GetUploadEndpointResponsePayloadSchema extends SpruceSchema.Schema {
1224
+ id: 'getUploadEndpointResponsePayload';
1248
1225
  version: 'v2022_05_13';
1249
1226
  namespace: 'Files';
1250
1227
  name: '';
1251
1228
  fields: {
1252
- /** . */
1253
- 'wasSuccessful': {
1254
- type: 'boolean';
1255
- isRequired: true;
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.';
1256
1233
  options: undefined;
1257
1234
  };
1258
1235
  };
1259
1236
  }
1260
- interface SaveLocalSettingsResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveLocalSettingsResponsePayloadSchema> {
1237
+ interface GetUploadEndpointResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetUploadEndpointResponsePayloadSchema> {
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;