@sprucelabs/spruce-file-utils 15.1.22 → 15.1.23

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 (4) hide show
  1. package/README.md +0 -1
  2. package/build/.spruce/schemas/schemas.types.d.ts +130 -130
  3. package/build/esm/.spruce/schemas/schemas.types.d.ts +130 -130
  4. package/package.json +1 -1
package/README.md CHANGED
@@ -3,4 +3,3 @@ Spruce File Utils
3
3
  ## Useful links
4
4
 
5
5
  - [Spruce Developer Documentation: https://developer.spruce.ai](https://developer.spruce.ai)
6
-
package/build/.spruce/schemas/schemas.types.d.ts CHANGED
@@ -719,96 +719,112 @@ 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 GetUploadEndpointResponsePayload {
723
- /** . The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client. */
724
- 'restEndpointUrl'?: string | undefined | null;
722
+ interface GetSettingsStatusEmitTarget {
723
+ 'organizationId': string;
725
724
  }
726
- interface GetUploadEndpointResponsePayloadSchema extends SpruceSchema.Schema {
727
- id: 'getUploadEndpointResponsePayload';
725
+ interface GetSettingsStatusEmitTargetSchema extends SpruceSchema.Schema {
726
+ id: 'getSettingsStatusEmitTarget';
728
727
  version: 'v2022_05_13';
729
728
  namespace: 'Files';
730
729
  name: '';
731
730
  fields: {
732
- /** . The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client. */
733
- 'restEndpointUrl': {
734
- type: 'text';
735
- hint: 'The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client.';
731
+ /** . */
732
+ 'organizationId': {
733
+ type: 'id';
734
+ isRequired: true;
736
735
  options: undefined;
737
736
  };
738
737
  };
739
738
  }
740
- interface GetUploadEndpointResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetUploadEndpointResponsePayloadSchema> {
739
+ interface GetSettingsStatusEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTargetSchema> {
741
740
  }
742
741
  }
743
742
  namespace SpruceSchemas.Files.v2022_05_13 {
744
- interface UploadEmitTarget {
745
- 'locationId'?: string | undefined | null;
746
- 'organizationId'?: string | undefined | null;
747
- 'filePersonId'?: string | undefined | null;
743
+ interface GetSettingsStatusResponsePayload {
744
+ 'didSupplyS3Creds': boolean;
748
745
  }
749
- interface UploadEmitTargetSchema extends SpruceSchema.Schema {
750
- id: 'uploadEmitTarget';
746
+ interface GetSettingsStatusResponsePayloadSchema extends SpruceSchema.Schema {
747
+ id: 'getSettingsStatusResponsePayload';
751
748
  version: 'v2022_05_13';
752
749
  namespace: 'Files';
753
750
  name: '';
754
751
  fields: {
755
752
  /** . */
756
- 'locationId': {
757
- type: 'id';
753
+ 'didSupplyS3Creds': {
754
+ type: 'boolean';
755
+ isRequired: true;
758
756
  options: undefined;
759
757
  };
758
+ };
759
+ }
760
+ interface GetSettingsStatusResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusResponsePayloadSchema> {
761
+ }
762
+ }
763
+ namespace SpruceSchemas.Files.v2022_05_13 {
764
+ interface SaveSettingsEmitTarget {
765
+ 'organizationId': string;
766
+ }
767
+ interface SaveSettingsEmitTargetSchema extends SpruceSchema.Schema {
768
+ id: 'saveSettingsEmitTarget';
769
+ version: 'v2022_05_13';
770
+ namespace: 'Files';
771
+ name: '';
772
+ fields: {
760
773
  /** . */
761
774
  'organizationId': {
762
775
  type: 'id';
763
- options: undefined;
764
- };
765
- /** . */
766
- 'filePersonId': {
767
- type: 'text';
776
+ isRequired: true;
768
777
  options: undefined;
769
778
  };
770
779
  };
771
780
  }
772
- interface UploadEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema> {
781
+ interface SaveSettingsEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetSchema> {
773
782
  }
774
783
  }
775
784
  namespace SpruceSchemas.Files.v2022_05_13 {
776
- interface UploadEmitPayload {
777
- 'base64Body': string;
778
- 'name': string;
785
+ interface SaveSettingsEmitPayload {
786
+ 'awsAccessKeyId': string;
787
+ 'awsSecretAccessKey': string;
788
+ 'awsS3Bucket': string;
779
789
  }
780
- interface UploadEmitPayloadSchema extends SpruceSchema.Schema {
781
- id: 'uploadEmitPayload';
790
+ interface SaveSettingsEmitPayloadSchema extends SpruceSchema.Schema {
791
+ id: 'saveSettingsEmitPayload';
782
792
  version: 'v2022_05_13';
783
793
  namespace: 'Files';
784
794
  name: '';
785
795
  fields: {
786
796
  /** . */
787
- 'base64Body': {
797
+ 'awsAccessKeyId': {
798
+ type: 'id';
799
+ isRequired: true;
800
+ options: undefined;
801
+ };
802
+ /** . */
803
+ 'awsSecretAccessKey': {
788
804
  type: 'text';
789
805
  isRequired: true;
790
806
  options: undefined;
791
807
  };
792
808
  /** . */
793
- 'name': {
809
+ 'awsS3Bucket': {
794
810
  type: 'text';
795
811
  isRequired: true;
796
812
  options: undefined;
797
813
  };
798
814
  };
799
815
  }
800
- interface UploadEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema> {
816
+ interface SaveSettingsEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayloadSchema> {
801
817
  }
802
818
  }
803
819
  namespace SpruceSchemas.Files.v2022_05_13 {
804
- interface UploadEmitTargetAndPayload {
820
+ interface SaveSettingsEmitTargetAndPayload {
805
821
  /** Source. */
806
822
  'source'?: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSource | undefined | null;
807
- 'target'?: SpruceSchemas.Files.v2022_05_13.UploadEmitTarget | undefined | null;
808
- 'payload': SpruceSchemas.Files.v2022_05_13.UploadEmitPayload;
823
+ 'target': SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTarget;
824
+ 'payload': SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayload;
809
825
  }
810
- interface UploadEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
811
- id: 'uploadEmitTargetAndPayload';
826
+ interface SaveSettingsEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
827
+ id: 'saveSettingsEmitTargetAndPayload';
812
828
  version: 'v2022_05_13';
813
829
  namespace: 'Files';
814
830
  name: '';
@@ -823,87 +839,66 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
823
839
  };
824
840
  /** . */
825
841
  'target': {
826
- type: 'schema';
827
- options: {
828
- schema: SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema;
829
- };
830
- };
831
- /** . */
832
- 'payload': {
833
842
  type: 'schema';
834
843
  isRequired: true;
835
844
  options: {
836
- schema: SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema;
845
+ schema: SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetSchema;
837
846
  };
838
847
  };
839
- };
840
- }
841
- interface UploadEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetAndPayloadSchema> {
842
- }
843
- }
844
- namespace SpruceSchemas.Files.v2022_05_13 {
845
- interface UploadResponsePayload {
846
- 'file': SpruceSchemas.Files.v2022_05_13.UploadedFile;
847
- }
848
- interface UploadResponsePayloadSchema extends SpruceSchema.Schema {
849
- id: 'uploadResponsePayload';
850
- version: 'v2022_05_13';
851
- namespace: 'Files';
852
- name: '';
853
- fields: {
854
848
  /** . */
855
- 'file': {
849
+ 'payload': {
856
850
  type: 'schema';
857
851
  isRequired: true;
858
852
  options: {
859
- schema: SpruceSchemas.Files.v2022_05_13.UploadedFileSchema;
853
+ schema: SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayloadSchema;
860
854
  };
861
855
  };
862
856
  };
863
857
  }
864
- interface UploadResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadResponsePayloadSchema> {
858
+ interface SaveSettingsEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetAndPayloadSchema> {
865
859
  }
866
860
  }
867
861
  namespace SpruceSchemas.Files.v2022_05_13 {
868
- interface GetSettingsStatusEmitTarget {
869
- 'organizationId': string;
862
+ interface SaveSettingsResponsePayload {
863
+ 'wasSuccessful': boolean;
870
864
  }
871
- interface GetSettingsStatusEmitTargetSchema extends SpruceSchema.Schema {
872
- id: 'getSettingsStatusEmitTarget';
865
+ interface SaveSettingsResponsePayloadSchema extends SpruceSchema.Schema {
866
+ id: 'saveSettingsResponsePayload';
873
867
  version: 'v2022_05_13';
874
868
  namespace: 'Files';
875
869
  name: '';
876
870
  fields: {
877
871
  /** . */
878
- 'organizationId': {
879
- type: 'id';
872
+ 'wasSuccessful': {
873
+ type: 'boolean';
880
874
  isRequired: true;
881
875
  options: undefined;
882
876
  };
883
877
  };
884
878
  }
885
- interface GetSettingsStatusEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTargetSchema> {
879
+ interface SaveSettingsResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsResponsePayloadSchema> {
886
880
  }
887
881
  }
888
882
  namespace SpruceSchemas.Files.v2022_05_13 {
889
- interface GetSettingsStatusResponsePayload {
890
- 'didSupplyS3Creds': boolean;
883
+ interface GetUploadEndpointResponsePayload {
884
+ /** . The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client. */
885
+ 'restEndpointUrl'?: string | undefined | null;
891
886
  }
892
- interface GetSettingsStatusResponsePayloadSchema extends SpruceSchema.Schema {
893
- id: 'getSettingsStatusResponsePayload';
887
+ interface GetUploadEndpointResponsePayloadSchema extends SpruceSchema.Schema {
888
+ id: 'getUploadEndpointResponsePayload';
894
889
  version: 'v2022_05_13';
895
890
  namespace: 'Files';
896
891
  name: '';
897
892
  fields: {
898
- /** . */
899
- 'didSupplyS3Creds': {
900
- type: 'boolean';
901
- isRequired: true;
893
+ /** . The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client. */
894
+ 'restEndpointUrl': {
895
+ type: 'text';
896
+ hint: 'The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client.';
902
897
  options: undefined;
903
898
  };
904
899
  };
905
900
  }
906
- interface GetSettingsStatusResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusResponsePayloadSchema> {
901
+ interface GetUploadEndpointResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetUploadEndpointResponsePayloadSchema> {
907
902
  }
908
903
  }
909
904
  namespace SpruceSchemas.Files.v2022_05_13 {
@@ -940,70 +935,74 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
940
935
  }
941
936
  }
942
937
  namespace SpruceSchemas.Files.v2022_05_13 {
943
- interface SaveSettingsEmitTarget {
944
- 'organizationId': string;
938
+ interface UploadEmitTarget {
939
+ 'locationId'?: string | undefined | null;
940
+ 'organizationId'?: string | undefined | null;
941
+ 'filePersonId'?: string | undefined | null;
945
942
  }
946
- interface SaveSettingsEmitTargetSchema extends SpruceSchema.Schema {
947
- id: 'saveSettingsEmitTarget';
943
+ interface UploadEmitTargetSchema extends SpruceSchema.Schema {
944
+ id: 'uploadEmitTarget';
948
945
  version: 'v2022_05_13';
949
946
  namespace: 'Files';
950
947
  name: '';
951
948
  fields: {
949
+ /** . */
950
+ 'locationId': {
951
+ type: 'id';
952
+ options: undefined;
953
+ };
952
954
  /** . */
953
955
  'organizationId': {
954
956
  type: 'id';
955
- isRequired: true;
957
+ options: undefined;
958
+ };
959
+ /** . */
960
+ 'filePersonId': {
961
+ type: 'text';
956
962
  options: undefined;
957
963
  };
958
964
  };
959
965
  }
960
- interface SaveSettingsEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetSchema> {
966
+ interface UploadEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema> {
961
967
  }
962
968
  }
963
969
  namespace SpruceSchemas.Files.v2022_05_13 {
964
- interface SaveSettingsEmitPayload {
965
- 'awsAccessKeyId': string;
966
- 'awsSecretAccessKey': string;
967
- 'awsS3Bucket': string;
970
+ interface UploadEmitPayload {
971
+ 'base64Body': string;
972
+ 'name': string;
968
973
  }
969
- interface SaveSettingsEmitPayloadSchema extends SpruceSchema.Schema {
970
- id: 'saveSettingsEmitPayload';
974
+ interface UploadEmitPayloadSchema extends SpruceSchema.Schema {
975
+ id: 'uploadEmitPayload';
971
976
  version: 'v2022_05_13';
972
977
  namespace: 'Files';
973
978
  name: '';
974
979
  fields: {
975
980
  /** . */
976
- 'awsAccessKeyId': {
977
- type: 'id';
978
- isRequired: true;
979
- options: undefined;
980
- };
981
- /** . */
982
- 'awsSecretAccessKey': {
981
+ 'base64Body': {
983
982
  type: 'text';
984
983
  isRequired: true;
985
984
  options: undefined;
986
985
  };
987
986
  /** . */
988
- 'awsS3Bucket': {
987
+ 'name': {
989
988
  type: 'text';
990
989
  isRequired: true;
991
990
  options: undefined;
992
991
  };
993
992
  };
994
993
  }
995
- interface SaveSettingsEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayloadSchema> {
994
+ interface UploadEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema> {
996
995
  }
997
996
  }
998
997
  namespace SpruceSchemas.Files.v2022_05_13 {
999
- interface SaveSettingsEmitTargetAndPayload {
998
+ interface UploadEmitTargetAndPayload {
1000
999
  /** Source. */
1001
1000
  'source'?: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSource | undefined | null;
1002
- 'target': SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTarget;
1003
- 'payload': SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayload;
1001
+ 'target'?: SpruceSchemas.Files.v2022_05_13.UploadEmitTarget | undefined | null;
1002
+ 'payload': SpruceSchemas.Files.v2022_05_13.UploadEmitPayload;
1004
1003
  }
1005
- interface SaveSettingsEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
1006
- id: 'saveSettingsEmitTargetAndPayload';
1004
+ interface UploadEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
1005
+ id: 'uploadEmitTargetAndPayload';
1007
1006
  version: 'v2022_05_13';
1008
1007
  namespace: 'Files';
1009
1008
  name: '';
@@ -1019,9 +1018,8 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1019
1018
  /** . */
1020
1019
  'target': {
1021
1020
  type: 'schema';
1022
- isRequired: true;
1023
1021
  options: {
1024
- schema: SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetSchema;
1022
+ schema: SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema;
1025
1023
  };
1026
1024
  };
1027
1025
  /** . */
@@ -1029,33 +1027,12 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1029
1027
  type: 'schema';
1030
1028
  isRequired: true;
1031
1029
  options: {
1032
- schema: SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayloadSchema;
1030
+ schema: SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema;
1033
1031
  };
1034
1032
  };
1035
1033
  };
1036
1034
  }
1037
- interface SaveSettingsEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetAndPayloadSchema> {
1038
- }
1039
- }
1040
- namespace SpruceSchemas.Files.v2022_05_13 {
1041
- interface SaveSettingsResponsePayload {
1042
- 'wasSuccessful': boolean;
1043
- }
1044
- interface SaveSettingsResponsePayloadSchema extends SpruceSchema.Schema {
1045
- id: 'saveSettingsResponsePayload';
1046
- version: 'v2022_05_13';
1047
- namespace: 'Files';
1048
- name: '';
1049
- fields: {
1050
- /** . */
1051
- 'wasSuccessful': {
1052
- type: 'boolean';
1053
- isRequired: true;
1054
- options: undefined;
1055
- };
1056
- };
1057
- }
1058
- interface SaveSettingsResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsResponsePayloadSchema> {
1035
+ interface UploadEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetAndPayloadSchema> {
1059
1036
  }
1060
1037
  }
1061
1038
  namespace SpruceSchemas.Files.v2022_05_13 {
@@ -1093,6 +1070,29 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1093
1070
  interface UploadedFileEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadedFileSchema> {
1094
1071
  }
1095
1072
  }
1073
+ namespace SpruceSchemas.Files.v2022_05_13 {
1074
+ interface UploadResponsePayload {
1075
+ 'file': SpruceSchemas.Files.v2022_05_13.UploadedFile;
1076
+ }
1077
+ interface UploadResponsePayloadSchema extends SpruceSchema.Schema {
1078
+ id: 'uploadResponsePayload';
1079
+ version: 'v2022_05_13';
1080
+ namespace: 'Files';
1081
+ name: '';
1082
+ fields: {
1083
+ /** . */
1084
+ 'file': {
1085
+ type: 'schema';
1086
+ isRequired: true;
1087
+ options: {
1088
+ schema: SpruceSchemas.Files.v2022_05_13.UploadedFileSchema;
1089
+ };
1090
+ };
1091
+ };
1092
+ }
1093
+ interface UploadResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadResponsePayloadSchema> {
1094
+ }
1095
+ }
1096
1096
  namespace SpruceSchemas.Files.v2022_05_13 {
1097
1097
  interface SettingsTarget {
1098
1098
  'organizationId': string;
package/build/esm/.spruce/schemas/schemas.types.d.ts CHANGED
@@ -719,96 +719,112 @@ 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 GetUploadEndpointResponsePayload {
723
- /** . The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client. */
724
- 'restEndpointUrl'?: string | undefined | null;
722
+ interface GetSettingsStatusEmitTarget {
723
+ 'organizationId': string;
725
724
  }
726
- interface GetUploadEndpointResponsePayloadSchema extends SpruceSchema.Schema {
727
- id: 'getUploadEndpointResponsePayload';
725
+ interface GetSettingsStatusEmitTargetSchema extends SpruceSchema.Schema {
726
+ id: 'getSettingsStatusEmitTarget';
728
727
  version: 'v2022_05_13';
729
728
  namespace: 'Files';
730
729
  name: '';
731
730
  fields: {
732
- /** . The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client. */
733
- 'restEndpointUrl': {
734
- type: 'text';
735
- hint: 'The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client.';
731
+ /** . */
732
+ 'organizationId': {
733
+ type: 'id';
734
+ isRequired: true;
736
735
  options: undefined;
737
736
  };
738
737
  };
739
738
  }
740
- interface GetUploadEndpointResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetUploadEndpointResponsePayloadSchema> {
739
+ interface GetSettingsStatusEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTargetSchema> {
741
740
  }
742
741
  }
743
742
  namespace SpruceSchemas.Files.v2022_05_13 {
744
- interface UploadEmitTarget {
745
- 'locationId'?: string | undefined | null;
746
- 'organizationId'?: string | undefined | null;
747
- 'filePersonId'?: string | undefined | null;
743
+ interface GetSettingsStatusResponsePayload {
744
+ 'didSupplyS3Creds': boolean;
748
745
  }
749
- interface UploadEmitTargetSchema extends SpruceSchema.Schema {
750
- id: 'uploadEmitTarget';
746
+ interface GetSettingsStatusResponsePayloadSchema extends SpruceSchema.Schema {
747
+ id: 'getSettingsStatusResponsePayload';
751
748
  version: 'v2022_05_13';
752
749
  namespace: 'Files';
753
750
  name: '';
754
751
  fields: {
755
752
  /** . */
756
- 'locationId': {
757
- type: 'id';
753
+ 'didSupplyS3Creds': {
754
+ type: 'boolean';
755
+ isRequired: true;
758
756
  options: undefined;
759
757
  };
758
+ };
759
+ }
760
+ interface GetSettingsStatusResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusResponsePayloadSchema> {
761
+ }
762
+ }
763
+ namespace SpruceSchemas.Files.v2022_05_13 {
764
+ interface SaveSettingsEmitTarget {
765
+ 'organizationId': string;
766
+ }
767
+ interface SaveSettingsEmitTargetSchema extends SpruceSchema.Schema {
768
+ id: 'saveSettingsEmitTarget';
769
+ version: 'v2022_05_13';
770
+ namespace: 'Files';
771
+ name: '';
772
+ fields: {
760
773
  /** . */
761
774
  'organizationId': {
762
775
  type: 'id';
763
- options: undefined;
764
- };
765
- /** . */
766
- 'filePersonId': {
767
- type: 'text';
776
+ isRequired: true;
768
777
  options: undefined;
769
778
  };
770
779
  };
771
780
  }
772
- interface UploadEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema> {
781
+ interface SaveSettingsEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetSchema> {
773
782
  }
774
783
  }
775
784
  namespace SpruceSchemas.Files.v2022_05_13 {
776
- interface UploadEmitPayload {
777
- 'base64Body': string;
778
- 'name': string;
785
+ interface SaveSettingsEmitPayload {
786
+ 'awsAccessKeyId': string;
787
+ 'awsSecretAccessKey': string;
788
+ 'awsS3Bucket': string;
779
789
  }
780
- interface UploadEmitPayloadSchema extends SpruceSchema.Schema {
781
- id: 'uploadEmitPayload';
790
+ interface SaveSettingsEmitPayloadSchema extends SpruceSchema.Schema {
791
+ id: 'saveSettingsEmitPayload';
782
792
  version: 'v2022_05_13';
783
793
  namespace: 'Files';
784
794
  name: '';
785
795
  fields: {
786
796
  /** . */
787
- 'base64Body': {
797
+ 'awsAccessKeyId': {
798
+ type: 'id';
799
+ isRequired: true;
800
+ options: undefined;
801
+ };
802
+ /** . */
803
+ 'awsSecretAccessKey': {
788
804
  type: 'text';
789
805
  isRequired: true;
790
806
  options: undefined;
791
807
  };
792
808
  /** . */
793
- 'name': {
809
+ 'awsS3Bucket': {
794
810
  type: 'text';
795
811
  isRequired: true;
796
812
  options: undefined;
797
813
  };
798
814
  };
799
815
  }
800
- interface UploadEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema> {
816
+ interface SaveSettingsEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayloadSchema> {
801
817
  }
802
818
  }
803
819
  namespace SpruceSchemas.Files.v2022_05_13 {
804
- interface UploadEmitTargetAndPayload {
820
+ interface SaveSettingsEmitTargetAndPayload {
805
821
  /** Source. */
806
822
  'source'?: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSource | undefined | null;
807
- 'target'?: SpruceSchemas.Files.v2022_05_13.UploadEmitTarget | undefined | null;
808
- 'payload': SpruceSchemas.Files.v2022_05_13.UploadEmitPayload;
823
+ 'target': SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTarget;
824
+ 'payload': SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayload;
809
825
  }
810
- interface UploadEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
811
- id: 'uploadEmitTargetAndPayload';
826
+ interface SaveSettingsEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
827
+ id: 'saveSettingsEmitTargetAndPayload';
812
828
  version: 'v2022_05_13';
813
829
  namespace: 'Files';
814
830
  name: '';
@@ -823,87 +839,66 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
823
839
  };
824
840
  /** . */
825
841
  'target': {
826
- type: 'schema';
827
- options: {
828
- schema: SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema;
829
- };
830
- };
831
- /** . */
832
- 'payload': {
833
842
  type: 'schema';
834
843
  isRequired: true;
835
844
  options: {
836
- schema: SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema;
845
+ schema: SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetSchema;
837
846
  };
838
847
  };
839
- };
840
- }
841
- interface UploadEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetAndPayloadSchema> {
842
- }
843
- }
844
- namespace SpruceSchemas.Files.v2022_05_13 {
845
- interface UploadResponsePayload {
846
- 'file': SpruceSchemas.Files.v2022_05_13.UploadedFile;
847
- }
848
- interface UploadResponsePayloadSchema extends SpruceSchema.Schema {
849
- id: 'uploadResponsePayload';
850
- version: 'v2022_05_13';
851
- namespace: 'Files';
852
- name: '';
853
- fields: {
854
848
  /** . */
855
- 'file': {
849
+ 'payload': {
856
850
  type: 'schema';
857
851
  isRequired: true;
858
852
  options: {
859
- schema: SpruceSchemas.Files.v2022_05_13.UploadedFileSchema;
853
+ schema: SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayloadSchema;
860
854
  };
861
855
  };
862
856
  };
863
857
  }
864
- interface UploadResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadResponsePayloadSchema> {
858
+ interface SaveSettingsEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetAndPayloadSchema> {
865
859
  }
866
860
  }
867
861
  namespace SpruceSchemas.Files.v2022_05_13 {
868
- interface GetSettingsStatusEmitTarget {
869
- 'organizationId': string;
862
+ interface SaveSettingsResponsePayload {
863
+ 'wasSuccessful': boolean;
870
864
  }
871
- interface GetSettingsStatusEmitTargetSchema extends SpruceSchema.Schema {
872
- id: 'getSettingsStatusEmitTarget';
865
+ interface SaveSettingsResponsePayloadSchema extends SpruceSchema.Schema {
866
+ id: 'saveSettingsResponsePayload';
873
867
  version: 'v2022_05_13';
874
868
  namespace: 'Files';
875
869
  name: '';
876
870
  fields: {
877
871
  /** . */
878
- 'organizationId': {
879
- type: 'id';
872
+ 'wasSuccessful': {
873
+ type: 'boolean';
880
874
  isRequired: true;
881
875
  options: undefined;
882
876
  };
883
877
  };
884
878
  }
885
- interface GetSettingsStatusEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTargetSchema> {
879
+ interface SaveSettingsResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsResponsePayloadSchema> {
886
880
  }
887
881
  }
888
882
  namespace SpruceSchemas.Files.v2022_05_13 {
889
- interface GetSettingsStatusResponsePayload {
890
- 'didSupplyS3Creds': boolean;
883
+ interface GetUploadEndpointResponsePayload {
884
+ /** . The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client. */
885
+ 'restEndpointUrl'?: string | undefined | null;
891
886
  }
892
- interface GetSettingsStatusResponsePayloadSchema extends SpruceSchema.Schema {
893
- id: 'getSettingsStatusResponsePayload';
887
+ interface GetUploadEndpointResponsePayloadSchema extends SpruceSchema.Schema {
888
+ id: 'getUploadEndpointResponsePayload';
894
889
  version: 'v2022_05_13';
895
890
  namespace: 'Files';
896
891
  name: '';
897
892
  fields: {
898
- /** . */
899
- 'didSupplyS3Creds': {
900
- type: 'boolean';
901
- isRequired: true;
893
+ /** . The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client. */
894
+ 'restEndpointUrl': {
895
+ type: 'text';
896
+ hint: 'The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client.';
902
897
  options: undefined;
903
898
  };
904
899
  };
905
900
  }
906
- interface GetSettingsStatusResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusResponsePayloadSchema> {
901
+ interface GetUploadEndpointResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetUploadEndpointResponsePayloadSchema> {
907
902
  }
908
903
  }
909
904
  namespace SpruceSchemas.Files.v2022_05_13 {
@@ -940,70 +935,74 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
940
935
  }
941
936
  }
942
937
  namespace SpruceSchemas.Files.v2022_05_13 {
943
- interface SaveSettingsEmitTarget {
944
- 'organizationId': string;
938
+ interface UploadEmitTarget {
939
+ 'locationId'?: string | undefined | null;
940
+ 'organizationId'?: string | undefined | null;
941
+ 'filePersonId'?: string | undefined | null;
945
942
  }
946
- interface SaveSettingsEmitTargetSchema extends SpruceSchema.Schema {
947
- id: 'saveSettingsEmitTarget';
943
+ interface UploadEmitTargetSchema extends SpruceSchema.Schema {
944
+ id: 'uploadEmitTarget';
948
945
  version: 'v2022_05_13';
949
946
  namespace: 'Files';
950
947
  name: '';
951
948
  fields: {
949
+ /** . */
950
+ 'locationId': {
951
+ type: 'id';
952
+ options: undefined;
953
+ };
952
954
  /** . */
953
955
  'organizationId': {
954
956
  type: 'id';
955
- isRequired: true;
957
+ options: undefined;
958
+ };
959
+ /** . */
960
+ 'filePersonId': {
961
+ type: 'text';
956
962
  options: undefined;
957
963
  };
958
964
  };
959
965
  }
960
- interface SaveSettingsEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetSchema> {
966
+ interface UploadEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema> {
961
967
  }
962
968
  }
963
969
  namespace SpruceSchemas.Files.v2022_05_13 {
964
- interface SaveSettingsEmitPayload {
965
- 'awsAccessKeyId': string;
966
- 'awsSecretAccessKey': string;
967
- 'awsS3Bucket': string;
970
+ interface UploadEmitPayload {
971
+ 'base64Body': string;
972
+ 'name': string;
968
973
  }
969
- interface SaveSettingsEmitPayloadSchema extends SpruceSchema.Schema {
970
- id: 'saveSettingsEmitPayload';
974
+ interface UploadEmitPayloadSchema extends SpruceSchema.Schema {
975
+ id: 'uploadEmitPayload';
971
976
  version: 'v2022_05_13';
972
977
  namespace: 'Files';
973
978
  name: '';
974
979
  fields: {
975
980
  /** . */
976
- 'awsAccessKeyId': {
977
- type: 'id';
978
- isRequired: true;
979
- options: undefined;
980
- };
981
- /** . */
982
- 'awsSecretAccessKey': {
981
+ 'base64Body': {
983
982
  type: 'text';
984
983
  isRequired: true;
985
984
  options: undefined;
986
985
  };
987
986
  /** . */
988
- 'awsS3Bucket': {
987
+ 'name': {
989
988
  type: 'text';
990
989
  isRequired: true;
991
990
  options: undefined;
992
991
  };
993
992
  };
994
993
  }
995
- interface SaveSettingsEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayloadSchema> {
994
+ interface UploadEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema> {
996
995
  }
997
996
  }
998
997
  namespace SpruceSchemas.Files.v2022_05_13 {
999
- interface SaveSettingsEmitTargetAndPayload {
998
+ interface UploadEmitTargetAndPayload {
1000
999
  /** Source. */
1001
1000
  'source'?: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSource | undefined | null;
1002
- 'target': SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTarget;
1003
- 'payload': SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayload;
1001
+ 'target'?: SpruceSchemas.Files.v2022_05_13.UploadEmitTarget | undefined | null;
1002
+ 'payload': SpruceSchemas.Files.v2022_05_13.UploadEmitPayload;
1004
1003
  }
1005
- interface SaveSettingsEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
1006
- id: 'saveSettingsEmitTargetAndPayload';
1004
+ interface UploadEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
1005
+ id: 'uploadEmitTargetAndPayload';
1007
1006
  version: 'v2022_05_13';
1008
1007
  namespace: 'Files';
1009
1008
  name: '';
@@ -1019,9 +1018,8 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1019
1018
  /** . */
1020
1019
  'target': {
1021
1020
  type: 'schema';
1022
- isRequired: true;
1023
1021
  options: {
1024
- schema: SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetSchema;
1022
+ schema: SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema;
1025
1023
  };
1026
1024
  };
1027
1025
  /** . */
@@ -1029,33 +1027,12 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1029
1027
  type: 'schema';
1030
1028
  isRequired: true;
1031
1029
  options: {
1032
- schema: SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayloadSchema;
1030
+ schema: SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema;
1033
1031
  };
1034
1032
  };
1035
1033
  };
1036
1034
  }
1037
- interface SaveSettingsEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetAndPayloadSchema> {
1038
- }
1039
- }
1040
- namespace SpruceSchemas.Files.v2022_05_13 {
1041
- interface SaveSettingsResponsePayload {
1042
- 'wasSuccessful': boolean;
1043
- }
1044
- interface SaveSettingsResponsePayloadSchema extends SpruceSchema.Schema {
1045
- id: 'saveSettingsResponsePayload';
1046
- version: 'v2022_05_13';
1047
- namespace: 'Files';
1048
- name: '';
1049
- fields: {
1050
- /** . */
1051
- 'wasSuccessful': {
1052
- type: 'boolean';
1053
- isRequired: true;
1054
- options: undefined;
1055
- };
1056
- };
1057
- }
1058
- interface SaveSettingsResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsResponsePayloadSchema> {
1035
+ interface UploadEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetAndPayloadSchema> {
1059
1036
  }
1060
1037
  }
1061
1038
  namespace SpruceSchemas.Files.v2022_05_13 {
@@ -1093,6 +1070,29 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1093
1070
  interface UploadedFileEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadedFileSchema> {
1094
1071
  }
1095
1072
  }
1073
+ namespace SpruceSchemas.Files.v2022_05_13 {
1074
+ interface UploadResponsePayload {
1075
+ 'file': SpruceSchemas.Files.v2022_05_13.UploadedFile;
1076
+ }
1077
+ interface UploadResponsePayloadSchema extends SpruceSchema.Schema {
1078
+ id: 'uploadResponsePayload';
1079
+ version: 'v2022_05_13';
1080
+ namespace: 'Files';
1081
+ name: '';
1082
+ fields: {
1083
+ /** . */
1084
+ 'file': {
1085
+ type: 'schema';
1086
+ isRequired: true;
1087
+ options: {
1088
+ schema: SpruceSchemas.Files.v2022_05_13.UploadedFileSchema;
1089
+ };
1090
+ };
1091
+ };
1092
+ }
1093
+ interface UploadResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadResponsePayloadSchema> {
1094
+ }
1095
+ }
1096
1096
  namespace SpruceSchemas.Files.v2022_05_13 {
1097
1097
  interface SettingsTarget {
1098
1098
  'organizationId': string;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@sprucelabs/spruce-file-utils",
3
3
  "description": "Utils for working with files and Sprucebot.",
4
- "version": "15.1.22",
4
+ "version": "15.1.23",
5
5
  "skill": {
6
6
  "namespace": "files"
7
7
  },