Automatically generate the services files

Author: mvantellingen

src/commercetools/services/__init__.py

@@ -4,14 +4,14 @@
 from commercetools.services.carts import CartService
 from commercetools.services.categories import CategoryService
 from commercetools.services.channels import ChannelService
-from commercetools.services.custom_object import CustomObjectService
+from commercetools.services.custom_objects import CustomObjectService
 from commercetools.services.customer_groups import CustomerGroupService
 from commercetools.services.customers import CustomerService
 from commercetools.services.discount_codes import DiscountCodeService
 from commercetools.services.extensions import ExtensionService
 from commercetools.services.graphqls import GraphqlService
 from commercetools.services.in_stores import In_StoreService
-from commercetools.services.inventory_entries import InventoryEntryService
+from commercetools.services.inventory import InventoryEntryService
 from commercetools.services.login import LoginService
 from commercetools.services.me import MeService
 from commercetools.services.messages import MessageService
@@ -21,6 +21,7 @@
 from commercetools.services.product_projections import ProductProjectionService
 from commercetools.services.product_types import ProductTypeService
 from commercetools.services.products import ProductService
+from commercetools.services.project import ProjectService
 from commercetools.services.reviews import ReviewService
 from commercetools.services.shipping_methods import ShippingMethodService
 from commercetools.services.shopping_lists import ShoppingListService
@@ -32,68 +33,70 @@
 from commercetools.services.zones import ZoneService
 
 
-class ServiceMixin:
-    category: CategoryService
+class ServicesMixin:
+    api_client: ApiClientService
     cart: CartService
     cart_discount: CartDiscountService
+    category: CategoryService
     channel: ChannelService
+    custom_object: CustomObjectService
     customer: CustomerService
     customer_group: CustomerGroupService
-    custom_object: CustomObjectService
     discount_code: DiscountCodeService
+    extension: ExtensionService
     graphql: GraphqlService
+    in_store: In_StoreService
     inventory_entry: InventoryEntryService
     login: LoginService
+    me: MeService
     message: MessageService
     order: OrderService
     payment: PaymentService
     product: ProductService
     product_discount: ProductDiscountService
     product_projection: ProductProjectionService
     product_type: ProductTypeService
+    project: ProjectService
     review: ReviewService
     shipping_method: ShippingMethodService
     shopping_list: ShoppingListService
     state: StateService
+    store: StoreService
     subscription: SubscriptionService
     tax_category: TaxCategoryService
     type: TypeService
     zone: ZoneService
-    me: MeService
-    extension: ExtensionService
-    api_client: ApiClientService
-    store: StoreService
-    in_store: In_StoreService
 
     def register_services(self):
-        self.category = CategoryService(self)
-        self.cart = CartService(self)
-        self.cart_discount = CartDiscountService(self)
-        self.channel = ChannelService(self)
-        self.customer = CustomerService(self)
-        self.customer_group = CustomerGroupService(self)
-        self.custom_object = CustomObjectService(self)
-        self.discount_code = DiscountCodeService(self)
-        self.graphql = GraphqlService(self)
-        self.inventory_entry = InventoryEntryService(self)
+        self.api_clients = ApiClientService(self)
+        self.carts = CartService(self)
+        self.cart_discounts = CartDiscountService(self)
+        self.categories = CategoryService(self)
+        self.channels = ChannelService(self)
+        self.custom_objects = CustomObjectService(self)
+        self.customers = CustomerService(self)
+        self.customer_groups = CustomerGroupService(self)
+        self.discount_codes = DiscountCodeService(self)
+        self.extensions = ExtensionService(self)
+        self.graphqls = GraphqlService(self)
+        self.in_stores = In_StoreService(self)
+        self.inventory = InventoryEntryService(self)
         self.login = LoginService(self)
-        self.message = MessageService(self)
-        self.order = OrderService(self)
-        self.payment = PaymentService(self)
-        self.product = ProductService(self)
-        self.product_discount = ProductDiscountService(self)
-        self.product_projection = ProductProjectionService(self)
-        self.product_type = ProductTypeService(self)
-        self.review = ReviewService(self)
-        self.shipping_method = ShippingMethodService(self)
-        self.shopping_list = ShoppingListService(self)
-        self.state = StateService(self)
-        self.subscription = SubscriptionService(self)
-        self.tax_category = TaxCategoryService(self)
-        self.type = TypeService(self)
-        self.zone = ZoneService(self)
         self.me = MeService(self)
