@shopify/shopify-api/dist/esm/rest/admin/2024-01/customer.mjs.map

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

{"version":3,"file":"customer.mjs","sources":["../../../../../../../rest/admin/2024-01/customer.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  fields?: unknown;\n}\ninterface DeleteArgs {\n  session: Session;\n  id: number | string;\n}\ninterface AllArgs {\n  [key: string]: unknown;\n  session: Session;\n  ids?: 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  limit?: unknown;\n  fields?: unknown;\n}\ninterface CountArgs {\n  [key: string]: unknown;\n  session: Session;\n  created_at_min?: unknown;\n  created_at_max?: unknown;\n  updated_at_min?: unknown;\n  updated_at_max?: unknown;\n}\ninterface OrdersArgs {\n  [key: string]: unknown;\n  session: Session;\n  id: number | string;\n  status?: unknown;\n}\ninterface SearchArgs {\n  [key: string]: unknown;\n  session: Session;\n  order?: unknown;\n  query?: unknown;\n  limit?: unknown;\n  fields?: unknown;\n  returnFullResponse?: boolean;\n}\ninterface AccountActivationUrlArgs {\n  [key: string]: unknown;\n  body?: {[key: string]: unknown} | null;\n}\ninterface SendInviteArgs {\n  [key: string]: unknown;\n  body?: {[key: string]: unknown} | null;\n}\n\nexport class Customer extends Base {\n  public static apiVersion = ApiVersion.January24;\n\n  protected static hasOne: {[key: string]: typeof Base} = {\n    \"metafield\": Metafield\n  };\n  protected static hasMany: {[key: string]: typeof Base} = {};\n  protected static paths: ResourcePath[] = [\n    {\"http_method\": \"delete\", \"operation\": \"delete\", \"ids\": [\"id\"], \"path\": \"customers/<id>.json\"},\n    {\"http_method\": \"get\", \"operation\": \"count\", \"ids\": [], \"path\": \"customers/count.json\"},\n    {\"http_method\": \"get\", \"operation\": \"get\", \"ids\": [], \"path\": \"customers.json\"},\n    {\"http_method\": \"get\", \"operation\": \"get\", \"ids\": [\"id\"], \"path\": \"customers/<id>.json\"},\n    {\"http_method\": \"get\", \"operation\": \"orders\", \"ids\": [\"id\"], \"path\": \"customers/<id>/orders.json\"},\n    {\"http_method\": \"get\", \"operation\": \"search\", \"ids\": [], \"path\": \"customers/search.json\"},\n    {\"http_method\": \"post\", \"operation\": \"account_activation_url\", \"ids\": [\"id\"], \"path\": \"customers/<id>/account_activation_url.json\"},\n    {\"http_method\": \"post\", \"operation\": \"post\", \"ids\": [], \"path\": \"customers.json\"},\n    {\"http_method\": \"post\", \"operation\": \"send_invite\", \"ids\": [\"id\"], \"path\": \"customers/<id>/send_invite.json\"},\n    {\"http_method\": \"put\", \"operation\": \"put\", \"ids\": [\"id\"], \"path\": \"customers/<id>.json\"}\n  ];\n  protected static resourceNames: ResourceNames[] = [\n    {\n      \"singular\": \"customer\",\n      \"plural\": \"customers\"\n    }\n  ];\n\n  public static async find(\n    {\n      session,\n      id,\n      fields = null\n    }: FindArgs\n  ): Promise<Customer | null> {\n    const result = await this.baseFind<Customer>({\n      session: session,\n      requireIds: true,\n      urlIds: {\"id\": 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    }: DeleteArgs\n  ): Promise<unknown> {\n    const response = await this.request<Customer>({\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      ids = 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      limit = null,\n      fields = null,\n      ...otherArgs\n    }: AllArgs\n  ): Promise<FindAllResponse<Customer>> {\n    const response = await this.baseFind<Customer>({\n      session: session,\n      urlIds: {},\n      params: {\"ids\": ids, \"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, \"limit\": limit, \"fields\": fields, ...otherArgs},\n    });\n\n    return response;\n  }\n\n  public static async count(\n    {\n      session,\n      created_at_min = null,\n      created_at_max = null,\n      updated_at_min = null,\n      updated_at_max = null,\n      ...otherArgs\n    }: CountArgs\n  ): Promise<unknown> {\n    const response = await this.request<Customer>({\n      http_method: \"get\",\n      operation: \"count\",\n      session: session,\n      urlIds: {},\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, ...otherArgs},\n      body: {},\n      entity: null,\n    });\n\n    return response ? response.body : null;\n  }\n\n  public static async orders(\n    {\n      session,\n      id,\n      status = null,\n      ...otherArgs\n    }: OrdersArgs\n  ): Promise<unknown> {\n    const response = await this.request<Customer>({\n      http_method: \"get\",\n      operation: \"orders\",\n      session: session,\n      urlIds: {\"id\": id},\n      params: {\"status\": status, ...otherArgs},\n      body: {},\n      entity: null,\n    });\n\n    return response ? response.body : null;\n  }\n\n  public static async search(\n    {\n      session,\n      order = null,\n      query = null,\n      limit = null,\n      fields = null,\n      returnFullResponse = false,\n      ...otherArgs\n    }: SearchArgs\n  ): Promise<unknown> {\n    const response = await this.request<Customer>({\n      http_method: \"get\",\n      operation: \"search\",\n      session: session,\n      urlIds: {},\n      params: {\"order\": order, \"query\": query, \"limit\": limit, \"fields\": fields, ...otherArgs},\n      body: {},\n      entity: null,\n    });\n\n    return returnFullResponse ? response : response?.body;\n  }\n\n  public async account_activation_url(\n    {\n      body = null,\n      ...otherArgs\n    }: AccountActivationUrlArgs\n  ): Promise<unknown> {\n    const response = await this.request<Customer>({\n      http_method: \"post\",\n      operation: \"account_activation_url\",\n      session: this.session,\n      urlIds: {\"id\": this.id},\n      params: {...otherArgs},\n      body: body,\n      entity: this,\n    });\n\n    return response ? response.body : null;\n  }\n\n  public async send_invite(\n    {\n      body = null,\n      ...otherArgs\n    }: SendInviteArgs\n  ): Promise<unknown> {\n    const response = await this.request<Customer>({\n      http_method: \"post\",\n      operation: \"send_invite\",\n      session: this.session,\n      urlIds: {\"id\": this.id},\n      params: {...otherArgs},\n      body: body,\n      entity: this,\n    });\n\n    return response ? response.body : null;\n  }\n\n  public accepts_marketing: boolean | null;\n  public accepts_marketing_updated_at: string | null;\n  public addresses: {[key: string]: unknown}[] | null;\n  public created_at: string | null;\n  public currency: string | null;\n  public default_address: {[key: string]: unknown} | null;\n  public email: string | null;\n  public email_marketing_consent: {[key: string]: unknown} | null;\n  public first_name: string | null;\n  public id: string | null;\n  public last_name: string | null;\n  public last_order_id: string | null;\n  public last_order_name: string | null;\n  public marketing_opt_in_level: string | null;\n  public metafield: Metafield | null | {[key: string]: any};\n  public multipass_identifier: string | null;\n  public note: string | null;\n  public orders_count: number | null;\n  public password: string | null;\n  public password_confirmation: string | null;\n  public phone: string | null;\n  public sms_marketing_consent: {[key: string]: unknown} | null;\n  public state: string | null;\n  public tags: string | null;\n  public tax_exempt: boolean | null;\n  public tax_exemptions: string[] | null;\n  public total_spent: string | null;\n  public updated_at: string | null;\n  public verified_email: boolean | null;\n}\n"],"names":[],"mappings":";;;;AAAA;;AAEwH;AA8DlH,MAAO,QAAS,SAAQ,IAAI,CAAA;AACzB,IAAA,OAAO,UAAU,GAAG,UAAU,CAAC,SAAS;IAErC,OAAO,MAAM,GAAiC;AACtD,QAAA,WAAW,EAAE;KACd;AACS,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,qBAAqB,EAAC;AAC9F,QAAA,EAAC,aAAa,EAAE,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,sBAAsB,EAAC;AACvF,QAAA,EAAC,aAAa,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,gBAAgB,EAAC;AAC/E,QAAA,EAAC,aAAa,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,qBAAqB,EAAC;AACxF,QAAA,EAAC,aAAa,EAAE,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,4BAA4B,EAAC;AAClG,QAAA,EAAC,aAAa,EAAE,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,uBAAuB,EAAC;AACzF,QAAA,EAAC,aAAa,EAAE,MAAM,EAAE,WAAW,EAAE,wBAAwB,EAAE,KAAK,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,4CAA4C,EAAC;AACnI,QAAA,EAAC,aAAa,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,gBAAgB,EAAC;AACjF,QAAA,EAAC,aAAa,EAAE,MAAM,EAAE,WAAW,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,iCAAiC,EAAC;AAC7G,QAAA,EAAC,aAAa,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,qBAAqB;KACxF;IACS,OAAO,aAAa,GAAoB;AAChD,QAAA;AACE,YAAA,UAAU,EAAE,UAAU;AACtB,YAAA,QAAQ,EAAE;AACX;KACF;AAEM,IAAA,aAAa,IAAI,CACtB,EACE,OAAO,EACP,EAAE,EACF,MAAM,GAAG,IAAI,EACJ,EAAA;AAEX,QAAA,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAW;AAC3C,YAAA,OAAO,EAAE,OAAO;AAChB,YAAA,UAAU,EAAE,IAAI;AAChB,YAAA,MAAM,EAAE,EAAC,IAAI,EAAE,EAAE,EAAC;AAClB,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;IAEO,aAAa,MAAM,CACxB,EACE,OAAO,EACP,EAAE,EACS,EAAA;AAEb,QAAA,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAW;AAC5C,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,GAAG,GAAG,IAAI,EACV,QAAQ,GAAG,IAAI,EACf,cAAc,GAAG,IAAI,EACrB,cAAc,GAAG,IAAI,EACrB,cAAc,GAAG,IAAI,EACrB,cAAc,GAAG,IAAI,EACrB,KAAK,GAAG,IAAI,EACZ,MAAM,GAAG,IAAI,EACb,GAAG,SAAS,EACJ,EAAA;AAEV,QAAA,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAW;AAC7C,YAAA,OAAO,EAAE,OAAO;AAChB,YAAA,MAAM,EAAE,EAAE;AACV,YAAA,MAAM,EAAE,EAAC,KAAK,EAAE,GAAG,EAAE,UAAU,EAAE,QAAQ,EAAE,gBAAgB,EAAE,cAAc,EAAE,gBAAgB,EAAE,cAAc,EAAE,gBAAgB,EAAE,cAAc,EAAE,gBAAgB,EAAE,cAAc,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,SAAS,EAAC;AACnO,SAAA,CAAC;AAEF,QAAA,OAAO,QAAQ;IACjB;IAEO,aAAa,KAAK,CACvB,EACE,OAAO,EACP,cAAc,GAAG,IAAI,EACrB,cAAc,GAAG,IAAI,EACrB,cAAc,GAAG,IAAI,EACrB,cAAc,GAAG,IAAI,EACrB,GAAG,SAAS,EACF,EAAA;AAEZ,QAAA,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAW;AAC5C,YAAA,WAAW,EAAE,KAAK;AAClB,YAAA,SAAS,EAAE,OAAO;AAClB,YAAA,OAAO,EAAE,OAAO;AAChB,YAAA,MAAM,EAAE,EAAE;YACV,MAAM,EAAE,EAAC,gBAAgB,EAAE,cAAc,EAAE,gBAAgB,EAAE,cAAc,EAAE,gBAAgB,EAAE,cAAc,EAAE,gBAAgB,EAAE,cAAc,EAAE,GAAG,SAAS,EAAC;AAC9J,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,MAAM,CACxB,EACE,OAAO,EACP,EAAE,EACF,MAAM,GAAG,IAAI,EACb,GAAG,SAAS,EACD,EAAA;AAEb,QAAA,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAW;AAC5C,YAAA,WAAW,EAAE,KAAK;AAClB,YAAA,SAAS,EAAE,QAAQ;AACnB,YAAA,OAAO,EAAE,OAAO;AAChB,YAAA,MAAM,EAAE,EAAC,IAAI,EAAE,EAAE,EAAC;YAClB,MAAM,EAAE,EAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,SAAS,EAAC;AACxC,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,MAAM,CACxB,EACE,OAAO,EACP,KAAK,GAAG,IAAI,EACZ,KAAK,GAAG,IAAI,EACZ,KAAK,GAAG,IAAI,EACZ,MAAM,GAAG,IAAI,EACb,kBAAkB,GAAG,KAAK,EAC1B,GAAG,SAAS,EACD,EAAA;AAEb,QAAA,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAW;AAC5C,YAAA,WAAW,EAAE,KAAK;AAClB,YAAA,SAAS,EAAE,QAAQ;AACnB,YAAA,OAAO,EAAE,OAAO;AAChB,YAAA,MAAM,EAAE,EAAE;YACV,MAAM,EAAE,EAAC,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,SAAS,EAAC;AACxF,YAAA,IAAI,EAAE,EAAE;AACR,YAAA,MAAM,EAAE,IAAI;AACb,SAAA,CAAC;QAEF,OAAO,kBAAkB,GAAG,QAAQ,GAAG,QAAQ,EAAE,IAAI;IACvD;IAEO,MAAM,sBAAsB,CACjC,EACE,IAAI,GAAG,IAAI,EACX,GAAG,SAAS,EACa,EAAA;AAE3B,QAAA,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAW;AAC5C,YAAA,WAAW,EAAE,MAAM;AACnB,YAAA,SAAS,EAAE,wBAAwB;YACnC,OAAO,EAAE,IAAI,CAAC,OAAO;AACrB,YAAA,MAAM,EAAE,EAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAC;AACvB,YAAA,MAAM,EAAE,EAAC,GAAG,SAAS,EAAC;AACtB,YAAA,IAAI,EAAE,IAAI;AACV,YAAA,MAAM,EAAE,IAAI;AACb,SAAA,CAAC;QAEF,OAAO,QAAQ,GAAG,QAAQ,CAAC,IAAI,GAAG,IAAI;IACxC;IAEO,MAAM,WAAW,CACtB,EACE,IAAI,GAAG,IAAI,EACX,GAAG,SAAS,EACG,EAAA;AAEjB,QAAA,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAW;AAC5C,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,GAAG,SAAS,EAAC;AACtB,YAAA,IAAI,EAAE,IAAI;AACV,YAAA,MAAM,EAAE,IAAI;AACb,SAAA,CAAC;QAEF,OAAO,QAAQ,GAAG,QAAQ,CAAC,IAAI,GAAG,IAAI;IACxC;AAEO,IAAA,iBAAiB;AACjB,IAAA,4BAA4B;AAC5B,IAAA,SAAS;AACT,IAAA,UAAU;AACV,IAAA,QAAQ;AACR,IAAA,eAAe;AACf,IAAA,KAAK;AACL,IAAA,uBAAuB;AACvB,IAAA,UAAU;AACV,IAAA,EAAE;AACF,IAAA,SAAS;AACT,IAAA,aAAa;AACb,IAAA,eAAe;AACf,IAAA,sBAAsB;AACtB,IAAA,SAAS;AACT,IAAA,oBAAoB;AACpB,IAAA,IAAI;AACJ,IAAA,YAAY;AACZ,IAAA,QAAQ;AACR,IAAA,qBAAqB;AACrB,IAAA,KAAK;AACL,IAAA,qBAAqB;AACrB,IAAA,KAAK;AACL,IAAA,IAAI;AACJ,IAAA,UAAU;AACV,IAAA,cAAc;AACd,IAAA,WAAW;AACX,IAAA,UAAU;AACV,IAAA,cAAc;;;;;"}