mcm-cli 1.4.2__py3-none-any.whl → 1.5.1__py3-none-any.whl

{mcm_cli-1.4.2.dist-info → mcm_cli-1.5.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mcm-cli
-Version: 1.4.2
+Version: 1.5.1
 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.4.2.dist-info → mcm_cli-1.5.1.dist-info}/RECORD

@@ -1,18 +1,18 @@
 mcmcli/__init__.py,sha256=-U6lMZ9_99IXAKwnqnYXYr6NcO6TSmG-kxewgvJjU4k,575
-mcmcli/__main__.py,sha256=8rr--sz02pkM_Z6u90JYm8f1s6sbHmgXF82xfIF6rqg,1844
+mcmcli/__main__.py,sha256=a4A9mxOQMsB-6DK_5mABC-ersAhxnVFjqQ-u-TZ99hY,1844
 mcmcli/logging.py,sha256=xjRS5ey1ONx_d34qB1Fetb_SwPysoh2hzNDuNAaYYWQ,1739
 mcmcli/requests.py,sha256=IuySBQ8P_GoGF3f_TRysfgQNOhi2n9M84WK_eRXnoEU,2945
 mcmcli/command/account.py,sha256=FWXmzOLj4rVLVLEv-w0eDVlQVrkONvR1UewZbcTDgE4,24994
 mcmcli/command/admin.py,sha256=2GC0B3oqQsT5N5mHUyezgZvzPkB4-oGtddguOWfdLJs,15980
 mcmcli/command/auth.py,sha256=Ak7ZNEskWPpMoeTJcbYlEpDBgzxn8N33Q2dNf67SsCs,2926
-mcmcli/command/campaign.py,sha256=SU6TrDy6YhqM0JWPzbYWLpXZrz7Ymw31pd168dK2LZk,10638
+mcmcli/command/campaign.py,sha256=wh6WU19dCw0NBTp521g5wK6_0GraviWZxxahIcSlD44,12364
 mcmcli/command/config.py,sha256=08C5ftAvdvpQ26Z329LqhP8AxTI629LS7Ou6glzrRgw,4396
 mcmcli/command/decision.py,sha256=iLvEDEa2k0LAgoXrOvcdn-HcFRo90E8Dxht_Ls9EGCY,8690
 mcmcli/command/report.py,sha256=N8IMyDZ5QpY11-KkZG-n5_ZzEeh-ME5s2s3wrAKEGjY,5387
 mcmcli/command/wallet.py,sha256=vG2rg7tPwGsV9YB7cpvkiocbqtB1reqXn7dmolFmzD4,11536
 mcmcli/data/account.py,sha256=pe7tPapP6vlUD5D5L5Nh5k2bkWdYOK01Mpt5fBYFnJs,1782
 mcmcli/data/account_user.py,sha256=27nQp52nMma5a3QszSJGqgq5Z0ivIb-nMZcZuhEgbEg,1328
-mcmcli/data/campaign.py,sha256=-HR-SbEfe44Ys_UXnYr9HRG0TPcGkO2k61iEsz9uET0,2284
+mcmcli/data/campaign.py,sha256=jwExzdEHLanhYTfR4-rkL3mGheROoRi3bkGnD-5nKCg,3496
 mcmcli/data/decision.py,sha256=bQ5j_PbPRSFa0sY5g9UVqdNzl_2epchcz1lHoDVuV90,2880
 mcmcli/data/error.py,sha256=d6xa_jTXumlA0EzXy2PJQ86ajBb0Pm90fss9R3LuHUc,1094
 mcmcli/data/item.py,sha256=Z2xTRhU8T4vyJADO0l6-XPyQXvb9DX_OAjExhSXpW2A,1091
@@ -23,10 +23,10 @@ mcmcli/data/seller.py,sha256=40SA7QekM3a3svDrDYLo_QYJ68VUxDO0KeGejJMp4k4,1004
 mcmcli/data/token.py,sha256=11wtyLHCAZHu0LVbNDPa-yipcL6lenxoYIKEI58VzFs,1744
 mcmcli/data/user_join_request.py,sha256=lXMO2hE_VpRg0JofVrYAVM82S-RLFkPrZk8-drvhoDI,1251
 mcmcli/data/wallet.py,sha256=eMUi8N0vJdg_E10TPhSPoZkZtmIG7gHyqgabQ8C5Lg8,3217
