@sprucelabs/spruce-file-utils 18.6.1 → 18.6.2

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 +103 -103
  2. package/build/esm/.spruce/schemas/schemas.types.d.ts +103 -103
  3. package/package.json +1 -1
package/build/.spruce/schemas/schemas.types.d.ts CHANGED
@@ -921,96 +921,70 @@ 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 SaveSettingsEmitTarget {
925
+ 'organizationId': string;
927
926
  }
928
- interface GetUploadEndpointResponsePayloadSchema extends SpruceSchema.Schema {
929
- id: 'getUploadEndpointResponsePayload';
927
+ interface SaveSettingsEmitTargetSchema extends SpruceSchema.Schema {
928
+ id: 'saveSettingsEmitTarget';
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 SaveSettingsEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetSchema> {
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 SaveSettingsEmitPayload {
946
+ 'awsAccessKeyId': string;
947
+ 'awsSecretAccessKey': string;
948
+ 'awsS3Bucket': string;
950
949
  }
951
- interface UploadEmitTargetSchema extends SpruceSchema.Schema {
952
- id: 'uploadEmitTarget';
950
+ interface SaveSettingsEmitPayloadSchema extends SpruceSchema.Schema {
951
+ id: 'saveSettingsEmitPayload';
953
952
  version: 'v2022_05_13';
954
953
  namespace: 'Files';
955
954
  name: '';
956
955
  fields: {
957
956
  /** . */
958
- 'locationId': {
959
- type: 'id';
960
- options: undefined;
961
- };
962
- /** . */
963
- 'organizationId': {
957
+ 'awsAccessKeyId': {
964
958
  type: 'id';
959
+ isRequired: true;
965
960
  options: undefined;
966
961
  };
967
962
  /** . */
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': {
963
+ 'awsSecretAccessKey': {
990
964
  type: 'text';
991
965
  isRequired: true;
992
966
  options: undefined;
993
967
  };
994
968
  /** . */
995
- 'name': {
969
+ 'awsS3Bucket': {
996
970
  type: 'text';
997
971
  isRequired: true;
998
972
  options: undefined;
999
973
  };
1000
974
  };
1001
975
  }
1002
- interface UploadEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema> {
976
+ interface SaveSettingsEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayloadSchema> {
1003
977
  }
1004
978
  }
1005
979
  namespace SpruceSchemas.Files.v2022_05_13 {
1006
- interface UploadEmitTargetAndPayload {
980
+ interface SaveSettingsEmitTargetAndPayload {
1007
981
  /** Source. */
1008
982
  '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;
983
+ 'target': SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTarget;
984
+ 'payload': SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayload;
1011
985
  }
1012
- interface UploadEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
1013
- id: 'uploadEmitTargetAndPayload';
986
+ interface SaveSettingsEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
987
+ id: 'saveSettingsEmitTargetAndPayload';
1014
988
  version: 'v2022_05_13';
1015
989
  namespace: 'Files';
1016
990
  name: '';
@@ -1026,8 +1000,9 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1026
1000
  /** . */
1027
1001
  'target': {
1028
1002
  type: 'schema';
1003
+ isRequired: true;
1029
1004
  options: {
1030
- schema: SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema;
1005
+ schema: SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetSchema;
1031
1006
  };
1032
1007
  };
1033
1008
  /** . */
@@ -1035,35 +1010,33 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1035
1010
  type: 'schema';
1036
1011
  isRequired: true;
1037
1012
  options: {
1038
- schema: SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema;
1013
+ schema: SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayloadSchema;
1039
1014
  };
1040
1015
  };
1041
1016
  };
1042
1017
  }
1043
- interface UploadEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetAndPayloadSchema> {
1018
+ interface SaveSettingsEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetAndPayloadSchema> {
1044
1019
  }
1045
1020
  }
1046
1021
  namespace SpruceSchemas.Files.v2022_05_13 {
1047
- interface UploadResponsePayload {
1048
- 'file': SpruceSchemas.Files.v2022_05_13.UploadedFile;
1022
+ interface SaveSettingsResponsePayload {
1023
+ 'wasSuccessful': boolean;
1049
1024
  }
1050
- interface UploadResponsePayloadSchema extends SpruceSchema.Schema {
1051
- id: 'uploadResponsePayload';
1025
+ interface SaveSettingsResponsePayloadSchema extends SpruceSchema.Schema {
1026
+ id: 'saveSettingsResponsePayload';
1052
1027
  version: 'v2022_05_13';
1053
1028
  namespace: 'Files';
1054
1029
  name: '';
1055
1030
  fields: {
1056
1031
  /** . */
1057
- 'file': {
1058
- type: 'schema';
1032
+ 'wasSuccessful': {
1033
+ type: 'boolean';
1059
1034
  isRequired: true;
1060
- options: {
1061
- schema: SpruceSchemas.Files.v2022_05_13.UploadedFileSchema;
1062
- };
1035
+ options: undefined;
1063
1036
  };
1064
1037
  };
1065
1038
  }
1066
- interface UploadResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadResponsePayloadSchema> {
1039
+ interface SaveSettingsResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsResponsePayloadSchema> {
1067
1040
  }
1068
1041
  }
1069
1042
  namespace SpruceSchemas.Files.v2022_05_13 {
@@ -1142,70 +1115,74 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1142
1115
  }
1143
1116
  }
1144
1117
  namespace SpruceSchemas.Files.v2022_05_13 {
1145
- interface SaveSettingsEmitTarget {
1146
- 'organizationId': string;
1118
+ interface UploadEmitTarget {
1119
+ 'locationId'?: string | undefined | null;
1120
+ 'organizationId'?: string | undefined | null;
1121
+ 'filePersonId'?: string | undefined | null;
1147
1122
  }
1148
- interface SaveSettingsEmitTargetSchema extends SpruceSchema.Schema {
1149
- id: 'saveSettingsEmitTarget';
1123
+ interface UploadEmitTargetSchema extends SpruceSchema.Schema {
1124
+ id: 'uploadEmitTarget';
1150
1125
  version: 'v2022_05_13';
1151
1126
  namespace: 'Files';
1152
1127
  name: '';
1153
1128
  fields: {
1129
+ /** . */
1130
+ 'locationId': {
1131
+ type: 'id';
1132
+ options: undefined;
1133
+ };
1154
1134
  /** . */
1155
1135
  'organizationId': {
1156
1136
  type: 'id';
1157
- isRequired: true;
1137
+ options: undefined;
1138
+ };
1139
+ /** . */
1140
+ 'filePersonId': {
1141
+ type: 'text';
1158
1142
  options: undefined;
1159
1143
  };
1160
1144
  };
1161
1145
  }
1162
- interface SaveSettingsEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetSchema> {
1146
+ interface UploadEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema> {
1163
1147
  }
1164
1148
  }
1165
1149
  namespace SpruceSchemas.Files.v2022_05_13 {
1166
- interface SaveSettingsEmitPayload {
1167
- 'awsAccessKeyId': string;
1168
- 'awsSecretAccessKey': string;
1169
- 'awsS3Bucket': string;
1150
+ interface UploadEmitPayload {
1151
+ 'base64Body': string;
1152
+ 'name': string;
1170
1153
  }
1171
- interface SaveSettingsEmitPayloadSchema extends SpruceSchema.Schema {
1172
- id: 'saveSettingsEmitPayload';
1154
+ interface UploadEmitPayloadSchema extends SpruceSchema.Schema {
1155
+ id: 'uploadEmitPayload';
1173
1156
  version: 'v2022_05_13';
1174
1157
  namespace: 'Files';
1175
1158
  name: '';
1176
1159
  fields: {
1177
1160
  /** . */
1178
- 'awsAccessKeyId': {
1179
- type: 'id';
1180
- isRequired: true;
1181
- options: undefined;
1182
- };
1183
- /** . */
1184
- 'awsSecretAccessKey': {
1161
+ 'base64Body': {
1185
1162
  type: 'text';
1186
1163
  isRequired: true;
1187
1164
  options: undefined;
1188
1165
  };
1189
1166
  /** . */
1190
- 'awsS3Bucket': {
1167
+ 'name': {
1191
1168
  type: 'text';
1192
1169
  isRequired: true;
1193
1170
  options: undefined;
1194
1171
  };
1195
1172
  };
1196
1173
  }
1197
- interface SaveSettingsEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayloadSchema> {
1174
+ interface UploadEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema> {
1198
1175
  }
1199
1176
  }
1200
1177
  namespace SpruceSchemas.Files.v2022_05_13 {
1201
- interface SaveSettingsEmitTargetAndPayload {
1178
+ interface UploadEmitTargetAndPayload {
1202
1179
  /** Source. */
1203
1180
  '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;
1181
+ 'target'?: SpruceSchemas.Files.v2022_05_13.UploadEmitTarget | undefined | null;
1182
+ 'payload': SpruceSchemas.Files.v2022_05_13.UploadEmitPayload;
1206
1183
  }
1207
- interface SaveSettingsEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
1208
- id: 'saveSettingsEmitTargetAndPayload';
1184
+ interface UploadEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
1185
+ id: 'uploadEmitTargetAndPayload';
1209
1186
  version: 'v2022_05_13';
1210
1187
  namespace: 'Files';
1211
1188
  name: '';
@@ -1221,9 +1198,8 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1221
1198
  /** . */
1222
1199
  'target': {
1223
1200
  type: 'schema';
1224
- isRequired: true;
1225
1201
  options: {
1226
- schema: SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetSchema;
1202
+ schema: SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema;
1227
1203
  };
1228
1204
  };
1229
1205
  /** . */
@@ -1231,33 +1207,34 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1231
1207
  type: 'schema';
1232
1208
  isRequired: true;
1233
1209
  options: {
1234
- schema: SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayloadSchema;
1210
+ schema: SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema;
1235
1211
  };
1236
1212
  };
1237
1213
  };
1238
1214
  }
1239
- interface SaveSettingsEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetAndPayloadSchema> {
1215
+ interface UploadEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetAndPayloadSchema> {
1240
1216
  }
1241
1217
  }
1242
1218
  namespace SpruceSchemas.Files.v2022_05_13 {
1243
- interface SaveSettingsResponsePayload {
1244
- 'wasSuccessful': boolean;
1219
+ interface GetUploadEndpointResponsePayload {
1220
+ /** . The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client. */
1221
+ 'restEndpointUrl'?: string | undefined | null;
1245
1222
  }
1246
- interface SaveSettingsResponsePayloadSchema extends SpruceSchema.Schema {
1247
- id: 'saveSettingsResponsePayload';
1223
+ interface GetUploadEndpointResponsePayloadSchema extends SpruceSchema.Schema {
1224
+ id: 'getUploadEndpointResponsePayload';
1248
1225
  version: 'v2022_05_13';
1249
1226
  namespace: 'Files';
1250
1227
  name: '';
1251
1228
  fields: {
1252
- /** . */
1253
- 'wasSuccessful': {
1254
- type: 'boolean';
1255
- isRequired: true;
1229
+ /** . The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client. */
1230
+ 'restEndpointUrl': {
1231
+ type: 'text';
1232
+ hint: 'The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client.';
1256
1233
  options: undefined;
1257
1234
  };
1258
1235
  };
1259
1236
  }
1260
- interface SaveSettingsResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsResponsePayloadSchema> {
1237
+ interface GetUploadEndpointResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetUploadEndpointResponsePayloadSchema> {
1261
1238
  }
1262
1239
  }
1263
1240
  namespace SpruceSchemas.Files.v2022_05_13 {
@@ -1302,6 +1279,29 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1302
1279
  interface UploadedFileEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadedFileSchema> {
1303
1280
  }
1304
1281
  }
1282
+ namespace SpruceSchemas.Files.v2022_05_13 {
1283
+ interface UploadResponsePayload {
1284
+ 'file': SpruceSchemas.Files.v2022_05_13.UploadedFile;
1285
+ }
1286
+ interface UploadResponsePayloadSchema extends SpruceSchema.Schema {
1287
+ id: 'uploadResponsePayload';
1288
+ version: 'v2022_05_13';
1289
+ namespace: 'Files';
1290
+ name: '';
1291
+ fields: {
1292
+ /** . */
1293
+ 'file': {
1294
+ type: 'schema';
1295
+ isRequired: true;
1296
+ options: {
1297
+ schema: SpruceSchemas.Files.v2022_05_13.UploadedFileSchema;
1298
+ };
1299
+ };
1300
+ };
1301
+ }
1302
+ interface UploadResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadResponsePayloadSchema> {
1303
+ }
1304
+ }
1305
1305
  namespace SpruceSchemas.Files.v2022_05_13 {
1306
1306
  interface SettingsTarget {
1307
1307
  'organizationId': string;
package/build/esm/.spruce/schemas/schemas.types.d.ts CHANGED
@@ -921,96 +921,70 @@ 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 SaveSettingsEmitTarget {
925
+ 'organizationId': string;
927
926
  }
928
- interface GetUploadEndpointResponsePayloadSchema extends SpruceSchema.Schema {
929
- id: 'getUploadEndpointResponsePayload';
927
+ interface SaveSettingsEmitTargetSchema extends SpruceSchema.Schema {
928
+ id: 'saveSettingsEmitTarget';
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 SaveSettingsEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetSchema> {
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 SaveSettingsEmitPayload {
946
+ 'awsAccessKeyId': string;
947
+ 'awsSecretAccessKey': string;
948
+ 'awsS3Bucket': string;
950
949
  }
951
- interface UploadEmitTargetSchema extends SpruceSchema.Schema {
952
- id: 'uploadEmitTarget';
950
+ interface SaveSettingsEmitPayloadSchema extends SpruceSchema.Schema {
951
+ id: 'saveSettingsEmitPayload';
953
952
  version: 'v2022_05_13';
954
953
  namespace: 'Files';
955
954
  name: '';
956
955
  fields: {
957
956
  /** . */
958
- 'locationId': {
959
- type: 'id';
960
- options: undefined;
961
- };
962
- /** . */
963
- 'organizationId': {
957
+ 'awsAccessKeyId': {
964
958
  type: 'id';
959
+ isRequired: true;
965
960
  options: undefined;
966
961
  };
967
962
  /** . */
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': {
963
+ 'awsSecretAccessKey': {
990
964
  type: 'text';
991
965
  isRequired: true;
992
966
  options: undefined;
993
967
  };
994
968
  /** . */
995
- 'name': {
969
+ 'awsS3Bucket': {
996
970
  type: 'text';
997
971
  isRequired: true;
998
972
  options: undefined;
999
973
  };
1000
974
  };
1001
975
  }
1002
- interface UploadEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema> {
976
+ interface SaveSettingsEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayloadSchema> {
1003
977
  }
1004
978
  }
1005
979
  namespace SpruceSchemas.Files.v2022_05_13 {
1006
- interface UploadEmitTargetAndPayload {
980
+ interface SaveSettingsEmitTargetAndPayload {
1007
981
  /** Source. */
1008
982
  '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;
983
+ 'target': SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTarget;
984
+ 'payload': SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayload;
1011
985
  }
1012
- interface UploadEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
1013
- id: 'uploadEmitTargetAndPayload';
986
+ interface SaveSettingsEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
987
+ id: 'saveSettingsEmitTargetAndPayload';
1014
988
  version: 'v2022_05_13';
1015
989
  namespace: 'Files';
1016
990
  name: '';
@@ -1026,8 +1000,9 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1026
1000
  /** . */
1027
1001
  'target': {
1028
1002
  type: 'schema';
1003
+ isRequired: true;
1029
1004
  options: {
1030
- schema: SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema;
1005
+ schema: SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetSchema;
1031
1006
  };
1032
1007
  };
1033
1008
  /** . */
@@ -1035,35 +1010,33 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1035
1010
  type: 'schema';
1036
1011
  isRequired: true;
1037
1012
  options: {
1038
- schema: SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema;
1013
+ schema: SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayloadSchema;
1039
1014
  };
1040
1015
  };
1041
1016
  };
1042
1017
  }
1043
- interface UploadEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetAndPayloadSchema> {
1018
+ interface SaveSettingsEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetAndPayloadSchema> {
1044
1019
  }
1045
1020
  }
1046
1021
  namespace SpruceSchemas.Files.v2022_05_13 {
1047
- interface UploadResponsePayload {
1048
- 'file': SpruceSchemas.Files.v2022_05_13.UploadedFile;
1022
+ interface SaveSettingsResponsePayload {
1023
+ 'wasSuccessful': boolean;
1049
1024
  }
1050
- interface UploadResponsePayloadSchema extends SpruceSchema.Schema {
1051
- id: 'uploadResponsePayload';
1025
+ interface SaveSettingsResponsePayloadSchema extends SpruceSchema.Schema {
1026
+ id: 'saveSettingsResponsePayload';
1052
1027
  version: 'v2022_05_13';
1053
1028
  namespace: 'Files';
1054
1029
  name: '';
1055
1030
  fields: {
1056
1031
  /** . */
1057
- 'file': {
1058
- type: 'schema';
1032
+ 'wasSuccessful': {
1033
+ type: 'boolean';
1059
1034
  isRequired: true;
1060
- options: {
1061
- schema: SpruceSchemas.Files.v2022_05_13.UploadedFileSchema;
1062
- };
1035
+ options: undefined;
1063
1036
  };
1064
1037
  };
1065
1038
  }
1066
- interface UploadResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadResponsePayloadSchema> {
1039
+ interface SaveSettingsResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsResponsePayloadSchema> {
1067
1040
  }
1068
1041
  }
1069
1042
  namespace SpruceSchemas.Files.v2022_05_13 {
@@ -1142,70 +1115,74 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1142
1115
  }
1143
1116
  }
1144
1117
  namespace SpruceSchemas.Files.v2022_05_13 {
1145
- interface SaveSettingsEmitTarget {
1146
- 'organizationId': string;
1118
+ interface UploadEmitTarget {
1119
+ 'locationId'?: string | undefined | null;
1120
+ 'organizationId'?: string | undefined | null;
1121
+ 'filePersonId'?: string | undefined | null;
1147
1122
  }
1148
- interface SaveSettingsEmitTargetSchema extends SpruceSchema.Schema {
1149
- id: 'saveSettingsEmitTarget';
1123
+ interface UploadEmitTargetSchema extends SpruceSchema.Schema {
1124
+ id: 'uploadEmitTarget';
1150
1125
  version: 'v2022_05_13';
1151
1126
  namespace: 'Files';
1152
1127
  name: '';
1153
1128
  fields: {
1129
+ /** . */
1130
+ 'locationId': {
1131
+ type: 'id';
1132
+ options: undefined;
1133
+ };
1154
1134
  /** . */
1155
1135
  'organizationId': {
1156
1136
  type: 'id';
1157
- isRequired: true;
1137
+ options: undefined;
1138
+ };
1139
+ /** . */
1140
+ 'filePersonId': {
1141
+ type: 'text';
1158
1142
  options: undefined;
1159
1143
  };
1160
1144
  };
1161
1145
  }
1162
- interface SaveSettingsEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetSchema> {
1146
+ interface UploadEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema> {
1163
1147
  }
1164
1148
  }
1165
1149
  namespace SpruceSchemas.Files.v2022_05_13 {
1166
- interface SaveSettingsEmitPayload {
1167
- 'awsAccessKeyId': string;
1168
- 'awsSecretAccessKey': string;
1169
- 'awsS3Bucket': string;
1150
+ interface UploadEmitPayload {
1151
+ 'base64Body': string;
1152
+ 'name': string;
1170
1153
  }
1171
- interface SaveSettingsEmitPayloadSchema extends SpruceSchema.Schema {
1172
- id: 'saveSettingsEmitPayload';
1154
+ interface UploadEmitPayloadSchema extends SpruceSchema.Schema {
1155
+ id: 'uploadEmitPayload';
1173
1156
  version: 'v2022_05_13';
1174
1157
  namespace: 'Files';
1175
1158
  name: '';
1176
1159
  fields: {
1177
1160
  /** . */
1178
- 'awsAccessKeyId': {
1179
- type: 'id';
1180
- isRequired: true;
1181
- options: undefined;
1182
- };
1183
- /** . */
1184
- 'awsSecretAccessKey': {
1161
+ 'base64Body': {
1185
1162
  type: 'text';
1186
1163
  isRequired: true;
1187
1164
  options: undefined;
1188
1165
  };
1189
1166
  /** . */
1190
- 'awsS3Bucket': {
1167
+ 'name': {
1191
1168
  type: 'text';
1192
1169
  isRequired: true;
1193
1170
  options: undefined;
1194
1171
  };
1195
1172
  };
1196
1173
  }
1197
- interface SaveSettingsEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayloadSchema> {
1174
+ interface UploadEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema> {
1198
1175
  }
1199
1176
  }
1200
1177
  namespace SpruceSchemas.Files.v2022_05_13 {
1201
- interface SaveSettingsEmitTargetAndPayload {
1178
+ interface UploadEmitTargetAndPayload {
1202
1179
  /** Source. */
1203
1180
  '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;
1181
+ 'target'?: SpruceSchemas.Files.v2022_05_13.UploadEmitTarget | undefined | null;
1182
+ 'payload': SpruceSchemas.Files.v2022_05_13.UploadEmitPayload;
1206
1183
  }
1207
- interface SaveSettingsEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
1208
- id: 'saveSettingsEmitTargetAndPayload';
1184
+ interface UploadEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
1185
+ id: 'uploadEmitTargetAndPayload';
1209
1186
  version: 'v2022_05_13';
1210
1187
  namespace: 'Files';
1211
1188
  name: '';
@@ -1221,9 +1198,8 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1221
1198
  /** . */
1222
1199
  'target': {
1223
1200
  type: 'schema';
1224
- isRequired: true;
1225
1201
  options: {
1226
- schema: SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetSchema;
1202
+ schema: SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema;
1227
1203
  };
1228
1204
  };
1229
1205
  /** . */
@@ -1231,33 +1207,34 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1231
1207
  type: 'schema';
1232
1208
  isRequired: true;
1233
1209
  options: {
1234
- schema: SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayloadSchema;
1210
+ schema: SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema;
1235
1211
  };
1236
1212
  };
1237
1213
  };
1238
1214
  }
1239
- interface SaveSettingsEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetAndPayloadSchema> {
1215
+ interface UploadEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetAndPayloadSchema> {
1240
1216
  }
1241
1217
  }
1242
1218
  namespace SpruceSchemas.Files.v2022_05_13 {
1243
- interface SaveSettingsResponsePayload {
1244
- 'wasSuccessful': boolean;
1219
+ interface GetUploadEndpointResponsePayload {
1220
+ /** . The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client. */
1221
+ 'restEndpointUrl'?: string | undefined | null;
1245
1222
  }
1246
- interface SaveSettingsResponsePayloadSchema extends SpruceSchema.Schema {
1247
- id: 'saveSettingsResponsePayload';
1223
+ interface GetUploadEndpointResponsePayloadSchema extends SpruceSchema.Schema {
1224
+ id: 'getUploadEndpointResponsePayload';
1248
1225
  version: 'v2022_05_13';
1249
1226
  namespace: 'Files';
1250
1227
  name: '';
1251
1228
  fields: {
1252
- /** . */
1253
- 'wasSuccessful': {
1254
- type: 'boolean';
1255
- isRequired: true;
1229
+ /** . The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client. */
1230
+ 'restEndpointUrl': {
1231
+ type: 'text';
1232
+ hint: 'The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client.';
1256
1233
  options: undefined;
1257
1234
  };
1258
1235
  };
1259
1236
  }
1260
- interface SaveSettingsResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsResponsePayloadSchema> {
1237
+ interface GetUploadEndpointResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetUploadEndpointResponsePayloadSchema> {
1261
1238
  }
1262
1239
  }
1263
1240
  namespace SpruceSchemas.Files.v2022_05_13 {
@@ -1302,6 +1279,29 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1302
1279
  interface UploadedFileEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadedFileSchema> {
1303
1280
  }
1304
1281
  }
1282
+ namespace SpruceSchemas.Files.v2022_05_13 {
1283
+ interface UploadResponsePayload {
1284
+ 'file': SpruceSchemas.Files.v2022_05_13.UploadedFile;
1285
+ }
1286
+ interface UploadResponsePayloadSchema extends SpruceSchema.Schema {
1287
+ id: 'uploadResponsePayload';
1288
+ version: 'v2022_05_13';
1289
+ namespace: 'Files';
1290
+ name: '';
1291
+ fields: {
1292
+ /** . */
1293
+ 'file': {
1294
+ type: 'schema';
1295
+ isRequired: true;
1296
+ options: {
1297
+ schema: SpruceSchemas.Files.v2022_05_13.UploadedFileSchema;
1298
+ };
1299
+ };
1300
+ };
1301
+ }
1302
+ interface UploadResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadResponsePayloadSchema> {
1303
+ }
1304
+ }
1305
1305
  namespace SpruceSchemas.Files.v2022_05_13 {
1306
1306
  interface SettingsTarget {
1307
1307
  'organizationId': string;
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.1",
4
+ "version": "18.6.2",
5
5
  "skill": {
6
6
  "namespace": "files"
7
7
  },