mcm-cli 1.1.0__tar.gz → 1.3.0__tar.gz

{mcm_cli-1.1.0/mcm_cli.egg-info → mcm_cli-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mcm-cli
-Version: 1.1.0
+Version: 1.3.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.1.0 → mcm_cli-1.3.0/mcm_cli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mcm-cli
-Version: 1.1.0
+Version: 1.3.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.1.0 → mcm_cli-1.3.0}/mcm_cli.egg-info/SOURCES.txt

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

{mcm_cli-1.1.0 → mcm_cli-1.3.0}/mcmcli/__main__.py

@@ -35,7 +35,7 @@ def version():
 	"""
 	Show the tool version
 	"""
-	typer.echo(f"Version: mcm-cli v1.1.0")
+	typer.echo(f"Version: mcm-cli v1.3.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.1.0 → mcm_cli-1.3.0}/mcmcli/command/account.py

@@ -16,6 +16,7 @@ from enum import Enum
 from mcmcli.data.account import Account, AccountListWrapper
 from mcmcli.data.account_user import User, UserWrapper, UserListWrapper
 from mcmcli.data.error import Error
+from mcmcli.data.item import ItemList, Item
 from mcmcli.data.seller import Seller, SellerListWrapper
 from mcmcli.requests import CurlString, api_request
 from typing import Any, Callable, Dict, Optional, Tuple, TypeVar
@@ -95,6 +96,16 @@ def bulk_invite_ad_account_owners(
                 continue
             account_creation_count += 1
 
+            #
+            # TODO: investigate if this step is necessary
+            # Activate the ad account
+            #
+            #if account:
+            #    error = a.activate_account_with_retry(account)
+            #    if error:
+            #        print(f"\nERROR: Failed to activate the ad account {account_id}. {error.message}.", file=sys.stderr, flush=True)
+            #        continue
+
         error = a.send_invitation_email_with_retry(account_id, email_address, user_name, create_user, dry_run)
         if error:
             print(f"\nERROR: Failed to send the mail for the ad account ID {account_id}. {error.message}.", file=sys.stderr, flush=True)
@@ -151,6 +162,187 @@ def bulk_check_user_registrations(
         print(f'"{account_id}","{is_account_exist}","{email_address}","{is_user_exist}","{user_role}","{user_status}"')
     return
 
+@app.command()
+def delete_user(
+    account_id: str = typer.Option(help="Ad account ID"),
+    user_email: str = typer.Option(help="User's email address"),
+    email_notification: bool = typer.Option(True, help="Send the email notification to the user"),
+    profile: str = typer.Option("default", help="profile name of the MCM CLI."),
+):
+    """
+    Delete the email user. It will send the notification email to the user by default.
+    Please use the `--no-email-notification` option if you want to skip it.
+    """
+    a = _create_account_command(profile)
+    if a is None:
+        return
+
+    err, users = a.list_account_users(account_id)
+    if err:
+        print(f"ERROR: {err}", file=sys.stderr, flush=True)
+        sys.exit()
+    if user_email not in users:
+        print(f"ERROR: The email user {user_email} was not found in the ad account {account_id}.", file=sys.stderr, flush=True)
+        sys.exit()
+
+    user_id = users[user_email].id
+    err = a.delete_user(account_id, user_id, email_notification)
+    if err:
+        print(f"ERROR: {err}", file=sys.stderr, flush=True)
+        sys.exit()
+
+    print(f'Successfully deleted the email user {user_email} from the ad account ID {account_id}.')
+
+
+@app.command()
+def invite_user(
+    account_id: str = typer.Option(help="Ad account ID"),
+    user_email: str = typer.Option(help="User's email address"),
+    user_name: str = typer.Option(help="User's name"),
+    user_role: UserRole = typer.Option(UserRole.AD_ACCOUNT_OWNER.value, help="User Role"),
+    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."),
+):
+    """
+    Invite a user as an ad account owner. The process creates the ad account if it doesn’t exist
+    and sends an invitation email to the user.
+    """
+    a = _create_account_command(profile)
+    if a is None:
+        return
+
+    #
+    # get the list of sellers
+    #
+    _, error, seller_dictionary = a.list_sellers()
+    if error:
+        print(f"ERROR: {error.message}")
+        sys.exit()
+
+    seller = _lookup_dict(account_id, seller_dictionary)
+    if seller is None:
+        print(f"ERROR: Could not find the ad account ID {account_id}")
+        sys.exit()
+
+    #
+    # create the ad account first
+    #
+    _, error, _ = a.create_account(seller.id, seller.title, to_curl=False)
+    if error and error.code != 6:
+        # error code 6 means the ad account already exists; we can ignore it.
+        print(f"ERROR: {error.message}")
+        sys.exit()
+
+    # We can assume that the ad account exists at this line, because we checked it above.
+
+    #
+    # invite the user
+    #
+    curl, error, user_join_request = a.invite_user(account_id, user_email, user_name, user_role, to_curl)
+    if to_curl:
+        print(curl)
+    elif error:
+        print(f"ERROR: {error.message}")
+        sys.exit()
+    else:
+        print(user_join_request)
+
+
+@app.command()
+def create_account(
+    account_id: str = typer.Option(help="Ad account ID"),
+    account_name: str = typer.Option(help="Ad account name"),
+    to_curl: bool = typer.Option(False, help="Generate the curl command instead of executing it."),
+    to_json: bool = typer.Option(False, help="Print raw output in json"),
+    profile: str = typer.Option("default", help="profile name of the MCM CLI."),
+):
+    """
+    Create a new ad account.
+    """
+    a = _create_account_command(profile)
+    if a is None:
+        return
+
+    curl, error, account_info = a.create_account(account_id, account_name, to_curl)
+    if to_curl:
+        print(curl)
+        sys.exit()
+    if error:
+        print(f"ERROR: {error.message}")
+        sys.exit()
+    if account_info is None:
+        print(f"ERROR: account information is None, which is not supposed to be.")
+        sys.exit()
+
+    if to_json:
+        print(account_info.model_dump_json())
+        sys.exit()
+
+    print(f"""Ad account ID {account_info.id} ("{account_info.title}") has been created.""")
+
+
+@app.command()
+def list_accounts(
+    to_curl: bool = typer.Option(False, help="Generate the curl command instead of executing it."),
+    to_json: bool = typer.Option(False, help="Print raw output in json"),
+    profile: str = typer.Option("default", help="profile name of the MCM CLI."),
+):
+    """
+    List all ad accounts on the platform.
+    """
+    a = _create_account_command(profile)
+    if a is None:
+        return
+
+    curl, error, accounts = a.list_accounts(to_curl)
+    if to_curl:
+        print(curl)
+        return
+    if error:
+        print(f"ERROR: {error.message}")
+        return
+    if to_json:
+        json_dumps = [x.model_dump_json() for x in accounts.values()]
+        print(f"[{','.join(json_dumps)}]")
+        return
+
+    print("Ad Account ID, State, Ad Account Title")
+    for a in accounts.values():
+        print(f"{a.id}, {a.state_info.state}, {a.title}")
+
+    return
+
+@app.command()
+def list_account_items(
+    account_id: str = typer.Option(help="Ad account ID"),
+    to_curl: bool = typer.Option(False, help="Generate the curl command instead of executing it."),
+    to_json: bool = typer.Option(False, help="Print raw output in json"),
+    profile: str = typer.Option("default", help="profile name of the MCM CLI."),
+):
+    """
+    List all items for a given ad account.
+    """
+    a = _create_account_command(profile)
+    if a is None:
+        return
+
+    curl, error, items = a.list_account_items(account_id, to_curl)
+
+    if to_curl:
+        print(curl)
+        sys.exit()
+    if error:
+        print(f"ERROR: {error.message}")
+        sys.exit()
+    if to_json:
+        json_dumps = [x.model_dump_json() for x in items]
+        print(f"[{','.join(json_dumps)}]")
+        sys.exit()
+
+    print("Ad Account ID, Item ID, Is Active, Created At, Item Title")
+    for i in items:
+        print(f"{account_id}, {i.id}, {i.is_active}, {i.created_timestamp}, {i.title}")
+
 
 class AccountCommand:
     def __init__(
@@ -255,6 +447,21 @@ class AccountCommand:
         return error
 
 
+    def delete_user(
+        self,
+        account_id,
+        user_id,
+        send_email_notification,
+    ) -> Optional[Error]:
+        _api_url = f"{self.api_base_url}/ad-accounts/{account_id}/users/{user_id}?reason=UserDeleted"
+        if not send_email_notification:
+            _api_url += "&bypass_notification=true"
+
+        _, error, _ = api_request('DELETE', False, _api_url, self.headers)
+
+        return error
+
+
     def invite_user(
         self,
         account_id,
@@ -285,6 +492,50 @@ class AccountCommand:
         ret = UserWrapper(**json_obj).user
         return None, None, ret
 
+    def activate_account(
+        self,
+        account: Account,
+        ) -> Optional[Error]:
+        account.state_info.state = "ACTIVE"
+        account.state_info.state_case = "ACTIVATED"
+
+        _api_url = f"{self.api_base_url}/ad-accounts/{account.id}"
+        _payload = {
+            "ad_account": account.model_dump_json()
+        }
+        _, error, _ = api_request('POST', False, _api_url, self.headers, _payload)
+        if error:
+            return error
+
+        _api_url = f"{self.api_base_url}/ad_accounts/{account.id}/state-info"
+        _payload = account.state_info.model_dump_json()
+        _, error, _ = api_request('POST', False, _api_url, self.headers, _payload)
+        if error:
+            return error
+
+        return None
+
+
+    
+    def activate_account_with_retry(
+        self,
+        account: Account,
+    ) -> Optional[Error]:
+        retries = 0
+        delay = 1
+        max_retries = 3
+        while retries < max_retries:
+            error = self.activate_account(account)
+            if error and error.code == 16:
+                print(f"\nERROR: authentication token expired. Retrying...", file=sys.stderr, flush=True)
+                self.refresh_token()
+                retries += 1
+                time.sleep(delay)
+                continue
+            return error
+        return Error(code=16, message="Failed to regain an authentication token")
+
+
     def create_account(
         self,
         account_id,
@@ -420,6 +671,88 @@ class AccountCommand:
         )
 
 
+    def list_account_items(
+        self,
+        account_id,
+        to_curl=False
+    ) -> tuple[
+        Optional[CurlString],
+        Optional[Error],
+        list[Item]
+    ]:
+        _api_url = f"{self.api_base_url}/ad-accounts/{account_id}/items"
+        _payload = {
+            "ad_account_id": account_id,
+            "search_keyword":[],
+            "order_by": [{
+                "column": "ID",
+                "direction": "ASC"
+            }],
+            "filter": [
+                {
+                    "column": "IS_ACTIVE",
+                    "filter_operator": "EQ",
+                    "value": "true or false",
+                }
+            ],
+            "page_index": 1,
+            "page_size": MAX_NUM_ITEMS_PER_PAGE,
+        }
+
+        #
+        # Get active items
+        #
+        curl, error, active_items = self.list_account_items_(to_curl, _api_url, self.headers, _payload, True)
+        if curl:
+            return curl, None, []
+        if error:
+            return None, error, []
+        #
+        # Get inactive items
+        #
+        _, error, inactive_items = self.list_account_items_(to_curl, _api_url, self.headers, _payload, False)
+        if error:
+            return None, error, []
+
+        return None, None, active_items + inactive_items
+
+
+    def list_account_items_(
+        self, 
+        to_curl,
+        _api_url,
+        _headers,
+        _payload,
+        _is_active
+    ) -> tuple[
+        Optional[CurlString],
+        Optional[Error],
+        list[Item]
+    ]:
+        items = []
+        num_items = 0
+        page_index = 1
+        while True:
+            _payload["page_index"] = page_index
+            _payload["filter"][0]["value"] = "true" if _is_active else "false"
+
+            curl, error, json_obj = api_request('POST', to_curl, _api_url, _headers, _payload)
+            if curl:
+                return curl, None, []
+            if error:
+                return None, error, []
+
+            item_group = ItemList(**json_obj)
+            items += item_group.rows
+            num_items += len(item_group.rows)
+
+            if num_items >= item_group.num_counts:
+                break
+            page_index += 1
+
+        return None, None, items
+    
+
 
 #
 # Helper functions

{mcm_cli-1.1.0 → mcm_cli-1.3.0}/mcmcli/command/wallet.py

@@ -12,9 +12,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from datetime import datetime
 from enum import Enum
 from mcmcli.data.error import Error
-from mcmcli.data.wallet import Wallet, WalletsWrapper
+from mcmcli.data.wallet import Wallet, WalletsWrapper, PlatformWalletsWrapper
 from mcmcli.requests import CurlString, api_request
 
 import json
@@ -36,20 +37,68 @@ class OperationType(Enum):
     DEPOSIT = "deposit"
     WITHDRAW = "withdraw"
 
+def _get_wallet_balance(wallet: Wallet):
+    wa0 = wallet.accounts[0]
+    wa1 = wallet.accounts[1]
+
+    credits_amount_micro  = wa0.balance.amount_micro if wa0.type == 'CREDITS' else wa1.balance.amount_micro
+    pre_paid_amount_micro = wa0.balance.amount_micro if wa0.type == 'PRE_PAID' else wa1.balance.amount_micro
+    credit_balance = float(credits_amount_micro) / float(1000000)
+    prepaid_balance = float(pre_paid_amount_micro) / float(1000000)
+
+    return (credit_balance, prepaid_balance)
+
+
+@app.command()
+def platform_balance(
+    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."),
+):
+    """
+    Get the current balances of all ad accounts in CSV format.
+    """
+    auth = mcmcli.command.auth.AuthCommand(profile)
+    curl, error, token = auth.get_token()
+    if error:
+        print(f"ERROR: {error.message}", file=sys.stderr, flush=True)
+        return
+
+    # Get current UTC timestamp and format it as an ISO 8601 string with microseconds
+    current_timestamp = datetime.utcnow().isoformat(timespec='microseconds') + "Z"
+
+    wc = WalletCommand(profile, auth, token.token)
+    curl, error, platform_wallets = wc.get_platform_balance(to_curl)
+    if to_curl:
+        print(curl)
+        return
+    if error:
+        print(f"ERROR: {error.message}", file=sys.stderr, flush=True)
+        return
+    if platform_wallets is None:
+        print(f"ERROR: Cannot find the wallets", file=sys.stderr, flush=True)
+        return
+
+    print("ad_account_id,credit_balance,prepaid_balance,got_balance_info_at_utc")
+    for account_id, account_data in platform_wallets.items():
+        wallet = account_data.wallets[0]
+        credit_balance, prepaid_balance = _get_wallet_balance(wallet)
+        print(f'{account_id},{credit_balance},{prepaid_balance},{current_timestamp}')
+    
+
 @app.command()
 def balance(
     account_id: str = typer.Option(help="Ad account ID"), 
     to_curl: bool = typer.Option(False, help="Generate the curl command instead of executing it."),
     to_json: bool = typer.Option(False, help="Print raw output in json"),
-    profile: str = "default",
-    ):
+    profile: str = typer.Option("default", help="profile name of the MCM CLI."),
+):
     """
     Retrive the current balance of the given ad account's wallet.
     """
     auth = mcmcli.command.auth.AuthCommand(profile)
     curl, error, token = auth.get_token()
     if error:
-        print(f"ERROR: {error.message}")
+        print(f"ERROR: {error.message}", file=sys.stderr, flush=True)
         return
 
     wc = WalletCommand(profile, auth, token.token)
@@ -58,24 +107,20 @@ def balance(
         print(curl)
         return
     if error:
-        print(f"ERROR: {error.message}")
+        print(f"ERROR: {error.message}", file=sys.stderr, flush=True)
+        return
+    if wallet is None:
+        print(f"ERROR: Wallet does not exist.", file=sys.stderr, flush=True)
         return
     if to_json:
         print(wallet.model_dump_json())
         return
     
-    wa0 = wallet.accounts[0]
-    wa1 = wallet.accounts[1]
-
-    credits_amount_micro  = wa0.balance.amount_micro if wa0.type == 'CREDITS' else wa1.balance.amount_micro
-    pre_paid_amount_micro = wa0.balance.amount_micro if wa0.type == 'PRE_PAID' else wa1.balance.amount_micro
-    credit_amount = float(credits_amount_micro) / float(1000000)
-    money_amount = float(pre_paid_amount_micro) / float(1000000)
+    credit_balance, prepaid_balance = _get_wallet_balance(wallet)
 
     print(f"Ad account ID = {account_id}")
-    print(f"Wallet ID = {wallet.id}")
-    print(f"PRE_PAID balance = {money_amount}")
-    print(f"CREDITS balance = {credit_amount}")
+    print(f"CREDITS balance = {credit_balance}")
+    print(f"PRE_PAID balance = {prepaid_balance}")
     return
 
 
@@ -86,8 +131,8 @@ def deposit(
     fund_amount: float = typer.Option(help="The fund amount to deposit"), 
     to_curl: bool = typer.Option(False, help="Generate the curl command instead of executing it."),
     to_json: bool = typer.Option(False, help="Print raw output in json"),
-    profile: str = "default",
-    ):
+    profile: str = typer.Option("default", help="profile name of the MCM CLI."),
+):
     """
     Add or top up the money amount to the current balance of the given ad account's wallet.
     """
@@ -137,8 +182,8 @@ def withdraw(
     fund_amount: float = typer.Option(help="The amount of credit to add"), 
     to_curl: bool = typer.Option(False, help="Generate the curl command instead of executing it."),
     to_json: bool = typer.Option(False, help="Print raw output in json"),
-    profile: str = "default",
-    ):    
+    profile: str = typer.Option("default", help="profile name of the MCM CLI."),
+):    
     """
     Withdraws the money amount from the current balance of the given ad account's wallet.
     """
@@ -202,6 +247,25 @@ class WalletCommand:
             "Authorization": f"Bearer {token}"
         }
 
+    def get_platform_balance(
+        self,
+        to_curl: bool,
+    ) -> tuple[
+        None | CurlString,
+        None | Error,
+        None | dict[str, WalletsWrapper]
+    ]:
+        _api_url = f"{self.api_base_url}/wallets-bulk/read"
+
+        curl, error, json_obj = api_request('POST', to_curl, _api_url, self.headers)
+        if curl:
+            return curl, None, None
+        if error:
+            return None, error, None
+
+        platform_wallets_wrapper = PlatformWalletsWrapper(**json_obj)
+        return None, None, platform_wallets_wrapper.result
+
 
     def get_balance(
         self,

mcm_cli-1.3.0/mcmcli/data/item.py

@@ -0,0 +1,42 @@
+# 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 dataclasses
+#
+class Price(BaseModel):
+    currency: str
+    amount: float
+
+class Item(BaseModel):
+    id: str
+    title: str
+    price: Price
+    sale_price: Price
+    link: str
+    image_link: str
+    category: str
+    review_count: str
+    rating_score: float
+    is_active: bool
+    is_new: Optional[bool]
+    created_timestamp: str
+
+class ItemList(BaseModel):
+    rows: list[Item]
+    num_counts: int
+    created_timestamp_filter: str

{mcm_cli-1.1.0 → mcm_cli-1.3.0}/mcmcli/data/wallet.py

@@ -67,3 +67,46 @@ class Wallet(BaseModel):
 
 class WalletsWrapper(BaseModel):
     wallets: list[Wallet]
+
+
+#
+# API response dataclasses for the platform balance API responses
+#
+#
+# {
+#     "result": {
+#         "10054": {
+#             "wallets": [
+#                 {
+#                     "id": "wRydQ9MhQx4ZyJED", 
+#                     "title": "", 
+#                     "ad_account_id": "10054", 
+#                     "type": "PRE_PAYMENT", 
+#                     "accounts": [
+#                         {
+#                             "type": "CREDITS", 
+#                             "balance": {
+#                                 "currency": "USD", 
+#                                 "amount_micro": "1890020000"
+#                             }
+#                         },
+#                         {
+#                             "type": "PRE_PAID", 
+#                             "balance": {
+#                                 "currency": "USD", 
+#                                 "amount_micro": "0"
+#                             }
+#                         }
+#                     ], 
+#                     "created_at": "2024-09-24T17:26:09.437580Z", 
+#                     "updated_at": "2024-10-20T22:00:21.412482Z"
+#                 }
+#             ]
+#         }
+#     }
+# }
+
+class PlatformWalletsWrapper(BaseModel):
+    result: dict[str, WalletsWrapper] # Dictionary with ad_account_id as keys
+
+

{mcm_cli-1.1.0 → mcm_cli-1.3.0}/mcmcli/requests.py

@@ -41,6 +41,15 @@ def get(url, headers):
     except Exception as e:
         return e, None
 
+
+def delete(url, headers):
+    try:
+        res = requests.delete(url, headers=headers)
+        return None, json.loads(res.text)
+    except Exception as e:
+        return e, None
+
+
 def post(url, headers, payload):
     try:
         res = requests.post(url, headers=headers, json=payload)
@@ -62,6 +71,8 @@ def api_request(method, to_curl, url, headers, payload=None) -> tuple[CurlString
 
     if method == 'GET':
         error, json_obj = get(url, headers)
+    elif method == 'DELETE':
+        error, json_obj = delete(url, headers)
     elif method == 'POST':
         error, json_obj = post(url, headers, payload)
     elif method == 'PUT':

{mcm_cli-1.1.0 → mcm_cli-1.3.0}/setup.py

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