@shopify/shopify-api
Version:
Shopify API Library for Node - accelerate development with support for authentication, graphql proxy, webhooks
79 lines • 2.82 kB
TypeScript
/***********************************************************************************************************************
* This file is auto-generated. If you have an issue, please create a GitHub issue. *
***********************************************************************************************************************/
import { Base, FindAllResponse } from '../../base';
import { ResourcePath, ResourceNames } from '../../types';
import { Session } from '../../../lib/session/session';
import { ApiVersion } from '../../../lib/types';
interface FindArgs {
session: Session;
id: number | string;
}
interface DeleteArgs {
session: Session;
id: number | string;
}
interface AllArgs {
[key: string]: unknown;
session: Session;
limit?: unknown;
offset?: unknown;
}
interface CountArgs {
[key: string]: unknown;
session: Session;
}
interface EngagementsArgs {
[key: string]: unknown;
occurred_on?: unknown;
impressions_count?: unknown;
views_count?: unknown;
clicks_count?: unknown;
shares_count?: unknown;
favorites_count?: unknown;
comments_count?: unknown;
ad_spend?: unknown;
is_cumulative?: unknown;
body?: {
[key: string]: unknown;
} | null;
}
export declare class MarketingEvent extends Base {
static apiVersion: ApiVersion;
protected static hasOne: {
[key: string]: typeof Base;
};
protected static hasMany: {
[key: string]: typeof Base;
};
protected static paths: ResourcePath[];
protected static resourceNames: ResourceNames[];
static find({ session, id }: FindArgs): Promise<MarketingEvent | null>;
static delete({ session, id }: DeleteArgs): Promise<unknown>;
static all({ session, limit, offset, ...otherArgs }: AllArgs): Promise<FindAllResponse<MarketingEvent>>;
static count({ session, ...otherArgs }: CountArgs): Promise<unknown>;
engagements({ occurred_on, impressions_count, views_count, clicks_count, shares_count, favorites_count, comments_count, ad_spend, is_cumulative, body, ...otherArgs }: EngagementsArgs): Promise<unknown>;
event_type: string | null;
marketing_channel: string | null;
paid: boolean | null;
started_at: string | null;
UTM_parameters: {
[key: string]: unknown;
} | null;
budget: string | null;
budget_type: string | null;
currency: string | null;
description: string | null;
ended_at: string | null;
id: string | null;
manage_url: string | null;
marketed_resources: {
[key: string]: unknown;
}[] | null;
preview_url: string | null;
referring_domain: string | null;
remote_id: string | null;
scheduled_to_end_at: string | null;
}
export {};
//# sourceMappingURL=marketing_event.d.ts.map