instagram-graph-api
Version:
A library to help perform requests to the Instagram Graph API.
37 lines (36 loc) • 1.34 kB
TypeScript
import { AlbumMetric, SimplePostMetric, StoryMetric } from '../../../Enums';
import { AbstractRequest } from '../../AbstractRequest';
import { GetMediaInsightsResponse } from './GetMediaInsightsResponse';
import { BasicInsightsMetricData, MetricValue } from '../../data/insights/BasicInsightsMetricData';
/**
* An abstract class to represent request that gets insights about a media object.
*
* @param T te type of metrics. This matches the type of media object (Post or Story).
*
* @author Tiago Grosso <tiagogrosso99@gmail.com>
* @since 0.2.0
*/
export declare abstract class AbstractGetMediaInsightsRequest<T extends SimplePostMetric | StoryMetric | AlbumMetric> extends AbstractRequest<GetMediaInsightsResponse> {
/**
* The media object id.
*/
private readonly mediaId;
/**
* The constructor.
*
* @param accessToken the access token.
* @param mediaId the media object id (must be of type 'Post').
* @param metrics the metrics to retrieve from the API.
*/
protected constructor(accessToken: string, mediaId: string, metrics: Set<T>);
/**
* @inheritdoc
*/
protected url(): string;
/**
* @inheritdoc
*/
protected parseResponse(response: {
data: BasicInsightsMetricData<MetricValue<number>[]>[];
}): GetMediaInsightsResponse;
}