Skip to content

Commit edb33cd

Browse files
integrationsegoiintegrationsegoi
committed
Version: 1.1.7RC1
1 parent 26e04f5 commit edb33cd

17 files changed

Lines changed: 1030 additions & 40 deletions

‎README.md‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
11
![E-goi](https://www.e-goi.com/wp-content/themes/egoi2019/imgs/svg/logo-egoi.svg)
22

3+
Get started quickly with E-goi with our integration tools. Our SDK is a modern open source library that makes it easy to integrate your application with E-goi services.
4+
35
Almost anything you can do in E-goi, you can do with our API.
46

57
The API describes each available method. Learn about parameters, errors, and how to format your requests. That means you can easily call on E-goi actions for your integration.
68
**API** Full documentation at https://developers.e-goi.com/api/v3/
79

8-
If you find a bug or something worth fixing, create an issue.
10+
**Note:** This repository is currently in **Release Candidate** stage. Use with caution in production environments.
11+
12+
Feel free to **fork this repository** and adapt it to your needs. Contributions and improvements are always welcome!
913

1014
### Changelog
11-
#### 1.1.6RC1
15+
#### 1.1.7RC1
1216
## Requirements.
1317

1418
Python >=3.7
@@ -646,6 +650,7 @@ Class | Method | HTTP request | Description
646650
- [OperationActionResponse](docs/models/OperationActionResponse.md)
647651
- [Order](docs/models/Order.md)
648652
- [OrderPatchRequest](docs/models/OrderPatchRequest.md)
653+
- [OrderProduct](docs/models/OrderProduct.md)
649654
- [Overall](docs/models/Overall.md)
650655
- [PatchRequestBaseField](docs/models/PatchRequestBaseField.md)
651656
- [PatchRequestField](docs/models/PatchRequestField.md)

‎docs/apis/tags/EcommerceApi.md‎

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -512,9 +512,39 @@ with egoi_api.ApiClient(configuration) as api_client:
512512
order_total=1,
513513
order_id="100",
514514
cart_id="cart1",
515+
order_date="1970-01-01T00:00:00.00Z",
516+
order_status="unknown",
515517
contact=dict(),
516518
products=[
517-
Product()
519+
OrderProduct(
520+
product_identifier="-",
521+
catalog_id=Id(1),
522+
name="Product name",
523+
description="Product description",
524+
sku="sku_example",
525+
upc="upc_example",
526+
ean="ean_example",
527+
gtin="gtin_example",
528+
mpn="mpn_example",
529+
link="link_example",
530+
image_link="image_link_example",
531+
price=10,
532+
sale_price=10,
533+
brand="brand_example",
534+
quantity=0,
535+
categories=[
536+
"Clothing>Women>Blue Jeans"
537+
],
538+
related_products=[
539+
"related_products_example"
540+
],
541+
custom_attributes=[
542+
ProductCustomAttributes(
543+
alias="sale_price_5",
544+
value="15.45",
545+
)
546+
],
547+
)
518548
],
519549
)
520550
try:
@@ -2212,6 +2242,7 @@ with egoi_api.ApiClient(configuration) as api_client:
22122242
body = ImportOrdersBulk([
22132243
ImportOrdersBulkBulkRequest(
22142244
order_id="100",
2245+
order_status="unknown",
22152246
contact_id="customer@e-goi.com",
22162247
revenue=100,
22172248
store_url="https://www.e-goi.com",

‎docs/models/CreateOrder.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ Key | Input Type | Accessed Type | Description | Notes
1313
**order_id** | str, | str, | Order ID is any non-empty unique string |
1414
**order_total** | decimal.Decimal, int, float, | decimal.Decimal, | Ecommerce cart total | [optional] value must be a 64 bit float
1515
**cart_id** | str, | str, | Cart ID that originated this order | [optional]
16+
**order_date** | str, datetime, | str, | Date and hour of the order | [optional] value must conform to RFC-3339 date-time
17+
**order_status** | str, | str, | Status of the order | [optional] must be one of ["created", "pending", "canceled", "completed", "unknown", ] if omitted the server will use the default value of "unknown"
1618
**[contact](#contact)** | dict, frozendict.frozendict, | frozendict.frozendict, | Contact | [optional]
1719
**[products](#products)** | list, tuple, | tuple, | List of products | [optional]
1820
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
@@ -44,7 +46,7 @@ list, tuple, | tuple, | List of products |
4446
### Tuple Items
4547
Class Name | Input Type | Accessed Type | Description | Notes
4648
------------- | ------------- | ------------- | ------------- | -------------
47-
[**Product**](Product.md) | [**Product**](Product.md) | [**Product**](Product.md) | |
49+
[**OrderProduct**](OrderProduct.md) | [**OrderProduct**](OrderProduct.md) | [**OrderProduct**](OrderProduct.md) | |
4850

4951
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
5052

‎docs/models/ImportOrdersBulkBulkRequest.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,12 @@ dict, frozendict.frozendict, | frozendict.frozendict, | Order data |
1111
Key | Input Type | Accessed Type | Description | Notes
1212
------------ | ------------- | ------------- | ------------- | -------------
1313
**[date](#date)** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | Ecommerce order date (For technical reasons, all orders synchronized will have the date of synchronization.) |
14-
**revenue** | decimal.Decimal, int, float, | decimal.Decimal, | Ecommerce order revenue |
14+
**revenue** | decimal.Decimal, int, float, | decimal.Decimal, | Ecommerce order revenue. Must be greater than 0. |
15+
**contact_id** | str, | str, | Contact ID is any non-empty unique string identifying the user (such as an email address or e-goi uid) |
1516
**[items](#items)** | list, tuple, | tuple, | Array of ordered products |
1617
**order_id** | str, | str, | Ecommerce order id |
1718
**store_url** | str, | str, | Ecommerce store url |
18-
**contact_id** | str, | str, | Contact ID is any non-empty unique string identifying the user (such as an email address or e-goi uid) | [optional]
19+
**order_status** | str, | str, | Status of the order | [optional] must be one of ["created", "pending", "canceled", "completed", "unknown", ] if omitted the server will use the default value of "unknown"
1920
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
2021

2122
# date

‎docs/models/OrderProduct.md‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# egoi_api.model.order_product.OrderProduct
2+
3+
Order Product schema
4+
5+
## Model Type Info
6+
Input Type | Accessed Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
dict, frozendict.frozendict, | frozendict.frozendict, | Order Product schema |
9+
10+
### Dictionary Keys
11+
Key | Input Type | Accessed Type | Description | Notes
12+
------------ | ------------- | ------------- | ------------- | -------------
13+
**product_identifier** | str, | str, | The ID of the product in your store | [optional]
14+
**catalog_id** | [**Id**](Id.md) | [**Id**](Id.md) | | [optional]
15+
**name** | str, | str, | Name of the product | [optional]
16+
**description** | str, | str, | Description of the product | [optional]
17+
**sku** | str, | str, | Stock Keeping Unit | [optional]
18+
**upc** | str, | str, | Universal Product Code | [optional]
19+
**ean** | str, | str, | European Article Numbering | [optional]
20+
**gtin** | str, | str, | Global Trade Item Number | [optional]
21+
**mpn** | str, | str, | Manufacturer Part Number | [optional]
22+
**link** | str, | str, | Link for the product | [optional]
23+
**image_link** | str, | str, | Link for the product image | [optional]
24+
**price** | decimal.Decimal, int, float, | decimal.Decimal, | Price of the product | [optional] if omitted the server will use the default value of 0value must be a 64 bit float
25+
**sale_price** | decimal.Decimal, int, float, | decimal.Decimal, | Sale price of the product | [optional] if omitted the server will use the default value of 0value must be a 64 bit float
26+
**brand** | str, | str, | Brand of the product | [optional]
27+
**quantity** | decimal.Decimal, int, float, | decimal.Decimal, | Quantity of the product | [optional] if omitted the server will use the default value of 0value must be a 64 bit float
28+
**[categories](#categories)** | list, tuple, | tuple, | Array of product categories, using the character '>' as delimiter for the breadcrumb syntax | [optional]
29+
**[related_products](#related_products)** | list, tuple, | tuple, | Related products, array of 'product_identifier' | [optional]
30+
**[custom_attributes](#custom_attributes)** | list, tuple, | tuple, | Custom attributes | [optional]
31+
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
32+
33+
# categories
34+
35+
Array of product categories, using the character '>' as delimiter for the breadcrumb syntax
36+
37+
## Model Type Info
38+
Input Type | Accessed Type | Description | Notes
39+
------------ | ------------- | ------------- | -------------
40+
list, tuple, | tuple, | Array of product categories, using the character '>' as delimiter for the breadcrumb syntax |
41+
42+
### Tuple Items
43+
Class Name | Input Type | Accessed Type | Description | Notes
44+
------------- | ------------- | ------------- | ------------- | -------------
45+
items | str, | str, | |
46+
47+
# related_products
48+
49+
Related products, array of 'product_identifier'
50+
51+
## Model Type Info
52+
Input Type | Accessed Type | Description | Notes
53+
------------ | ------------- | ------------- | -------------
54+
list, tuple, | tuple, | Related products, array of 'product_identifier' |
55+
56+
### Tuple Items
57+
Class Name | Input Type | Accessed Type | Description | Notes
58+
------------- | ------------- | ------------- | ------------- | -------------
59+
items | str, | str, | |
60+
61+
# custom_attributes
62+
63+
Custom attributes
64+
65+
## Model Type Info
66+
Input Type | Accessed Type | Description | Notes
67+
------------ | ------------- | ------------- | -------------
68+
list, tuple, | tuple, | Custom attributes |
69+
70+
### Tuple Items
71+
Class Name | Input Type | Accessed Type | Description | Notes
72+
------------- | ------------- | ------------- | ------------- | -------------
73+
[**ProductCustomAttributes**](ProductCustomAttributes.md) | [**ProductCustomAttributes**](ProductCustomAttributes.md) | [**ProductCustomAttributes**](ProductCustomAttributes.md) | |
74+
75+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
76+

‎egoi_api/__init__.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
Generated by: https://openapi-generator.tech
1212
"""
1313

14-
__version__ = "1.1.6RC1"
14+
__version__ = "1.1.7RC1"
1515

1616
# import ApiClient
1717
from egoi_api.api_client import ApiClient

‎egoi_api/api_client.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1003,7 +1003,7 @@ def __init__(
10031003
self.default_headers[header_name] = header_value
10041004
self.cookie = cookie
10051005
# Set default User-Agent.
1006-
self.user_agent = 'OpenAPI-Generator/1.1.6RC1/python'
1006+
self.user_agent = 'OpenAPI-Generator/1.1.7RC1/python'
10071007

10081008
def __enter__(self):
10091009
return self

‎egoi_api/configuration.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -403,7 +403,7 @@ def to_debug_report(self):
403403
"OS: {env}\n"\
404404
"Python Version: {pyversion}\n"\
405405
"Version of the API: V3\n"\
406-
"SDK Package Version: 1.1.6RC1".\
406+
"SDK Package Version: 1.1.7RC1".\
407407
format(env=sys.platform, pyversion=sys.version)
408408

409409
def get_host_settings(self):

‎egoi_api/model/create_order.py‎

Lines changed: 62 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,43 @@ class properties:
4444
order_id = schemas.StrSchema
4545
order_total = schemas.Float64Schema
4646
cart_id = schemas.StrSchema
47+
order_date = schemas.DateTimeSchema
48+
49+
50+
class order_status(
51+
schemas.EnumBase,
52+
schemas.StrSchema
53+
):
54+
55+
56+
class MetaOapg:
57+
enum_value_to_name = {
58+
"created": "CREATED",
59+
"pending": "PENDING",
60+
"canceled": "CANCELED",
61+
"completed": "COMPLETED",
62+
"unknown": "UNKNOWN",
63+
}
64+
65+
@schemas.classproperty
66+
def CREATED(cls):
67+
return cls("created")
68+
69+
@schemas.classproperty
70+
def PENDING(cls):
71+
return cls("pending")
72+
73+
@schemas.classproperty
74+
def CANCELED(cls):
75+
return cls("canceled")
76+
77+
@schemas.classproperty
78+
def COMPLETED(cls):
79+
return cls("completed")
80+
81+
@schemas.classproperty
82+
def UNKNOWN(cls):
83+
return cls("unknown")
4784

4885

4986
class contact(
@@ -91,12 +128,12 @@ class products(
91128
class MetaOapg:
92129

93130
@staticmethod
94-
def items() -> typing.Type['Product']:
95-
return Product
131+
def items() -> typing.Type['OrderProduct']:
132+
return OrderProduct
96133

97134
def __new__(
98135
cls,
99-
arg: typing.Union[typing.Tuple['Product'], typing.List['Product']],
136+
arg: typing.Union[typing.Tuple['OrderProduct'], typing.List['OrderProduct']],
100137
_configuration: typing.Optional[schemas.Configuration] = None,
101138
) -> 'products':
102139
return super().__new__(
@@ -105,12 +142,14 @@ def __new__(
105142
_configuration=_configuration,
106143
)
107144

108-
def __getitem__(self, i: int) -> 'Product':
145+
def __getitem__(self, i: int) -> 'OrderProduct':
109146
return super().__getitem__(i)
110147
__annotations__ = {
111148
"order_id": order_id,
112149
"order_total": order_total,
113150
"cart_id": cart_id,
151+
"order_date": order_date,
152+
"order_status": order_status,
114153
"contact": contact,
115154
"products": products,
116155
}
@@ -126,6 +165,12 @@ def __getitem__(self, name: typing_extensions.Literal["order_total"]) -> MetaOap
126165
@typing.overload
127166
def __getitem__(self, name: typing_extensions.Literal["cart_id"]) -> MetaOapg.properties.cart_id: ...
128167

168+
@typing.overload
169+
def __getitem__(self, name: typing_extensions.Literal["order_date"]) -> MetaOapg.properties.order_date: ...
170+
171+
@typing.overload
172+
def __getitem__(self, name: typing_extensions.Literal["order_status"]) -> MetaOapg.properties.order_status: ...
173+
129174
@typing.overload
130175
def __getitem__(self, name: typing_extensions.Literal["contact"]) -> MetaOapg.properties.contact: ...
131176

@@ -135,7 +180,7 @@ def __getitem__(self, name: typing_extensions.Literal["products"]) -> MetaOapg.p
135180
@typing.overload
136181
def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ...
137182

138-
def __getitem__(self, name: typing.Union[typing_extensions.Literal["order_id", "order_total", "cart_id", "contact", "products", ], str]):
183+
def __getitem__(self, name: typing.Union[typing_extensions.Literal["order_id", "order_total", "cart_id", "order_date", "order_status", "contact", "products", ], str]):
139184
# dict_instance[name] accessor
140185
return super().__getitem__(name)
141186

@@ -149,6 +194,12 @@ def get_item_oapg(self, name: typing_extensions.Literal["order_total"]) -> typin
149194
@typing.overload
150195
def get_item_oapg(self, name: typing_extensions.Literal["cart_id"]) -> typing.Union[MetaOapg.properties.cart_id, schemas.Unset]: ...
151196

197+
@typing.overload
198+
def get_item_oapg(self, name: typing_extensions.Literal["order_date"]) -> typing.Union[MetaOapg.properties.order_date, schemas.Unset]: ...
199+
200+
@typing.overload
201+
def get_item_oapg(self, name: typing_extensions.Literal["order_status"]) -> typing.Union[MetaOapg.properties.order_status, schemas.Unset]: ...
202+
152203
@typing.overload
153204
def get_item_oapg(self, name: typing_extensions.Literal["contact"]) -> typing.Union[MetaOapg.properties.contact, schemas.Unset]: ...
154205

@@ -158,7 +209,7 @@ def get_item_oapg(self, name: typing_extensions.Literal["products"]) -> typing.U
158209
@typing.overload
159210
def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ...
160211

161-
def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["order_id", "order_total", "cart_id", "contact", "products", ], str]):
212+
def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["order_id", "order_total", "cart_id", "order_date", "order_status", "contact", "products", ], str]):
162213
return super().get_item_oapg(name)
163214

164215

@@ -168,6 +219,8 @@ def __new__(
168219
order_id: typing.Union[MetaOapg.properties.order_id, str, ],
169220
order_total: typing.Union[MetaOapg.properties.order_total, decimal.Decimal, int, float, schemas.Unset] = schemas.unset,
170221
cart_id: typing.Union[MetaOapg.properties.cart_id, str, schemas.Unset] = schemas.unset,
222+
order_date: typing.Union[MetaOapg.properties.order_date, str, datetime, schemas.Unset] = schemas.unset,
223+
order_status: typing.Union[MetaOapg.properties.order_status, str, schemas.Unset] = schemas.unset,
171224
contact: typing.Union[MetaOapg.properties.contact, dict, frozendict.frozendict, schemas.Unset] = schemas.unset,
172225
products: typing.Union[MetaOapg.properties.products, list, tuple, schemas.Unset] = schemas.unset,
173226
_configuration: typing.Optional[schemas.Configuration] = None,
@@ -179,11 +232,13 @@ def __new__(
179232
order_id=order_id,
180233
order_total=order_total,
181234
cart_id=cart_id,
235+
order_date=order_date,
236+
order_status=order_status,
182237
contact=contact,
183238
products=products,
184239
_configuration=_configuration,
185240
**kwargs,
186241
)
187242

188243
from egoi_api.model.contact_base_extra_full import ContactBaseExtraFull
189-
from egoi_api.model.product import Product
244+
from egoi_api.model.order_product import OrderProduct

0 commit comments

Comments
 (0)