UNPKG

@commercelayer/sdk

Version:
1 lines 14.2 kB
{"version":3,"sources":["../src/resources/captures.ts"],"names":["ApiResource"],"mappings":";;;;;AAoKA,IAAM,QAAA,GAAN,MAAM,SAAA,SAAiBA,6BAAA,CAAqB;AAAA,EAE3C,OAAgB,IAAA,GAAoB,UAAA;AAAA,EAEpC,MAAM,MAAA,CAAO,QAAA,EAAyB,MAAA,EAAuC,OAAA,EAA6C;AACzH,IAAA,OAAO,IAAA,CAAK,SAAA,CAAU,MAAA,CAA+B,EAAE,GAAG,QAAA,EAAU,IAAA,EAAM,SAAA,CAAS,IAAA,EAAK,EAAG,MAAA,EAAQ,OAAO,CAAA;AAAA,EAC3G;AAAA,EAEA,MAAM,KAAA,CAAM,SAAA,EAA6B,MAAA,EAAqC,OAAA,EAA2C;AACxH,IAAA,MAAM,UAAA,GAAc,UAAsB,EAAA,IAAM,SAAA;AAChD,IAAA,OAAO,IAAA,CAAK,SAAA,CAAU,KAAA,CAAa,EAAE,IAAA,EAAM,QAAA,EAAS,EAAG,CAAA,SAAA,EAAY,UAAU,CAAA,MAAA,CAAA,EAAU,MAAA,EAAQ,OAAO,CAAA;AAAA,EACvG;AAAA,EAEA,MAAM,WAAA,CAAY,SAAA,EAA6B,MAAA,EAAsC,OAAA,EAA8D;AAClJ,IAAA,MAAM,UAAA,GAAc,UAAsB,EAAA,IAAM,SAAA;AAChD,IAAA,OAAO,IAAA,CAAK,SAAA,CAAU,KAAA,CAAkB,EAAE,IAAA,EAAM,aAAA,EAAc,EAAG,CAAA,SAAA,EAAY,UAAU,CAAA,YAAA,CAAA,EAAgB,MAAA,EAAQ,OAAO,CAAA;AAAA,EACvH;AAAA,EAEA,MAAM,MAAA,CAAO,SAAA,EAA6B,MAAA,EAAiC,OAAA,EAAyD;AACnI,IAAA,MAAM,UAAA,GAAc,UAAsB,EAAA,IAAM,SAAA;AAChD,IAAA,OAAO,IAAA,CAAK,SAAA,CAAU,KAAA,CAAa,EAAE,IAAA,EAAM,QAAA,EAAS,EAAG,CAAA,SAAA,EAAY,UAAU,CAAA,OAAA,CAAA,EAAW,MAAA,EAAQ,OAAO,CAAA;AAAA,EACxG;AAAA,EAEA,MAAM,QAAA,CAAS,SAAA,EAA6B,MAAA,EAAmC,OAAA,EAA2D;AACzI,IAAA,MAAM,UAAA,GAAc,UAAsB,EAAA,IAAM,SAAA;AAChD,IAAA,OAAO,IAAA,CAAK,SAAA,CAAU,KAAA,CAAe,EAAE,IAAA,EAAM,UAAA,EAAW,EAAG,CAAA,SAAA,EAAY,UAAU,CAAA,SAAA,CAAA,EAAa,MAAA,EAAQ,OAAO,CAAA;AAAA,EAC9G;AAAA,EAEA,MAAM,YAAA,CAAa,SAAA,EAA6B,MAAA,EAAsC,OAAA,EAA8D;AACnJ,IAAA,MAAM,UAAA,GAAc,UAAsB,EAAA,IAAM,SAAA;AAChD,IAAA,OAAO,IAAA,CAAK,SAAA,CAAU,KAAA,CAAkB,EAAE,IAAA,EAAM,cAAA,EAAe,EAAG,CAAA,SAAA,EAAY,UAAU,CAAA,aAAA,CAAA,EAAiB,MAAA,EAAQ,OAAO,CAAA;AAAA,EACzH;AAAA,EAEA,MAAM,uBAAA,CAAwB,SAAA,EAA6B,MAAA,EAA6C,OAAA,EAAmD;AAC1J,IAAA,MAAM,UAAA,GAAc,UAAsB,EAAA,IAAM,SAAA;AAChD,IAAA,OAAO,IAAA,CAAK,SAAA,CAAU,KAAA,CAAqB,EAAE,IAAA,EAAM,gBAAA,EAAiB,EAAG,CAAA,SAAA,EAAY,UAAU,CAAA,wBAAA,CAAA,EAA4B,MAAA,EAAQ,OAAO,CAAA;AAAA,EACzI;AAAA,EAEA,MAAM,OAAA,CAAQ,SAAA,EAA6B,MAAA,EAAkC,OAAA,EAA0D;AACtI,IAAA,MAAM,UAAA,GAAc,UAAsB,EAAA,IAAM,SAAA;AAChD,IAAA,OAAO,IAAA,CAAK,SAAA,CAAU,KAAA,CAAc,EAAE,IAAA,EAAM,SAAA,EAAU,EAAG,CAAA,SAAA,EAAY,UAAU,CAAA,QAAA,CAAA,EAAY,MAAA,EAAQ,OAAO,CAAA;AAAA,EAC3G;AAAA,EAEA,MAAM,MAAA,CAAO,SAAA,EAA6B,MAAA,EAAsC,OAAA,EAA4C;AAC3H,IAAA,MAAM,UAAA,GAAc,UAAsB,EAAA,IAAM,SAAA;AAChD,IAAA,OAAO,IAAA,CAAK,SAAA,CAAU,KAAA,CAAc,EAAE,IAAA,EAAM,SAAA,EAAU,EAAG,CAAA,SAAA,EAAY,UAAU,CAAA,OAAA,CAAA,EAAW,MAAA,EAAQ,OAAO,CAAA;AAAA,EAC1G;AAAA,EAEA,MAAM,QAAA,CAAS,EAAA,EAAsB,MAAA,EAAuC,OAAA,EAA6C;AACxH,IAAA,OAAO,KAAK,SAAA,CAAU,MAAA,CAA+B,EAAE,EAAA,EAAK,OAAO,OAAO,QAAA,GAAW,EAAA,GAAI,EAAA,CAAG,EAAA,EAAI,MAAM,SAAA,CAAS,IAAA,EAAM,UAAU,IAAA,EAAK,EAAG,QAAQ,OAAO,CAAA;AAAA,EACvJ;AAAA,EAEA,MAAM,OAAA,CAAQ,EAAA,EAAsB,MAAA,EAAuC,OAAA,EAA6C;AACvH,IAAA,OAAO,KAAK,SAAA,CAAU,MAAA,CAA+B,EAAE,EAAA,EAAK,OAAO,OAAO,QAAA,GAAW,EAAA,GAAI,EAAA,CAAG,EAAA,EAAI,MAAM,SAAA,CAAS,IAAA,EAAM,SAAS,IAAA,EAAK,EAAG,QAAQ,OAAO,CAAA;AAAA,EACtJ;AAAA,EAEA,MAAM,oBAAA,CAAqB,EAAA,EAAsB,YAAA,EAAsB,QAAuC,OAAA,EAA6C;AAC1J,IAAA,OAAO,KAAK,SAAA,CAAU,MAAA,CAA+B,EAAE,EAAA,EAAK,OAAO,OAAO,QAAA,GAAW,EAAA,GAAI,EAAA,CAAG,EAAA,EAAI,MAAM,SAAA,CAAS,IAAA,EAAM,sBAAsB,YAAA,EAAa,EAAG,QAAQ,OAAO,CAAA;AAAA,EAC3K;AAAA,EAEA,MAAM,OAAA,CAAQ,EAAA,EAAsB,MAAA,EAAuC,OAAA,EAA6C;AACvH,IAAA,OAAO,KAAK,SAAA,CAAU,MAAA,CAA+B,EAAE,EAAA,EAAK,OAAO,OAAO,QAAA,GAAW,EAAA,GAAI,EAAA,CAAG,EAAA,EAAI,MAAM,SAAA,CAAS,IAAA,EAAM,SAAS,IAAA,EAAK,EAAG,QAAQ,OAAO,CAAA;AAAA,EACtJ;AAAA,EAGA,UAAU,QAAA,EAAoC;AAC7C,IAAA,OAAO,QAAA,CAAS,IAAA,IAAS,QAAA,CAAS,IAAA,KAAS,SAAA,CAAS,IAAA;AAAA,EACrD;AAAA,EAGA,aAAa,EAAA,EAA4C;AACxD,IAAA,OAAO,KAAA,CAAM,qBAAiC,EAAE,CAAA;AAAA,EACjD;AAAA,EAEA,sBAAsB,GAAA,EAA6B;AAClD,IAAA,OAAO,KAAA,CAAM,qBAAA,CAAkC,GAAG,GAAG,CAAA;AAAA,EACtD;AAAA,EAGA,IAAA,GAAoB;AACnB,IAAA,OAAO,SAAA,CAAS,IAAA;AAAA,EACjB;AAED,CAAA;AAGA,IAAM,QAAA,GAAW,IAAI,QAAA,EAAS;AAC9B,IAAO,gBAAA,GAAQ","file":"chunk-KNXPWX4D.cjs","sourcesContent":["import { ApiResource } from '../resource'\nimport type { Resource, ResourceUpdate, ResourceId, ResourcesConfig, ResourceRel, ListResponse, ResourceSort, /* ResourceFilter */ } from '../resource'\nimport type { QueryParamsRetrieve, QueryParamsList } from '../query'\n\nimport type { Order } from './orders'\nimport type { Attachment } from './attachments'\nimport type { Event } from './events'\nimport type { Version } from './versions'\nimport type { EventStore } from './event_stores'\nimport type { Authorization } from './authorizations'\nimport type { Refund } from './refunds'\nimport type { Return } from './returns'\nimport type { AdyenPayment } from './adyen_payments'\nimport type { AxervePayment } from './axerve_payments'\nimport type { BraintreePayment } from './braintree_payments'\nimport type { CheckoutComPayment } from './checkout_com_payments'\nimport type { ExternalPayment } from './external_payments'\nimport type { KlarnaPayment } from './klarna_payments'\nimport type { PaypalPayment } from './paypal_payments'\nimport type { SatispayPayment } from './satispay_payments'\nimport type { StripePayment } from './stripe_payments'\nimport type { WireTransfer } from './wire_transfers'\n\n\ntype CaptureType = 'captures'\ntype CaptureRel = ResourceRel & { type: CaptureType }\n\n\nexport type CaptureSort = Pick<Capture, 'id' | 'number' | 'amount_cents'> & ResourceSort\n// export type CaptureFilter = Pick<Capture, 'id' | 'number' | 'currency_code' | 'amount_cents' | 'succeeded' | 'message' | 'error_code' | 'error_detail' | 'token' | 'gateway_transaction_id'> & ResourceFilter\n\n\ninterface Capture extends Resource {\n\t\n\treadonly type: CaptureType\n\n\t/** \n\t * The transaction number, auto generated.\n\t * @example ```\"42/T/001\"```\n\t */\n\tnumber: string\n\t/** \n\t * The international 3-letter currency code as defined by the ISO 4217 standard, inherited from the associated order.\n\t * @example ```\"EUR\"```\n\t */\n\tcurrency_code: string\n\t/** \n\t * The transaction amount, in cents.\n\t * @example ```1500```\n\t */\n\tamount_cents: number\n\t/** \n\t * The transaction amount, float.\n\t * @example ```15```\n\t */\n\tamount_float: number\n\t/** \n\t * The transaction amount, formatted.\n\t * @example ```\"€15,00\"```\n\t */\n\tformatted_amount: string\n\t/** \n\t * Indicates if the transaction is successful.\n\t */\n\tsucceeded: boolean\n\t/** \n\t * The message returned by the payment gateway.\n\t * @example ```\"Accepted\"```\n\t */\n\tmessage?: string | null\n\t/** \n\t * The error code, if any, returned by the payment gateway.\n\t * @example ```\"00001\"```\n\t */\n\terror_code?: string | null\n\t/** \n\t * The error detail, if any, returned by the payment gateway.\n\t * @example ```\"Already settled\"```\n\t */\n\terror_detail?: string | null\n\t/** \n\t * The token identifying the transaction, returned by the payment gateway.\n\t * @example ```\"xxxx-yyyy-zzzz\"```\n\t */\n\ttoken?: string | null\n\t/** \n\t * The ID identifying the transaction, returned by the payment gateway.\n\t * @example ```\"xxxx-yyyy-zzzz\"```\n\t */\n\tgateway_transaction_id?: string | null\n\t/** \n\t * The amount to be refunded, in cents.\n\t * @example ```500```\n\t */\n\trefund_amount_cents?: number | null\n\t/** \n\t * The amount to be refunded, float.\n\t * @example ```5```\n\t */\n\trefund_amount_float?: number | null\n\t/** \n\t * The amount to be refunded, formatted.\n\t * @example ```\"€5,00\"```\n\t */\n\tformatted_refund_amount?: string | null\n\t/** \n\t * The balance to be refunded, in cents.\n\t * @example ```1000```\n\t */\n\trefund_balance_cents?: number | null\n\t/** \n\t * The balance to be refunded, float.\n\t * @example ```10```\n\t */\n\trefund_balance_float?: number | null\n\t/** \n\t * The balance to be refunded, formatted.\n\t * @example ```\"€10,00\"```\n\t */\n\tformatted_refund_balance?: string | null\n\n\torder?: Order | null\n\tpayment_source?: AdyenPayment | AxervePayment | BraintreePayment | CheckoutComPayment | ExternalPayment | KlarnaPayment | PaypalPayment | SatispayPayment | StripePayment | WireTransfer | null\n\tattachments?: Attachment[] | null\n\tevents?: Event[] | null\n\tversions?: Version[] | null\n\tevent_stores?: EventStore[] | null\n\treference_authorization?: Authorization | null\n\trefunds?: Refund[] | null\n\treturn?: Return | null\n\n}\n\n\ninterface CaptureUpdate extends ResourceUpdate {\n\t\n\t/** \n\t * Indicates if the transaction is successful.\n\t */\n\tsucceeded?: boolean | null\n\t/** \n\t * Send this attribute if you want to forward a stuck transaction to succeeded and update associated order states accordingly.\n\t * @example ```true```\n\t */\n\t_forward?: boolean | null\n\t/** \n\t * Send this attribute if you want to create a refund for this capture.\n\t * @example ```true```\n\t */\n\t_refund?: boolean | null\n\t/** \n\t * Send this attribute as a value in cents if you want to overwrite the amount to be refunded.\n\t * @example ```500```\n\t */\n\t_refund_amount_cents?: number | null\n\t/** \n\t * Send this attribute if you want to refund a succeeded capture of a pending order (which is left unpaid).\n\t * @example ```true```\n\t */\n\t_cancel?: boolean | null\n\t\n}\n\n\nclass Captures extends ApiResource<Capture> {\n\n\tstatic readonly TYPE: CaptureType = 'captures' as const\n\n\tasync update(resource: CaptureUpdate, params?: QueryParamsRetrieve<Capture>, options?: ResourcesConfig): Promise<Capture> {\n\t\treturn this.resources.update<CaptureUpdate, Capture>({ ...resource, type: Captures.TYPE }, params, options)\n\t}\n\n\tasync order(captureId: string | Capture, params?: QueryParamsRetrieve<Order>, options?: ResourcesConfig): Promise<Order> {\n\t\tconst _captureId = (captureId as Capture).id || captureId as string\n\t\treturn this.resources.fetch<Order>({ type: 'orders' }, `captures/${_captureId}/order`, params, options) as unknown as Order\n\t}\n\n\tasync attachments(captureId: string | Capture, params?: QueryParamsList<Attachment>, options?: ResourcesConfig): Promise<ListResponse<Attachment>> {\n\t\tconst _captureId = (captureId as Capture).id || captureId as string\n\t\treturn this.resources.fetch<Attachment>({ type: 'attachments' }, `captures/${_captureId}/attachments`, params, options) as unknown as ListResponse<Attachment>\n\t}\n\n\tasync events(captureId: string | Capture, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>> {\n\t\tconst _captureId = (captureId as Capture).id || captureId as string\n\t\treturn this.resources.fetch<Event>({ type: 'events' }, `captures/${_captureId}/events`, params, options) as unknown as ListResponse<Event>\n\t}\n\n\tasync versions(captureId: string | Capture, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>> {\n\t\tconst _captureId = (captureId as Capture).id || captureId as string\n\t\treturn this.resources.fetch<Version>({ type: 'versions' }, `captures/${_captureId}/versions`, params, options) as unknown as ListResponse<Version>\n\t}\n\n\tasync event_stores(captureId: string | Capture, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>> {\n\t\tconst _captureId = (captureId as Capture).id || captureId as string\n\t\treturn this.resources.fetch<EventStore>({ type: 'event_stores' }, `captures/${_captureId}/event_stores`, params, options) as unknown as ListResponse<EventStore>\n\t}\n\n\tasync reference_authorization(captureId: string | Capture, params?: QueryParamsRetrieve<Authorization>, options?: ResourcesConfig): Promise<Authorization> {\n\t\tconst _captureId = (captureId as Capture).id || captureId as string\n\t\treturn this.resources.fetch<Authorization>({ type: 'authorizations' }, `captures/${_captureId}/reference_authorization`, params, options) as unknown as Authorization\n\t}\n\n\tasync refunds(captureId: string | Capture, params?: QueryParamsList<Refund>, options?: ResourcesConfig): Promise<ListResponse<Refund>> {\n\t\tconst _captureId = (captureId as Capture).id || captureId as string\n\t\treturn this.resources.fetch<Refund>({ type: 'refunds' }, `captures/${_captureId}/refunds`, params, options) as unknown as ListResponse<Refund>\n\t}\n\n\tasync return(captureId: string | Capture, params?: QueryParamsRetrieve<Return>, options?: ResourcesConfig): Promise<Return> {\n\t\tconst _captureId = (captureId as Capture).id || captureId as string\n\t\treturn this.resources.fetch<Return>({ type: 'returns' }, `captures/${_captureId}/return`, params, options) as unknown as Return\n\t}\n\n\tasync _forward(id: string | Capture, params?: QueryParamsRetrieve<Capture>, options?: ResourcesConfig): Promise<Capture> {\n\t\treturn this.resources.update<CaptureUpdate, Capture>({ id: (typeof id === 'string')? id: id.id, type: Captures.TYPE, _forward: true }, params, options)\n\t}\n\n\tasync _refund(id: string | Capture, params?: QueryParamsRetrieve<Capture>, options?: ResourcesConfig): Promise<Capture> {\n\t\treturn this.resources.update<CaptureUpdate, Capture>({ id: (typeof id === 'string')? id: id.id, type: Captures.TYPE, _refund: true }, params, options)\n\t}\n\n\tasync _refund_amount_cents(id: string | Capture, triggerValue: number, params?: QueryParamsRetrieve<Capture>, options?: ResourcesConfig): Promise<Capture> {\n\t\treturn this.resources.update<CaptureUpdate, Capture>({ id: (typeof id === 'string')? id: id.id, type: Captures.TYPE, _refund_amount_cents: triggerValue }, params, options)\n\t}\n\n\tasync _cancel(id: string | Capture, params?: QueryParamsRetrieve<Capture>, options?: ResourcesConfig): Promise<Capture> {\n\t\treturn this.resources.update<CaptureUpdate, Capture>({ id: (typeof id === 'string')? id: id.id, type: Captures.TYPE, _cancel: true }, params, options)\n\t}\n\n\n\tisCapture(resource: any): resource is Capture {\n\t\treturn resource.type && (resource.type === Captures.TYPE)\n\t}\n\n\n\trelationship(id: string | ResourceId | null): CaptureRel {\n\t\treturn super.relationshipOneToOne<CaptureRel>(id)\n\t}\n\n\trelationshipToMany(...ids: string[]): CaptureRel[] {\n\t\treturn super.relationshipOneToMany<CaptureRel>(...ids)\n\t}\n\n\n\ttype(): CaptureType {\n\t\treturn Captures.TYPE\n\t}\n\n}\n\n\nconst instance = new Captures()\nexport default instance\n\nexport type { Captures, Capture, CaptureUpdate, CaptureType }\n"]}