@adcp/sdk API Reference - v7.9.0
    Preparing search index...

    Interface GetRightsSuccess

    interface GetRightsSuccess {
        rights: {
            rights_id: string;
            brand_id: string;
            name: string;
            description?: string;
            right_type?: RightType;
            match_score?: number;
            match_reasons?: string[];
            available_uses: RightUse[];
            countries?: string[];
            excluded_countries?: string[];
            exclusivity_status?: {
                available?: boolean;
                existing_exclusives?: string[];
            };
            pricing_options: RightsPricingOption[];
            content_restrictions?: string[];
            preview_assets?: { url: string; usage?: string }[];
        }[];
        excluded?: {
            brand_id: string;
            name?: string;
            reason: string;
            suggestions?: string[];
        }[];
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index

    Properties

    rights excluded? context? ext?

    Properties

    rights: {
        rights_id: string;
        brand_id: string;
        name: string;
        description?: string;
        right_type?: RightType;
        match_score?: number;
        match_reasons?: string[];
        available_uses: RightUse[];
        countries?: string[];
        excluded_countries?: string[];
        exclusivity_status?: {
            available?: boolean;
            existing_exclusives?: string[];
        };
        pricing_options: RightsPricingOption[];
        content_restrictions?: string[];
        preview_assets?: { url: string; usage?: string }[];
    }[]

    Matching rights with pricing options, ranked by relevance

    Type Declaration

    • rights_id: string

      Identifier for this rights offering. Referenced in acquire_rights.

    • brand_id: string

      Brand identifier from the agent's roster

    • name: string

      Display name of the rights subject

    • Optionaldescription?: string

      Description of the rights subject

    • Optionalright_type?: RightType
    • Optionalmatch_score?: number

      Relevance score from 0 to 1

      0

      1

    • Optionalmatch_reasons?: string[]

      Human-readable reasons for the match

    • available_uses: RightUse[]

      Rights uses available for licensing

    • Optionalcountries?: string[]

      Countries where rights are available (ISO 3166-1 alpha-2). When both countries and excluded_countries are present, the effective set is countries minus excluded_countries. If neither is present, all countries are available.

    • Optionalexcluded_countries?: string[]

      Countries excluded from availability

    • Optionalexclusivity_status?: { available?: boolean; existing_exclusives?: string[] }

      Current exclusivity availability

      • Optionalavailable?: boolean

        Whether exclusivity is available

      • Optionalexisting_exclusives?: string[]

        Active exclusivity commitments that may affect availability. Implementers should use vague descriptions ('exclusive commitment in this category') rather than specific deal terms to protect confidential business relationships.

    • pricing_options: RightsPricingOption[]

      Available pricing options for these rights

    • Optionalcontent_restrictions?: string[]

      Content restrictions or approval requirements

    • Optionalpreview_assets?: { url: string; usage?: string }[]

      Preview-only assets for evaluation

    excluded?: {
        brand_id: string;
        name?: string;
        reason: string;
        suggestions?: string[];
    }[]

    Results that matched but were filtered out, with reasons

    Type Declaration

    • brand_id: string
    • Optionalname?: string
    • reason: string

      Why this result was excluded. May be sanitized to protect confidential brand rules.

    • Optionalsuggestions?: string[]

      Actionable alternatives if the exclusion is fixable (e.g., 'Available in BE and DE markets'). Absent if the exclusion is final.

    context?: ContextObject
    ext?: ExtensionObject

    Settings

    Member Visibility

    On This Page

    Properties