mcm-cli 1.3.1__tar.gz → 1.4.0__tar.gz

{mcm_cli-1.3.1/mcm_cli.egg-info → mcm_cli-1.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mcm-cli
-Version: 1.3.1
+Version: 1.4.0
 Summary: A command-line interface for Moloco Commerde Media
 Home-page: https://github.com/moloco-mcm/mcm-cli
 Author: Moloco MCM Team

{mcm_cli-1.3.1 → mcm_cli-1.4.0/mcm_cli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mcm-cli
-Version: 1.3.1
+Version: 1.4.0
 Summary: A command-line interface for Moloco Commerde Media
 Home-page: https://github.com/moloco-mcm/mcm-cli
 Author: Moloco MCM Team

{mcm_cli-1.3.1 → mcm_cli-1.4.0}/mcm_cli.egg-info/SOURCES.txt

@@ -23,6 +23,7 @@ mcmcli/data/account_user.py
 mcmcli/data/decision.py
 mcmcli/data/error.py
 mcmcli/data/item.py
+mcmcli/data/item_blocking_result.py
 mcmcli/data/seller.py
 mcmcli/data/token.py
 mcmcli/data/wallet.py

{mcm_cli-1.3.1 → mcm_cli-1.4.0}/mcmcli/__main__.py

@@ -35,7 +35,7 @@ def version():
 	"""
 	Show the tool version
 	"""
-	typer.echo(f"Version: mcm-cli v1.3.1")
+	typer.echo(f"Version: mcm-cli v1.4.0")
 
 app.add_typer(mcmcli.command.account.app, name="account", help="Ad account management")
 app.add_typer(mcmcli.command.admin.app, name="admin", help="Platform administration")

{mcm_cli-1.3.1 → mcm_cli-1.4.0}/mcmcli/command/admin.py

@@ -11,6 +11,11 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
+from datetime import datetime, timedelta, timezone
+from mcmcli.data.error import Error
+from mcmcli.data.item_blocking_result import ItemBlockingResult
+from mcmcli.requests import CurlString, api_request
+from typing import Optional
 
 import mcmcli.command.account
 import mcmcli.command.auth
@@ -43,6 +48,35 @@ def list_wallet_balances(
     admin.list_wallet_balances()
 
 
+@app.command()
+def block_item(
+    item_id: str = typer.Option(help="Item ID"),
+    account_id: str = typer.Option(None, help="The Ad Account ID is applicable only for MSPI catalogs. If this value is provided, only the item associated with the specified seller ID will be removed from ad serving. If it is not provided, the specified item will be removed for all sellers in the MSPI catalog."),
+    to_curl: bool = typer.Option(False, help="Generate the curl command instead of executing it."),
+    profile: str = typer.Option("default", help="Profile name of the MCM CLI."),
+):
+    """
+    Item Kill Switch Command.
+    This API immediately blocks an item or an ad account item from appearing in ads by marking it as “blocked.”
+    """
+    timestamp = datetime.now(timezone.utc).strftime("%Y-%m-%dT%H:%M:%S.%fZ")
+
+    # print(f"invoked block_item(item_id={item_id}, account_id={account_id}, blocked='Requested at {timestamp}')");
+    admin = _create_admin_command(profile)
+    if admin is None:
+        return
+    
+    curl, error, result = admin.block_item(item_id=item_id, account_id=account_id, to_curl=to_curl)
+    if curl:
+        print(curl)
+        return
+    if error:
+        print(f"ERROR: {error.message}", file=sys.stderr, flush=True)
+        return
+    
+    print(result.model_dump_json())
+    return
+
 class AdminCommand:
     def __init__(
         self,
@@ -63,6 +97,36 @@ class AdminCommand:
             "Authorization": f"Bearer {token}"
         }
 
+    def block_item(
+        self,
+        item_id,
+        account_id,
+        to_curl,
+    ) -> tuple[
+        Optional[CurlString],
+        Optional[Error],
+        Optional[ItemBlockingResult],
+    ]:
+        _api_url = f"{self.api_base_url}/item-status-bulk"
+        _requested_at = datetime.now(timezone.utc).strftime("%Y-%m-%dT%H:%M:%S.%fZ")
+        _payload = { 
+            "items": [{
+                "item_id": item_id,
+                "seller_id": account_id,
+                "updated_time": _requested_at,
+                "blocked": f'Requested at {_requested_at}',
+            }]
+        }
+        if account_id is None:
+            del _payload["items"][0]["seller_id"]
+        
+        curl, error, json_obj = api_request('POST', to_curl, _api_url, self.headers, _payload)
+        if curl:
+            return curl, None, None
+        if error:
+            return None, error, None
+        return None, None, ItemBlockingResult(**json_obj)
+    
     def list_wallet_balances(
         self
     ):

mcm_cli-1.4.0/mcmcli/data/item_blocking_result.py

@@ -0,0 +1,54 @@
+# Copyright 2023 Moloco, Inc
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from pydantic import BaseModel
+from typing import Optional
+
+#
+# API response dataclasse of the item kill switch API
+#
+# The example response is as below:
+# {
+#   "success_items": [
+#     {
+#       "item_id": "item_1",
+#       "seller_id": "seller_1",
+#       "region": ""
+#     }
+#   ],
+#   "failure_items": [
+#     {
+#       "item_id": "item_2",
+#       "seller_id": "seller_2",
+#       "region": "",
+#       "message": "rpc error: code = Internal desc = ad account not found"
+#     }
+#   ]
+# }
+
+class SucceededItemBlockingAttempt(BaseModel):
+    item_id: str
+    seller_id: str
+    region: str
+
+class FailedItemBlockingAttempt(BaseModel):
+    item_id: str
+    seller_id: str
+    region: str
+    message: str
+
+
+class ItemBlockingResult(BaseModel):
+    success_items: list[SucceededItemBlockingAttempt]
+    failure_items: list[FailedItemBlockingAttempt]

{mcm_cli-1.3.1 → mcm_cli-1.4.0}/setup.py

@@ -18,7 +18,7 @@ from setuptools import setup, find_packages
 
 setup(
     name='mcm-cli',
-    version='1.3.1',
+    version='1.4.0',
     description='A command-line interface for Moloco Commerde Media',
     long_description=open('README.md').read(),
     long_description_content_type='text/markdown',