@commercelayer/sdk
Version:
Commerce Layer Javascript SDK
1 lines • 16.9 kB
Source Map (JSON)
{"version":3,"sources":["../src/resources/exports.ts"],"names":["ApiResource"],"mappings":";;;;;AAsKA,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,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,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,MAAA,CAAO,EAAA,EAAqB,MAAA,EAAsC,OAAA,EAA4C;AACnH,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,QAAQ,IAAA,EAAK,EAAG,QAAQ,OAAO,CAAA;AAAA,EAClJ;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,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-DCEQF4SO.cjs","sourcesContent":["import type { QueryParamsList, QueryParamsRetrieve } from '../query'\nimport type { ListResponse, Resource, ResourceCreate, ResourceId, ResourceRel, ResourceSort, /* ResourceFilter */ ResourcesConfig, ResourceUpdate, } from '../resource'\nimport { ApiResource } from '../resource'\nimport type { EventStore } from './event_stores'\nimport type { Event } from './events'\n\n\ntype ExportType = 'exports'\ntype ExportRel = ResourceRel & { type: ExportType }\n\n\nexport type ExportSort = Pick<Export, 'id' | 'resource_type' | 'format' | 'status' | 'started_at' | 'completed_at' | 'interrupted_at' | 'records_count' | 'processed_count' | 'attachment_url'> & ResourceSort\n// export type ExportFilter = Pick<Export, 'id' | 'resource_type' | 'format' | 'status' | 'started_at' | 'completed_at' | 'interrupted_at' | 'records_count' | 'processed_count' | 'attachment_url' | 'errors_log'> & ResourceFilter\n\n\ninterface Export extends Resource {\n\t\n\treadonly type: ExportType\n\n\t/** \n\t * The type of resource being exported. One of 'applications', 'event_stores', 'organizations', 'addresses', 'geocoders', 'events', 'tags', 'adjustments', 'price_lists', 'payment_gateways', 'payment_methods', 'markets', 'customer_groups', 'line_items', 'discount_engine_items', 'promotions', 'adyen_payments', 'orders', 'transactions', 'order_factories', 'attachments', 'tax_calculators', 'tax_categories', 'skus', 'shipping_categories', 'axerve_payments', 'order_validation_rules', 'braintree_payments', 'bundles', 'sku_lists', 'sku_list_items', 'stock_items', 'stock_locations', 'promotion_rules', 'coupons', 'returns', 'carrier_accounts', 'checkout_com_payments', 'customers', 'customer_addresses', 'customer_payment_sources', 'customer_subscriptions', 'order_subscriptions', 'customer_password_resets', 'delivery_lead_times', 'shipping_methods', 'shipments', 'discount_engines', 'pickups', 'parcels', 'webhooks', 'event_callbacks', 'external_payments', 'gift_cards', 'in_stock_subscriptions', 'inventory_models', 'inventory_stock_locations', 'inventory_return_locations', 'klarna_payments', 'line_item_options', 'return_line_items', 'stock_line_items', 'stock_reservations', 'stock_transfers', 'notifications', 'sku_options', 'links', 'tax_rules', 'merchants', 'subscription_models', 'stores', 'price_list_schedulers', 'order_subscription_items', 'payment_options', 'resource_errors', 'paypal_payments', 'packages', 'parcel_line_items', 'prices', 'price_tiers', 'reserved_stocks', 'satispay_payments', 'shipping_method_tiers', 'shipping_zones', 'stripe_payments', or 'wire_transfers'.\n\t * @example ```\"skus\"```\n\t */\n\tresource_type: 'applications' | 'event_stores' | 'organizations' | 'addresses' | 'geocoders' | 'events' | 'tags' | 'adjustments' | 'price_lists' | 'payment_gateways' | 'payment_methods' | 'markets' | 'customer_groups' | 'line_items' | 'discount_engine_items' | 'promotions' | 'adyen_payments' | 'orders' | 'transactions' | 'order_factories' | 'attachments' | 'tax_calculators' | 'tax_categories' | 'skus' | 'shipping_categories' | 'axerve_payments' | 'order_validation_rules' | 'braintree_payments' | 'bundles' | 'sku_lists' | 'sku_list_items' | 'stock_items' | 'stock_locations' | 'promotion_rules' | 'coupons' | 'returns' | 'carrier_accounts' | 'checkout_com_payments' | 'customers' | 'customer_addresses' | 'customer_payment_sources' | 'customer_subscriptions' | 'order_subscriptions' | 'customer_password_resets' | 'delivery_lead_times' | 'shipping_methods' | 'shipments' | 'discount_engines' | 'pickups' | 'parcels' | 'webhooks' | 'event_callbacks' | 'external_payments' | 'gift_cards' | 'in_stock_subscriptions' | 'inventory_models' | 'inventory_stock_locations' | 'inventory_return_locations' | 'klarna_payments' | 'line_item_options' | 'return_line_items' | 'stock_line_items' | 'stock_reservations' | 'stock_transfers' | 'notifications' | 'sku_options' | 'links' | 'tax_rules' | 'merchants' | 'subscription_models' | 'stores' | 'price_list_schedulers' | 'order_subscription_items' | 'payment_options' | 'resource_errors' | 'paypal_payments' | 'packages' | 'parcel_line_items' | 'prices' | 'price_tiers' | 'reserved_stocks' | 'satispay_payments' | 'shipping_method_tiers' | 'shipping_zones' | 'stripe_payments' | 'wire_transfers'\n\t/** \n\t * The format of the export. One of 'csv', or 'json' (default).\n\t * @example ```\"json\"```\n\t */\n\tformat?: 'csv' | 'json' | null\n\t/** \n\t * The export job status. One of 'pending' (default), 'in_progress', 'interrupted', 'completed', or 'failed'.\n\t * @example ```\"in_progress\"```\n\t */\n\tstatus: 'pending' | 'in_progress' | 'interrupted' | 'completed' | 'failed'\n\t/** \n\t * List of related resources that should be included in the export (redundant when 'fields' are specified).\n\t * @example ```[\"prices.price_tiers\"]```\n\t */\n\tincludes?: string[] | null\n\t/** \n\t * List of fields to export for the main and related resources (automatically included). Pass the asterisk '*' to include all exportable fields for the main and related resources.\n\t * @example ```[\"code\",\"name\",\"prices.*\",\"prices.price_tiers.price_amount_cents\"]```\n\t */\n\tfields?: string[] | null\n\t/** \n\t * The filters used to select the records to be exported.\n\t * @example ```{\"code_eq\":\"AAA\"}```\n\t */\n\tfilters?: Record<string, any> | null\n\t/** \n\t * Send this attribute if you want to skip exporting redundant attributes (IDs, timestamps, blanks, etc.), useful when combining export and import to duplicate your dataset.\n\t */\n\tdry_data?: boolean | null\n\t/** \n\t * Send this attribute to apply JWT scope–based sales channel filtering to the exported data.\n\t * @example ```true```\n\t */\n\tjwt_filters?: boolean | null\n\t/** \n\t * Time at which the export was started.\n\t * @example ```\"2018-01-01T12:00:00.000Z\"```\n\t */\n\tstarted_at?: string | null\n\t/** \n\t * Time at which the export was completed.\n\t * @example ```\"2018-01-01T12:00:00.000Z\"```\n\t */\n\tcompleted_at?: string | null\n\t/** \n\t * Estimated time at which the export should complete (dynamically refres^hed).\n\t * @example ```\"2018-01-01T12:00:00.000Z\"```\n\t */\n\testimated_completion_at?: string | null\n\t/** \n\t * Time at which the export was interrupted.\n\t * @example ```\"2018-01-01T12:00:00.000Z\"```\n\t */\n\tinterrupted_at?: string | null\n\t/** \n\t * Indicates the number of records to be exported.\n\t * @example ```300```\n\t */\n\trecords_count?: number | null\n\t/** \n\t * Indicates how many records have been processed in real time.\n\t * @example ```270```\n\t */\n\tprocessed_count?: number | null\n\t/** \n\t * The percentage of progress of the export.\n\t * @example ```30```\n\t */\n\tprogress?: number | null\n\t/** \n\t * The URL to the output file, which will be generated upon export completion.\n\t * @example ```\"http://cl_exports.s3.amazonaws.com/\"```\n\t */\n\tattachment_url?: string | null\n\t/** \n\t * Contains the exports errors, if any.\n\t * @example ```{\"RuntimeError\":\"query timeout\"}```\n\t */\n\terrors_log?: Record<string, any> | null\n\n\tevents?: Event[] | null\n\tevent_stores?: EventStore[] | null\n\n}\n\n\ninterface ExportCreate extends ResourceCreate {\n\t\n\t/** \n\t * The type of resource being exported. One of 'applications', 'event_stores', 'organizations', 'addresses', 'geocoders', 'events', 'tags', 'adjustments', 'price_lists', 'payment_gateways', 'payment_methods', 'markets', 'customer_groups', 'line_items', 'discount_engine_items', 'promotions', 'adyen_payments', 'orders', 'transactions', 'order_factories', 'attachments', 'tax_calculators', 'tax_categories', 'skus', 'shipping_categories', 'axerve_payments', 'order_validation_rules', 'braintree_payments', 'bundles', 'sku_lists', 'sku_list_items', 'stock_items', 'stock_locations', 'promotion_rules', 'coupons', 'returns', 'carrier_accounts', 'checkout_com_payments', 'customers', 'customer_addresses', 'customer_payment_sources', 'customer_subscriptions', 'order_subscriptions', 'customer_password_resets', 'delivery_lead_times', 'shipping_methods', 'shipments', 'discount_engines', 'pickups', 'parcels', 'webhooks', 'event_callbacks', 'external_payments', 'gift_cards', 'in_stock_subscriptions', 'inventory_models', 'inventory_stock_locations', 'inventory_return_locations', 'klarna_payments', 'line_item_options', 'return_line_items', 'stock_line_items', 'stock_reservations', 'stock_transfers', 'notifications', 'sku_options', 'links', 'tax_rules', 'merchants', 'subscription_models', 'stores', 'price_list_schedulers', 'order_subscription_items', 'payment_options', 'resource_errors', 'paypal_payments', 'packages', 'parcel_line_items', 'prices', 'price_tiers', 'reserved_stocks', 'satispay_payments', 'shipping_method_tiers', 'shipping_zones', 'stripe_payments', or 'wire_transfers'.\n\t * @example ```\"skus\"```\n\t */\n\tresource_type: 'applications' | 'event_stores' | 'organizations' | 'addresses' | 'geocoders' | 'events' | 'tags' | 'adjustments' | 'price_lists' | 'payment_gateways' | 'payment_methods' | 'markets' | 'customer_groups' | 'line_items' | 'discount_engine_items' | 'promotions' | 'adyen_payments' | 'orders' | 'transactions' | 'order_factories' | 'attachments' | 'tax_calculators' | 'tax_categories' | 'skus' | 'shipping_categories' | 'axerve_payments' | 'order_validation_rules' | 'braintree_payments' | 'bundles' | 'sku_lists' | 'sku_list_items' | 'stock_items' | 'stock_locations' | 'promotion_rules' | 'coupons' | 'returns' | 'carrier_accounts' | 'checkout_com_payments' | 'customers' | 'customer_addresses' | 'customer_payment_sources' | 'customer_subscriptions' | 'order_subscriptions' | 'customer_password_resets' | 'delivery_lead_times' | 'shipping_methods' | 'shipments' | 'discount_engines' | 'pickups' | 'parcels' | 'webhooks' | 'event_callbacks' | 'external_payments' | 'gift_cards' | 'in_stock_subscriptions' | 'inventory_models' | 'inventory_stock_locations' | 'inventory_return_locations' | 'klarna_payments' | 'line_item_options' | 'return_line_items' | 'stock_line_items' | 'stock_reservations' | 'stock_transfers' | 'notifications' | 'sku_options' | 'links' | 'tax_rules' | 'merchants' | 'subscription_models' | 'stores' | 'price_list_schedulers' | 'order_subscription_items' | 'payment_options' | 'resource_errors' | 'paypal_payments' | 'packages' | 'parcel_line_items' | 'prices' | 'price_tiers' | 'reserved_stocks' | 'satispay_payments' | 'shipping_method_tiers' | 'shipping_zones' | 'stripe_payments' | 'wire_transfers'\n\t/** \n\t * The format of the export. One of 'csv', or 'json' (default).\n\t * @example ```\"json\"```\n\t */\n\tformat?: 'csv' | 'json' | null\n\t/** \n\t * List of related resources that should be included in the export (redundant when 'fields' are specified).\n\t * @example ```[\"prices.price_tiers\"]```\n\t */\n\tincludes?: string[] | null\n\t/** \n\t * List of fields to export for the main and related resources (automatically included). Pass the asterisk '*' to include all exportable fields for the main and related resources.\n\t * @example ```[\"code\",\"name\",\"prices.*\",\"prices.price_tiers.price_amount_cents\"]```\n\t */\n\tfields?: string[] | null\n\t/** \n\t * The filters used to select the records to be exported.\n\t * @example ```{\"code_eq\":\"AAA\"}```\n\t */\n\tfilters?: Record<string, any> | null\n\t/** \n\t * Send this attribute if you want to skip exporting redundant attributes (IDs, timestamps, blanks, etc.), useful when combining export and import to duplicate your dataset.\n\t */\n\tdry_data?: boolean | null\n\t/** \n\t * Send this attribute to apply JWT scope–based sales channel filtering to the exported data.\n\t * @example ```true```\n\t */\n\tjwt_filters?: boolean | null\n\t\n}\n\n\ninterface ExportUpdate extends ResourceUpdate {\n\t\n\t/** \n\t * Send this attribute if you want to restart an 'interrupted' export.\n\t * @example ```true```\n\t */\n\t_start?: boolean | null\n\t/** \n\t * Send this attribute if you want to mark status as 'interrupted'.\n\t * @example ```true```\n\t */\n\t_interrupt?: boolean | null\n\t\n}\n\n\nclass Exports extends ApiResource<Export> {\n\n\tstatic readonly TYPE: ExportType = 'exports' as const\n\n\tasync create(resource: ExportCreate, params?: QueryParamsRetrieve<Export>, options?: ResourcesConfig): Promise<Export> {\n\t\treturn this.resources.create<ExportCreate, Export>({ ...resource, type: Exports.TYPE }, params, options)\n\t}\n\n\tasync update(resource: ExportUpdate, params?: QueryParamsRetrieve<Export>, options?: ResourcesConfig): Promise<Export> {\n\t\treturn this.resources.update<ExportUpdate, Export>({ ...resource, type: Exports.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: Exports.TYPE } : id, options)\n\t}\n\n\tasync events(exportId: string | Export, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>> {\n\t\tconst _exportId = (exportId as Export).id || exportId as string\n\t\treturn this.resources.fetch<Event>({ type: 'events' }, `exports/${_exportId}/events`, params, options) as unknown as ListResponse<Event>\n\t}\n\n\tasync event_stores(exportId: string | Export, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>> {\n\t\tconst _exportId = (exportId as Export).id || exportId as string\n\t\treturn this.resources.fetch<EventStore>({ type: 'event_stores' }, `exports/${_exportId}/event_stores`, params, options) as unknown as ListResponse<EventStore>\n\t}\n\n\tasync _start(id: string | Export, params?: QueryParamsRetrieve<Export>, options?: ResourcesConfig): Promise<Export> {\n\t\treturn this.resources.update<ExportUpdate, Export>({ id: (typeof id === 'string')? id: id.id, type: Exports.TYPE, _start: true }, params, options)\n\t}\n\n\tasync _interrupt(id: string | Export, params?: QueryParamsRetrieve<Export>, options?: ResourcesConfig): Promise<Export> {\n\t\treturn this.resources.update<ExportUpdate, Export>({ id: (typeof id === 'string')? id: id.id, type: Exports.TYPE, _interrupt: true }, params, options)\n\t}\n\n\n\tisExport(resource: any): resource is Export {\n\t\treturn resource.type && (resource.type === Exports.TYPE)\n\t}\n\n\n\trelationship(id: string | ResourceId | null): ExportRel {\n\t\treturn super.relationshipOneToOne<ExportRel>(id)\n\t}\n\n\trelationshipToMany(...ids: string[]): ExportRel[] {\n\t\treturn super.relationshipOneToMany<ExportRel>(...ids)\n\t}\n\n\n\ttype(): ExportType {\n\t\treturn Exports.TYPE\n\t}\n\n}\n\n\nconst instance = new Exports()\nexport default instance\n\nexport type { Export, ExportCreate, Exports, ExportType, ExportUpdate }\n"]}