com.ecwid.apiclient.v3.ProductsApiClient.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of api-client Show documentation
Ecwid Rest API wrapper
There is a newer version: 0.347.0
package com.ecwid.apiclient.v3

import com.ecwid.apiclient.v3.dto.common.PagingResult
import com.ecwid.apiclient.v3.dto.common.PartialResult
import com.ecwid.apiclient.v3.dto.product.request.*
import com.ecwid.apiclient.v3.dto.product.result.*
import kotlin.reflect.KClass

// Products
// https://developers.ecwid.com/api-documentation/products
interface ProductsApiClient {
	fun searchProducts(request: ProductsSearchRequest.ByFilters): ProductsSearchResult
	fun  searchProducts(request: ProductsSearchRequest.ByFilters, resultClass: KClass): Result
		where Result : PartialResult

	fun searchProducts(request: ProductsSearchRequest.ByIds): ProductsSearchResult
	fun  searchProducts(request: ProductsSearchRequest.ByIds, resultClass: KClass): Result
		where Result : PartialResult

	fun searchProductsAsSequence(request: ProductsSearchRequest.ByFilters): Sequence
	fun  searchProductsAsSequence(request: ProductsSearchRequest.ByFilters, resultClass: KClass): Sequence
		where Result : PartialResult, Result : PagingResult

	fun searchProductsAsSequence(request: ProductsSearchRequest.ByIds): Sequence

	fun getProductDetails(request: ProductDetailsRequest): FetchedProduct
	fun  getProductDetails(request: ProductDetailsRequest, resultClass: KClass): Result
		where Result : PartialResult

	fun createProduct(request: ProductCreateRequest): ProductCreateResult
	fun updateProduct(request: ProductUpdateRequest): ProductUpdateResult
	fun updateProductInventory(request: ProductInventoryUpdateRequest): ProductInventoryUpdateResult
	fun getProductFilters(request: GetProductFiltersRequest): GetProductFiltersResult
	fun deleteProduct(request: ProductDeleteRequest): ProductDeleteResult
	fun uploadProductImage(request: ProductImageUploadRequest): ProductImageUploadResult
	fun uploadProductImageAsync(request: ProductImageAsyncUploadRequest): ProductImageAsyncUploadResult
	fun deleteProductImage(request: ProductImageDeleteRequest): ProductImageDeleteResult
	fun uploadProductGalleryImage(request: ProductGalleryImageUploadRequest): ProductGalleryImageUploadResult
	fun uploadProductGalleryImageAsync(request: ProductGalleryImageAsyncUploadRequest): ProductGalleryImageAsyncUploadResult
	fun deleteProductGalleryImage(request: ProductGalleryImageDeleteRequest): ProductGalleryImageDeleteResult
	fun deleteProductGalleryImages(request: ProductGalleryImagesDeleteRequest): ProductGalleryImagesDeleteResult
	fun downloadProductFile(request: ProductFileDownloadRequest): ByteArray
	fun uploadProductFile(request: ProductFileUploadRequest): ProductFileUploadResult
	fun updateProductFile(request: ProductFileUpdateRequest): ProductFileUpdateResult
	fun deleteProductFile(request: ProductFileDeleteRequest): ProductFileDeleteResult
	fun deleteProductFiles(request: ProductFilesDeleteRequest): ProductFilesDeleteResult
	fun searchDeletedProducts(request: DeletedProductsSearchRequest): DeletedProductsSearchResult
	fun searchDeletedProductsAsSequence(request: DeletedProductsSearchRequest): Sequence
}

@Suppress("EXTENSION_SHADOWED_BY_MEMBER")
inline fun > ProductsApiClient.getProductDetails(request: ProductDetailsRequest): Result {
	return getProductDetails(request, Result::class)
}

@Suppress("EXTENSION_SHADOWED_BY_MEMBER")
inline fun > ProductsApiClient.searchProducts(request: ProductsSearchRequest.ByIds): Result {
	return searchProducts(request, Result::class)
}

@Suppress("EXTENSION_SHADOWED_BY_MEMBER")
inline fun > ProductsApiClient.searchProducts(request: ProductsSearchRequest.ByFilters): Result {
	return searchProducts(request, Result::class)
}

@Suppress("EXTENSION_SHADOWED_BY_MEMBER")
inline fun  ProductsApiClient.searchProductsAsSequence(
	request: ProductsSearchRequest.ByFilters
): Sequence where Result : PartialResult, Result : PagingResult {
	return searchProductsAsSequence(request, Result::class)
}