@sprucelabs/spruce-file-utils 18.6.15 → 18.6.17

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