@shopify/shopify-api
Version:
Shopify API Library for Node - accelerate development with support for authentication, graphql proxy, webhooks
1 lines • 12.6 kB
Source Map (JSON)
{"version":3,"file":"article.mjs","sources":["../../../../../../../rest/admin/2025-04/article.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\nimport {Metafield} from './metafield';\n\ninterface FindArgs {\n session: Session;\n id: number | string;\n blog_id?: number | string | null;\n fields?: unknown;\n}\ninterface DeleteArgs {\n session: Session;\n id: number | string;\n blog_id?: number | string | null;\n}\ninterface AllArgs {\n [key: string]: unknown;\n session: Session;\n blog_id?: number | string | null;\n limit?: unknown;\n since_id?: unknown;\n created_at_min?: unknown;\n created_at_max?: unknown;\n updated_at_min?: unknown;\n updated_at_max?: unknown;\n published_at_min?: unknown;\n published_at_max?: unknown;\n published_status?: unknown;\n handle?: unknown;\n tag?: unknown;\n author?: unknown;\n fields?: unknown;\n}\ninterface AuthorsArgs {\n [key: string]: unknown;\n session: Session;\n}\ninterface CountArgs {\n [key: string]: unknown;\n session: Session;\n blog_id?: number | string | null;\n created_at_min?: unknown;\n created_at_max?: unknown;\n updated_at_min?: unknown;\n updated_at_max?: unknown;\n published_at_min?: unknown;\n published_at_max?: unknown;\n published_status?: unknown;\n}\ninterface TagsArgs {\n [key: string]: unknown;\n session: Session;\n blog_id?: number | string | null;\n limit?: unknown;\n popular?: unknown;\n}\n\nexport class Article extends Base {\n public static apiVersion = ApiVersion.April25;\n\n protected static hasOne: {[key: string]: typeof Base} = {};\n protected static hasMany: {[key: string]: typeof Base} = {\n \"metafields\": Metafield\n };\n protected static paths: ResourcePath[] = [\n {\"http_method\": \"delete\", \"operation\": \"delete\", \"ids\": [\"blog_id\", \"id\"], \"path\": \"blogs/<blog_id>/articles/<id>.json\"},\n {\"http_method\": \"get\", \"operation\": \"authors\", \"ids\": [], \"path\": \"articles/authors.json\"},\n {\"http_method\": \"get\", \"operation\": \"count\", \"ids\": [\"blog_id\"], \"path\": \"blogs/<blog_id>/articles/count.json\"},\n {\"http_method\": \"get\", \"operation\": \"get\", \"ids\": [\"blog_id\"], \"path\": \"blogs/<blog_id>/articles.json\"},\n {\"http_method\": \"get\", \"operation\": \"get\", \"ids\": [\"blog_id\", \"id\"], \"path\": \"blogs/<blog_id>/articles/<id>.json\"},\n {\"http_method\": \"get\", \"operation\": \"tags\", \"ids\": [], \"path\": \"articles/tags.json\"},\n {\"http_method\": \"get\", \"operation\": \"tags\", \"ids\": [\"blog_id\"], \"path\": \"blogs/<blog_id>/articles/tags.json\"},\n {\"http_method\": \"post\", \"operation\": \"post\", \"ids\": [\"blog_id\"], \"path\": \"blogs/<blog_id>/articles.json\"},\n {\"http_method\": \"put\", \"operation\": \"put\", \"ids\": [\"blog_id\", \"id\"], \"path\": \"blogs/<blog_id>/articles/<id>.json\"}\n ];\n protected static resourceNames: ResourceNames[] = [\n {\n \"singular\": \"article\",\n \"plural\": \"articles\"\n }\n ];\n\n public static async find(\n {\n session,\n id,\n blog_id = null,\n fields = null\n }: FindArgs\n ): Promise<Article | null> {\n const result = await this.baseFind<Article>({\n session: session,\n urlIds: {\"id\": id, \"blog_id\": blog_id},\n params: {\"fields\": fields},\n });\n return result.data ? result.data[0] : null;\n }\n\n public static async delete(\n {\n session,\n id,\n blog_id = null\n }: DeleteArgs\n ): Promise<unknown> {\n const response = await this.request<Article>({\n http_method: \"delete\",\n operation: \"delete\",\n session: session,\n urlIds: {\"id\": id, \"blog_id\": blog_id},\n params: {},\n });\n\n return response ? response.body : null;\n }\n\n public static async all(\n {\n session,\n blog_id = null,\n limit = null,\n since_id = null,\n created_at_min = null,\n created_at_max = null,\n updated_at_min = null,\n updated_at_max = null,\n published_at_min = null,\n published_at_max = null,\n published_status = null,\n handle = null,\n tag = null,\n author = null,\n fields = null,\n ...otherArgs\n }: AllArgs\n ): Promise<FindAllResponse<Article>> {\n const response = await this.baseFind<Article>({\n session: session,\n urlIds: {\"blog_id\": blog_id},\n params: {\"limit\": limit, \"since_id\": since_id, \"created_at_min\": created_at_min, \"created_at_max\": created_at_max, \"updated_at_min\": updated_at_min, \"updated_at_max\": updated_at_max, \"published_at_min\": published_at_min, \"published_at_max\": published_at_max, \"published_status\": published_status, \"handle\": handle, \"tag\": tag, \"author\": author, \"fields\": fields, ...otherArgs},\n });\n\n return response;\n }\n\n public static async authors(\n {\n session,\n ...otherArgs\n }: AuthorsArgs\n ): Promise<unknown> {\n const response = await this.request<Article>({\n http_method: \"get\",\n operation: \"authors\",\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 static async count(\n {\n session,\n blog_id = null,\n created_at_min = null,\n created_at_max = null,\n updated_at_min = null,\n updated_at_max = null,\n published_at_min = null,\n published_at_max = null,\n published_status = null,\n ...otherArgs\n }: CountArgs\n ): Promise<unknown> {\n const response = await this.request<Article>({\n http_method: \"get\",\n operation: \"count\",\n session: session,\n urlIds: {\"blog_id\": blog_id},\n params: {\"created_at_min\": created_at_min, \"created_at_max\": created_at_max, \"updated_at_min\": updated_at_min, \"updated_at_max\": updated_at_max, \"published_at_min\": published_at_min, \"published_at_max\": published_at_max, \"published_status\": published_status, ...otherArgs},\n body: {},\n entity: null,\n });\n\n return response ? response.body : null;\n }\n\n public static async tags(\n {\n session,\n blog_id = null,\n limit = null,\n popular = null,\n ...otherArgs\n }: TagsArgs\n ): Promise<unknown> {\n const response = await this.request<Article>({\n http_method: \"get\",\n operation: \"tags\",\n session: session,\n urlIds: {\"blog_id\": blog_id},\n params: {\"limit\": limit, \"popular\": popular, ...otherArgs},\n body: {},\n entity: null,\n });\n\n return response ? response.body : null;\n }\n\n public author: string | null;\n public blog_id: string | null;\n public body_html: string | null;\n public created_at: string | null;\n public handle: string | null;\n public id: string | null;\n public image: string | {[key: string]: unknown} | null;\n public metafields: Metafield[] | null | {[key: string]: any};\n public published: boolean | null;\n public published_at: string | null;\n public summary_html: string | null;\n public tags: string | null;\n public template_suffix: string | null;\n public title: string | null;\n public updated_at: string | null;\n public user_id: string | null;\n}\n"],"names":[],"mappings":";;;;AAAA;;AAEwH;AA8DlH,MAAO,OAAQ,SAAQ,IAAI,CAAA;AACxB,IAAA,OAAO,UAAU,GAAG,UAAU,CAAC,OAAO;AAEnC,IAAA,OAAO,MAAM,GAAiC,EAAE;IAChD,OAAO,OAAO,GAAiC;AACvD,QAAA,YAAY,EAAE;KACf;IACS,OAAO,KAAK,GAAmB;AACvC,QAAA,EAAC,aAAa,EAAE,QAAQ,EAAE,WAAW,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,oCAAoC,EAAC;AACxH,QAAA,EAAC,aAAa,EAAE,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,uBAAuB,EAAC;AAC1F,QAAA,EAAC,aAAa,EAAE,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,qCAAqC,EAAC;AAC/G,QAAA,EAAC,aAAa,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,+BAA+B,EAAC;AACvG,QAAA,EAAC,aAAa,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,oCAAoC,EAAC;AAClH,QAAA,EAAC,aAAa,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,oBAAoB,EAAC;AACpF,QAAA,EAAC,aAAa,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,oCAAoC,EAAC;AAC7G,QAAA,EAAC,aAAa,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,+BAA+B,EAAC;AACzG,QAAA,EAAC,aAAa,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,oCAAoC;KAClH;IACS,OAAO,aAAa,GAAoB;AAChD,QAAA;AACE,YAAA,UAAU,EAAE,SAAS;AACrB,YAAA,QAAQ,EAAE;AACX;KACF;AAEM,IAAA,aAAa,IAAI,CACtB,EACE,OAAO,EACP,EAAE,EACF,OAAO,GAAG,IAAI,EACd,MAAM,GAAG,IAAI,EACJ,EAAA;AAEX,QAAA,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAU;AAC1C,YAAA,OAAO,EAAE,OAAO;YAChB,MAAM,EAAE,EAAC,IAAI,EAAE,EAAE,EAAE,SAAS,EAAE,OAAO,EAAC;AACtC,YAAA,MAAM,EAAE,EAAC,QAAQ,EAAE,MAAM,EAAC;AAC3B,SAAA,CAAC;AACF,QAAA,OAAO,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI;IAC5C;AAEO,IAAA,aAAa,MAAM,CACxB,EACE,OAAO,EACP,EAAE,EACF,OAAO,GAAG,IAAI,EACH,EAAA;AAEb,QAAA,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAU;AAC3C,YAAA,WAAW,EAAE,QAAQ;AACrB,YAAA,SAAS,EAAE,QAAQ;AACnB,YAAA,OAAO,EAAE,OAAO;YAChB,MAAM,EAAE,EAAC,IAAI,EAAE,EAAE,EAAE,SAAS,EAAE,OAAO,EAAC;AACtC,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,OAAO,GAAG,IAAI,EACd,KAAK,GAAG,IAAI,EACZ,QAAQ,GAAG,IAAI,EACf,cAAc,GAAG,IAAI,EACrB,cAAc,GAAG,IAAI,EACrB,cAAc,GAAG,IAAI,EACrB,cAAc,GAAG,IAAI,EACrB,gBAAgB,GAAG,IAAI,EACvB,gBAAgB,GAAG,IAAI,EACvB,gBAAgB,GAAG,IAAI,EACvB,MAAM,GAAG,IAAI,EACb,GAAG,GAAG,IAAI,EACV,MAAM,GAAG,IAAI,EACb,MAAM,GAAG,IAAI,EACb,GAAG,SAAS,EACJ,EAAA;AAEV,QAAA,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAU;AAC5C,YAAA,OAAO,EAAE,OAAO;AAChB,YAAA,MAAM,EAAE,EAAC,SAAS,EAAE,OAAO,EAAC;YAC5B,MAAM,EAAE,EAAC,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,gBAAgB,EAAE,cAAc,EAAE,gBAAgB,EAAE,cAAc,EAAE,gBAAgB,EAAE,cAAc,EAAE,gBAAgB,EAAE,cAAc,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,SAAS,EAAC;AACzX,SAAA,CAAC;AAEF,QAAA,OAAO,QAAQ;IACjB;IAEO,aAAa,OAAO,CACzB,EACE,OAAO,EACP,GAAG,SAAS,EACA,EAAA;AAEd,QAAA,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAU;AAC3C,YAAA,WAAW,EAAE,KAAK;AAClB,YAAA,SAAS,EAAE,SAAS;AACpB,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;AAEO,IAAA,aAAa,KAAK,CACvB,EACE,OAAO,EACP,OAAO,GAAG,IAAI,EACd,cAAc,GAAG,IAAI,EACrB,cAAc,GAAG,IAAI,EACrB,cAAc,GAAG,IAAI,EACrB,cAAc,GAAG,IAAI,EACrB,gBAAgB,GAAG,IAAI,EACvB,gBAAgB,GAAG,IAAI,EACvB,gBAAgB,GAAG,IAAI,EACvB,GAAG,SAAS,EACF,EAAA;AAEZ,QAAA,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAU;AAC3C,YAAA,WAAW,EAAE,KAAK;AAClB,YAAA,SAAS,EAAE,OAAO;AAClB,YAAA,OAAO,EAAE,OAAO;AAChB,YAAA,MAAM,EAAE,EAAC,SAAS,EAAE,OAAO,EAAC;AAC5B,YAAA,MAAM,EAAE,EAAC,gBAAgB,EAAE,cAAc,EAAE,gBAAgB,EAAE,cAAc,EAAE,gBAAgB,EAAE,cAAc,EAAE,gBAAgB,EAAE,cAAc,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,GAAG,SAAS,EAAC;AAChR,YAAA,IAAI,EAAE,EAAE;AACR,YAAA,MAAM,EAAE,IAAI;AACb,SAAA,CAAC;QAEF,OAAO,QAAQ,GAAG,QAAQ,CAAC,IAAI,GAAG,IAAI;IACxC;IAEO,aAAa,IAAI,CACtB,EACE,OAAO,EACP,OAAO,GAAG,IAAI,EACd,KAAK,GAAG,IAAI,EACZ,OAAO,GAAG,IAAI,EACd,GAAG,SAAS,EACH,EAAA;AAEX,QAAA,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAU;AAC3C,YAAA,WAAW,EAAE,KAAK;AAClB,YAAA,SAAS,EAAE,MAAM;AACjB,YAAA,OAAO,EAAE,OAAO;AAChB,YAAA,MAAM,EAAE,EAAC,SAAS,EAAE,OAAO,EAAC;AAC5B,YAAA,MAAM,EAAE,EAAC,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,SAAS,EAAC;AAC1D,YAAA,IAAI,EAAE,EAAE;AACR,YAAA,MAAM,EAAE,IAAI;AACb,SAAA,CAAC;QAEF,OAAO,QAAQ,GAAG,QAAQ,CAAC,IAAI,GAAG,IAAI;IACxC;AAEO,IAAA,MAAM;AACN,IAAA,OAAO;AACP,IAAA,SAAS;AACT,IAAA,UAAU;AACV,IAAA,MAAM;AACN,IAAA,EAAE;AACF,IAAA,KAAK;AACL,IAAA,UAAU;AACV,IAAA,SAAS;AACT,IAAA,YAAY;AACZ,IAAA,YAAY;AACZ,IAAA,IAAI;AACJ,IAAA,eAAe;AACf,IAAA,KAAK;AACL,IAAA,UAAU;AACV,IAAA,OAAO;;;;;"}