diff --git a/build.gradle b/build.gradle index e98812b..1bf1ad9 100644 --- a/build.gradle +++ b/build.gradle @@ -2,7 +2,7 @@ apply plugin: 'idea' apply plugin: 'eclipse' group = 'mobi.appcent' -version = '1.0.3' +version = '1.0.4' buildscript { repositories { diff --git a/docs/PricedProduct.md b/docs/PricedProduct.md index afbf876..83c2a1c 100644 --- a/docs/PricedProduct.md +++ b/docs/PricedProduct.md @@ -1,6 +1,6 @@ -# PricedProduct +# Product ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**pricedProductVariants** | [**List<PricedVariant>**](PricedVariant.md) | | [optional] +**ProductVariants** | [**List<PricedVariant>**](PricedVariant.md) | | [optional] diff --git a/docs/StoreProductsListRes.md b/docs/StoreProductsListRes.md index caef816..5d76853 100644 --- a/docs/StoreProductsListRes.md +++ b/docs/StoreProductsListRes.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**products** | [**List<PricedProduct>**](PricedProduct.md) | | [optional] +**products** | [**List<Product>**](Product.md) | | [optional] **count** | **Integer** | The total number of items available | [optional] **offset** | **Integer** | The number of items skipped before these items | [optional] **limit** | **Integer** | The number of items per page | [optional] diff --git a/docs/StoreProductsRes.md b/docs/StoreProductsRes.md index 7cb8949..a008e2a 100644 --- a/docs/StoreProductsRes.md +++ b/docs/StoreProductsRes.md @@ -3,4 +3,4 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**product** | [**PricedProduct**](PricedProduct.md) | | [optional] +**product** | [**Product**](Product.md) | | [optional] diff --git a/pom.xml b/pom.xml index 4f7a82f..2e1ad1b 100644 --- a/pom.xml +++ b/pom.xml @@ -4,7 +4,7 @@ mobi.appcent medusa-java-sdk - 1.0.3 + 1.0.4 medusa-java-sdk diff --git a/src/main/java/mobi/appcent/medusa/store/model/response/PricedProduct.java b/src/main/java/mobi/appcent/medusa/store/model/response/PricedProduct.java deleted file mode 100644 index 75a0596..0000000 --- a/src/main/java/mobi/appcent/medusa/store/model/response/PricedProduct.java +++ /dev/null @@ -1,99 +0,0 @@ -/* - * Medusa Storefront API - * API reference for Medusa's Storefront endpoints. All endpoints are prefixed with `/store`. ## Authentication To send requests as an authenticated customer, you must use the Cookie Session ID. ## Expanding Fields In many endpoints you'll find an `expand` query parameter that can be passed to the endpoint. You can use the `expand` query parameter to unpack an entity's relations and return them in the response. Please note that the relations you pass to `expand` replace any relations that are expanded by default in the request. ### Expanding One Relation For example, when you retrieve a product, you can retrieve its collection by passing to the `expand` query parameter the value `collection`: ```bash curl \"http://localhost:9000/store/products/prod_01GDJGP2XPQT2N3JHZQFMH5V45?expand=collection\" ``` ### Expanding Multiple Relations You can expand more than one relation by separating the relations in the `expand` query parameter with a comma. For example, to retrieve both the variants and the collection of a product, pass to the `expand` query parameter the value `variants,collection`: ```bash curl \"http://localhost:9000/store/products/prod_01GDJGP2XPQT2N3JHZQFMH5V45?expand=variants,collection\" ``` ### Prevent Expanding Relations Some requests expand relations by default. You can prevent that by passing an empty expand value to retrieve an entity without any extra relations. For example: ```bash curl \"http://localhost:9000/store/products/prod_01GDJGP2XPQT2N3JHZQFMH5V45?expand\" ``` This would retrieve the product with only its properties, without any relations like `collection`. ## Selecting Fields In many endpoints you'll find a `fields` query parameter that can be passed to the endpoint. You can use the `fields` query parameter to specify which fields in the entity should be returned in the response. Please note that if you pass a `fields` query parameter, only the fields you pass in the value along with the `id` of the entity will be returned in the response. Also, the `fields` query parameter does not affect the expanded relations. You'll have to use the `expand` parameter instead. ### Selecting One Field For example, when you retrieve a list of products, you can retrieve only the titles of the products by passing `title` as a value to the `fields` query parameter: ```bash curl \"http://localhost:9000/store/products?fields=title\" ``` As mentioned above, the expanded relations such as `variants` will still be returned as they're not affected by the `fields` parameter. You can ensure that only the `title` field is returned by passing an empty value to the `expand` query parameter. For example: ```bash curl \"http://localhost:9000/store/products?fields=title&expand\" ``` ### Selecting Multiple Fields You can pass more than one field by seperating the field names in the `fields` query parameter with a comma. For example, to select the `title` and `handle` of a product: ```bash curl \"http://localhost:9000/store/products?fields=title,handle\" ``` ### Retrieve Only the ID You can pass an empty `fields` query parameter to return only the ID of an entity. For example: ```bash curl \"http://localhost:9000/store/products?fields\" ``` You can also pair with an empty `expand` query parameter to ensure that the relations aren't retrieved as well. For example: ```bash curl \"http://localhost:9000/store/products?fields&expand\" ``` ## Query Parameter Types This section covers how to pass some common data types as query parameters. This is useful if you're sending requests to the API endpoints and not using our JS Client. For example, when using cURL or Postman. ### Strings You can pass a string value in the form of `=`. For example: ```bash curl \"http://localhost:9000/store/products?title=Shirt\" ``` If the string has any characters other than letters and numbers, you must encode them. For example, if the string has spaces, you can encode the space with `+` or `%20`: ```bash curl \"http://localhost:9000/store/products?title=Blue%20Shirt\" ``` You can use tools like [this one](https://www.urlencoder.org/) to learn how a value can be encoded. ### Integers You can pass an integer value in the form of `=`. For example: ```bash curl \"http://localhost:9000/store/products?offset=1\" ``` ### Boolean You can pass a boolean value in the form of `=`. For example: ```bash curl \"http://localhost:9000/store/products?is_giftcard=true\" ``` ### Date and DateTime You can pass a date value in the form `=`. The date must be in the format `YYYY-MM-DD`. For example: ```bash curl -g \"http://localhost:9000/store/products?created_at[lt]=2023-02-17\" ``` You can also pass the time using the format `YYYY-MM-DDTHH:MM:SSZ`. Please note that the `T` and `Z` here are fixed. For example: ```bash curl -g \"http://localhost:9000/store/products?created_at[lt]=2023-02-17T07:22:30Z\" ``` ### Array Each array value must be passed as a separate query parameter in the form `[]=`. You can also specify the index of each parameter in the brackets `[0]=`. For example: ```bash curl -g \"http://localhost:9000/store/products?sales_channel_id[]=sc_01GPGVB42PZ7N3YQEP2WDM7PC7&sales_channel_id[]=sc_234PGVB42PZ7N3YQEP2WDM7PC7\" ``` Note that the `-g` parameter passed to `curl` disables errors being thrown for using the brackets. Read more [here](https://curl.se/docs/manpage.html#-g). ### Object Object parameters must be passed as separate query parameters in the form `[]=`. For example: ```bash curl -g \"http://localhost:9000/store/products?created_at[lt]=2023-02-17&created_at[gt]=2022-09-17\" ``` ## Pagination ### Query Parameters In listing endpoints, such as list customers or list products, you can control the pagination using the query parameters `limit` and `offset`. `limit` is used to specify the maximum number of items that can be return in the response. `offset` is used to specify how many items to skip before returning the resulting entities. You can use the `offset` query parameter to change between pages. For example, if the limit is 50, at page 1 the offset should be 0; at page 2 the offset should be 50, and so on. For example, to limit the number of products returned in the List Products endpoint: ```bash curl \"http://localhost:9000/store/products?limit=5\" ``` ### Response Fields In the response of listing endpoints, aside from the entities retrieved, there are three pagination-related fields returned: `count`, `limit`, and `offset`. Similar to the query parameters, `limit` is the maximum number of items that can be returned in the response, and `field` is the number of items that were skipped before the entities in the result. `count` is the total number of available items of this entity. It can be used to determine how many pages are there. For example, if the `count` is 100 and the `limit` is 50, you can divide the `count` by the `limit` to get the number of pages: `100/50 = 2 pages`. - * - * OpenAPI spec version: 1.0.0 - * - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * Do not edit the class manually. - */ - -package mobi.appcent.medusa.store.model.response; - -import java.util.Objects; - -import com.google.gson.annotations.SerializedName; -import io.swagger.v3.oas.annotations.media.Schema; - -import java.util.ArrayList; -import java.util.List; - -/** - * PricedProduct - */ - -@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2023-02-24T12:45:51.835798768Z[GMT]") -public class PricedProduct extends Product { - @SerializedName("variants") - private List pricedProductVariants = null; - - public PricedProduct pricedProductVariants(List pricedProductVariants) { - this.pricedProductVariants = pricedProductVariants; - return this; - } - - public PricedProduct addPricedProductVariantsItem(PricedVariant pricedProductVariantsItem) { - if (this.pricedProductVariants == null) { - this.pricedProductVariants = new ArrayList(); - } - this.pricedProductVariants.add(pricedProductVariantsItem); - return this; - } - - /** - * Get pricedProductVariants - * @return pricedProductVariants - **/ - @Schema(description = "") - public List getPricedProductVariants() { - return pricedProductVariants; - } - - public void setPricedProductVariants(List pricedProductVariants) { - this.pricedProductVariants = pricedProductVariants; - } - - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - PricedProduct pricedProduct = (PricedProduct) o; - return Objects.equals(this.pricedProductVariants, pricedProduct.pricedProductVariants) && - super.equals(o); - } - - @Override - public int hashCode() { - return Objects.hash(pricedProductVariants, super.hashCode()); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class PricedProduct {\n"); - sb.append(" ").append(toIndentedString(super.toString())).append("\n"); - sb.append(" pricedProductVariants: ").append(toIndentedString(pricedProductVariants)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} diff --git a/src/main/java/mobi/appcent/medusa/store/model/response/StoreProductsListRes.java b/src/main/java/mobi/appcent/medusa/store/model/response/StoreProductsListRes.java index 27f3e49..8fbd5f2 100644 --- a/src/main/java/mobi/appcent/medusa/store/model/response/StoreProductsListRes.java +++ b/src/main/java/mobi/appcent/medusa/store/model/response/StoreProductsListRes.java @@ -26,7 +26,7 @@ @javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2023-02-24T12:45:51.835798768Z[GMT]") public class StoreProductsListRes { @SerializedName("products") - private List products = null; + private List products = null; @SerializedName("count") private Integer count = null; @@ -37,14 +37,14 @@ public class StoreProductsListRes { @SerializedName("limit") private Integer limit = null; - public StoreProductsListRes products(List products) { + public StoreProductsListRes products(List products) { this.products = products; return this; } - public StoreProductsListRes addProductsItem(PricedProduct productsItem) { + public StoreProductsListRes addProductsItem(Product productsItem) { if (this.products == null) { - this.products = new ArrayList(); + this.products = new ArrayList(); } this.products.add(productsItem); return this; @@ -55,11 +55,11 @@ public StoreProductsListRes addProductsItem(PricedProduct productsItem) { * @return products **/ @Schema(description = "") - public List getProducts() { + public List getProducts() { return products; } - public void setProducts(List products) { + public void setProducts(List products) { this.products = products; } diff --git a/src/main/java/mobi/appcent/medusa/store/model/response/StoreProductsRes.java b/src/main/java/mobi/appcent/medusa/store/model/response/StoreProductsRes.java index c062c10..ad4380a 100644 --- a/src/main/java/mobi/appcent/medusa/store/model/response/StoreProductsRes.java +++ b/src/main/java/mobi/appcent/medusa/store/model/response/StoreProductsRes.java @@ -24,9 +24,9 @@ @javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.JavaClientCodegen", date = "2023-02-24T12:45:51.835798768Z[GMT]") public class StoreProductsRes { @SerializedName("product") - private PricedProduct product = null; + private Product product = null; - public StoreProductsRes product(PricedProduct product) { + public StoreProductsRes product(Product product) { this.product = product; return this; } @@ -36,11 +36,11 @@ public StoreProductsRes product(PricedProduct product) { * @return product **/ @Schema(description = "") - public PricedProduct getProduct() { + public Product getProduct() { return product; } - public void setProduct(PricedProduct product) { + public void setProduct(Product product) { this.product = product; }