-        self.extension = ExtensionService(self)
-        self.api_client = ApiClientService(self)
-        self.store = StoreService(self)
-        self.in_store = In_StoreService(self)
+        self.messages = MessageService(self)
+        self.orders = OrderService(self)
+        self.payments = PaymentService(self)
+        self.products = ProductService(self)
+        self.product_discounts = ProductDiscountService(self)
+        self.product_projections = ProductProjectionService(self)
+        self.product_types = ProductTypeService(self)
+        self.project = ProjectService(self)
+        self.reviews = ReviewService(self)
+        self.shipping_methods = ShippingMethodService(self)
+        self.shopping_lists = ShoppingListService(self)
+        self.states = StateService(self)
+        self.stores = StoreService(self)
+        self.subscriptions = SubscriptionService(self)
+        self.tax_categories = TaxCategoryService(self)
+        self.types = TypeService(self)
+        self.zones = ZoneService(self)

src/commercetools/services/api_clients.py

@@ -1,59 +1,88 @@
+# DO NOT EDIT! This file is automatically generated
 import typing
-from typing import Optional
 
 from commercetools import schemas, types
-from commercetools.services import abstract
+from commercetools.services import abstract, traits
 from commercetools.typing import OptionalListStr
 
-__all__ = ["ApiClientService"]
 
-
-class ApiClientDeleteSchema(abstract.AbstractDeleteSchema):
+class _ApiClientQuerySchema(
+    traits.ExpandableSchema,
+    traits.SortableSchema,
+    traits.PagingSchema,
+    traits.QuerySchema,
+):
     pass
 
 
-class ApiClientQuerySchema(abstract.AbstractQuerySchema):
-    pass
+class ApiClientService(abstract.AbstractService):
+    """Manage your API Clients via an API.
 
+    Useful for Infrastructure-as-Code tooling, and regularly rotating API secrets.
+    """
 
-class ApiClientService(abstract.AbstractService):
-    def get_by_id(self, id: str) -> types.ApiClient:
-        return self._client._get(f"api-clients/{id}", {}, schemas.ApiClientSchemaSchema)
+    def get_by_id(self, id) -> types.ApiClient:
+        """Get ApiClient by ID"""
+        params = {}
+        return self._client._get(
+            endpoint=f"api-clients/{id}",
+            params=params,
+            schema_cls=schemas.ApiClientSchema,
+        )
 
     def query(
         self,
-        where: OptionalListStr = None,
+        *,
+        expand: OptionalListStr = None,
         sort: OptionalListStr = None,
-        expand: typing.Optional[str] = None,
-        limit: typing.Optional[int] = None,
-        offset: typing.Optional[int] = None,
+        limit: int = None,
+        offset: int = None,
+        with_total: bool = None,
+        where: OptionalListStr = None,
+        predicate_var: typing.Dict[str, str] = None,
     ) -> types.ApiClientPagedQueryResponse:
-        params = ApiClientQuerySchema().dump(
+        """Manage your API Clients via an API. Useful for Infrastructure-as-Code
+        tooling, and regularly rotating API secrets.
+        """
+        params = self._serialize_params(
             {
-                "where": where,
-                "sort": sort,
                 "expand": expand,
+                "sort": sort,
                 "limit": limit,
                 "offset": offset,
-            }
+                "withTotal": with_total,
+                "where": where,
+                "predicate_var": predicate_var,
+            },
+            _ApiClientQuerySchema,
         )
         return self._client._get(
-            "api-clients", params, schemas.ApiClientPagedQueryResponseSchema
+            endpoint="api-clients",
+            params=params,
+            schema_cls=schemas.ApiClientPagedQueryResponseSchema,
         )
 
-    def create(self, draft: types.ApiClientDraft) -> types.ApiClient:
+    def create(
+        self, draft: types.ApiClientDraft, *, expand: OptionalListStr = None
+    ) -> types.ApiClient:
+        """Manage your API Clients via an API. Useful for Infrastructure-as-Code
+        tooling, and regularly rotating API secrets.
+        """
+        params = self._serialize_params({"expand": expand}, traits.ExpandableSchema)
         return self._client._post(
-            "api-clients",
-            {},
-            draft,
-            schemas.ApiClientDraftSchema,
-            schemas.ApiClientSchema,
+            endpoint="api-clients",
+            params=params,
+            data_object=draft,
+            request_schema_cls=schemas.ApiClientDraftSchema,
+            response_schema_cls=schemas.ApiClientSchema,
         )
 
-    def delete_by_id(self, id: str, *, force_delete: bool = False) -> types.ApiClient:
+    def delete_by_id(self, id, *, force_delete: bool = False) -> types.ApiClient:
+        """Delete ApiClient by ID"""
+        params = {}
         return self._client._delete(
             endpoint=f"api-clients/{id}",
-            params={},
+            params=params,
             response_schema_cls=schemas.ApiClientSchema,
             force_delete=force_delete,
         )