-mcm_cli-1.4.2.dist-info/LICENSE,sha256=RFhQPdSOiMTguUX7JSoIuTxA7HVzCbj_p8WU36HjUQQ,10947
-mcm_cli-1.4.2.dist-info/METADATA,sha256=6Y7vHnYzLC2-4-7AHMDyL2mprCj0BKVMCUAP8sOGob8,3056
-mcm_cli-1.4.2.dist-info/NOTICE,sha256=Ldnl2MjRaXPxcldUdbI2NTybq60XAa2LowRhFrRTuiI,76
-mcm_cli-1.4.2.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-mcm_cli-1.4.2.dist-info/entry_points.txt,sha256=qTHAWZ-ejSiU4t11RYwtAU8ScqhQPDeMVTG9y4wMVLg,60
-mcm_cli-1.4.2.dist-info/top_level.txt,sha256=sh7oqIaqLQlMtKHlxHHgpV2xGMrBMPFWpSp0C6nvJ_Y,7
-mcm_cli-1.4.2.dist-info/RECORD,,
+mcm_cli-1.5.1.dist-info/LICENSE,sha256=RFhQPdSOiMTguUX7JSoIuTxA7HVzCbj_p8WU36HjUQQ,10947
+mcm_cli-1.5.1.dist-info/METADATA,sha256=mnhJv3rIBrVgGmBCGcUl9ACei2q4QVHhL34PKgxq2H4,3056
+mcm_cli-1.5.1.dist-info/NOTICE,sha256=Ldnl2MjRaXPxcldUdbI2NTybq60XAa2LowRhFrRTuiI,76
+mcm_cli-1.5.1.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+mcm_cli-1.5.1.dist-info/entry_points.txt,sha256=qTHAWZ-ejSiU4t11RYwtAU8ScqhQPDeMVTG9y4wMVLg,60
+mcm_cli-1.5.1.dist-info/top_level.txt,sha256=sh7oqIaqLQlMtKHlxHHgpV2xGMrBMPFWpSp0C6nvJ_Y,7
+mcm_cli-1.5.1.dist-info/RECORD,,

mcmcli/__main__.py

@@ -37,7 +37,7 @@ def version():
 	"""
 	Show the tool version
 	"""
-	typer.echo(f"Version: mcm-cli v1.4.2")
+	typer.echo(f"Version: mcm-cli v1.5.1")
 
 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")

mcmcli/command/campaign.py

