Renamed DTOs and methods for Storage API

weden-ecwid · weden-ecwid · commit 42900cd26439 · 2022-05-31T11:39:53.000+04:00
diff --git a/src/main/kotlin/com/ecwid/apiclient/v3/ApiClient.kt b/src/main/kotlin/com/ecwid/apiclient/v3/ApiClient.kt
@@ -298,10 +298,10 @@ interface ApplicationApiClient {
 // Application storage
 // https://developers.ecwid.com/api-documentation/app-storage
 interface ApplicationStorageApiClient {
-	fun getStorageEntity(request: StorageEntityRequest): FetchedStorageData
-	fun getAllStorageEntities(request: StorageEntitiesRequest): StorageEntitiesResult
-	fun createOrUpdateStorageEntity(request: StorageEntityUpdateRequest): StorageEntityUpdateResult
-	fun deleteStorageEntity(request: StorageEntityDeleteRequest): StorageEntityDeleteResult
+	fun getStorageData(request: StorageDataRequest): FetchedStorageData
+	fun getAllStorageData(request: AllStorageDataRequest): AllStorageDataResult
+	fun createOrUpdateStorageData(request: StorageDataUpdateRequest): StorageDataUpdateResult
+	fun deleteStorageData(request: StorageDataDeleteRequest): StorageDataDeleteResult
 }
 
 // Starter site
diff --git a/src/main/kotlin/com/ecwid/apiclient/v3/dto/storage/request/AllStorageDataRequest.kt b/src/main/kotlin/com/ecwid/apiclient/v3/dto/storage/request/AllStorageDataRequest.kt
@@ -3,7 +3,7 @@ package com.ecwid.apiclient.v3.dto.storage.request
 import com.ecwid.apiclient.v3.dto.ApiRequest
 import com.ecwid.apiclient.v3.impl.RequestInfo
 
-class StorageEntitiesRequest : ApiRequest {
+class AllStorageDataRequest : ApiRequest {
 
 	override fun toRequestInfo() = RequestInfo.createGetRequest(
 		pathSegments = listOf(
diff --git a/src/main/kotlin/com/ecwid/apiclient/v3/dto/storage/request/StorageDataDeleteRequest.kt b/src/main/kotlin/com/ecwid/apiclient/v3/dto/storage/request/StorageDataDeleteRequest.kt
@@ -3,7 +3,7 @@ package com.ecwid.apiclient.v3.dto.storage.request
 import com.ecwid.apiclient.v3.dto.ApiRequest
 import com.ecwid.apiclient.v3.impl.RequestInfo
 
-data class StorageEntityDeleteRequest(
+data class StorageDataDeleteRequest(
 	val key: String = "",
 ) : ApiRequest {
 
diff --git a/src/main/kotlin/com/ecwid/apiclient/v3/dto/storage/request/StorageDataRequest.kt b/src/main/kotlin/com/ecwid/apiclient/v3/dto/storage/request/StorageDataRequest.kt
@@ -3,7 +3,7 @@ package com.ecwid.apiclient.v3.dto.storage.request
 import com.ecwid.apiclient.v3.dto.ApiRequest
 import com.ecwid.apiclient.v3.impl.RequestInfo
 
-data class StorageEntityRequest(
+data class StorageDataRequest(
 	val key: String = "",
 ) : ApiRequest {
 
diff --git a/src/main/kotlin/com/ecwid/apiclient/v3/dto/storage/request/StorageDataUpdateRequest.kt b/src/main/kotlin/com/ecwid/apiclient/v3/dto/storage/request/StorageDataUpdateRequest.kt
@@ -5,17 +5,17 @@ import com.ecwid.apiclient.v3.httptransport.HttpBody
 import com.ecwid.apiclient.v3.impl.MIME_TYPE_APPLICATION_JSON
 import com.ecwid.apiclient.v3.impl.RequestInfo
 
-data class StorageEntityUpdateRequest(
-	private val updatedStorageEntity: UpdatedStorageData = UpdatedStorageData(),
+data class StorageDataUpdateRequest(
+	private val updatedStorageData: UpdatedStorageData = UpdatedStorageData(),
 ) : ApiRequest {
 
 	override fun toRequestInfo() = RequestInfo.createPutRequest(
 		pathSegments = listOf(
 			"storage",
-			updatedStorageEntity.key,
+			updatedStorageData.key,
 		),
 		httpBody = HttpBody.ByteArrayBody(
-			bytes = updatedStorageEntity.value.toByteArray(),
+			bytes = updatedStorageData.value.toByteArray(),
 			mimeType = MIME_TYPE_APPLICATION_JSON,
 		),
 	)
diff --git a/src/main/kotlin/com/ecwid/apiclient/v3/dto/storage/result/AllStorageDataResult.kt b/src/main/kotlin/com/ecwid/apiclient/v3/dto/storage/result/AllStorageDataResult.kt
@@ -0,0 +1,3 @@
+package com.ecwid.apiclient.v3.dto.storage.result
+
+class AllStorageDataResult : ArrayList<FetchedStorageData>()
diff --git a/src/main/kotlin/com/ecwid/apiclient/v3/dto/storage/result/StorageDataDeleteResult.kt b/src/main/kotlin/com/ecwid/apiclient/v3/dto/storage/result/StorageDataDeleteResult.kt
@@ -2,6 +2,6 @@ package com.ecwid.apiclient.v3.dto.storage.result
 
 import com.ecwid.apiclient.v3.dto.common.ApiResultDTO
 
-data class StorageEntityDeleteResult(
+data class StorageDataDeleteResult(
 	val deleteCount: Int = 0,
 ) : ApiResultDTO
diff --git a/src/main/kotlin/com/ecwid/apiclient/v3/dto/storage/result/StorageDataUpdateResult.kt b/src/main/kotlin/com/ecwid/apiclient/v3/dto/storage/result/StorageDataUpdateResult.kt
@@ -2,6 +2,6 @@ package com.ecwid.apiclient.v3.dto.storage.result
 
 import com.ecwid.apiclient.v3.dto.common.ApiResultDTO
 
-data class StorageEntityUpdateResult(
+data class StorageDataUpdateResult(
 	val updateCount: Int = 0,
 ) : ApiResultDTO
diff --git a/src/main/kotlin/com/ecwid/apiclient/v3/dto/storage/result/StorageEntitiesResult.kt b/src/main/kotlin/com/ecwid/apiclient/v3/dto/storage/result/StorageEntitiesResult.kt
diff --git a/src/main/kotlin/com/ecwid/apiclient/v3/impl/ApplicationStorageApiClientImpl.kt b/src/main/kotlin/com/ecwid/apiclient/v3/impl/ApplicationStorageApiClientImpl.kt
@@ -9,16 +9,16 @@ internal class ApplicationStorageApiClientImpl(
 	private val apiClientHelper: ApiClientHelper,
 ) : ApplicationStorageApiClient {
 
-	override fun getStorageEntity(request: StorageEntityRequest) =
+	override fun getStorageData(request: StorageDataRequest) =
 		apiClientHelper.makeObjectResultRequest<FetchedStorageData>(request)
 
-	override fun getAllStorageEntities(request: StorageEntitiesRequest) =
-		apiClientHelper.makeObjectResultRequest<StorageEntitiesResult>(request)
+	override fun getAllStorageData(request: AllStorageDataRequest) =
+		apiClientHelper.makeObjectResultRequest<AllStorageDataResult>(request)
 
-	override fun createOrUpdateStorageEntity(request: StorageEntityUpdateRequest) =
-		apiClientHelper.makeObjectResultRequest<StorageEntityUpdateResult>(request)
+	override fun createOrUpdateStorageData(request: StorageDataUpdateRequest) =
+		apiClientHelper.makeObjectResultRequest<StorageDataUpdateResult>(request)
 
-	override fun deleteStorageEntity(request: StorageEntityDeleteRequest) =
-		apiClientHelper.makeObjectResultRequest<StorageEntityDeleteResult>(request)
+	override fun deleteStorageData(request: StorageDataDeleteRequest) =
+		apiClientHelper.makeObjectResultRequest<StorageDataDeleteResult>(request)
 
 }
diff --git a/src/test/kotlin/com/ecwid/apiclient/v3/entity/StorageTest.kt b/src/test/kotlin/com/ecwid/apiclient/v3/entity/StorageTest.kt
@@ -22,19 +22,19 @@ class StorageTest : BaseEntityTest() {
 		val value = updateData.toJson()
 
 		val updatedStorageEntity = UpdatedStorageData(key = key, value = value)
-		val updateRequest = StorageEntityUpdateRequest(updatedStorageEntity)
-		val updateResult = apiClient.createOrUpdateStorageEntity(updateRequest)
+		val updateRequest = StorageDataUpdateRequest(updatedStorageEntity)
+		val updateResult = apiClient.createOrUpdateStorageData(updateRequest)
 		assertEquals(1, updateResult.updateCount)
 
-		val storageEntityRequest = StorageEntityRequest(key)
-		val storageEntity = apiClient.getStorageEntity(storageEntityRequest)
+		val storageEntityRequest = StorageDataRequest(key)
+		val storageEntity = apiClient.getStorageData(storageEntityRequest)
 		assertEquals(updatedStorageEntity, storageEntity.toUpdated())
 
 		val fetchedData = StorageApiData.fromJson(storageEntity.value)
 		assertEquals(updateData, fetchedData)
 
-		val deleteRequest = StorageEntityDeleteRequest(key)
-		val deleteResult = apiClient.deleteStorageEntity(deleteRequest)
+		val deleteRequest = StorageDataDeleteRequest(key)
+		val deleteResult = apiClient.deleteStorageData(deleteRequest)
 		assertEquals(1, deleteResult.deleteCount)
 	}
 
@@ -46,22 +46,22 @@ class StorageTest : BaseEntityTest() {
 		)
 
 		updatedEntities.forEach { entity ->
-			val updateRequest = StorageEntityUpdateRequest(entity)
-			val updateResult = apiClient.createOrUpdateStorageEntity(updateRequest)
+			val updateRequest = StorageDataUpdateRequest(entity)
+			val updateResult = apiClient.createOrUpdateStorageData(updateRequest)
 			assertEquals(1, updateResult.updateCount)
 		}
 
-		val storageEntitiesRequest = StorageEntitiesRequest()
-		val storageEntitiesResult = apiClient.getAllStorageEntities(storageEntitiesRequest)
+		val storageEntitiesRequest = AllStorageDataRequest()
+		val storageEntitiesResult = apiClient.getAllStorageData(storageEntitiesRequest)
 		storageEntitiesResult.forEach { fetchedEntity ->
 			val updatedEntity = updatedEntities.find { it.key == fetchedEntity.key }
 			assertNotNull(updatedEntity)
 			assertEquals(updatedEntity, fetchedEntity.toUpdated())
 		}
 
 		updatedEntities.forEach { entity ->
-			val deleteRequest = StorageEntityDeleteRequest(entity.key)
-			val deleteResult = apiClient.deleteStorageEntity(deleteRequest)
+			val deleteRequest = StorageDataDeleteRequest(entity.key)
+			val deleteResult = apiClient.deleteStorageData(deleteRequest)
 			assertEquals(1, deleteResult.deleteCount)
 		}
 	}

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+package com.ecwid.apiclient.v3.dto.storage.result`
	`2`	`+`
	`3`	`+class AllStorageDataResult : ArrayList<FetchedStorageData>()`