@sprucelabs/spruce-file-utils 18.1.10 → 18.1.11

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 +130 -130
  2. package/build/esm/.spruce/schemas/schemas.types.d.ts +130 -130
  3. package/package.json +1 -1
package/build/.spruce/schemas/schemas.types.d.ts CHANGED
@@ -921,96 +921,112 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
921
921
  }
922
922
  }
923
923
  namespace SpruceSchemas.Files.v2022_05_13 {
924
- interface GetUploadEndpointResponsePayload {
925
- /** . The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client. */
926
- 'restEndpointUrl'?: string | undefined | null;
924
+ interface GetSettingsStatusEmitTarget {
925
+ 'organizationId': string;
927
926
  }
928
- interface GetUploadEndpointResponsePayloadSchema extends SpruceSchema.Schema {
929
- id: 'getUploadEndpointResponsePayload';
927
+ interface GetSettingsStatusEmitTargetSchema extends SpruceSchema.Schema {
928
+ id: 'getSettingsStatusEmitTarget';
930
929
  version: 'v2022_05_13';
931
930
  namespace: 'Files';
932
931
  name: '';
933
932
  fields: {
934
- /** . The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client. */
935
- 'restEndpointUrl': {
936
- type: 'text';
937
- hint: 'The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client.';
933
+ /** . */
934
+ 'organizationId': {
935
+ type: 'id';
936
+ isRequired: true;
938
937
  options: undefined;
939
938
  };
940
939
  };
941
940
  }
942
- interface GetUploadEndpointResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetUploadEndpointResponsePayloadSchema> {
941
+ interface GetSettingsStatusEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTargetSchema> {
943
942
  }
944
943
  }
945
944
  namespace SpruceSchemas.Files.v2022_05_13 {
946
- interface UploadEmitTarget {
947
- 'locationId'?: string | undefined | null;
948
- 'organizationId'?: string | undefined | null;
949
- 'filePersonId'?: string | undefined | null;
945
+ interface GetSettingsStatusResponsePayload {
946
+ 'didConfigureFileUploads': boolean;
950
947
  }
951
- interface UploadEmitTargetSchema extends SpruceSchema.Schema {
952
- id: 'uploadEmitTarget';
948
+ interface GetSettingsStatusResponsePayloadSchema extends SpruceSchema.Schema {
949
+ id: 'getSettingsStatusResponsePayload';
953
950
  version: 'v2022_05_13';
954
951
  namespace: 'Files';
955
952
  name: '';
956
953
  fields: {
957
954
  /** . */
958
- 'locationId': {
959
- type: 'id';
955
+ 'didConfigureFileUploads': {
956
+ type: 'boolean';
957
+ isRequired: true;
960
958
  options: undefined;
961
959
  };
960
+ };
961
+ }
962
+ interface GetSettingsStatusResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusResponsePayloadSchema> {
963
+ }
964
+ }
965
+ namespace SpruceSchemas.Files.v2022_05_13 {
966
+ interface SaveSettingsEmitTarget {
967
+ 'organizationId': string;
968
+ }
969
+ interface SaveSettingsEmitTargetSchema extends SpruceSchema.Schema {
970
+ id: 'saveSettingsEmitTarget';
971
+ version: 'v2022_05_13';
972
+ namespace: 'Files';
973
+ name: '';
974
+ fields: {
962
975
  /** . */
963
976
  'organizationId': {
964
977
  type: 'id';
965
- options: undefined;
966
- };
967
- /** . */
968
- 'filePersonId': {
969
- type: 'text';
978
+ isRequired: true;
970
979
  options: undefined;
971
980
  };
972
981
  };
973
982
  }
974
- interface UploadEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema> {
983
+ interface SaveSettingsEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetSchema> {
975
984
  }
976
985
  }
977
986
  namespace SpruceSchemas.Files.v2022_05_13 {
978
- interface UploadEmitPayload {
979
- 'base64Body': string;
980
- 'name': string;
987
+ interface SaveSettingsEmitPayload {
988
+ 'awsAccessKeyId': string;
989
+ 'awsSecretAccessKey': string;
990
+ 'awsS3Bucket': string;
981
991
  }
982
- interface UploadEmitPayloadSchema extends SpruceSchema.Schema {
983
- id: 'uploadEmitPayload';
992
+ interface SaveSettingsEmitPayloadSchema extends SpruceSchema.Schema {
993
+ id: 'saveSettingsEmitPayload';
984
994
  version: 'v2022_05_13';
985
995
  namespace: 'Files';
986
996
  name: '';
987
997
  fields: {
988
998
  /** . */
989
- 'base64Body': {
999
+ 'awsAccessKeyId': {
1000
+ type: 'id';
1001
+ isRequired: true;
1002
+ options: undefined;
1003
+ };
1004
+ /** . */
1005
+ 'awsSecretAccessKey': {
990
1006
  type: 'text';
991
1007
  isRequired: true;
992
1008
  options: undefined;
993
1009
  };
994
1010
  /** . */
995
- 'name': {
1011
+ 'awsS3Bucket': {
996
1012
  type: 'text';
997
1013
  isRequired: true;
998
1014
  options: undefined;
999
1015
  };
1000
1016
  };
1001
1017
  }
1002
- interface UploadEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema> {
1018
+ interface SaveSettingsEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayloadSchema> {
1003
1019
  }
1004
1020
  }
1005
1021
  namespace SpruceSchemas.Files.v2022_05_13 {
1006
- interface UploadEmitTargetAndPayload {
1022
+ interface SaveSettingsEmitTargetAndPayload {
1007
1023
  /** Source. */
1008
1024
  'source'?: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSource | undefined | null;
1009
- 'target'?: SpruceSchemas.Files.v2022_05_13.UploadEmitTarget | undefined | null;
1010
- 'payload': SpruceSchemas.Files.v2022_05_13.UploadEmitPayload;
1025
+ 'target': SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTarget;
1026
+ 'payload': SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayload;
1011
1027
  }
1012
- interface UploadEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
1013
- id: 'uploadEmitTargetAndPayload';
1028
+ interface SaveSettingsEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
1029
+ id: 'saveSettingsEmitTargetAndPayload';
1014
1030
  version: 'v2022_05_13';
1015
1031
  namespace: 'Files';
1016
1032
  name: '';
@@ -1025,87 +1041,66 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1025
1041
  };
1026
1042
  /** . */
1027
1043
  'target': {
1028
- type: 'schema';
1029
- options: {
1030
- schema: SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema;
1031
- };
1032
- };
1033
- /** . */
1034
- 'payload': {
1035
1044
  type: 'schema';
1036
1045
  isRequired: true;
1037
1046
  options: {
1038
- schema: SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema;
1047
+ schema: SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetSchema;
1039
1048
  };
1040
1049
  };
1041
- };
1042
- }
1043
- interface UploadEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetAndPayloadSchema> {
1044
- }
1045
- }
1046
- namespace SpruceSchemas.Files.v2022_05_13 {
1047
- interface UploadResponsePayload {
1048
- 'file': SpruceSchemas.Files.v2022_05_13.UploadedFile;
1049
- }
1050
- interface UploadResponsePayloadSchema extends SpruceSchema.Schema {
1051
- id: 'uploadResponsePayload';
1052
- version: 'v2022_05_13';
1053
- namespace: 'Files';
1054
- name: '';
1055
- fields: {
1056
1050
  /** . */
1057
- 'file': {
1051
+ 'payload': {
1058
1052
  type: 'schema';
1059
1053
  isRequired: true;
1060
1054
  options: {
1061
- schema: SpruceSchemas.Files.v2022_05_13.UploadedFileSchema;
1055
+ schema: SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayloadSchema;
1062
1056
  };
1063
1057
  };
1064
1058
  };
1065
1059
  }
1066
- interface UploadResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadResponsePayloadSchema> {
1060
+ interface SaveSettingsEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetAndPayloadSchema> {
1067
1061
  }
1068
1062
  }
1069
1063
  namespace SpruceSchemas.Files.v2022_05_13 {
1070
- interface GetSettingsStatusEmitTarget {
1071
- 'organizationId': string;
1064
+ interface SaveSettingsResponsePayload {
1065
+ 'wasSuccessful': boolean;
1072
1066
  }
1073
- interface GetSettingsStatusEmitTargetSchema extends SpruceSchema.Schema {
1074
- id: 'getSettingsStatusEmitTarget';
1067
+ interface SaveSettingsResponsePayloadSchema extends SpruceSchema.Schema {
1068
+ id: 'saveSettingsResponsePayload';
1075
1069
  version: 'v2022_05_13';
1076
1070
  namespace: 'Files';
1077
1071
  name: '';
1078
1072
  fields: {
1079
1073
  /** . */
1080
- 'organizationId': {
1081
- type: 'id';
1074
+ 'wasSuccessful': {
1075
+ type: 'boolean';
1082
1076
  isRequired: true;
1083
1077
  options: undefined;
1084
1078
  };
1085
1079
  };
1086
1080
  }
1087
- interface GetSettingsStatusEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTargetSchema> {
1081
+ interface SaveSettingsResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsResponsePayloadSchema> {
1088
1082
  }
1089
1083
  }
1090
1084
  namespace SpruceSchemas.Files.v2022_05_13 {
1091
- interface GetSettingsStatusResponsePayload {
1092
- 'didConfigureFileUploads': boolean;
1085
+ interface GetUploadEndpointResponsePayload {
1086
+ /** . The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client. */
1087
+ 'restEndpointUrl'?: string | undefined | null;
1093
1088
  }
1094
- interface GetSettingsStatusResponsePayloadSchema extends SpruceSchema.Schema {
1095
- id: 'getSettingsStatusResponsePayload';
1089
+ interface GetUploadEndpointResponsePayloadSchema extends SpruceSchema.Schema {
1090
+ id: 'getUploadEndpointResponsePayload';
1096
1091
  version: 'v2022_05_13';
1097
1092
  namespace: 'Files';
1098
1093
  name: '';
1099
1094
  fields: {
1100
- /** . */
1101
- 'didConfigureFileUploads': {
1102
- type: 'boolean';
1103
- isRequired: true;
1095
+ /** . The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client. */
1096
+ 'restEndpointUrl': {
1097
+ type: 'text';
1098
+ hint: 'The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client.';
1104
1099
  options: undefined;
1105
1100
  };
1106
1101
  };
1107
1102
  }
1108
- interface GetSettingsStatusResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusResponsePayloadSchema> {
1103
+ interface GetUploadEndpointResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetUploadEndpointResponsePayloadSchema> {
1109
1104
  }
1110
1105
  }
1111
1106
  namespace SpruceSchemas.Files.v2022_05_13 {
@@ -1142,70 +1137,74 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1142
1137
  }
1143
1138
  }
1144
1139
  namespace SpruceSchemas.Files.v2022_05_13 {
1145
- interface SaveSettingsEmitTarget {
1146
- 'organizationId': string;
1140
+ interface UploadEmitTarget {
1141
+ 'locationId'?: string | undefined | null;
1142
+ 'organizationId'?: string | undefined | null;
1143
+ 'filePersonId'?: string | undefined | null;
1147
1144
  }
1148
- interface SaveSettingsEmitTargetSchema extends SpruceSchema.Schema {
1149
- id: 'saveSettingsEmitTarget';
1145
+ interface UploadEmitTargetSchema extends SpruceSchema.Schema {
1146
+ id: 'uploadEmitTarget';
1150
1147
  version: 'v2022_05_13';
1151
1148
  namespace: 'Files';
1152
1149
  name: '';
1153
1150
  fields: {
1151
+ /** . */
1152
+ 'locationId': {
1153
+ type: 'id';
1154
+ options: undefined;
1155
+ };
1154
1156
  /** . */
1155
1157
  'organizationId': {
1156
1158
  type: 'id';
1157
- isRequired: true;
1159
+ options: undefined;
1160
+ };
1161
+ /** . */
1162
+ 'filePersonId': {
1163
+ type: 'text';
1158
1164
  options: undefined;
1159
1165
  };
1160
1166
  };
1161
1167
  }
1162
- interface SaveSettingsEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetSchema> {
1168
+ interface UploadEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema> {
1163
1169
  }
1164
1170
  }
1165
1171
  namespace SpruceSchemas.Files.v2022_05_13 {
1166
- interface SaveSettingsEmitPayload {
1167
- 'awsAccessKeyId': string;
1168
- 'awsSecretAccessKey': string;
1169
- 'awsS3Bucket': string;
1172
+ interface UploadEmitPayload {
1173
+ 'base64Body': string;
1174
+ 'name': string;
1170
1175
  }
1171
- interface SaveSettingsEmitPayloadSchema extends SpruceSchema.Schema {
1172
- id: 'saveSettingsEmitPayload';
1176
+ interface UploadEmitPayloadSchema extends SpruceSchema.Schema {
1177
+ id: 'uploadEmitPayload';
1173
1178
  version: 'v2022_05_13';
1174
1179
  namespace: 'Files';
1175
1180
  name: '';
1176
1181
  fields: {
1177
1182
  /** . */
1178
- 'awsAccessKeyId': {
1179
- type: 'id';
1180
- isRequired: true;
1181
- options: undefined;
1182
- };
1183
- /** . */
1184
- 'awsSecretAccessKey': {
1183
+ 'base64Body': {
1185
1184
  type: 'text';
1186
1185
  isRequired: true;
1187
1186
  options: undefined;
1188
1187
  };
1189
1188
  /** . */
1190
- 'awsS3Bucket': {
1189
+ 'name': {
1191
1190
  type: 'text';
1192
1191
  isRequired: true;
1193
1192
  options: undefined;
1194
1193
  };
1195
1194
  };
1196
1195
  }
1197
- interface SaveSettingsEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayloadSchema> {
1196
+ interface UploadEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema> {
1198
1197
  }
1199
1198
  }
1200
1199
  namespace SpruceSchemas.Files.v2022_05_13 {
1201
- interface SaveSettingsEmitTargetAndPayload {
1200
+ interface UploadEmitTargetAndPayload {
1202
1201
  /** Source. */
1203
1202
  'source'?: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSource | undefined | null;
1204
- 'target': SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTarget;
1205
- 'payload': SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayload;
1203
+ 'target'?: SpruceSchemas.Files.v2022_05_13.UploadEmitTarget | undefined | null;
1204
+ 'payload': SpruceSchemas.Files.v2022_05_13.UploadEmitPayload;
1206
1205
  }
1207
- interface SaveSettingsEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
1208
- id: 'saveSettingsEmitTargetAndPayload';
1206
+ interface UploadEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
1207
+ id: 'uploadEmitTargetAndPayload';
1209
1208
  version: 'v2022_05_13';
1210
1209
  namespace: 'Files';
1211
1210
  name: '';
@@ -1221,9 +1220,8 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1221
1220
  /** . */
1222
1221
  'target': {
1223
1222
  type: 'schema';
1224
- isRequired: true;
1225
1223
  options: {
1226
- schema: SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetSchema;
1224
+ schema: SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema;
1227
1225
  };
1228
1226
  };
1229
1227
  /** . */
@@ -1231,33 +1229,12 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1231
1229
  type: 'schema';
1232
1230
  isRequired: true;
1233
1231
  options: {
1234
- schema: SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayloadSchema;
1232
+ schema: SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema;
1235
1233
  };
1236
1234
  };
1237
1235
  };
1238
1236
  }
1239
- interface SaveSettingsEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetAndPayloadSchema> {
1240
- }
1241
- }
1242
- namespace SpruceSchemas.Files.v2022_05_13 {
1243
- interface SaveSettingsResponsePayload {
1244
- 'wasSuccessful': boolean;
1245
- }
1246
- interface SaveSettingsResponsePayloadSchema extends SpruceSchema.Schema {
1247
- id: 'saveSettingsResponsePayload';
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 SaveSettingsResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsResponsePayloadSchema> {
1237
+ interface UploadEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetAndPayloadSchema> {
1261
1238
  }
1262
1239
  }
1263
1240
  namespace SpruceSchemas.Files.v2022_05_13 {
@@ -1302,6 +1279,29 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1302
1279
  interface UploadedFileEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadedFileSchema> {
1303
1280
  }
1304
1281
  }
1282
+ namespace SpruceSchemas.Files.v2022_05_13 {
1283
+ interface UploadResponsePayload {
1284
+ 'file': SpruceSchemas.Files.v2022_05_13.UploadedFile;
1285
+ }
1286
+ interface UploadResponsePayloadSchema extends SpruceSchema.Schema {
1287
+ id: 'uploadResponsePayload';
1288
+ version: 'v2022_05_13';
1289
+ namespace: 'Files';
1290
+ name: '';
1291
+ fields: {
1292
+ /** . */
1293
+ 'file': {
1294
+ type: 'schema';
1295
+ isRequired: true;
1296
+ options: {
1297
+ schema: SpruceSchemas.Files.v2022_05_13.UploadedFileSchema;
1298
+ };
1299
+ };
1300
+ };
1301
+ }
1302
+ interface UploadResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadResponsePayloadSchema> {
1303
+ }
1304
+ }
1305
1305
  namespace SpruceSchemas.Files.v2022_05_13 {
1306
1306
  interface SettingsTarget {
1307
1307
  'organizationId': string;
package/build/esm/.spruce/schemas/schemas.types.d.ts CHANGED
@@ -921,96 +921,112 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
921
921
  }
922
922
  }
923
923
  namespace SpruceSchemas.Files.v2022_05_13 {
924
- interface GetUploadEndpointResponsePayload {
925
- /** . The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client. */
926
- 'restEndpointUrl'?: string | undefined | null;
924
+ interface GetSettingsStatusEmitTarget {
925
+ 'organizationId': string;
927
926
  }
928
- interface GetUploadEndpointResponsePayloadSchema extends SpruceSchema.Schema {
929
- id: 'getUploadEndpointResponsePayload';
927
+ interface GetSettingsStatusEmitTargetSchema extends SpruceSchema.Schema {
928
+ id: 'getSettingsStatusEmitTarget';
930
929
  version: 'v2022_05_13';
931
930
  namespace: 'Files';
932
931
  name: '';
933
932
  fields: {
934
- /** . The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client. */
935
- 'restEndpointUrl': {
936
- type: 'text';
937
- hint: 'The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client.';
933
+ /** . */
934
+ 'organizationId': {
935
+ type: 'id';
936
+ isRequired: true;
938
937
  options: undefined;
939
938
  };
940
939
  };
941
940
  }
942
- interface GetUploadEndpointResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetUploadEndpointResponsePayloadSchema> {
941
+ interface GetSettingsStatusEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTargetSchema> {
943
942
  }
944
943
  }
945
944
  namespace SpruceSchemas.Files.v2022_05_13 {
946
- interface UploadEmitTarget {
947
- 'locationId'?: string | undefined | null;
948
- 'organizationId'?: string | undefined | null;
949
- 'filePersonId'?: string | undefined | null;
945
+ interface GetSettingsStatusResponsePayload {
946
+ 'didConfigureFileUploads': boolean;
950
947
  }
951
- interface UploadEmitTargetSchema extends SpruceSchema.Schema {
952
- id: 'uploadEmitTarget';
948
+ interface GetSettingsStatusResponsePayloadSchema extends SpruceSchema.Schema {
949
+ id: 'getSettingsStatusResponsePayload';
953
950
  version: 'v2022_05_13';
954
951
  namespace: 'Files';
955
952
  name: '';
956
953
  fields: {
957
954
  /** . */
958
- 'locationId': {
959
- type: 'id';
955
+ 'didConfigureFileUploads': {
956
+ type: 'boolean';
957
+ isRequired: true;
960
958
  options: undefined;
961
959
  };
960
+ };
961
+ }
962
+ interface GetSettingsStatusResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusResponsePayloadSchema> {
963
+ }
964
+ }
965
+ namespace SpruceSchemas.Files.v2022_05_13 {
966
+ interface SaveSettingsEmitTarget {
967
+ 'organizationId': string;
968
+ }
969
+ interface SaveSettingsEmitTargetSchema extends SpruceSchema.Schema {
970
+ id: 'saveSettingsEmitTarget';
971
+ version: 'v2022_05_13';
972
+ namespace: 'Files';
973
+ name: '';
974
+ fields: {
962
975
  /** . */
963
976
  'organizationId': {
964
977
  type: 'id';
965
- options: undefined;
966
- };
967
- /** . */
968
- 'filePersonId': {
969
- type: 'text';
978
+ isRequired: true;
970
979
  options: undefined;
971
980
  };
972
981
  };
973
982
  }
974
- interface UploadEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema> {
983
+ interface SaveSettingsEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetSchema> {
975
984
  }
976
985
  }
977
986
  namespace SpruceSchemas.Files.v2022_05_13 {
978
- interface UploadEmitPayload {
979
- 'base64Body': string;
980
- 'name': string;
987
+ interface SaveSettingsEmitPayload {
988
+ 'awsAccessKeyId': string;
989
+ 'awsSecretAccessKey': string;
990
+ 'awsS3Bucket': string;
981
991
  }
982
- interface UploadEmitPayloadSchema extends SpruceSchema.Schema {
983
- id: 'uploadEmitPayload';
992
+ interface SaveSettingsEmitPayloadSchema extends SpruceSchema.Schema {
993
+ id: 'saveSettingsEmitPayload';
984
994
  version: 'v2022_05_13';
985
995
  namespace: 'Files';
986
996
  name: '';
987
997
  fields: {
988
998
  /** . */
989
- 'base64Body': {
999
+ 'awsAccessKeyId': {
1000
+ type: 'id';
1001
+ isRequired: true;
1002
+ options: undefined;
1003
+ };
1004
+ /** . */
1005
+ 'awsSecretAccessKey': {
990
1006
  type: 'text';
991
1007
  isRequired: true;
992
1008
  options: undefined;
993
1009
  };
994
1010
  /** . */
995
- 'name': {
1011
+ 'awsS3Bucket': {
996
1012
  type: 'text';
997
1013
  isRequired: true;
998
1014
  options: undefined;
999
1015
  };
1000
1016
  };
1001
1017
  }
1002
- interface UploadEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema> {
1018
+ interface SaveSettingsEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayloadSchema> {
1003
1019
  }
1004
1020
  }
1005
1021
  namespace SpruceSchemas.Files.v2022_05_13 {
1006
- interface UploadEmitTargetAndPayload {
1022
+ interface SaveSettingsEmitTargetAndPayload {
1007
1023
  /** Source. */
1008
1024
  'source'?: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSource | undefined | null;
1009
- 'target'?: SpruceSchemas.Files.v2022_05_13.UploadEmitTarget | undefined | null;
1010
- 'payload': SpruceSchemas.Files.v2022_05_13.UploadEmitPayload;
1025
+ 'target': SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTarget;
1026
+ 'payload': SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayload;
1011
1027
  }
1012
- interface UploadEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
1013
- id: 'uploadEmitTargetAndPayload';
1028
+ interface SaveSettingsEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
1029
+ id: 'saveSettingsEmitTargetAndPayload';
1014
1030
  version: 'v2022_05_13';
1015
1031
  namespace: 'Files';
1016
1032
  name: '';
@@ -1025,87 +1041,66 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1025
1041
  };
1026
1042
  /** . */
1027
1043
  'target': {
1028
- type: 'schema';
1029
- options: {
1030
- schema: SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema;
1031
- };
1032
- };
1033
- /** . */
1034
- 'payload': {
1035
1044
  type: 'schema';
1036
1045
  isRequired: true;
1037
1046
  options: {
1038
- schema: SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema;
1047
+ schema: SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetSchema;
1039
1048
  };
1040
1049
  };
1041
- };
1042
- }
1043
- interface UploadEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetAndPayloadSchema> {
1044
- }
1045
- }
1046
- namespace SpruceSchemas.Files.v2022_05_13 {
1047
- interface UploadResponsePayload {
1048
- 'file': SpruceSchemas.Files.v2022_05_13.UploadedFile;
1049
- }
1050
- interface UploadResponsePayloadSchema extends SpruceSchema.Schema {
1051
- id: 'uploadResponsePayload';
1052
- version: 'v2022_05_13';
1053
- namespace: 'Files';
1054
- name: '';
1055
- fields: {
1056
1050
  /** . */
1057
- 'file': {
1051
+ 'payload': {
1058
1052
  type: 'schema';
1059
1053
  isRequired: true;
1060
1054
  options: {
1061
- schema: SpruceSchemas.Files.v2022_05_13.UploadedFileSchema;
1055
+ schema: SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayloadSchema;
1062
1056
  };
1063
1057
  };
1064
1058
  };
1065
1059
  }
1066
- interface UploadResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadResponsePayloadSchema> {
1060
+ interface SaveSettingsEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetAndPayloadSchema> {
1067
1061
  }
1068
1062
  }
1069
1063
  namespace SpruceSchemas.Files.v2022_05_13 {
1070
- interface GetSettingsStatusEmitTarget {
1071
- 'organizationId': string;
1064
+ interface SaveSettingsResponsePayload {
1065
+ 'wasSuccessful': boolean;
1072
1066
  }
1073
- interface GetSettingsStatusEmitTargetSchema extends SpruceSchema.Schema {
1074
- id: 'getSettingsStatusEmitTarget';
1067
+ interface SaveSettingsResponsePayloadSchema extends SpruceSchema.Schema {
1068
+ id: 'saveSettingsResponsePayload';
1075
1069
  version: 'v2022_05_13';
1076
1070
  namespace: 'Files';
1077
1071
  name: '';
1078
1072
  fields: {
1079
1073
  /** . */
1080
- 'organizationId': {
1081
- type: 'id';
1074
+ 'wasSuccessful': {
1075
+ type: 'boolean';
1082
1076
  isRequired: true;
1083
1077
  options: undefined;
1084
1078
  };
1085
1079
  };
1086
1080
  }
1087
- interface GetSettingsStatusEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTargetSchema> {
1081
+ interface SaveSettingsResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsResponsePayloadSchema> {
1088
1082
  }
1089
1083
  }
1090
1084
  namespace SpruceSchemas.Files.v2022_05_13 {
1091
- interface GetSettingsStatusResponsePayload {
1092
- 'didConfigureFileUploads': boolean;
1085
+ interface GetUploadEndpointResponsePayload {
1086
+ /** . The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client. */
1087
+ 'restEndpointUrl'?: string | undefined | null;
1093
1088
  }
1094
- interface GetSettingsStatusResponsePayloadSchema extends SpruceSchema.Schema {
1095
- id: 'getSettingsStatusResponsePayload';
1089
+ interface GetUploadEndpointResponsePayloadSchema extends SpruceSchema.Schema {
1090
+ id: 'getUploadEndpointResponsePayload';
1096
1091
  version: 'v2022_05_13';
1097
1092
  namespace: 'Files';
1098
1093
  name: '';
1099
1094
  fields: {
1100
- /** . */
1101
- 'didConfigureFileUploads': {
1102
- type: 'boolean';
1103
- isRequired: true;
1095
+ /** . The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client. */
1096
+ 'restEndpointUrl': {
1097
+ type: 'text';
1098
+ hint: 'The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client.';
1104
1099
  options: undefined;
1105
1100
  };
1106
1101
  };
1107
1102
  }
1108
- interface GetSettingsStatusResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusResponsePayloadSchema> {
1103
+ interface GetUploadEndpointResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetUploadEndpointResponsePayloadSchema> {
1109
1104
  }
1110
1105
  }
1111
1106
  namespace SpruceSchemas.Files.v2022_05_13 {
@@ -1142,70 +1137,74 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1142
1137
  }
1143
1138
  }
1144
1139
  namespace SpruceSchemas.Files.v2022_05_13 {
1145
- interface SaveSettingsEmitTarget {
1146
- 'organizationId': string;
1140
+ interface UploadEmitTarget {
1141
+ 'locationId'?: string | undefined | null;
1142
+ 'organizationId'?: string | undefined | null;
1143
+ 'filePersonId'?: string | undefined | null;
1147
1144
  }
1148
- interface SaveSettingsEmitTargetSchema extends SpruceSchema.Schema {
1149
- id: 'saveSettingsEmitTarget';
1145
+ interface UploadEmitTargetSchema extends SpruceSchema.Schema {
1146
+ id: 'uploadEmitTarget';
1150
1147
  version: 'v2022_05_13';
1151
1148
  namespace: 'Files';
1152
1149
  name: '';
1153
1150
  fields: {
1151
+ /** . */
1152
+ 'locationId': {
1153
+ type: 'id';
1154
+ options: undefined;
1155
+ };
1154
1156
  /** . */
1155
1157
  'organizationId': {
1156
1158
  type: 'id';
1157
- isRequired: true;
1159
+ options: undefined;
1160
+ };
1161
+ /** . */
1162
+ 'filePersonId': {
1163
+ type: 'text';
1158
1164
  options: undefined;
1159
1165
  };
1160
1166
  };
1161
1167
  }
1162
- interface SaveSettingsEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetSchema> {
1168
+ interface UploadEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema> {
1163
1169
  }
1164
1170
  }
1165
1171
  namespace SpruceSchemas.Files.v2022_05_13 {
1166
- interface SaveSettingsEmitPayload {
1167
- 'awsAccessKeyId': string;
1168
- 'awsSecretAccessKey': string;
1169
- 'awsS3Bucket': string;
1172
+ interface UploadEmitPayload {
1173
+ 'base64Body': string;
1174
+ 'name': string;
1170
1175
  }
1171
- interface SaveSettingsEmitPayloadSchema extends SpruceSchema.Schema {
1172
- id: 'saveSettingsEmitPayload';
1176
+ interface UploadEmitPayloadSchema extends SpruceSchema.Schema {
1177
+ id: 'uploadEmitPayload';
1173
1178
  version: 'v2022_05_13';
1174
1179
  namespace: 'Files';
1175
1180
  name: '';
1176
1181
  fields: {
1177
1182
  /** . */
1178
- 'awsAccessKeyId': {
1179
- type: 'id';
1180
- isRequired: true;
1181
- options: undefined;
1182
- };
1183
- /** . */
1184
- 'awsSecretAccessKey': {
1183
+ 'base64Body': {
1185
1184
  type: 'text';
1186
1185
  isRequired: true;
1187
1186
  options: undefined;
1188
1187
  };
1189
1188
  /** . */
1190
- 'awsS3Bucket': {
1189
+ 'name': {
1191
1190
  type: 'text';
1192
1191
  isRequired: true;
1193
1192
  options: undefined;
1194
1193
  };
1195
1194
  };
1196
1195
  }
1197
- interface SaveSettingsEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayloadSchema> {
1196
+ interface UploadEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema> {
1198
1197
  }
1199
1198
  }
1200
1199
  namespace SpruceSchemas.Files.v2022_05_13 {
1201
- interface SaveSettingsEmitTargetAndPayload {
1200
+ interface UploadEmitTargetAndPayload {
1202
1201
  /** Source. */
1203
1202
  'source'?: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSource | undefined | null;
1204
- 'target': SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTarget;
1205
- 'payload': SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayload;
1203
+ 'target'?: SpruceSchemas.Files.v2022_05_13.UploadEmitTarget | undefined | null;
1204
+ 'payload': SpruceSchemas.Files.v2022_05_13.UploadEmitPayload;
1206
1205
  }
1207
- interface SaveSettingsEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
1208
- id: 'saveSettingsEmitTargetAndPayload';
1206
+ interface UploadEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
1207
+ id: 'uploadEmitTargetAndPayload';
1209
1208
  version: 'v2022_05_13';
1210
1209
  namespace: 'Files';
1211
1210
  name: '';
@@ -1221,9 +1220,8 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1221
1220
  /** . */
1222
1221
  'target': {
1223
1222
  type: 'schema';
1224
- isRequired: true;
1225
1223
  options: {
1226
- schema: SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetSchema;
1224
+ schema: SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema;
1227
1225
  };
1228
1226
  };
1229
1227
  /** . */
@@ -1231,33 +1229,12 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1231
1229
  type: 'schema';
1232
1230
  isRequired: true;
1233
1231
  options: {
1234
- schema: SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayloadSchema;
1232
+ schema: SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema;
1235
1233
  };
1236
1234
  };
1237
1235
  };
1238
1236
  }
1239
- interface SaveSettingsEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetAndPayloadSchema> {
1240
- }
1241
- }
1242
- namespace SpruceSchemas.Files.v2022_05_13 {
1243
- interface SaveSettingsResponsePayload {
1244
- 'wasSuccessful': boolean;
1245
- }
1246
- interface SaveSettingsResponsePayloadSchema extends SpruceSchema.Schema {
1247
- id: 'saveSettingsResponsePayload';
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 SaveSettingsResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsResponsePayloadSchema> {
1237
+ interface UploadEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetAndPayloadSchema> {
1261
1238
  }
1262
1239
  }
1263
1240
  namespace SpruceSchemas.Files.v2022_05_13 {
@@ -1302,6 +1279,29 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1302
1279
  interface UploadedFileEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadedFileSchema> {
1303
1280
  }
1304
1281
  }
1282
+ namespace SpruceSchemas.Files.v2022_05_13 {
1283
+ interface UploadResponsePayload {
1284
+ 'file': SpruceSchemas.Files.v2022_05_13.UploadedFile;
1285
+ }
1286
+ interface UploadResponsePayloadSchema extends SpruceSchema.Schema {
1287
+ id: 'uploadResponsePayload';
1288
+ version: 'v2022_05_13';
1289
+ namespace: 'Files';
1290
+ name: '';
1291
+ fields: {
1292
+ /** . */
1293
+ 'file': {
1294
+ type: 'schema';
1295
+ isRequired: true;
1296
+ options: {
1297
+ schema: SpruceSchemas.Files.v2022_05_13.UploadedFileSchema;
1298
+ };
1299
+ };
1300
+ };
1301
+ }
1302
+ interface UploadResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadResponsePayloadSchema> {
1303
+ }
1304
+ }
1305
1305
  namespace SpruceSchemas.Files.v2022_05_13 {
1306
1306
  interface SettingsTarget {
1307
1307
  'organizationId': string;
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": "18.1.10",
4
+ "version": "18.1.11",
5
5
  "skill": {
6
6
  "namespace": "files"
7
7
  },