@shopify/shopify-api/dist/esm/rest/admin/2025-07/marketing_event.mjs.map

Shopify API Library for Node - accelerate development with support for authentication, graphql proxy, webhooks

{"version":3,"file":"marketing_event.mjs","sources":["../../../../../../../rest/admin/2025-07/marketing_event.ts"],"sourcesContent":["/***********************************************************************************************************************\n* This file is auto-generated. If you have an issue, please create a GitHub issue.                                     *\n***********************************************************************************************************************/\n\nimport {Base, FindAllResponse} from '../../base';\nimport {ResourcePath, ResourceNames} from '../../types';\nimport {Session} from '../../../lib/session/session';\nimport {ApiVersion} from '../../../lib/types';\n\ninterface FindArgs {\n  session: Session;\n  id: number | string;\n}\ninterface DeleteArgs {\n  session: Session;\n  id: number | string;\n}\ninterface AllArgs {\n  [key: string]: unknown;\n  session: Session;\n  limit?: unknown;\n  offset?: unknown;\n}\ninterface CountArgs {\n  [key: string]: unknown;\n  session: Session;\n}\ninterface EngagementsArgs {\n  [key: string]: unknown;\n  occurred_on?: unknown;\n  impressions_count?: unknown;\n  views_count?: unknown;\n  clicks_count?: unknown;\n  shares_count?: unknown;\n  favorites_count?: unknown;\n  comments_count?: unknown;\n  ad_spend?: unknown;\n  is_cumulative?: unknown;\n  body?: {[key: string]: unknown} | null;\n}\n\nexport class MarketingEvent extends Base {\n  public static apiVersion = ApiVersion.July25;\n\n  protected static hasOne: {[key: string]: typeof Base} = {};\n  protected static hasMany: {[key: string]: typeof Base} = {};\n  protected static paths: ResourcePath[] = [\n    {\"http_method\": \"delete\", \"operation\": \"delete\", \"ids\": [\"id\"], \"path\": \"marketing_events/<id>.json\"},\n    {\"http_method\": \"get\", \"operation\": \"count\", \"ids\": [], \"path\": \"marketing_events/count.json\"},\n    {\"http_method\": \"get\", \"operation\": \"get\", \"ids\": [], \"path\": \"marketing_events.json\"},\n    {\"http_method\": \"get\", \"operation\": \"get\", \"ids\": [\"id\"], \"path\": \"marketing_events/<id>.json\"},\n    {\"http_method\": \"post\", \"operation\": \"engagements\", \"ids\": [\"id\"], \"path\": \"marketing_events/<id>/engagements.json\"},\n    {\"http_method\": \"post\", \"operation\": \"post\", \"ids\": [], \"path\": \"marketing_events.json\"},\n    {\"http_method\": \"put\", \"operation\": \"put\", \"ids\": [\"id\"], \"path\": \"marketing_events/<id>.json\"}\n  ];\n  protected static resourceNames: ResourceNames[] = [\n    {\n      \"singular\": \"marketing_event\",\n      \"plural\": \"marketing_events\"\n    }\n  ];\n\n  public static async find(\n    {\n      session,\n      id\n    }: FindArgs\n  ): Promise<MarketingEvent | null> {\n    const result = await this.baseFind<MarketingEvent>({\n      session: session,\n      urlIds: {\"id\": id},\n      params: {},\n    });\n    return result.data ? result.data[0] : null;\n  }\n\n  public static async delete(\n    {\n      session,\n      id\n    }: DeleteArgs\n  ): Promise<unknown> {\n    const response = await this.request<MarketingEvent>({\n      http_method: \"delete\",\n      operation: \"delete\",\n      session: session,\n      urlIds: {\"id\": id},\n      params: {},\n    });\n\n    return response ? response.body : null;\n  }\n\n  public static async all(\n    {\n      session,\n      limit = null,\n      offset = null,\n      ...otherArgs\n    }: AllArgs\n  ): Promise<FindAllResponse<MarketingEvent>> {\n    const response = await this.baseFind<MarketingEvent>({\n      session: session,\n      urlIds: {},\n      params: {\"limit\": limit, \"offset\": offset, ...otherArgs},\n    });\n\n    return response;\n  }\n\n  public static async count(\n    {\n      session,\n      ...otherArgs\n    }: CountArgs\n  ): Promise<unknown> {\n    const response = await this.request<MarketingEvent>({\n      http_method: \"get\",\n      operation: \"count\",\n      session: session,\n      urlIds: {},\n      params: {...otherArgs},\n      body: {},\n      entity: null,\n    });\n\n    return response ? response.body : null;\n  }\n\n  public async engagements(\n    {\n      occurred_on = null,\n      impressions_count = null,\n      views_count = null,\n      clicks_count = null,\n      shares_count = null,\n      favorites_count = null,\n      comments_count = null,\n      ad_spend = null,\n      is_cumulative = null,\n      body = null,\n      ...otherArgs\n    }: EngagementsArgs\n  ): Promise<unknown> {\n    const response = await this.request<MarketingEvent>({\n      http_method: \"post\",\n      operation: \"engagements\",\n      session: this.session,\n      urlIds: {\"id\": this.id},\n      params: {\"occurred_on\": occurred_on, \"impressions_count\": impressions_count, \"views_count\": views_count, \"clicks_count\": clicks_count, \"shares_count\": shares_count, \"favorites_count\": favorites_count, \"comments_count\": comments_count, \"ad_spend\": ad_spend, \"is_cumulative\": is_cumulative, ...otherArgs},\n      body: body,\n      entity: this,\n    });\n\n    return response ? response.body : null;\n  }\n\n  public event_type: string | null;\n  public marketing_channel: string | null;\n  public paid: boolean | null;\n  public started_at: string | null;\n  public UTM_parameters: {[key: string]: unknown} | null;\n  public budget: string | null;\n  public budget_type: string | null;\n  public currency: string | null;\n  public description: string | null;\n  public ended_at: string | null;\n  public id: string | null;\n  public manage_url: string | null;\n  public marketed_resources: {[key: string]: unknown}[] | null;\n  public preview_url: string | null;\n  public referring_domain: string | null;\n  public remote_id: string | null;\n  public scheduled_to_end_at: string | null;\n}\n"],"names":[],"mappings":";;;AAAA;;AAEwH;AAuClH,MAAO,cAAe,SAAQ,IAAI,CAAA;AAC/B,IAAA,OAAO,UAAU,GAAG,UAAU,CAAC,MAAM;AAElC,IAAA,OAAO,MAAM,GAAiC,EAAE;AAChD,IAAA,OAAO,OAAO,GAAiC,EAAE;IACjD,OAAO,KAAK,GAAmB;AACvC,QAAA,EAAC,aAAa,EAAE,QAAQ,EAAE,WAAW,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,4BAA4B,EAAC;AACrG,QAAA,EAAC,aAAa,EAAE,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,6BAA6B,EAAC;AAC9F,QAAA,EAAC,aAAa,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,uBAAuB,EAAC;AACtF,QAAA,EAAC,aAAa,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,4BAA4B,EAAC;AAC/F,QAAA,EAAC,aAAa,EAAE,MAAM,EAAE,WAAW,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,wCAAwC,EAAC;AACpH,QAAA,EAAC,aAAa,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,uBAAuB,EAAC;AACxF,QAAA,EAAC,aAAa,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,4BAA4B;KAC/F;IACS,OAAO,aAAa,GAAoB;AAChD,QAAA;AACE,YAAA,UAAU,EAAE,iBAAiB;AAC7B,YAAA,QAAQ,EAAE;AACX;KACF;IAEM,aAAa,IAAI,CACtB,EACE,OAAO,EACP,EAAE,EACO,EAAA;AAEX,QAAA,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAiB;AACjD,YAAA,OAAO,EAAE,OAAO;AAChB,YAAA,MAAM,EAAE,EAAC,IAAI,EAAE,EAAE,EAAC;AAClB,YAAA,MAAM,EAAE,EAAE;AACX,SAAA,CAAC;AACF,QAAA,OAAO,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI;IAC5C;IAEO,aAAa,MAAM,CACxB,EACE,OAAO,EACP,EAAE,EACS,EAAA;AAEb,QAAA,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAiB;AAClD,YAAA,WAAW,EAAE,QAAQ;AACrB,YAAA,SAAS,EAAE,QAAQ;AACnB,YAAA,OAAO,EAAE,OAAO;AAChB,YAAA,MAAM,EAAE,EAAC,IAAI,EAAE,EAAE,EAAC;AAClB,YAAA,MAAM,EAAE,EAAE;AACX,SAAA,CAAC;QAEF,OAAO,QAAQ,GAAG,QAAQ,CAAC,IAAI,GAAG,IAAI;IACxC;AAEO,IAAA,aAAa,GAAG,CACrB,EACE,OAAO,EACP,KAAK,GAAG,IAAI,EACZ,MAAM,GAAG,IAAI,EACb,GAAG,SAAS,EACJ,EAAA;AAEV,QAAA,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAiB;AACnD,YAAA,OAAO,EAAE,OAAO;AAChB,YAAA,MAAM,EAAE,EAAE;AACV,YAAA,MAAM,EAAE,EAAC,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,SAAS,EAAC;AACzD,SAAA,CAAC;AAEF,QAAA,OAAO,QAAQ;IACjB;IAEO,aAAa,KAAK,CACvB,EACE,OAAO,EACP,GAAG,SAAS,EACF,EAAA;AAEZ,QAAA,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAiB;AAClD,YAAA,WAAW,EAAE,KAAK;AAClB,YAAA,SAAS,EAAE,OAAO;AAClB,YAAA,OAAO,EAAE,OAAO;AAChB,YAAA,MAAM,EAAE,EAAE;AACV,YAAA,MAAM,EAAE,EAAC,GAAG,SAAS,EAAC;AACtB,YAAA,IAAI,EAAE,EAAE;AACR,YAAA,MAAM,EAAE,IAAI;AACb,SAAA,CAAC;QAEF,OAAO,QAAQ,GAAG,QAAQ,CAAC,IAAI,GAAG,IAAI;IACxC;IAEO,MAAM,WAAW,CACtB,EACE,WAAW,GAAG,IAAI,EAClB,iBAAiB,GAAG,IAAI,EACxB,WAAW,GAAG,IAAI,EAClB,YAAY,GAAG,IAAI,EACnB,YAAY,GAAG,IAAI,EACnB,eAAe,GAAG,IAAI,EACtB,cAAc,GAAG,IAAI,EACrB,QAAQ,GAAG,IAAI,EACf,aAAa,GAAG,IAAI,EACpB,IAAI,GAAG,IAAI,EACX,GAAG,SAAS,EACI,EAAA;AAElB,QAAA,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAiB;AAClD,YAAA,WAAW,EAAE,MAAM;AACnB,YAAA,SAAS,EAAE,aAAa;YACxB,OAAO,EAAE,IAAI,CAAC,OAAO;AACrB,YAAA,MAAM,EAAE,EAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAC;AACvB,YAAA,MAAM,EAAE,EAAC,aAAa,EAAE,WAAW,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,aAAa,EAAE,WAAW,EAAE,cAAc,EAAE,YAAY,EAAE,cAAc,EAAE,YAAY,EAAE,iBAAiB,EAAE,eAAe,EAAE,gBAAgB,EAAE,cAAc,EAAE,UAAU,EAAE,QAAQ,EAAE,eAAe,EAAE,aAAa,EAAE,GAAG,SAAS,EAAC;AAC9S,YAAA,IAAI,EAAE,IAAI;AACV,YAAA,MAAM,EAAE,IAAI;AACb,SAAA,CAAC;QAEF,OAAO,QAAQ,GAAG,QAAQ,CAAC,IAAI,GAAG,IAAI;IACxC;AAEO,IAAA,UAAU;AACV,IAAA,iBAAiB;AACjB,IAAA,IAAI;AACJ,IAAA,UAAU;AACV,IAAA,cAAc;AACd,IAAA,MAAM;AACN,IAAA,WAAW;AACX,IAAA,QAAQ;AACR,IAAA,WAAW;AACX,IAAA,QAAQ;AACR,IAAA,EAAE;AACF,IAAA,UAAU;AACV,IAAA,kBAAkB;AAClB,IAAA,WAAW;AACX,IAAA,gBAAgB;AAChB,IAAA,SAAS;AACT,IAAA,mBAAmB;;;;;"}