@commercelayer/sdk/lib/chunk-BHXCVURA.cjs.map

Commerce Layer Javascript SDK

{"version":3,"sources":["../src/resources/returns.ts"],"names":["ApiResource"],"mappings":";;;;;AA+MA,IAAM,OAAA,GAAN,MAAM,QAAA,SAAgBA,6BAAA,CAAoB;AAAA,EAEzC,OAAgB,IAAA,GAAmB,SAAA;AAAA,EAEnC,MAAM,MAAA,CAAO,QAAA,EAAwB,MAAA,EAAsC,OAAA,EAA4C;AACtH,IAAA,OAAO,IAAA,CAAK,SAAA,CAAU,MAAA,CAA6B,EAAE,GAAG,QAAA,EAAU,IAAA,EAAM,QAAA,CAAQ,IAAA,EAAK,EAAG,MAAA,EAAQ,OAAO,CAAA;AAAA,EACxG;AAAA,EAEA,MAAM,MAAA,CAAO,QAAA,EAAwB,MAAA,EAAsC,OAAA,EAA4C;AACtH,IAAA,OAAO,IAAA,CAAK,SAAA,CAAU,MAAA,CAA6B,EAAE,GAAG,QAAA,EAAU,IAAA,EAAM,QAAA,CAAQ,IAAA,EAAK,EAAG,MAAA,EAAQ,OAAO,CAAA;AAAA,EACxG;AAAA,EAEA,MAAM,MAAA,CAAO,EAAA,EAAyB,OAAA,EAA0C;AAC/E,IAAA,MAAM,IAAA,CAAK,SAAA,CAAU,MAAA,CAAQ,OAAO,EAAA,KAAO,QAAA,GAAW,EAAE,EAAA,EAAI,IAAA,EAAM,QAAA,CAAQ,IAAA,EAAK,GAAI,IAAI,OAAO,CAAA;AAAA,EAC/F;AAAA,EAEA,MAAM,KAAA,CAAM,QAAA,EAA2B,MAAA,EAAqC,OAAA,EAA2C;AACtH,IAAA,MAAM,SAAA,GAAa,SAAoB,EAAA,IAAM,QAAA;AAC7C,IAAA,OAAO,IAAA,CAAK,SAAA,CAAU,KAAA,CAAa,EAAE,IAAA,EAAM,QAAA,EAAS,EAAG,CAAA,QAAA,EAAW,SAAS,CAAA,MAAA,CAAA,EAAU,MAAA,EAAQ,OAAO,CAAA;AAAA,EACrG;AAAA,EAEA,MAAM,QAAA,CAAS,QAAA,EAA2B,MAAA,EAAwC,OAAA,EAA8C;AAC/H,IAAA,MAAM,SAAA,GAAa,SAAoB,EAAA,IAAM,QAAA;AAC7C,IAAA,OAAO,IAAA,CAAK,SAAA,CAAU,KAAA,CAAgB,EAAE,IAAA,EAAM,WAAA,EAAY,EAAG,CAAA,QAAA,EAAW,SAAS,CAAA,SAAA,CAAA,EAAa,MAAA,EAAQ,OAAO,CAAA;AAAA,EAC9G;AAAA,EAEA,MAAM,cAAA,CAAe,QAAA,EAA2B,MAAA,EAA6C,OAAA,EAAmD;AAC/I,IAAA,MAAM,SAAA,GAAa,SAAoB,EAAA,IAAM,QAAA;AAC7C,IAAA,OAAO,IAAA,CAAK,SAAA,CAAU,KAAA,CAAqB,EAAE,IAAA,EAAM,iBAAA,EAAkB,EAAG,CAAA,QAAA,EAAW,SAAS,CAAA,eAAA,CAAA,EAAmB,MAAA,EAAQ,OAAO,CAAA;AAAA,EAC/H;AAAA,EAEA,MAAM,cAAA,CAAe,QAAA,EAA2B,MAAA,EAAuC,OAAA,EAA6C;AACnI,IAAA,MAAM,SAAA,GAAa,SAAoB,EAAA,IAAM,QAAA;AAC7C,IAAA,OAAO,IAAA,CAAK,SAAA,CAAU,KAAA,CAAe,EAAE,IAAA,EAAM,WAAA,EAAY,EAAG,CAAA,QAAA,EAAW,SAAS,CAAA,eAAA,CAAA,EAAmB,MAAA,EAAQ,OAAO,CAAA;AAAA,EACnH;AAAA,EAEA,MAAM,mBAAA,CAAoB,QAAA,EAA2B,MAAA,EAAuC,OAAA,EAA6C;AACxI,IAAA,MAAM,SAAA,GAAa,SAAoB,EAAA,IAAM,QAAA;AAC7C,IAAA,OAAO,IAAA,CAAK,SAAA,CAAU,KAAA,CAAe,EAAE,IAAA,EAAM,WAAA,EAAY,EAAG,CAAA,QAAA,EAAW,SAAS,CAAA,oBAAA,CAAA,EAAwB,MAAA,EAAQ,OAAO,CAAA;AAAA,EACxH;AAAA,EAEA,MAAM,iBAAA,CAAkB,QAAA,EAA2B,MAAA,EAAuC,OAAA,EAA6C;AACtI,IAAA,MAAM,SAAA,GAAa,SAAoB,EAAA,IAAM,QAAA;AAC7C,IAAA,OAAO,IAAA,CAAK,SAAA,CAAU,KAAA,CAAe,EAAE,IAAA,EAAM,UAAA,EAAW,EAAG,CAAA,QAAA,EAAW,SAAS,CAAA,kBAAA,CAAA,EAAsB,MAAA,EAAQ,OAAO,CAAA;AAAA,EACrH;AAAA,EAEA,MAAM,gBAAA,CAAiB,QAAA,EAA2B,MAAA,EAAsC,OAAA,EAA4C;AACnI,IAAA,MAAM,SAAA,GAAa,SAAoB,EAAA,IAAM,QAAA;AAC7C,IAAA,OAAO,IAAA,CAAK,SAAA,CAAU,KAAA,CAAc,EAAE,IAAA,EAAM,SAAA,EAAU,EAAG,CAAA,QAAA,EAAW,SAAS,CAAA,iBAAA,CAAA,EAAqB,MAAA,EAAQ,OAAO,CAAA;AAAA,EAClH;AAAA,EAEA,MAAM,iBAAA,CAAkB,QAAA,EAA2B,MAAA,EAA0C,OAAA,EAAkE;AAC9J,IAAA,MAAM,SAAA,GAAa,SAAoB,EAAA,IAAM,QAAA;AAC7C,IAAA,OAAO,IAAA,CAAK,SAAA,CAAU,KAAA,CAAsB,EAAE,IAAA,EAAM,mBAAA,EAAoB,EAAG,CAAA,QAAA,EAAW,SAAS,CAAA,kBAAA,CAAA,EAAsB,MAAA,EAAQ,OAAO,CAAA;AAAA,EACrI;AAAA,EAEA,MAAM,WAAA,CAAY,QAAA,EAA2B,MAAA,EAAsC,OAAA,EAA8D;AAChJ,IAAA,MAAM,SAAA,GAAa,SAAoB,EAAA,IAAM,QAAA;AAC7C,IAAA,OAAO,IAAA,CAAK,SAAA,CAAU,KAAA,CAAkB,EAAE,IAAA,EAAM,aAAA,EAAc,EAAG,CAAA,QAAA,EAAW,SAAS,CAAA,YAAA,CAAA,EAAgB,MAAA,EAAQ,OAAO,CAAA;AAAA,EACrH;AAAA,EAEA,MAAM,eAAA,CAAgB,QAAA,EAA2B,MAAA,EAAyC,OAAA,EAAiE;AAC1J,IAAA,MAAM,SAAA,GAAa,SAAoB,EAAA,IAAM,QAAA;AAC7C,IAAA,OAAO,IAAA,CAAK,SAAA,CAAU,KAAA,CAAqB,EAAE,IAAA,EAAM,iBAAA,EAAkB,EAAG,CAAA,QAAA,EAAW,SAAS,CAAA,gBAAA,CAAA,EAAoB,MAAA,EAAQ,OAAO,CAAA;AAAA,EAChI;AAAA,EAEA,MAAM,MAAA,CAAO,QAAA,EAA2B,MAAA,EAAiC,OAAA,EAAyD;AACjI,IAAA,MAAM,SAAA,GAAa,SAAoB,EAAA,IAAM,QAAA;AAC7C,IAAA,OAAO,IAAA,CAAK,SAAA,CAAU,KAAA,CAAa,EAAE,IAAA,EAAM,QAAA,EAAS,EAAG,CAAA,QAAA,EAAW,SAAS,CAAA,OAAA,CAAA,EAAW,MAAA,EAAQ,OAAO,CAAA;AAAA,EACtG;AAAA,EAEA,MAAM,IAAA,CAAK,QAAA,EAA2B,MAAA,EAA+B,OAAA,EAAuD;AAC3H,IAAA,MAAM,SAAA,GAAa,SAAoB,EAAA,IAAM,QAAA;AAC7C,IAAA,OAAO,IAAA,CAAK,SAAA,CAAU,KAAA,CAAW,EAAE,IAAA,EAAM,MAAA,EAAO,EAAG,CAAA,QAAA,EAAW,SAAS,CAAA,KAAA,CAAA,EAAS,MAAA,EAAQ,OAAO,CAAA;AAAA,EAChG;AAAA,EAEA,MAAM,QAAA,CAAS,QAAA,EAA2B,MAAA,EAAmC,OAAA,EAA2D;AACvI,IAAA,MAAM,SAAA,GAAa,SAAoB,EAAA,IAAM,QAAA;AAC7C,IAAA,OAAO,IAAA,CAAK,SAAA,CAAU,KAAA,CAAe,EAAE,IAAA,EAAM,UAAA,EAAW,EAAG,CAAA,QAAA,EAAW,SAAS,CAAA,SAAA,CAAA,EAAa,MAAA,EAAQ,OAAO,CAAA;AAAA,EAC5G;AAAA,EAEA,MAAM,YAAA,CAAa,QAAA,EAA2B,MAAA,EAAsC,OAAA,EAA8D;AACjJ,IAAA,MAAM,SAAA,GAAa,SAAoB,EAAA,IAAM,QAAA;AAC7C,IAAA,OAAO,IAAA,CAAK,SAAA,CAAU,KAAA,CAAkB,EAAE,IAAA,EAAM,cAAA,EAAe,EAAG,CAAA,QAAA,EAAW,SAAS,CAAA,aAAA,CAAA,EAAiB,MAAA,EAAQ,OAAO,CAAA;AAAA,EACvH;AAAA,EAEA,MAAM,QAAA,CAAS,EAAA,EAAqB,MAAA,EAAsC,OAAA,EAA4C;AACrH,IAAA,OAAO,KAAK,SAAA,CAAU,MAAA,CAA6B,EAAE,EAAA,EAAK,OAAO,OAAO,QAAA,GAAW,EAAA,GAAI,EAAA,CAAG,EAAA,EAAI,MAAM,QAAA,CAAQ,IAAA,EAAM,UAAU,IAAA,EAAK,EAAG,QAAQ,OAAO,CAAA;AAAA,EACpJ;AAAA,EAEA,MAAM,QAAA,CAAS,EAAA,EAAqB,MAAA,EAAsC,OAAA,EAA4C;AACrH,IAAA,OAAO,KAAK,SAAA,CAAU,MAAA,CAA6B,EAAE,EAAA,EAAK,OAAO,OAAO,QAAA,GAAW,EAAA,GAAI,EAAA,CAAG,EAAA,EAAI,MAAM,QAAA,CAAQ,IAAA,EAAM,UAAU,IAAA,EAAK,EAAG,QAAQ,OAAO,CAAA;AAAA,EACpJ;AAAA,EAEA,MAAM,OAAA,CAAQ,EAAA,EAAqB,MAAA,EAAsC,OAAA,EAA4C;AACpH,IAAA,OAAO,KAAK,SAAA,CAAU,MAAA,CAA6B,EAAE,EAAA,EAAK,OAAO,OAAO,QAAA,GAAW,EAAA,GAAI,EAAA,CAAG,EAAA,EAAI,MAAM,QAAA,CAAQ,IAAA,EAAM,SAAS,IAAA,EAAK,EAAG,QAAQ,OAAO,CAAA;AAAA,EACnJ;AAAA,EAEA,MAAM,KAAA,CAAM,EAAA,EAAqB,MAAA,EAAsC,OAAA,EAA4C;AAClH,IAAA,OAAO,KAAK,SAAA,CAAU,MAAA,CAA6B,EAAE,EAAA,EAAK,OAAO,OAAO,QAAA,GAAW,EAAA,GAAI,EAAA,CAAG,EAAA,EAAI,MAAM,QAAA,CAAQ,IAAA,EAAM,OAAO,IAAA,EAAK,EAAG,QAAQ,OAAO,CAAA;AAAA,EACjJ;AAAA,EAEA,MAAM,OAAA,CAAQ,EAAA,EAAqB,MAAA,EAAsC,OAAA,EAA4C;AACpH,IAAA,OAAO,KAAK,SAAA,CAAU,MAAA,CAA6B,EAAE,EAAA,EAAK,OAAO,OAAO,QAAA,GAAW,EAAA,GAAI,EAAA,CAAG,EAAA,EAAI,MAAM,QAAA,CAAQ,IAAA,EAAM,SAAS,IAAA,EAAK,EAAG,QAAQ,OAAO,CAAA;AAAA,EACnJ;AAAA,EAEA,MAAM,QAAA,CAAS,EAAA,EAAqB,MAAA,EAAsC,OAAA,EAA4C;AACrH,IAAA,OAAO,KAAK,SAAA,CAAU,MAAA,CAA6B,EAAE,EAAA,EAAK,OAAO,OAAO,QAAA,GAAW,EAAA,GAAI,EAAA,CAAG,EAAA,EAAI,MAAM,QAAA,CAAQ,IAAA,EAAM,UAAU,IAAA,EAAK,EAAG,QAAQ,OAAO,CAAA;AAAA,EACpJ;AAAA,EAEA,MAAM,QAAA,CAAS,EAAA,EAAqB,MAAA,EAAsC,OAAA,EAA4C;AACrH,IAAA,OAAO,KAAK,SAAA,CAAU,MAAA,CAA6B,EAAE,EAAA,EAAK,OAAO,OAAO,QAAA,GAAW,EAAA,GAAI,EAAA,CAAG,EAAA,EAAI,MAAM,QAAA,CAAQ,IAAA,EAAM,UAAU,IAAA,EAAK,EAAG,QAAQ,OAAO,CAAA;AAAA,EACpJ;AAAA,EAEA,MAAM,QAAA,CAAS,EAAA,EAAqB,MAAA,EAAsC,OAAA,EAA4C;AACrH,IAAA,OAAO,KAAK,SAAA,CAAU,MAAA,CAA6B,EAAE,EAAA,EAAK,OAAO,OAAO,QAAA,GAAW,EAAA,GAAI,EAAA,CAAG,EAAA,EAAI,MAAM,QAAA,CAAQ,IAAA,EAAM,UAAU,IAAA,EAAK,EAAG,QAAQ,OAAO,CAAA;AAAA,EACpJ;AAAA,EAEA,MAAM,UAAA,CAAW,EAAA,EAAqB,MAAA,EAAsC,OAAA,EAA4C;AACvH,IAAA,OAAO,KAAK,SAAA,CAAU,MAAA,CAA6B,EAAE,EAAA,EAAK,OAAO,OAAO,QAAA,GAAW,EAAA,GAAI,EAAA,CAAG,EAAA,EAAI,MAAM,QAAA,CAAQ,IAAA,EAAM,YAAY,IAAA,EAAK,EAAG,QAAQ,OAAO,CAAA;AAAA,EACtJ;AAAA,EAEA,MAAM,OAAA,CAAQ,EAAA,EAAqB,MAAA,EAAsC,OAAA,EAA4C;AACpH,IAAA,OAAO,KAAK,SAAA,CAAU,MAAA,CAA6B,EAAE,EAAA,EAAK,OAAO,OAAO,QAAA,GAAW,EAAA,GAAI,EAAA,CAAG,EAAA,EAAI,MAAM,QAAA,CAAQ,IAAA,EAAM,SAAS,IAAA,EAAK,EAAG,QAAQ,OAAO,CAAA;AAAA,EACnJ;AAAA,EAEA,MAAM,oBAAA,CAAqB,EAAA,EAAqB,YAAA,EAAsB,QAAsC,OAAA,EAA4C;AACvJ,IAAA,OAAO,KAAK,SAAA,CAAU,MAAA,CAA6B,EAAE,EAAA,EAAK,OAAO,OAAO,QAAA,GAAW,EAAA,GAAI,EAAA,CAAG,EAAA,EAAI,MAAM,QAAA,CAAQ,IAAA,EAAM,sBAAsB,YAAA,EAAa,EAAG,QAAQ,OAAO,CAAA;AAAA,EACxK;AAAA,EAEA,MAAM,SAAA,CAAU,EAAA,EAAqB,YAAA,EAAsB,QAAsC,OAAA,EAA4C;AAC5I,IAAA,OAAO,KAAK,SAAA,CAAU,MAAA,CAA6B,EAAE,EAAA,EAAK,OAAO,OAAO,QAAA,GAAW,EAAA,GAAI,EAAA,CAAG,EAAA,EAAI,MAAM,QAAA,CAAQ,IAAA,EAAM,WAAW,YAAA,EAAa,EAAG,QAAQ,OAAO,CAAA;AAAA,EAC7J;AAAA,EAEA,MAAM,YAAA,CAAa,EAAA,EAAqB,YAAA,EAAsB,QAAsC,OAAA,EAA4C;AAC/I,IAAA,OAAO,KAAK,SAAA,CAAU,MAAA,CAA6B,EAAE,EAAA,EAAK,OAAO,OAAO,QAAA,GAAW,EAAA,GAAI,EAAA,CAAG,EAAA,EAAI,MAAM,QAAA,CAAQ,IAAA,EAAM,cAAc,YAAA,EAAa,EAAG,QAAQ,OAAO,CAAA;AAAA,EAChK;AAAA,EAGA,SAAS,QAAA,EAAmC;AAC3C,IAAA,OAAO,QAAA,CAAS,IAAA,IAAS,QAAA,CAAS,IAAA,KAAS,QAAA,CAAQ,IAAA;AAAA,EACpD;AAAA,EAGA,aAAa,EAAA,EAA2C;AACvD,IAAA,OAAO,KAAA,CAAM,qBAAgC,EAAE,CAAA;AAAA,EAChD;AAAA,EAEA,sBAAsB,GAAA,EAA4B;AACjD,IAAA,OAAO,KAAA,CAAM,qBAAA,CAAiC,GAAG,GAAG,CAAA;AAAA,EACrD;AAAA,EAGA,IAAA,GAAmB;AAClB,IAAA,OAAO,QAAA,CAAQ,IAAA;AAAA,EAChB;AAED,CAAA;AAGA,IAAM,QAAA,GAAW,IAAI,OAAA,EAAQ;AAC7B,IAAO,eAAA,GAAQ","file":"chunk-BHXCVURA.cjs","sourcesContent":["import { ApiResource } from '../resource'\nimport type { Resource, ResourceCreate, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse, ResourceSort, /* ResourceFilter */ } from '../resource'\nimport type { QueryParamsRetrieve, QueryParamsList } from '../query'\n\nimport type { Order, OrderType } from './orders'\nimport type { Customer } from './customers'\nimport type { StockLocation, StockLocationType } from './stock_locations'\nimport type { Address } from './addresses'\nimport type { Capture, CaptureType } from './captures'\nimport type { Refund } from './refunds'\nimport type { ReturnLineItem } from './return_line_items'\nimport type { Attachment } from './attachments'\nimport type { ResourceError } from './resource_errors'\nimport type { Event } from './events'\nimport type { Tag, TagType } from './tags'\nimport type { Version } from './versions'\nimport type { EventStore } from './event_stores'\n\n\ntype ReturnType = 'returns'\ntype ReturnRel = ResourceRel & { type: ReturnType }\ntype OrderRel = ResourceRel & { type: OrderType }\ntype StockLocationRel = ResourceRel & { type: StockLocationType }\ntype CaptureRel = ResourceRel & { type: CaptureType }\ntype TagRel = ResourceRel & { type: TagType }\n\n\nexport type ReturnSort = Pick<Return, 'id' | 'number' | 'status' | 'approved_at' | 'cancelled_at' | 'shipped_at' | 'rejected_at' | 'received_at' | 'refunded_at' | 'archived_at'> & ResourceSort\n// export type ReturnFilter = Pick<Return, 'id' | 'number' | 'status' | 'skus_count' | 'approved_at' | 'cancelled_at' | 'shipped_at' | 'rejected_at' | 'received_at' | 'refunded_at' | 'archived_at'> & ResourceFilter\n\n\ninterface Return extends Resource {\n\t\n\treadonly type: ReturnType\n\n\t/** \n\t * Unique identifier for the return.\n\t * @example ```\"#1234/R/001\"```\n\t */\n\tnumber?: string | null\n\t/** \n\t * The return status. One of 'draft' (default), 'requested', 'approved', 'cancelled', 'shipped', 'rejected', 'received', or 'refunded'.\n\t * @example ```\"draft\"```\n\t */\n\tstatus: 'draft' | 'requested' | 'approved' | 'cancelled' | 'shipped' | 'rejected' | 'received' | 'refunded'\n\t/** \n\t * The email address of the associated customer.\n\t * @example ```\"john@example.com\"```\n\t */\n\tcustomer_email?: string | null\n\t/** \n\t * The total number of SKUs in the return's line items. This can be useful to display a preview of the return content.\n\t * @example ```2```\n\t */\n\tskus_count?: number | null\n\t/** \n\t * Time at which the return was approved.\n\t * @example ```\"2018-01-01T12:00:00.000Z\"```\n\t */\n\tapproved_at?: string | null\n\t/** \n\t * Time at which the return was cancelled.\n\t * @example ```\"2018-01-01T12:00:00.000Z\"```\n\t */\n\tcancelled_at?: string | null\n\t/** \n\t * Time at which the return was shipped.\n\t * @example ```\"2018-01-01T12:00:00.000Z\"```\n\t */\n\tshipped_at?: string | null\n\t/** \n\t * Time at which the return was rejected.\n\t * @example ```\"2018-01-01T12:00:00.000Z\"```\n\t */\n\trejected_at?: string | null\n\t/** \n\t * Time at which the return was received.\n\t * @example ```\"2018-01-01T12:00:00.000Z\"```\n\t */\n\treceived_at?: string | null\n\t/** \n\t * Time at which the return was refunded.\n\t * @example ```\"2018-01-01T12:00:00.000Z\"```\n\t */\n\trefunded_at?: string | null\n\t/** \n\t * Time at which the resource has been archived.\n\t * @example ```\"2018-01-01T12:00:00.000Z\"```\n\t */\n\tarchived_at?: string | null\n\t/** \n\t * The amount to be refunded, estimated by associated return line items, in cents.\n\t * @example ```500```\n\t */\n\testimated_refund_amount_cents?: number | null\n\t/** \n\t * The amount to be refunded, estimated by associated return line items, float.\n\t * @example ```5```\n\t */\n\testimated_refund_amount_float?: number | null\n\t/** \n\t * The amount to be refunded, estimated by associated return line items, formatted.\n\t * @example ```\"€5,00\"```\n\t */\n\tformatted_estimated_refund_amount?: string | null\n\n\torder?: Order | null\n\tcustomer?: Customer | null\n\tstock_location?: StockLocation | null\n\torigin_address?: Address | null\n\tdestination_address?: Address | null\n\treference_capture?: Capture | null\n\treference_refund?: Refund | null\n\treturn_line_items?: ReturnLineItem[] | null\n\tattachments?: Attachment[] | null\n\tresource_errors?: ResourceError[] | null\n\tevents?: Event[] | null\n\ttags?: Tag[] | null\n\tversions?: Version[] | null\n\tevent_stores?: EventStore[] | null\n\n}\n\n\ninterface ReturnCreate extends ResourceCreate {\n\t\n\torder: OrderRel\n\tstock_location?: StockLocationRel | null\n\treference_capture?: CaptureRel | null\n\ttags?: TagRel[] | null\n\n}\n\n\ninterface ReturnUpdate extends ResourceUpdate {\n\t\n\t/** \n\t * Send this attribute if you want to activate this return.\n\t * @example ```true```\n\t */\n\t_request?: boolean | null\n\t/** \n\t * Send this attribute if you want to mark this return as approved.\n\t * @example ```true```\n\t */\n\t_approve?: boolean | null\n\t/** \n\t * Send this attribute if you want to mark this return as cancelled.\n\t * @example ```true```\n\t */\n\t_cancel?: boolean | null\n\t/** \n\t * Send this attribute if you want to mark this return as shipped.\n\t * @example ```true```\n\t */\n\t_ship?: boolean | null\n\t/** \n\t * Send this attribute if you want to mark this return as rejected.\n\t * @example ```true```\n\t */\n\t_reject?: boolean | null\n\t/** \n\t * Send this attribute if you want to mark this return as received.\n\t * @example ```true```\n\t */\n\t_receive?: boolean | null\n\t/** \n\t * Send this attribute if you want to restock all of the return line items.\n\t * @example ```true```\n\t */\n\t_restock?: boolean | null\n\t/** \n\t * Send this attribute if you want to archive the return.\n\t * @example ```true```\n\t */\n\t_archive?: boolean | null\n\t/** \n\t * Send this attribute if you want to unarchive the return.\n\t * @example ```true```\n\t */\n\t_unarchive?: boolean | null\n\t/** \n\t * Send this attribute if you want to create a refund for this return.\n\t * @example ```true```\n\t */\n\t_refund?: boolean | null\n\t/** \n\t * Send this attribute as a value in cents to specify the amount to be refunded.\n\t * @example ```500```\n\t */\n\t_refund_amount_cents?: number | null\n\t/** \n\t * Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.\n\t */\n\t_add_tags?: string | null\n\t/** \n\t * Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.\n\t */\n\t_remove_tags?: string | null\n\n\tstock_location?: StockLocationRel | null\n\treference_capture?: CaptureRel | null\n\ttags?: TagRel[] | null\n\n}\n\n\nclass Returns extends ApiResource<Return> {\n\n\tstatic readonly TYPE: ReturnType = 'returns' as const\n\n\tasync create(resource: ReturnCreate, params?: QueryParamsRetrieve<Return>, options?: ResourcesConfig): Promise<Return> {\n\t\treturn this.resources.create<ReturnCreate, Return>({ ...resource, type: Returns.TYPE }, params, options)\n\t}\n\n\tasync update(resource: ReturnUpdate, params?: QueryParamsRetrieve<Return>, options?: ResourcesConfig): Promise<Return> {\n\t\treturn this.resources.update<ReturnUpdate, Return>({ ...resource, type: Returns.TYPE }, params, options)\n\t}\n\n\tasync delete(id: string | ResourceId, options?: ResourcesConfig): Promise<void> {\n\t\tawait this.resources.delete((typeof id === 'string')? { id, type: Returns.TYPE } : id, options)\n\t}\n\n\tasync order(returnId: string | Return, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order> {\n\t\tconst _returnId = (returnId as Return).id || returnId as string\n\t\treturn this.resources.fetch<Order>({ type: 'orders' }, `returns/${_returnId}/order`, params, options) as unknown as Order\n\t}\n\n\tasync customer(returnId: string | Return, params?: QueryParamsRetrieve<Customer>, options?: ResourcesConfig): Promise<Customer> {\n\t\tconst _returnId = (returnId as Return).id || returnId as string\n\t\treturn this.resources.fetch<Customer>({ type: 'customers' }, `returns/${_returnId}/customer`, params, options) as unknown as Customer\n\t}\n\n\tasync stock_location(returnId: string | Return, params?: QueryParamsRetrieve<StockLocation>, options?: ResourcesConfig): Promise<StockLocation> {\n\t\tconst _returnId = (returnId as Return).id || returnId as string\n\t\treturn this.resources.fetch<StockLocation>({ type: 'stock_locations' }, `returns/${_returnId}/stock_location`, params, options) as unknown as StockLocation\n\t}\n\n\tasync origin_address(returnId: string | Return, params?: QueryParamsRetrieve<Address>, options?: ResourcesConfig): Promise<Address> {\n\t\tconst _returnId = (returnId as Return).id || returnId as string\n\t\treturn this.resources.fetch<Address>({ type: 'addresses' }, `returns/${_returnId}/origin_address`, params, options) as unknown as Address\n\t}\n\n\tasync destination_address(returnId: string | Return, params?: QueryParamsRetrieve<Address>, options?: ResourcesConfig): Promise<Address> {\n\t\tconst _returnId = (returnId as Return).id || returnId as string\n\t\treturn this.resources.fetch<Address>({ type: 'addresses' }, `returns/${_returnId}/destination_address`, params, options) as unknown as Address\n\t}\n\n\tasync reference_capture(returnId: string | Return, params?: QueryParamsRetrieve<Capture>, options?: ResourcesConfig): Promise<Capture> {\n\t\tconst _returnId = (returnId as Return).id || returnId as string\n\t\treturn this.resources.fetch<Capture>({ type: 'captures' }, `returns/${_returnId}/reference_capture`, params, options) as unknown as Capture\n\t}\n\n\tasync reference_refund(returnId: string | Return, params?: QueryParamsRetrieve<Refund>, options?: ResourcesConfig): Promise<Refund> {\n\t\tconst _returnId = (returnId as Return).id || returnId as string\n\t\treturn this.resources.fetch<Refund>({ type: 'refunds' }, `returns/${_returnId}/reference_refund`, params, options) as unknown as Refund\n\t}\n\n\tasync return_line_items(returnId: string | Return, params?: QueryParamsList<ReturnLineItem>, options?: ResourcesConfig): Promise<ListResponse<ReturnLineItem>> {\n\t\tconst _returnId = (returnId as Return).id || returnId as string\n\t\treturn this.resources.fetch<ReturnLineItem>({ type: 'return_line_items' }, `returns/${_returnId}/return_line_items`, params, options) as unknown as ListResponse<ReturnLineItem>\n\t}\n\n\tasync attachments(returnId: string | Return, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>> {\n\t\tconst _returnId = (returnId as Return).id || returnId as string\n\t\treturn this.resources.fetch<Attachment>({ type: 'attachments' }, `returns/${_returnId}/attachments`, params, options) as unknown as ListResponse<Attachment>\n\t}\n\n\tasync resource_errors(returnId: string | Return, params?: QueryParamsList<ResourceError>, options?: ResourcesConfig): Promise<ListResponse<ResourceError>> {\n\t\tconst _returnId = (returnId as Return).id || returnId as string\n\t\treturn this.resources.fetch<ResourceError>({ type: 'resource_errors' }, `returns/${_returnId}/resource_errors`, params, options) as unknown as ListResponse<ResourceError>\n\t}\n\n\tasync events(returnId: string | Return, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>> {\n\t\tconst _returnId = (returnId as Return).id || returnId as string\n\t\treturn this.resources.fetch<Event>({ type: 'events' }, `returns/${_returnId}/events`, params, options) as unknown as ListResponse<Event>\n\t}\n\n\tasync tags(returnId: string | Return, params?: QueryParamsList<Tag>, options?: ResourcesConfig): Promise<ListResponse<Tag>> {\n\t\tconst _returnId = (returnId as Return).id || returnId as string\n\t\treturn this.resources.fetch<Tag>({ type: 'tags' }, `returns/${_returnId}/tags`, params, options) as unknown as ListResponse<Tag>\n\t}\n\n\tasync versions(returnId: string | Return, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>> {\n\t\tconst _returnId = (returnId as Return).id || returnId as string\n\t\treturn this.resources.fetch<Version>({ type: 'versions' }, `returns/${_returnId}/versions`, params, options) as unknown as ListResponse<Version>\n\t}\n\n\tasync event_stores(returnId: string | Return, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>> {\n\t\tconst _returnId = (returnId as Return).id || returnId as string\n\t\treturn this.resources.fetch<EventStore>({ type: 'event_stores' }, `returns/${_returnId}/event_stores`, params, options) as unknown as ListResponse<EventStore>\n\t}\n\n\tasync _request(id: string | Return, params?: QueryParamsRetrieve<Return>, options?: ResourcesConfig): Promise<Return> {\n\t\treturn this.resources.update<ReturnUpdate, Return>({ id: (typeof id === 'string')? id: id.id, type: Returns.TYPE, _request: true }, params, options)\n\t}\n\n\tasync _approve(id: string | Return, params?: QueryParamsRetrieve<Return>, options?: ResourcesConfig): Promise<Return> {\n\t\treturn this.resources.update<ReturnUpdate, Return>({ id: (typeof id === 'string')? id: id.id, type: Returns.TYPE, _approve: true }, params, options)\n\t}\n\n\tasync _cancel(id: string | Return, params?: QueryParamsRetrieve<Return>, options?: ResourcesConfig): Promise<Return> {\n\t\treturn this.resources.update<ReturnUpdate, Return>({ id: (typeof id === 'string')? id: id.id, type: Returns.TYPE, _cancel: true }, params, options)\n\t}\n\n\tasync _ship(id: string | Return, params?: QueryParamsRetrieve<Return>, options?: ResourcesConfig): Promise<Return> {\n\t\treturn this.resources.update<ReturnUpdate, Return>({ id: (typeof id === 'string')? id: id.id, type: Returns.TYPE, _ship: true }, params, options)\n\t}\n\n\tasync _reject(id: string | Return, params?: QueryParamsRetrieve<Return>, options?: ResourcesConfig): Promise<Return> {\n\t\treturn this.resources.update<ReturnUpdate, Return>({ id: (typeof id === 'string')? id: id.id, type: Returns.TYPE, _reject: true }, params, options)\n\t}\n\n\tasync _receive(id: string | Return, params?: QueryParamsRetrieve<Return>, options?: ResourcesConfig): Promise<Return> {\n\t\treturn this.resources.update<ReturnUpdate, Return>({ id: (typeof id === 'string')? id: id.id, type: Returns.TYPE, _receive: true }, params, options)\n\t}\n\n\tasync _restock(id: string | Return, params?: QueryParamsRetrieve<Return>, options?: ResourcesConfig): Promise<Return> {\n\t\treturn this.resources.update<ReturnUpdate, Return>({ id: (typeof id === 'string')? id: id.id, type: Returns.TYPE, _restock: true }, params, options)\n\t}\n\n\tasync _archive(id: string | Return, params?: QueryParamsRetrieve<Return>, options?: ResourcesConfig): Promise<Return> {\n\t\treturn this.resources.update<ReturnUpdate, Return>({ id: (typeof id === 'string')? id: id.id, type: Returns.TYPE, _archive: true }, params, options)\n\t}\n\n\tasync _unarchive(id: string | Return, params?: QueryParamsRetrieve<Return>, options?: ResourcesConfig): Promise<Return> {\n\t\treturn this.resources.update<ReturnUpdate, Return>({ id: (typeof id === 'string')? id: id.id, type: Returns.TYPE, _unarchive: true }, params, options)\n\t}\n\n\tasync _refund(id: string | Return, params?: QueryParamsRetrieve<Return>, options?: ResourcesConfig): Promise<Return> {\n\t\treturn this.resources.update<ReturnUpdate, Return>({ id: (typeof id === 'string')? id: id.id, type: Returns.TYPE, _refund: true }, params, options)\n\t}\n\n\tasync _refund_amount_cents(id: string | Return, triggerValue: number, params?: QueryParamsRetrieve<Return>, options?: ResourcesConfig): Promise<Return> {\n\t\treturn this.resources.update<ReturnUpdate, Return>({ id: (typeof id === 'string')? id: id.id, type: Returns.TYPE, _refund_amount_cents: triggerValue }, params, options)\n\t}\n\n\tasync _add_tags(id: string | Return, triggerValue: string, params?: QueryParamsRetrieve<Return>, options?: ResourcesConfig): Promise<Return> {\n\t\treturn this.resources.update<ReturnUpdate, Return>({ id: (typeof id === 'string')? id: id.id, type: Returns.TYPE, _add_tags: triggerValue }, params, options)\n\t}\n\n\tasync _remove_tags(id: string | Return, triggerValue: string, params?: QueryParamsRetrieve<Return>, options?: ResourcesConfig): Promise<Return> {\n\t\treturn this.resources.update<ReturnUpdate, Return>({ id: (typeof id === 'string')? id: id.id, type: Returns.TYPE, _remove_tags: triggerValue }, params, options)\n\t}\n\n\n\tisReturn(resource: any): resource is Return {\n\t\treturn resource.type && (resource.type === Returns.TYPE)\n\t}\n\n\n\trelationship(id: string | ResourceId | null): ReturnRel {\n\t\treturn super.relationshipOneToOne<ReturnRel>(id)\n\t}\n\n\trelationshipToMany(...ids: string[]): ReturnRel[] {\n\t\treturn super.relationshipOneToMany<ReturnRel>(...ids)\n\t}\n\n\n\ttype(): ReturnType {\n\t\treturn Returns.TYPE\n\t}\n\n}\n\n\nconst instance = new Returns()\nexport default instance\n\nexport type { Returns, Return, ReturnCreate, ReturnUpdate, ReturnType }\n"]}