UNPKG

@shopify/shopify-api

Version:

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

1 lines 15.8 kB
{"version":3,"file":"fulfillment_order.mjs","sources":["../../../../../../../rest/admin/2025-10/fulfillment_order.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 include_financial_summaries?: unknown;\n include_order_reference_fields?: unknown;\n}\ninterface AllArgs {\n [key: string]: unknown;\n session: Session;\n order_id?: number | string | null;\n include_financial_summaries?: unknown;\n include_order_reference_fields?: unknown;\n}\ninterface CancelArgs {\n [key: string]: unknown;\n body?: {[key: string]: unknown} | null;\n}\ninterface CloseArgs {\n [key: string]: unknown;\n message?: unknown;\n body?: {[key: string]: unknown} | null;\n}\ninterface HoldArgs {\n [key: string]: unknown;\n fulfillment_hold?: unknown;\n body?: {[key: string]: unknown} | null;\n}\ninterface MoveArgs {\n [key: string]: unknown;\n fulfillment_order?: unknown;\n body?: {[key: string]: unknown} | null;\n}\ninterface OpenArgs {\n [key: string]: unknown;\n body?: {[key: string]: unknown} | null;\n}\ninterface ReleaseHoldArgs {\n [key: string]: unknown;\n body?: {[key: string]: unknown} | null;\n}\ninterface RescheduleArgs {\n [key: string]: unknown;\n new_fulfill_at?: unknown;\n body?: {[key: string]: unknown} | null;\n}\ninterface SetFulfillmentOrdersDeadlineArgs {\n [key: string]: unknown;\n fulfillment_order_ids?: unknown;\n fulfillment_deadline?: unknown;\n body?: {[key: string]: unknown} | null;\n}\n\nexport class FulfillmentOrder extends Base {\n public static apiVersion = ApiVersion.October25;\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\": \"get\", \"operation\": \"get\", \"ids\": [\"id\"], \"path\": \"fulfillment_orders/<id>.json\"},\n {\"http_method\": \"get\", \"operation\": \"get\", \"ids\": [\"order_id\"], \"path\": \"orders/<order_id>/fulfillment_orders.json\"},\n {\"http_method\": \"post\", \"operation\": \"cancel\", \"ids\": [\"id\"], \"path\": \"fulfillment_orders/<id>/cancel.json\"},\n {\"http_method\": \"post\", \"operation\": \"close\", \"ids\": [\"id\"], \"path\": \"fulfillment_orders/<id>/close.json\"},\n {\"http_method\": \"post\", \"operation\": \"hold\", \"ids\": [\"id\"], \"path\": \"fulfillment_orders/<id>/hold.json\"},\n {\"http_method\": \"post\", \"operation\": \"move\", \"ids\": [\"id\"], \"path\": \"fulfillment_orders/<id>/move.json\"},\n {\"http_method\": \"post\", \"operation\": \"open\", \"ids\": [\"id\"], \"path\": \"fulfillment_orders/<id>/open.json\"},\n {\"http_method\": \"post\", \"operation\": \"release_hold\", \"ids\": [\"id\"], \"path\": \"fulfillment_orders/<id>/release_hold.json\"},\n {\"http_method\": \"post\", \"operation\": \"reschedule\", \"ids\": [\"id\"], \"path\": \"fulfillment_orders/<id>/reschedule.json\"},\n {\"http_method\": \"post\", \"operation\": \"set_fulfillment_orders_deadline\", \"ids\": [], \"path\": \"fulfillment_orders/set_fulfillment_orders_deadline.json\"}\n ];\n protected static resourceNames: ResourceNames[] = [\n {\n \"singular\": \"fulfillment_order\",\n \"plural\": \"fulfillment_orders\"\n }\n ];\n\n public static async find(\n {\n session,\n id,\n include_financial_summaries = null,\n include_order_reference_fields = null\n }: FindArgs\n ): Promise<FulfillmentOrder | null> {\n const result = await this.baseFind<FulfillmentOrder>({\n session: session,\n urlIds: {\"id\": id},\n params: {\"include_financial_summaries\": include_financial_summaries, \"include_order_reference_fields\": include_order_reference_fields},\n });\n return result.data ? result.data[0] : null;\n }\n\n public static async all(\n {\n session,\n order_id = null,\n include_financial_summaries = null,\n include_order_reference_fields = null,\n ...otherArgs\n }: AllArgs\n ): Promise<FindAllResponse<FulfillmentOrder>> {\n const response = await this.baseFind<FulfillmentOrder>({\n session: session,\n urlIds: {\"order_id\": order_id},\n params: {\"include_financial_summaries\": include_financial_summaries, \"include_order_reference_fields\": include_order_reference_fields, ...otherArgs},\n });\n\n return response;\n }\n\n public async cancel(\n {\n body = null,\n ...otherArgs\n }: CancelArgs\n ): Promise<unknown> {\n const response = await this.request<FulfillmentOrder>({\n http_method: \"post\",\n operation: \"cancel\",\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 close(\n {\n message = null,\n body = null,\n ...otherArgs\n }: CloseArgs\n ): Promise<unknown> {\n const response = await this.request<FulfillmentOrder>({\n http_method: \"post\",\n operation: \"close\",\n session: this.session,\n urlIds: {\"id\": this.id},\n params: {\"message\": message, ...otherArgs},\n body: body,\n entity: this,\n });\n\n return response ? response.body : null;\n }\n\n public async hold(\n {\n fulfillment_hold = null,\n body = null,\n ...otherArgs\n }: HoldArgs\n ): Promise<unknown> {\n const response = await this.request<FulfillmentOrder>({\n http_method: \"post\",\n operation: \"hold\",\n session: this.session,\n urlIds: {\"id\": this.id},\n params: {\"fulfillment_hold\": fulfillment_hold, ...otherArgs},\n body: body,\n entity: this,\n });\n\n return response ? response.body : null;\n }\n\n public async move(\n {\n fulfillment_order = null,\n body = null,\n ...otherArgs\n }: MoveArgs\n ): Promise<unknown> {\n const response = await this.request<FulfillmentOrder>({\n http_method: \"post\",\n operation: \"move\",\n session: this.session,\n urlIds: {\"id\": this.id},\n params: {\"fulfillment_order\": fulfillment_order, ...otherArgs},\n body: body,\n entity: this,\n });\n\n return response ? response.body : null;\n }\n\n public async open(\n {\n body = null,\n ...otherArgs\n }: OpenArgs\n ): Promise<unknown> {\n const response = await this.request<FulfillmentOrder>({\n http_method: \"post\",\n operation: \"open\",\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 release_hold(\n {\n body = null,\n ...otherArgs\n }: ReleaseHoldArgs\n ): Promise<unknown> {\n const response = await this.request<FulfillmentOrder>({\n http_method: \"post\",\n operation: \"release_hold\",\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 reschedule(\n {\n new_fulfill_at = null,\n body = null,\n ...otherArgs\n }: RescheduleArgs\n ): Promise<unknown> {\n const response = await this.request<FulfillmentOrder>({\n http_method: \"post\",\n operation: \"reschedule\",\n session: this.session,\n urlIds: {\"id\": this.id},\n params: {\"new_fulfill_at\": new_fulfill_at, ...otherArgs},\n body: body,\n entity: this,\n });\n\n return response ? response.body : null;\n }\n\n public async set_fulfillment_orders_deadline(\n {\n fulfillment_order_ids = null,\n fulfillment_deadline = null,\n body = null,\n ...otherArgs\n }: SetFulfillmentOrdersDeadlineArgs\n ): Promise<unknown> {\n const response = await this.request<FulfillmentOrder>({\n http_method: \"post\",\n operation: \"set_fulfillment_orders_deadline\",\n session: this.session,\n urlIds: {},\n params: {\"fulfillment_order_ids\": fulfillment_order_ids, \"fulfillment_deadline\": fulfillment_deadline, ...otherArgs},\n body: body,\n entity: this,\n });\n\n return response ? response.body : null;\n }\n\n public assigned_location: {[key: string]: unknown} | null;\n public assigned_location_id: string | null;\n public created_at: string | null;\n public delivery_method: {[key: string]: unknown} | null;\n public destination: {[key: string]: unknown} | null;\n public fulfill_at: string | null;\n public fulfill_by: string | null;\n public fulfillment_holds: {[key: string]: unknown}[] | null;\n public id: string | null;\n public international_duties: {[key: string]: unknown} | null;\n public line_items: {[key: string]: unknown}[] | null;\n public merchant_requests: {[key: string]: unknown}[] | null;\n public order_id: string | null;\n public request_status: string | null;\n public shop_id: string | null;\n public status: string | null;\n public supported_actions: string[] | null;\n public updated_at: string | null;\n}\n"],"names":[],"mappings":";;;AAAA;;AAEwH;AA2DlH,MAAO,gBAAiB,SAAQ,IAAI,CAAA;AACjC,IAAA,OAAO,UAAU,GAAG,UAAU,CAAC,SAAS;AAErC,IAAA,OAAO,MAAM,GAAiC,EAAE;AAChD,IAAA,OAAO,OAAO,GAAiC,EAAE;IACjD,OAAO,KAAK,GAAmB;AACvC,QAAA,EAAC,aAAa,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,8BAA8B,EAAC;AACjG,QAAA,EAAC,aAAa,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,2CAA2C,EAAC;AACpH,QAAA,EAAC,aAAa,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,qCAAqC,EAAC;AAC5G,QAAA,EAAC,aAAa,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,oCAAoC,EAAC;AAC1G,QAAA,EAAC,aAAa,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,mCAAmC,EAAC;AACxG,QAAA,EAAC,aAAa,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,mCAAmC,EAAC;AACxG,QAAA,EAAC,aAAa,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,mCAAmC,EAAC;AACxG,QAAA,EAAC,aAAa,EAAE,MAAM,EAAE,WAAW,EAAE,cAAc,EAAE,KAAK,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,2CAA2C,EAAC;AACxH,QAAA,EAAC,aAAa,EAAE,MAAM,EAAE,WAAW,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,yCAAyC,EAAC;AACpH,QAAA,EAAC,aAAa,EAAE,MAAM,EAAE,WAAW,EAAE,iCAAiC,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,yDAAyD;KACrJ;IACS,OAAO,aAAa,GAAoB;AAChD,QAAA;AACE,YAAA,UAAU,EAAE,mBAAmB;AAC/B,YAAA,QAAQ,EAAE;AACX;KACF;AAEM,IAAA,aAAa,IAAI,CACtB,EACE,OAAO,EACP,EAAE,EACF,2BAA2B,GAAG,IAAI,EAClC,8BAA8B,GAAG,IAAI,EAC5B,EAAA;AAEX,QAAA,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAmB;AACnD,YAAA,OAAO,EAAE,OAAO;AAChB,YAAA,MAAM,EAAE,EAAC,IAAI,EAAE,EAAE,EAAC;YAClB,MAAM,EAAE,EAAC,6BAA6B,EAAE,2BAA2B,EAAE,gCAAgC,EAAE,8BAA8B,EAAC;AACvI,SAAA,CAAC;AACF,QAAA,OAAO,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI;IAC5C;IAEO,aAAa,GAAG,CACrB,EACE,OAAO,EACP,QAAQ,GAAG,IAAI,EACf,2BAA2B,GAAG,IAAI,EAClC,8BAA8B,GAAG,IAAI,EACrC,GAAG,SAAS,EACJ,EAAA;AAEV,QAAA,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAmB;AACrD,YAAA,OAAO,EAAE,OAAO;AAChB,YAAA,MAAM,EAAE,EAAC,UAAU,EAAE,QAAQ,EAAC;AAC9B,YAAA,MAAM,EAAE,EAAC,6BAA6B,EAAE,2BAA2B,EAAE,gCAAgC,EAAE,8BAA8B,EAAE,GAAG,SAAS,EAAC;AACrJ,SAAA,CAAC;AAEF,QAAA,OAAO,QAAQ;IACjB;IAEO,MAAM,MAAM,CACjB,EACE,IAAI,GAAG,IAAI,EACX,GAAG,SAAS,EACD,EAAA;AAEb,QAAA,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAmB;AACpD,YAAA,WAAW,EAAE,MAAM;AACnB,YAAA,SAAS,EAAE,QAAQ;YACnB,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,MAAM,KAAK,CAChB,EACE,OAAO,GAAG,IAAI,EACd,IAAI,GAAG,IAAI,EACX,GAAG,SAAS,EACF,EAAA;AAEZ,QAAA,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAmB;AACpD,YAAA,WAAW,EAAE,MAAM;AACnB,YAAA,SAAS,EAAE,OAAO;YAClB,OAAO,EAAE,IAAI,CAAC,OAAO;AACrB,YAAA,MAAM,EAAE,EAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAC;YACvB,MAAM,EAAE,EAAC,SAAS,EAAE,OAAO,EAAE,GAAG,SAAS,EAAC;AAC1C,YAAA,IAAI,EAAE,IAAI;AACV,YAAA,MAAM,EAAE,IAAI;AACb,SAAA,CAAC;QAEF,OAAO,QAAQ,GAAG,QAAQ,CAAC,IAAI,GAAG,IAAI;IACxC;AAEO,IAAA,MAAM,IAAI,CACf,EACE,gBAAgB,GAAG,IAAI,EACvB,IAAI,GAAG,IAAI,EACX,GAAG,SAAS,EACH,EAAA;AAEX,QAAA,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAmB;AACpD,YAAA,WAAW,EAAE,MAAM;AACnB,YAAA,SAAS,EAAE,MAAM;YACjB,OAAO,EAAE,IAAI,CAAC,OAAO;AACrB,YAAA,MAAM,EAAE,EAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAC;YACvB,MAAM,EAAE,EAAC,kBAAkB,EAAE,gBAAgB,EAAE,GAAG,SAAS,EAAC;AAC5D,YAAA,IAAI,EAAE,IAAI;AACV,YAAA,MAAM,EAAE,IAAI;AACb,SAAA,CAAC;QAEF,OAAO,QAAQ,GAAG,QAAQ,CAAC,IAAI,GAAG,IAAI;IACxC;AAEO,IAAA,MAAM,IAAI,CACf,EACE,iBAAiB,GAAG,IAAI,EACxB,IAAI,GAAG,IAAI,EACX,GAAG,SAAS,EACH,EAAA;AAEX,QAAA,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAmB;AACpD,YAAA,WAAW,EAAE,MAAM;AACnB,YAAA,SAAS,EAAE,MAAM;YACjB,OAAO,EAAE,IAAI,CAAC,OAAO;AACrB,YAAA,MAAM,EAAE,EAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAC;YACvB,MAAM,EAAE,EAAC,mBAAmB,EAAE,iBAAiB,EAAE,GAAG,SAAS,EAAC;AAC9D,YAAA,IAAI,EAAE,IAAI;AACV,YAAA,MAAM,EAAE,IAAI;AACb,SAAA,CAAC;QAEF,OAAO,QAAQ,GAAG,QAAQ,CAAC,IAAI,GAAG,IAAI;IACxC;IAEO,MAAM,IAAI,CACf,EACE,IAAI,GAAG,IAAI,EACX,GAAG,SAAS,EACH,EAAA;AAEX,QAAA,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAmB;AACpD,YAAA,WAAW,EAAE,MAAM;AACnB,YAAA,SAAS,EAAE,MAAM;YACjB,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,YAAY,CACvB,EACE,IAAI,GAAG,IAAI,EACX,GAAG,SAAS,EACI,EAAA;AAElB,QAAA,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAmB;AACpD,YAAA,WAAW,EAAE,MAAM;AACnB,YAAA,SAAS,EAAE,cAAc;YACzB,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,MAAM,UAAU,CACrB,EACE,cAAc,GAAG,IAAI,EACrB,IAAI,GAAG,IAAI,EACX,GAAG,SAAS,EACG,EAAA;AAEjB,QAAA,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAmB;AACpD,YAAA,WAAW,EAAE,MAAM;AACnB,YAAA,SAAS,EAAE,YAAY;YACvB,OAAO,EAAE,IAAI,CAAC,OAAO;AACrB,YAAA,MAAM,EAAE,EAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAC;YACvB,MAAM,EAAE,EAAC,gBAAgB,EAAE,cAAc,EAAE,GAAG,SAAS,EAAC;AACxD,YAAA,IAAI,EAAE,IAAI;AACV,YAAA,MAAM,EAAE,IAAI;AACb,SAAA,CAAC;QAEF,OAAO,QAAQ,GAAG,QAAQ,CAAC,IAAI,GAAG,IAAI;IACxC;AAEO,IAAA,MAAM,+BAA+B,CAC1C,EACE,qBAAqB,GAAG,IAAI,EAC5B,oBAAoB,GAAG,IAAI,EAC3B,IAAI,GAAG,IAAI,EACX,GAAG,SAAS,EACqB,EAAA;AAEnC,QAAA,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAmB;AACpD,YAAA,WAAW,EAAE,MAAM;AACnB,YAAA,SAAS,EAAE,iCAAiC;YAC5C,OAAO,EAAE,IAAI,CAAC,OAAO;AACrB,YAAA,MAAM,EAAE,EAAE;AACV,YAAA,MAAM,EAAE,EAAC,uBAAuB,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,oBAAoB,EAAE,GAAG,SAAS,EAAC;AACpH,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,oBAAoB;AACpB,IAAA,UAAU;AACV,IAAA,eAAe;AACf,IAAA,WAAW;AACX,IAAA,UAAU;AACV,IAAA,UAAU;AACV,IAAA,iBAAiB;AACjB,IAAA,EAAE;AACF,IAAA,oBAAoB;AACpB,IAAA,UAAU;AACV,IAAA,iBAAiB;AACjB,IAAA,QAAQ;AACR,IAAA,cAAc;AACd,IAAA,OAAO;AACP,IAAA,MAAM;AACN,IAAA,iBAAiB;AACjB,IAAA,UAAU;;;;;"}