ad2games/soapy_cake

View on GitHub
api.yml

Summary

Maintainability
Test Coverage
---
versions:
  admin:
    accounting:
      mark_affiliate_bill_as_received: 1
      export_advertiser_bills: 1
      export_affiliate_bills: 1
      mark_affiliate_bill_as_paid: 1
    add:
      advertiser_credit: 1
      creative: 1
      manual_credit: 1
    addedit:
      advertiser: 1
      advertiser_credit_limit: 1
      affiliate: 2
      apply_suppression_list_to_offer: 1
      blacklist: 1
      campaign: 3
      caps: 1
      contact: 2
      creative: 1
      creative_files: 1
      exchange_rate: 1
      geo_targets: 3
      offer: 5
      offer_contract: 1
      offer_tiers: 1
      remove_blacklist: 1
      suppresion_list: 1
      vertical: 1
    auth:
      login: 2
    doc:
      posting_doc: 1
    edit:
      buyer: 1
    export:
      advertisers: 5
      affiliate_referrals: 1
      affiliates: 5
      blacklists: 1
      buyer_contracts: 1
      buyers: 1
      campaigns: 6
      creatives: 3
      offers: 5
      rules_targets: 3
      schedules: 1
    get:
      account_statuses: 1
      advertisers: 1
      affiliate_tags: 1
      affiliate_tiers: 1
      billing_cycles: 1
      blacklist_reasons: 1
      cap_intervals: 1
      cap_types: 1
      countries: 1
      currencies: 1
      departments: 1
      exchange_rates: 1
      get_api_key: 1
      inactive_reasons: 1
      languages: 1
      offer_statuses: 1
      offer_types: 1
      payment_settings: 1
      payment_types: 1
      price_formats: 1
      roles: 1
      tracking_domains: 1
      verticals: 2
    reports:
      advertiser_summary: 2
      affiliate_summary: 2
      campaign_summary: 2
      creative_summary: 2
      caps: 4
      clicks: 11
      conversion_changes: 10
      event_conversions: 17
      daily_summary_export: 1
      leads_by_affiliate_export: 1
      leads_by_buyer: 4
      login_export: 1
      offer_summary: 2
      traffic_export: 1
    signup:
      advertiser: 1
      affiliate: 4
      get_media_types: 1
      get_price_formats: 1
      get_traffic_types: 1
      get_vertical_categories: 1
    track:
      accepted_dispositions: 1
      conversion_dispositions: 2
      decrypt_affiliate_link: 1
      mass_conversion_adjustment: 2
      mass_conversion_insert: 2
      rejected_dispositions: 1
      update_conversion: 4
      update_conversion_disposition: 2
      update_conversion_events: 6
      update_conversion_price: 2
      update_conversion_revenue: 1
      update_lead_price: 2
      update_sale_revenue: 1
  affiliate:
    reports:
      bills: 3
    offers:
      offer_feed: 4

# Whitelist of read-only actions (don't modify CAKE data).
read_only:
  admin:
    accounting:
      - export_advertiser_bills
      - export_affiliate_bills
    export:
      - advertisers
      - affiliate_referrals
      - affiliates
      - blacklists
      - buyer_contracts
      - buyers
      - campaigns
      - creatives
      - offers
      - rules_targets
      - schedules
    get:
      - account_statuses
      - advertisers
      - affiliate_tags
      - affiliate_tiers
      - billing_cycles
      - blacklist_reasons
      - cap_intervals
      - cap_types
      - countries
      - currencies
      - departments
      - exchange_rates
      - get_api_key
      - inactive_reasons
      - languages
      - offer_statuses
      - offer_types
      - payment_settings
      - payment_types
      - price_formats
      - roles
      - tracking_domains
      - verticals
    reports:
      - advertiser_summary
      - affiliate_summary
      - campaign_summary
      - creative_summary
      - caps
      - clicks
      - conversion_changes
      - event_conversions
      - daily_summary_export
      - leads_by_affiliate_export
      - leads_by_buyer
      - login_export
      - offer_summary
      - traffic_export
    signup:
      - get_media_types
      - get_price_formats
      - get_traffic_types
      - get_vertical_categories
    track:
      - accepted_dispositions
      - conversion_dispositions
      - decrypt_affiliate_link
      - rejected_dispositions
  affiliate:
    reports:
      - bills
    offers:
      - offer_feed