@@ -51,7 +51,7 @@ def list_campaigns(
         print(curl)
         return
     if error:
-        print(f"ERROR: {error.message}")
+        print(f"ERROR: {error.message}", file=sys.stderr, flush=True)
         return
     if to_json:
         json_dumps = [x.model_dump_json() for x in campaigns]
@@ -103,6 +103,47 @@ def read_campaign(
 
     return
 
+@app.command()
+def archive_campaign(
+    account_id: str = typer.Option(help="Ad account ID"),
+    campaign_id: str = typer.Option(help="Campaign ID"), 
+    profile: str = typer.Option("default", help="Profile name of the MCM CLI."),
+):
+    """
+    Turn off (pause and disable) the campaign and archive it.
+    """
+    c = _create_campaign_command(profile)
+    if c is None:
+        return
+
+    _, error, campaign = c.read_campaign(account_id, campaign_id)
+    if error:
+        print(f"ERROR: Failed to read the campaign {campaign_id} of the ad account {account_id}: {error.message}", file=sys.stderr, flush=True)
+        return
+    
+    if campaign.state == 'ARCHIVED':
+        print(f"The campaign {campaign_id} of the ad account {account_id} is already archived.")
+        return
+
+    # Turn off the campaign
+    campaign.enabling_state = 'DISABLED'
+    campaign.state = 'PAUSED'
+    #campaign.daily_budget.amount_micro = (campaign.daily_budget.amount_micro // 10000) * 10000
+    _, error, campaign = c.update_campaign(campaign)
+    if error:
+        print(f"ERROR: Failed to turn off the campaign {campaign_id} of the ad account {account_id}: {error.message}", file=sys.stderr, flush=True)
+        return
+
+    # Archive the campaign
+    campaign.hidden = True
+    campaign.state = 'ARCHIVED'
+    _, error, campaign = c.update_campaign(campaign)
+    if error:
+        print(f"ERROR: Failed to archive the campaign {campaign_id} of the ad account {account_id}: {error.message}", file=sys.stderr, flush=True)
+        return
+
+    print(f"Archived the campaign {campaign_id} of the ad account {account_id}.")
+
 @app.command()
 def list_campaign_items(
     account_id: str = typer.Option(help="Ad account ID"), 
@@ -124,7 +165,7 @@ def list_campaign_items(
         print(curl)
         return
     if error:
-        print(f"ERROR: {error.message}")
+        print(f"ERROR: {error.message}", file=sys.stderr, flush=True)
         return   
     if to_json:
         json_dumps = [x.model_dump_json() for x in items]
@@ -156,7 +197,7 @@ def add_items_to_campaign(
 
     _, error, campaign = c.read_campaign(account_id, campaign_id)
     if error:
-        print(f"ERROR: {error.message}")
+        print(f"ERROR: {error.message}", file=sys.stderr, flush=True)
         return
 
     #
@@ -173,7 +214,7 @@ def add_items_to_campaign(
         print(curl)
         return
     if error:
-        print(f"ERROR: {error.message}")
+        print(f"ERROR: {error.message}", file=sys.stderr, flush=True)
         return
     if to_json:
         print(campaign.model_dump_json())

mcmcli/data/campaign.py

@@ -20,11 +20,11 @@ from typing import Optional
 #
 class MicroPrice(BaseModel):
     currency: str
-    amount_micro: str
+    amount_micro: int
 
 class Schedule(BaseModel):
     start: str
-    end: Optional[str]
+    end: Optional[str] = None
 
 class Budget(BaseModel):
     period: str
@@ -58,6 +58,56 @@ class Targeting(BaseModel):
     placement_setting: Optional[str]
     audience_setting: Optional[AudienceSetting]
 
+class TargetInventoryDimension(BaseModel):
+    width: int
+    height: int
+
+class BannerAsset(BaseModel):
+    creative_id: str
+    image_url: str
+    width: int
+    height: int
+    target_inventory_dimension: TargetInventoryDimension
+
+class LogoAsset(BaseModel):
+    creative_id: str
+    image_url: str
+
+class HeadlineAsset(BaseModel):
+    text: str
+
+class CTAAsset(BaseModel):
+    text: str
+
+class ReviewInformation(BaseModel):
+    status: str
+    rejection_reason: str
+    updated_at: str
+
+class Asset(BaseModel):
+    id: str
+    banner: BannerAsset
+    logo: LogoAsset
+    headline: HeadlineAsset
+    cta: CTAAsset
+    review_information: ReviewInformation
+    created_at: str
+    updated_at: str
+
+class CustomURLSetting(BaseModel):
+    url: str
+
+class LandPage(BaseModel):
+    type: str
+    custom_url_setting: CustomURLSetting
+    id: str
+    review_information: ReviewInformation
+    created_at: str
+    updated_at: str
+
+class ItemSelection(BaseModel):
+    type: str
+
 class Campaign(BaseModel):
     id: str
     title: str
@@ -80,6 +130,12 @@ class Campaign(BaseModel):
     updated_at: str
     audience_types: list[str]
     offsite_setting: Optional[str]
+    item_selection: Optional[ItemSelection]
+    assets: Optional[list[Asset]]
+    landing_pages: Optional[list[LandPage]]
+    landing_url_suffix: Optional[str]
+    catalog_brand_id: Optional[str]
+    catalog_category: Optional[str]
     
 class CampaignList(BaseModel):
     campaigns: list[Campaign]