@sprucelabs/spruce-file-utils 18.6.3 → 18.6.4

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 +129 -129
  2. package/build/esm/.spruce/schemas/schemas.types.d.ts +129 -129
  3. package/package.json +1 -1
package/build/.spruce/schemas/schemas.types.d.ts CHANGED
@@ -942,175 +942,150 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
942
942
  }
943
943
  }
944
944
  namespace SpruceSchemas.Files.v2022_05_13 {
945
- interface GetSettingsStatusResponsePayload {
946
- 'didConfigureFileUploads': boolean;
945
+ interface GetSettingsStatusEmitTargetAndPayload {
946
+ /** Source. */
947
+ 'source'?: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSource | undefined | null;
948
+ 'target': SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTarget;
947
949
  }
948
- interface GetSettingsStatusResponsePayloadSchema extends SpruceSchema.Schema {
949
- id: 'getSettingsStatusResponsePayload';
950
+ interface GetSettingsStatusEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
951
+ id: 'getSettingsStatusEmitTargetAndPayload';
950
952
  version: 'v2022_05_13';
951
953
  namespace: 'Files';
952
954
  name: '';
953
955
  fields: {
956
+ /** Source. */
957
+ 'source': {
958
+ label: 'Source';
959
+ type: 'schema';
960
+ options: {
961
+ schema: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSourceSchema;
962
+ };
963
+ };
954
964
  /** . */
955
- 'didConfigureFileUploads': {
956
- type: 'boolean';
965
+ 'target': {
966
+ type: 'schema';
957
967
  isRequired: true;
958
- options: undefined;
968
+ options: {
969
+ schema: SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTargetSchema;
970
+ };
959
971
  };
960
972
  };
961
973
  }
962
- interface GetSettingsStatusResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusResponsePayloadSchema> {
974
+ interface GetSettingsStatusEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTargetAndPayloadSchema> {
963
975
  }
964
976
  }
965
977
  namespace SpruceSchemas.Files.v2022_05_13 {
966
- interface SaveSettingsEmitTarget {
967
- 'organizationId': string;
978
+ interface GetSettingsStatusResponsePayload {
979
+ 'didConfigureFileUploads': boolean;
968
980
  }
969
- interface SaveSettingsEmitTargetSchema extends SpruceSchema.Schema {
970
- id: 'saveSettingsEmitTarget';
981
+ interface GetSettingsStatusResponsePayloadSchema extends SpruceSchema.Schema {
982
+ id: 'getSettingsStatusResponsePayload';
971
983
  version: 'v2022_05_13';
972
984
  namespace: 'Files';
973
985
  name: '';
974
986
  fields: {
975
987
  /** . */
976
- 'organizationId': {
977
- type: 'id';
988
+ 'didConfigureFileUploads': {
989
+ type: 'boolean';
978
990
  isRequired: true;
979
991
  options: undefined;
980
992
  };
981
993
  };
982
994
  }
983
- interface SaveSettingsEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetSchema> {
995
+ interface GetSettingsStatusResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusResponsePayloadSchema> {
984
996
  }
985
997
  }
986
998
  namespace SpruceSchemas.Files.v2022_05_13 {
987
- interface SaveSettingsEmitPayload {
988
- 'awsAccessKeyId': string;
989
- 'awsSecretAccessKey': string;
990
- 'awsS3Bucket': string;
999
+ interface GetUploadEndpointResponsePayload {
1000
+ /** . The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client. */
1001
+ 'restEndpointUrl'?: string | undefined | null;
991
1002
  }
992
- interface SaveSettingsEmitPayloadSchema extends SpruceSchema.Schema {
993
- id: 'saveSettingsEmitPayload';
1003
+ interface GetUploadEndpointResponsePayloadSchema extends SpruceSchema.Schema {
1004
+ id: 'getUploadEndpointResponsePayload';
994
1005
  version: 'v2022_05_13';
995
1006
  namespace: 'Files';
996
1007
  name: '';
997
1008
  fields: {
998
- /** . */
999
- 'awsAccessKeyId': {
1000
- type: 'id';
1001
- isRequired: true;
1002
- options: undefined;
1003
- };
1004
- /** . */
1005
- 'awsSecretAccessKey': {
1006
- type: 'text';
1007
- isRequired: true;
1008
- options: undefined;
1009
- };
1010
- /** . */
1011
- 'awsS3Bucket': {
1009
+ /** . The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client. */
1010
+ 'restEndpointUrl': {
1012
1011
  type: 'text';
1013
- isRequired: true;
1012
+ hint: 'The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client.';
1014
1013
  options: undefined;
1015
1014
  };
1016
1015
  };
1017
1016
  }
1018
- interface SaveSettingsEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayloadSchema> {
1017
+ interface GetUploadEndpointResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetUploadEndpointResponsePayloadSchema> {
1019
1018
  }
1020
1019
  }
1021
1020
  namespace SpruceSchemas.Files.v2022_05_13 {
1022
- interface SaveSettingsEmitTargetAndPayload {
1023
- /** Source. */
1024
- 'source'?: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSource | undefined | null;
1025
- 'target': SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTarget;
1026
- 'payload': SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayload;
1021
+ interface UploadEmitTarget {
1022
+ 'locationId'?: string | undefined | null;
1023
+ 'organizationId'?: string | undefined | null;
1024
+ 'filePersonId'?: string | undefined | null;
1027
1025
  }
1028
- interface SaveSettingsEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
1029
- id: 'saveSettingsEmitTargetAndPayload';
1026
+ interface UploadEmitTargetSchema extends SpruceSchema.Schema {
1027
+ id: 'uploadEmitTarget';
1030
1028
  version: 'v2022_05_13';
1031
1029
  namespace: 'Files';
1032
1030
  name: '';
1033
1031
  fields: {
1034
- /** Source. */
1035
- 'source': {
1036
- label: 'Source';
1037
- type: 'schema';
1038
- options: {
1039
- schema: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSourceSchema;
1040
- };
1032
+ /** . */
1033
+ 'locationId': {
1034
+ type: 'id';
1035
+ options: undefined;
1041
1036
  };
1042
1037
  /** . */
1043
- 'target': {
1044
- type: 'schema';
1045
- isRequired: true;
1046
- options: {
1047
- schema: SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetSchema;
1048
- };
1038
+ 'organizationId': {
1039
+ type: 'id';
1040
+ options: undefined;
1049
1041
  };
1050
1042
  /** . */
1051
- 'payload': {
1052
- type: 'schema';
1053
- isRequired: true;
1054
- options: {
1055
- schema: SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayloadSchema;
1056
- };
1043
+ 'filePersonId': {
1044
+ type: 'text';
1045
+ options: undefined;
1057
1046
  };
1058
1047
  };
1059
1048
  }
1060
- interface SaveSettingsEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetAndPayloadSchema> {
1049
+ interface UploadEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema> {
1061
1050
  }
1062
1051
  }
1063
1052
  namespace SpruceSchemas.Files.v2022_05_13 {
1064
- interface SaveSettingsResponsePayload {
1065
- 'wasSuccessful': boolean;
1053
+ interface UploadEmitPayload {
1054
+ 'base64Body': string;
1055
+ 'name': string;
1066
1056
  }
1067
- interface SaveSettingsResponsePayloadSchema extends SpruceSchema.Schema {
1068
- id: 'saveSettingsResponsePayload';
1057
+ interface UploadEmitPayloadSchema extends SpruceSchema.Schema {
1058
+ id: 'uploadEmitPayload';
1069
1059
  version: 'v2022_05_13';
1070
1060
  namespace: 'Files';
1071
1061
  name: '';
1072
1062
  fields: {
1073
1063
  /** . */
1074
- 'wasSuccessful': {
1075
- type: 'boolean';
1064
+ 'base64Body': {
1065
+ type: 'text';
1076
1066
  isRequired: true;
1077
1067
  options: undefined;
1078
1068
  };
1079
- };
1080
- }
1081
- interface SaveSettingsResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsResponsePayloadSchema> {
1082
- }
1083
- }
1084
- namespace SpruceSchemas.Files.v2022_05_13 {
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;
1088
- }
1089
- interface GetUploadEndpointResponsePayloadSchema extends SpruceSchema.Schema {
1090
- id: 'getUploadEndpointResponsePayload';
1091
- version: 'v2022_05_13';
1092
- namespace: 'Files';
1093
- name: '';
1094
- fields: {
1095
- /** . The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client. */
1096
- 'restEndpointUrl': {
1069
+ /** . */
1070
+ 'name': {
1097
1071
  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.';
1072
+ isRequired: true;
1099
1073
  options: undefined;
1100
1074
  };
1101
1075
  };
1102
1076
  }
1103
- interface GetUploadEndpointResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetUploadEndpointResponsePayloadSchema> {
1077
+ interface UploadEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema> {
1104
1078
  }
1105
1079
  }
1106
1080
  namespace SpruceSchemas.Files.v2022_05_13 {
1107
- interface GetSettingsStatusEmitTargetAndPayload {
1081
+ interface UploadEmitTargetAndPayload {
1108
1082
  /** Source. */
1109
1083
  'source'?: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSource | undefined | null;
1110
- 'target': SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTarget;
1084
+ 'target'?: SpruceSchemas.Files.v2022_05_13.UploadEmitTarget | undefined | null;
1085
+ 'payload': SpruceSchemas.Files.v2022_05_13.UploadEmitPayload;
1111
1086
  }
1112
- interface GetSettingsStatusEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
1113
- id: 'getSettingsStatusEmitTargetAndPayload';
1087
+ interface UploadEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
1088
+ id: 'uploadEmitTargetAndPayload';
1114
1089
  version: 'v2022_05_13';
1115
1090
  namespace: 'Files';
1116
1091
  name: '';
@@ -1125,86 +1100,89 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1125
1100
  };
1126
1101
  /** . */
1127
1102
  'target': {
1103
+ type: 'schema';
1104
+ options: {
1105
+ schema: SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema;
1106
+ };
1107
+ };
1108
+ /** . */
1109
+ 'payload': {
1128
1110
  type: 'schema';
1129
1111
  isRequired: true;
1130
1112
  options: {
1131
- schema: SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTargetSchema;
1113
+ schema: SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema;
1132
1114
  };
1133
1115
  };
1134
1116
  };
1135
1117
  }
1136
- interface GetSettingsStatusEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTargetAndPayloadSchema> {
1118
+ interface UploadEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetAndPayloadSchema> {
1137
1119
  }
1138
1120
  }
1139
1121
  namespace SpruceSchemas.Files.v2022_05_13 {
1140
- interface UploadEmitTarget {
1141
- 'locationId'?: string | undefined | null;
1142
- 'organizationId'?: string | undefined | null;
1143
- 'filePersonId'?: string | undefined | null;
1122
+ interface SaveSettingsEmitTarget {
1123
+ 'organizationId': string;
1144
1124
  }
1145
- interface UploadEmitTargetSchema extends SpruceSchema.Schema {
1146
- id: 'uploadEmitTarget';
1125
+ interface SaveSettingsEmitTargetSchema extends SpruceSchema.Schema {
1126
+ id: 'saveSettingsEmitTarget';
1147
1127
  version: 'v2022_05_13';
1148
1128
  namespace: 'Files';
1149
1129
  name: '';
1150
1130
  fields: {
1151
- /** . */
1152
- 'locationId': {
1153
- type: 'id';
1154
- options: undefined;
1155
- };
1156
1131
  /** . */
1157
1132
  'organizationId': {
1158
1133
  type: 'id';
1159
- options: undefined;
1160
- };
1161
- /** . */
1162
- 'filePersonId': {
1163
- type: 'text';
1134
+ isRequired: true;
1164
1135
  options: undefined;
1165
1136
  };
1166
1137
  };
1167
1138
  }
1168
- interface UploadEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema> {
1139
+ interface SaveSettingsEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetSchema> {
1169
1140
  }
1170
1141
  }
1171
1142
  namespace SpruceSchemas.Files.v2022_05_13 {
1172
- interface UploadEmitPayload {
1173
- 'base64Body': string;
1174
- 'name': string;
1143
+ interface SaveSettingsEmitPayload {
1144
+ 'awsAccessKeyId': string;
1145
+ 'awsSecretAccessKey': string;
1146
+ 'awsS3Bucket': string;
1175
1147
  }
1176
- interface UploadEmitPayloadSchema extends SpruceSchema.Schema {
1177
- id: 'uploadEmitPayload';
1148
+ interface SaveSettingsEmitPayloadSchema extends SpruceSchema.Schema {
1149
+ id: 'saveSettingsEmitPayload';
1178
1150
  version: 'v2022_05_13';
1179
1151
  namespace: 'Files';
1180
1152
  name: '';
1181
1153
  fields: {
1182
1154
  /** . */
1183
- 'base64Body': {
1155
+ 'awsAccessKeyId': {
1156
+ type: 'id';
1157
+ isRequired: true;
1158
+ options: undefined;
1159
+ };
1160
+ /** . */
1161
+ 'awsSecretAccessKey': {
1184
1162
  type: 'text';
1185
1163
  isRequired: true;
1186
1164
  options: undefined;
1187
1165
  };
1188
1166
  /** . */
1189
- 'name': {
1167
+ 'awsS3Bucket': {
1190
1168
  type: 'text';
1191
1169
  isRequired: true;
1192
1170
  options: undefined;
1193
1171
  };
1194
1172
  };
1195
1173
  }
1196
- interface UploadEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema> {
1174
+ interface SaveSettingsEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayloadSchema> {
1197
1175
  }
1198
1176
  }
1199
1177
  namespace SpruceSchemas.Files.v2022_05_13 {
1200
- interface UploadEmitTargetAndPayload {
1178
+ interface SaveSettingsEmitTargetAndPayload {
1201
1179
  /** Source. */
1202
1180
  'source'?: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSource | undefined | null;
1203
- 'target'?: SpruceSchemas.Files.v2022_05_13.UploadEmitTarget | undefined | null;
1204
- 'payload': SpruceSchemas.Files.v2022_05_13.UploadEmitPayload;
1181
+ 'target': SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTarget;
1182
+ 'payload': SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayload;
1205
1183
  }
1206
- interface UploadEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
1207
- id: 'uploadEmitTargetAndPayload';
1184
+ interface SaveSettingsEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
1185
+ id: 'saveSettingsEmitTargetAndPayload';
1208
1186
  version: 'v2022_05_13';
1209
1187
  namespace: 'Files';
1210
1188
  name: '';
@@ -1220,8 +1198,9 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1220
1198
  /** . */
1221
1199
  'target': {
1222
1200
  type: 'schema';
1201
+ isRequired: true;
1223
1202
  options: {
1224
- schema: SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema;
1203
+ schema: SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetSchema;
1225
1204
  };
1226
1205
  };
1227
1206
  /** . */
@@ -1229,12 +1208,33 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1229
1208
  type: 'schema';
1230
1209
  isRequired: true;
1231
1210
  options: {
1232
- schema: SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema;
1211
+ schema: SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayloadSchema;
1233
1212
  };
1234
1213
  };
1235
1214
  };
1236
1215
  }
1237
- interface UploadEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetAndPayloadSchema> {
1216
+ interface SaveSettingsEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetAndPayloadSchema> {
1217
+ }
1218
+ }
1219
+ namespace SpruceSchemas.Files.v2022_05_13 {
1220
+ interface SaveSettingsResponsePayload {
1221
+ 'wasSuccessful': boolean;
1222
+ }
1223
+ interface SaveSettingsResponsePayloadSchema extends SpruceSchema.Schema {
1224
+ id: 'saveSettingsResponsePayload';
1225
+ version: 'v2022_05_13';
1226
+ namespace: 'Files';
1227
+ name: '';
1228
+ fields: {
1229
+ /** . */
1230
+ 'wasSuccessful': {
1231
+ type: 'boolean';
1232
+ isRequired: true;
1233
+ options: undefined;
1234
+ };
1235
+ };
1236
+ }
1237
+ interface SaveSettingsResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsResponsePayloadSchema> {
1238
1238
  }
1239
1239
  }
1240
1240
  namespace SpruceSchemas.Files.v2022_05_13 {
package/build/esm/.spruce/schemas/schemas.types.d.ts CHANGED
@@ -942,175 +942,150 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
942
942
  }
943
943
  }
944
944
  namespace SpruceSchemas.Files.v2022_05_13 {
945
- interface GetSettingsStatusResponsePayload {
946
- 'didConfigureFileUploads': boolean;
945
+ interface GetSettingsStatusEmitTargetAndPayload {
946
+ /** Source. */
947
+ 'source'?: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSource | undefined | null;
948
+ 'target': SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTarget;
947
949
  }
948
- interface GetSettingsStatusResponsePayloadSchema extends SpruceSchema.Schema {
949
- id: 'getSettingsStatusResponsePayload';
950
+ interface GetSettingsStatusEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
951
+ id: 'getSettingsStatusEmitTargetAndPayload';
950
952
  version: 'v2022_05_13';
951
953
  namespace: 'Files';
952
954
  name: '';
953
955
  fields: {
956
+ /** Source. */
957
+ 'source': {
958
+ label: 'Source';
959
+ type: 'schema';
960
+ options: {
961
+ schema: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSourceSchema;
962
+ };
963
+ };
954
964
  /** . */
955
- 'didConfigureFileUploads': {
956
- type: 'boolean';
965
+ 'target': {
966
+ type: 'schema';
957
967
  isRequired: true;
958
- options: undefined;
968
+ options: {
969
+ schema: SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTargetSchema;
970
+ };
959
971
  };
960
972
  };
961
973
  }
962
- interface GetSettingsStatusResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusResponsePayloadSchema> {
974
+ interface GetSettingsStatusEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTargetAndPayloadSchema> {
963
975
  }
964
976
  }
965
977
  namespace SpruceSchemas.Files.v2022_05_13 {
966
- interface SaveSettingsEmitTarget {
967
- 'organizationId': string;
978
+ interface GetSettingsStatusResponsePayload {
979
+ 'didConfigureFileUploads': boolean;
968
980
  }
969
- interface SaveSettingsEmitTargetSchema extends SpruceSchema.Schema {
970
- id: 'saveSettingsEmitTarget';
981
+ interface GetSettingsStatusResponsePayloadSchema extends SpruceSchema.Schema {
982
+ id: 'getSettingsStatusResponsePayload';
971
983
  version: 'v2022_05_13';
972
984
  namespace: 'Files';
973
985
  name: '';
974
986
  fields: {
975
987
  /** . */
976
- 'organizationId': {
977
- type: 'id';
988
+ 'didConfigureFileUploads': {
989
+ type: 'boolean';
978
990
  isRequired: true;
979
991
  options: undefined;
980
992
  };
981
993
  };
982
994
  }
983
- interface SaveSettingsEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetSchema> {
995
+ interface GetSettingsStatusResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusResponsePayloadSchema> {
984
996
  }
985
997
  }
986
998
  namespace SpruceSchemas.Files.v2022_05_13 {
987
- interface SaveSettingsEmitPayload {
988
- 'awsAccessKeyId': string;
989
- 'awsSecretAccessKey': string;
990
- 'awsS3Bucket': string;
999
+ interface GetUploadEndpointResponsePayload {
1000
+ /** . The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client. */
1001
+ 'restEndpointUrl'?: string | undefined | null;
991
1002
  }
992
- interface SaveSettingsEmitPayloadSchema extends SpruceSchema.Schema {
993
- id: 'saveSettingsEmitPayload';
1003
+ interface GetUploadEndpointResponsePayloadSchema extends SpruceSchema.Schema {
1004
+ id: 'getUploadEndpointResponsePayload';
994
1005
  version: 'v2022_05_13';
995
1006
  namespace: 'Files';
996
1007
  name: '';
997
1008
  fields: {
998
- /** . */
999
- 'awsAccessKeyId': {
1000
- type: 'id';
1001
- isRequired: true;
1002
- options: undefined;
1003
- };
1004
- /** . */
1005
- 'awsSecretAccessKey': {
1006
- type: 'text';
1007
- isRequired: true;
1008
- options: undefined;
1009
- };
1010
- /** . */
1011
- 'awsS3Bucket': {
1009
+ /** . The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client. */
1010
+ 'restEndpointUrl': {
1012
1011
  type: 'text';
1013
- isRequired: true;
1012
+ hint: 'The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client.';
1014
1013
  options: undefined;
1015
1014
  };
1016
1015
  };
1017
1016
  }
1018
- interface SaveSettingsEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayloadSchema> {
1017
+ interface GetUploadEndpointResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetUploadEndpointResponsePayloadSchema> {
1019
1018
  }
1020
1019
  }
1021
1020
  namespace SpruceSchemas.Files.v2022_05_13 {
1022
- interface SaveSettingsEmitTargetAndPayload {
1023
- /** Source. */
1024
- 'source'?: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSource | undefined | null;
1025
- 'target': SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTarget;
1026
- 'payload': SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayload;
1021
+ interface UploadEmitTarget {
1022
+ 'locationId'?: string | undefined | null;
1023
+ 'organizationId'?: string | undefined | null;
1024
+ 'filePersonId'?: string | undefined | null;
1027
1025
  }
1028
- interface SaveSettingsEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
1029
- id: 'saveSettingsEmitTargetAndPayload';
1026
+ interface UploadEmitTargetSchema extends SpruceSchema.Schema {
1027
+ id: 'uploadEmitTarget';
1030
1028
  version: 'v2022_05_13';
1031
1029
  namespace: 'Files';
1032
1030
  name: '';
1033
1031
  fields: {
1034
- /** Source. */
1035
- 'source': {
1036
- label: 'Source';
1037
- type: 'schema';
1038
- options: {
1039
- schema: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSourceSchema;
1040
- };
1032
+ /** . */
1033
+ 'locationId': {
1034
+ type: 'id';
1035
+ options: undefined;
1041
1036
  };
1042
1037
  /** . */
1043
- 'target': {
1044
- type: 'schema';
1045
- isRequired: true;
1046
- options: {
1047
- schema: SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetSchema;
1048
- };
1038
+ 'organizationId': {
1039
+ type: 'id';
1040
+ options: undefined;
1049
1041
  };
1050
1042
  /** . */
1051
- 'payload': {
1052
- type: 'schema';
1053
- isRequired: true;
1054
- options: {
1055
- schema: SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayloadSchema;
1056
- };
1043
+ 'filePersonId': {
1044
+ type: 'text';
1045
+ options: undefined;
1057
1046
  };
1058
1047
  };
1059
1048
  }
1060
- interface SaveSettingsEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetAndPayloadSchema> {
1049
+ interface UploadEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema> {
1061
1050
  }
1062
1051
  }
1063
1052
  namespace SpruceSchemas.Files.v2022_05_13 {
1064
- interface SaveSettingsResponsePayload {
1065
- 'wasSuccessful': boolean;
1053
+ interface UploadEmitPayload {
1054
+ 'base64Body': string;
1055
+ 'name': string;
1066
1056
  }
1067
- interface SaveSettingsResponsePayloadSchema extends SpruceSchema.Schema {
1068
- id: 'saveSettingsResponsePayload';
1057
+ interface UploadEmitPayloadSchema extends SpruceSchema.Schema {
1058
+ id: 'uploadEmitPayload';
1069
1059
  version: 'v2022_05_13';
1070
1060
  namespace: 'Files';
1071
1061
  name: '';
1072
1062
  fields: {
1073
1063
  /** . */
1074
- 'wasSuccessful': {
1075
- type: 'boolean';
1064
+ 'base64Body': {
1065
+ type: 'text';
1076
1066
  isRequired: true;
1077
1067
  options: undefined;
1078
1068
  };
1079
- };
1080
- }
1081
- interface SaveSettingsResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsResponsePayloadSchema> {
1082
- }
1083
- }
1084
- namespace SpruceSchemas.Files.v2022_05_13 {
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;
1088
- }
1089
- interface GetUploadEndpointResponsePayloadSchema extends SpruceSchema.Schema {
1090
- id: 'getUploadEndpointResponsePayload';
1091
- version: 'v2022_05_13';
1092
- namespace: 'Files';
1093
- name: '';
1094
- fields: {
1095
- /** . The REST endpoint URL to user when uploading a file. If not set, you must use upload using the Mercury Client. */
1096
- 'restEndpointUrl': {
1069
+ /** . */
1070
+ 'name': {
1097
1071
  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.';
1072
+ isRequired: true;
1099
1073
  options: undefined;
1100
1074
  };
1101
1075
  };
1102
1076
  }
1103
- interface GetUploadEndpointResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetUploadEndpointResponsePayloadSchema> {
1077
+ interface UploadEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema> {
1104
1078
  }
1105
1079
  }
1106
1080
  namespace SpruceSchemas.Files.v2022_05_13 {
1107
- interface GetSettingsStatusEmitTargetAndPayload {
1081
+ interface UploadEmitTargetAndPayload {
1108
1082
  /** Source. */
1109
1083
  'source'?: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSource | undefined | null;
1110
- 'target': SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTarget;
1084
+ 'target'?: SpruceSchemas.Files.v2022_05_13.UploadEmitTarget | undefined | null;
1085
+ 'payload': SpruceSchemas.Files.v2022_05_13.UploadEmitPayload;
1111
1086
  }
1112
- interface GetSettingsStatusEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
1113
- id: 'getSettingsStatusEmitTargetAndPayload';
1087
+ interface UploadEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
1088
+ id: 'uploadEmitTargetAndPayload';
1114
1089
  version: 'v2022_05_13';
1115
1090
  namespace: 'Files';
1116
1091
  name: '';
@@ -1125,86 +1100,89 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1125
1100
  };
1126
1101
  /** . */
1127
1102
  'target': {
1103
+ type: 'schema';
1104
+ options: {
1105
+ schema: SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema;
1106
+ };
1107
+ };
1108
+ /** . */
1109
+ 'payload': {
1128
1110
  type: 'schema';
1129
1111
  isRequired: true;
1130
1112
  options: {
1131
- schema: SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTargetSchema;
1113
+ schema: SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema;
1132
1114
  };
1133
1115
  };
1134
1116
  };
1135
1117
  }
1136
- interface GetSettingsStatusEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.GetSettingsStatusEmitTargetAndPayloadSchema> {
1118
+ interface UploadEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetAndPayloadSchema> {
1137
1119
  }
1138
1120
  }
1139
1121
  namespace SpruceSchemas.Files.v2022_05_13 {
1140
- interface UploadEmitTarget {
1141
- 'locationId'?: string | undefined | null;
1142
- 'organizationId'?: string | undefined | null;
1143
- 'filePersonId'?: string | undefined | null;
1122
+ interface SaveSettingsEmitTarget {
1123
+ 'organizationId': string;
1144
1124
  }
1145
- interface UploadEmitTargetSchema extends SpruceSchema.Schema {
1146
- id: 'uploadEmitTarget';
1125
+ interface SaveSettingsEmitTargetSchema extends SpruceSchema.Schema {
1126
+ id: 'saveSettingsEmitTarget';
1147
1127
  version: 'v2022_05_13';
1148
1128
  namespace: 'Files';
1149
1129
  name: '';
1150
1130
  fields: {
1151
- /** . */
1152
- 'locationId': {
1153
- type: 'id';
1154
- options: undefined;
1155
- };
1156
1131
  /** . */
1157
1132
  'organizationId': {
1158
1133
  type: 'id';
1159
- options: undefined;
1160
- };
1161
- /** . */
1162
- 'filePersonId': {
1163
- type: 'text';
1134
+ isRequired: true;
1164
1135
  options: undefined;
1165
1136
  };
1166
1137
  };
1167
1138
  }
1168
- interface UploadEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema> {
1139
+ interface SaveSettingsEmitTargetEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetSchema> {
1169
1140
  }
1170
1141
  }
1171
1142
  namespace SpruceSchemas.Files.v2022_05_13 {
1172
- interface UploadEmitPayload {
1173
- 'base64Body': string;
1174
- 'name': string;
1143
+ interface SaveSettingsEmitPayload {
1144
+ 'awsAccessKeyId': string;
1145
+ 'awsSecretAccessKey': string;
1146
+ 'awsS3Bucket': string;
1175
1147
  }
1176
- interface UploadEmitPayloadSchema extends SpruceSchema.Schema {
1177
- id: 'uploadEmitPayload';
1148
+ interface SaveSettingsEmitPayloadSchema extends SpruceSchema.Schema {
1149
+ id: 'saveSettingsEmitPayload';
1178
1150
  version: 'v2022_05_13';
1179
1151
  namespace: 'Files';
1180
1152
  name: '';
1181
1153
  fields: {
1182
1154
  /** . */
1183
- 'base64Body': {
1155
+ 'awsAccessKeyId': {
1156
+ type: 'id';
1157
+ isRequired: true;
1158
+ options: undefined;
1159
+ };
1160
+ /** . */
1161
+ 'awsSecretAccessKey': {
1184
1162
  type: 'text';
1185
1163
  isRequired: true;
1186
1164
  options: undefined;
1187
1165
  };
1188
1166
  /** . */
1189
- 'name': {
1167
+ 'awsS3Bucket': {
1190
1168
  type: 'text';
1191
1169
  isRequired: true;
1192
1170
  options: undefined;
1193
1171
  };
1194
1172
  };
1195
1173
  }
1196
- interface UploadEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema> {
1174
+ interface SaveSettingsEmitPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayloadSchema> {
1197
1175
  }
1198
1176
  }
1199
1177
  namespace SpruceSchemas.Files.v2022_05_13 {
1200
- interface UploadEmitTargetAndPayload {
1178
+ interface SaveSettingsEmitTargetAndPayload {
1201
1179
  /** Source. */
1202
1180
  'source'?: SpruceSchemas.SpruceEventUtils.v2021_09_13.EventSource | undefined | null;
1203
- 'target'?: SpruceSchemas.Files.v2022_05_13.UploadEmitTarget | undefined | null;
1204
- 'payload': SpruceSchemas.Files.v2022_05_13.UploadEmitPayload;
1181
+ 'target': SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTarget;
1182
+ 'payload': SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayload;
1205
1183
  }
1206
- interface UploadEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
1207
- id: 'uploadEmitTargetAndPayload';
1184
+ interface SaveSettingsEmitTargetAndPayloadSchema extends SpruceSchema.Schema {
1185
+ id: 'saveSettingsEmitTargetAndPayload';
1208
1186
  version: 'v2022_05_13';
1209
1187
  namespace: 'Files';
1210
1188
  name: '';
@@ -1220,8 +1198,9 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1220
1198
  /** . */
1221
1199
  'target': {
1222
1200
  type: 'schema';
1201
+ isRequired: true;
1223
1202
  options: {
1224
- schema: SpruceSchemas.Files.v2022_05_13.UploadEmitTargetSchema;
1203
+ schema: SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetSchema;
1225
1204
  };
1226
1205
  };
1227
1206
  /** . */
@@ -1229,12 +1208,33 @@ declare module '@sprucelabs/spruce-core-schemas/build/.spruce/schemas/core.schem
1229
1208
  type: 'schema';
1230
1209
  isRequired: true;
1231
1210
  options: {
1232
- schema: SpruceSchemas.Files.v2022_05_13.UploadEmitPayloadSchema;
1211
+ schema: SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitPayloadSchema;
1233
1212
  };
1234
1213
  };
1235
1214
  };
1236
1215
  }
1237
- interface UploadEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.UploadEmitTargetAndPayloadSchema> {
1216
+ interface SaveSettingsEmitTargetAndPayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsEmitTargetAndPayloadSchema> {
1217
+ }
1218
+ }
1219
+ namespace SpruceSchemas.Files.v2022_05_13 {
1220
+ interface SaveSettingsResponsePayload {
1221
+ 'wasSuccessful': boolean;
1222
+ }
1223
+ interface SaveSettingsResponsePayloadSchema extends SpruceSchema.Schema {
1224
+ id: 'saveSettingsResponsePayload';
1225
+ version: 'v2022_05_13';
1226
+ namespace: 'Files';
1227
+ name: '';
1228
+ fields: {
1229
+ /** . */
1230
+ 'wasSuccessful': {
1231
+ type: 'boolean';
1232
+ isRequired: true;
1233
+ options: undefined;
1234
+ };
1235
+ };
1236
+ }
1237
+ interface SaveSettingsResponsePayloadEntity extends SchemaEntity<SpruceSchemas.Files.v2022_05_13.SaveSettingsResponsePayloadSchema> {
1238
1238
  }
1239
1239
  }
1240
1240
  namespace SpruceSchemas.Files.v2022_05_13 {
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.3",
4
+ "version": "18.6.4",
5
5
  "skill": {
6
6
  "namespace": "files"
7
7
  },