@commercelayer/sdk
Version:
Commerce Layer Javascript SDK
1 lines • 17.1 kB
Source Map (JSON)
{"version":3,"sources":["../src/resources/addresses.ts"],"names":["ApiResource"],"mappings":";;;;;AAkVA,IAAM,SAAA,GAAN,MAAM,UAAA,SAAkBA,6BAAA,CAAqB;AAAA,EAE5C,OAAgB,IAAA,GAAoB,WAAA;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,UAAA,CAAU,IAAA,EAAK,EAAG,MAAA,EAAQ,OAAO,CAAA;AAAA,EAC5G;AAAA,EAEA,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,UAAA,CAAU,IAAA,EAAK,EAAG,MAAA,EAAQ,OAAO,CAAA;AAAA,EAC5G;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,UAAA,CAAU,IAAA,EAAK,GAAI,IAAI,OAAO,CAAA;AAAA,EACjG;AAAA,EAEA,MAAM,QAAA,CAAS,SAAA,EAA6B,MAAA,EAAwC,OAAA,EAA8C;AACjI,IAAA,MAAM,UAAA,GAAc,UAAsB,EAAA,IAAM,SAAA;AAChD,IAAA,OAAO,IAAA,CAAK,SAAA,CAAU,KAAA,CAAgB,EAAE,IAAA,EAAM,WAAA,EAAY,EAAG,CAAA,UAAA,EAAa,UAAU,CAAA,SAAA,CAAA,EAAa,MAAA,EAAQ,OAAO,CAAA;AAAA,EACjH;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,UAAA,EAAa,UAAU,CAAA,OAAA,CAAA,EAAW,MAAA,EAAQ,OAAO,CAAA;AAAA,EACzG;AAAA,EAEA,MAAM,IAAA,CAAK,SAAA,EAA6B,MAAA,EAA+B,OAAA,EAAuD;AAC7H,IAAA,MAAM,UAAA,GAAc,UAAsB,EAAA,IAAM,SAAA;AAChD,IAAA,OAAO,IAAA,CAAK,SAAA,CAAU,KAAA,CAAW,EAAE,IAAA,EAAM,MAAA,EAAO,EAAG,CAAA,UAAA,EAAa,UAAU,CAAA,KAAA,CAAA,EAAS,MAAA,EAAQ,OAAO,CAAA;AAAA,EACnG;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,UAAA,EAAa,UAAU,CAAA,SAAA,CAAA,EAAa,MAAA,EAAQ,OAAO,CAAA;AAAA,EAC/G;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,UAAA,EAAa,UAAU,CAAA,aAAA,CAAA,EAAiB,MAAA,EAAQ,OAAO,CAAA;AAAA,EAC1H;AAAA,EAEA,MAAM,SAAA,CAAU,EAAA,EAAsB,YAAA,EAAsB,QAAuC,OAAA,EAA6C;AAC/I,IAAA,OAAO,KAAK,SAAA,CAAU,MAAA,CAA+B,EAAE,EAAA,EAAK,OAAO,OAAO,QAAA,GAAW,EAAA,GAAI,EAAA,CAAG,EAAA,EAAI,MAAM,UAAA,CAAU,IAAA,EAAM,WAAW,YAAA,EAAa,EAAG,QAAQ,OAAO,CAAA;AAAA,EACjK;AAAA,EAEA,MAAM,YAAA,CAAa,EAAA,EAAsB,YAAA,EAAsB,QAAuC,OAAA,EAA6C;AAClJ,IAAA,OAAO,KAAK,SAAA,CAAU,MAAA,CAA+B,EAAE,EAAA,EAAK,OAAO,OAAO,QAAA,GAAW,EAAA,GAAI,EAAA,CAAG,EAAA,EAAI,MAAM,UAAA,CAAU,IAAA,EAAM,cAAc,YAAA,EAAa,EAAG,QAAQ,OAAO,CAAA;AAAA,EACpK;AAAA,EAGA,UAAU,QAAA,EAAoC;AAC7C,IAAA,OAAO,QAAA,CAAS,IAAA,IAAS,QAAA,CAAS,IAAA,KAAS,UAAA,CAAU,IAAA;AAAA,EACtD;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,UAAA,CAAU,IAAA;AAAA,EAClB;AAED,CAAA;AAGA,IAAM,QAAA,GAAW,IAAI,SAAA,EAAU;AAC/B,IAAO,iBAAA,GAAQ","file":"chunk-7YWXHAMP.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 { Geocoder, GeocoderType } from './geocoders'\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 AddressType = 'addresses'\ntype AddressRel = ResourceRel & { type: AddressType }\ntype GeocoderRel = ResourceRel & { type: GeocoderType }\ntype TagRel = ResourceRel & { type: TagType }\n\n\nexport type AddressSort = Pick<Address, 'id' | 'city' | 'state_code' | 'country_code'> & ResourceSort\n// export type AddressFilter = Pick<Address, 'id' | 'business' | 'first_name' | 'last_name' | 'company' | 'line_1' | 'line_2' | 'city' | 'zip_code' | 'state_code' | 'country_code' | 'phone' | 'email' | 'notes' | 'lat' | 'lng' | 'billing_info'> & ResourceFilter\n\n\ninterface Address extends Resource {\n\t\n\treadonly type: AddressType\n\n\t/** \n\t * Indicates if it's a business or a personal address.\n\t */\n\tbusiness?: boolean | null\n\t/** \n\t * Address first name (personal).\n\t * @example ```\"John\"```\n\t */\n\tfirst_name?: string | null\n\t/** \n\t * Address last name (personal).\n\t * @example ```\"Smith\"```\n\t */\n\tlast_name?: string | null\n\t/** \n\t * Address company name (business).\n\t * @example ```\"The Red Brand Inc.\"```\n\t */\n\tcompany?: string | null\n\t/** \n\t * Company name (business) of first name and last name (personal).\n\t * @example ```\"John Smith\"```\n\t */\n\tfull_name?: string | null\n\t/** \n\t * Address line 1, i.e. Street address, PO Box.\n\t * @example ```\"2883 Geraldine Lane\"```\n\t */\n\tline_1: string\n\t/** \n\t * Address line 2, i.e. Apartment, Suite, Building.\n\t * @example ```\"Apt.23\"```\n\t */\n\tline_2?: string | null\n\t/** \n\t * Address city.\n\t * @example ```\"New York\"```\n\t */\n\tcity: string\n\t/** \n\t * ZIP or postal code.\n\t * @example ```\"10013\"```\n\t */\n\tzip_code?: string | null\n\t/** \n\t * State, province or region code.\n\t * @example ```\"NY\"```\n\t */\n\tstate_code?: string | null\n\t/** \n\t * The international 2-letter country code as defined by the ISO 3166-1 standard.\n\t * @example ```\"US\"```\n\t */\n\tcountry_code: string\n\t/** \n\t * Phone number (including extension).\n\t * @example ```\"(212) 646-338-1228\"```\n\t */\n\tphone: string\n\t/** \n\t * Compact description of the address location, without the full name.\n\t * @example ```\"2883 Geraldine Lane Apt.23, 10013 New York NY (US) (212) 646-338-1228\"```\n\t */\n\tfull_address?: string | null\n\t/** \n\t * Compact description of the address location, including the full name.\n\t * @example ```\"John Smith, 2883 Geraldine Lane Apt.23, 10013 New York NY (US) (212) 646-338-1228\"```\n\t */\n\tname?: string | null\n\t/** \n\t * Email address.\n\t * @example ```\"john@example.com\"```\n\t */\n\temail?: string | null\n\t/** \n\t * A free notes attached to the address. When used as a shipping address, this can be useful to let the customers add specific delivery instructions.\n\t * @example ```\"Please ring the bell twice\"```\n\t */\n\tnotes?: string | null\n\t/** \n\t * The address geocoded latitude. This is automatically generated when creating a shipping/billing address for an order and a valid geocoder is attached to the order's market.\n\t * @example ```40.6971494```\n\t */\n\tlat?: number | null\n\t/** \n\t * The address geocoded longitude. This is automatically generated when creating a shipping/billing address for an order and a valid geocoder is attached to the order's market.\n\t * @example ```-74.2598672```\n\t */\n\tlng?: number | null\n\t/** \n\t * Indicates if the latitude and logitude are present, either geocoded or manually updated.\n\t * @example ```true```\n\t */\n\tis_localized?: boolean | null\n\t/** \n\t * Indicates if the address has been successfully geocoded.\n\t * @example ```true```\n\t */\n\tis_geocoded?: boolean | null\n\t/** \n\t * The geocoder provider name (either Google or Bing).\n\t * @example ```\"google\"```\n\t */\n\tprovider_name?: string | null\n\t/** \n\t * The map url of the geocoded address (if geocoded).\n\t * @example ```\"https://www.google.com/maps/search/?api=1&query=40.6971494,-74.2598672\"```\n\t */\n\tmap_url?: string | null\n\t/** \n\t * The static map image url of the geocoded address (if geocoded).\n\t * @example ```\"https://maps.googleapis.com/maps/api/staticmap?center=40.6971494,-74.2598672&size=640x320&zoom=15\"```\n\t */\n\tstatic_map_url?: string | null\n\t/** \n\t * Customer's billing information (i.e. VAT number, codice fiscale).\n\t * @example ```\"VAT ID IT02382940977\"```\n\t */\n\tbilling_info?: string | null\n\n\tgeocoder?: Geocoder | null\n\tevents?: Event[] | null\n\ttags?: Tag[] | null\n\tversions?: Version[] | null\n\tevent_stores?: EventStore[] | null\n\n}\n\n\ninterface AddressCreate extends ResourceCreate {\n\t\n\t/** \n\t * Indicates if it's a business or a personal address.\n\t */\n\tbusiness?: boolean | null\n\t/** \n\t * Address first name (personal).\n\t * @example ```\"John\"```\n\t */\n\tfirst_name?: string | null\n\t/** \n\t * Address last name (personal).\n\t * @example ```\"Smith\"```\n\t */\n\tlast_name?: string | null\n\t/** \n\t * Address company name (business).\n\t * @example ```\"The Red Brand Inc.\"```\n\t */\n\tcompany?: string | null\n\t/** \n\t * Address line 1, i.e. Street address, PO Box.\n\t * @example ```\"2883 Geraldine Lane\"```\n\t */\n\tline_1: string\n\t/** \n\t * Address line 2, i.e. Apartment, Suite, Building.\n\t * @example ```\"Apt.23\"```\n\t */\n\tline_2?: string | null\n\t/** \n\t * Address city.\n\t * @example ```\"New York\"```\n\t */\n\tcity: string\n\t/** \n\t * ZIP or postal code.\n\t * @example ```\"10013\"```\n\t */\n\tzip_code?: string | null\n\t/** \n\t * State, province or region code.\n\t * @example ```\"NY\"```\n\t */\n\tstate_code?: string | null\n\t/** \n\t * The international 2-letter country code as defined by the ISO 3166-1 standard.\n\t * @example ```\"US\"```\n\t */\n\tcountry_code: string\n\t/** \n\t * Phone number (including extension).\n\t * @example ```\"(212) 646-338-1228\"```\n\t */\n\tphone: string\n\t/** \n\t * Email address.\n\t * @example ```\"john@example.com\"```\n\t */\n\temail?: string | null\n\t/** \n\t * A free notes attached to the address. When used as a shipping address, this can be useful to let the customers add specific delivery instructions.\n\t * @example ```\"Please ring the bell twice\"```\n\t */\n\tnotes?: string | null\n\t/** \n\t * The address geocoded latitude. This is automatically generated when creating a shipping/billing address for an order and a valid geocoder is attached to the order's market.\n\t * @example ```40.6971494```\n\t */\n\tlat?: number | null\n\t/** \n\t * The address geocoded longitude. This is automatically generated when creating a shipping/billing address for an order and a valid geocoder is attached to the order's market.\n\t * @example ```-74.2598672```\n\t */\n\tlng?: number | null\n\t/** \n\t * Customer's billing information (i.e. VAT number, codice fiscale).\n\t * @example ```\"VAT ID IT02382940977\"```\n\t */\n\tbilling_info?: string | null\n\n\tgeocoder?: GeocoderRel | null\n\ttags?: TagRel[] | null\n\n}\n\n\ninterface AddressUpdate extends ResourceUpdate {\n\t\n\t/** \n\t * Indicates if it's a business or a personal address.\n\t */\n\tbusiness?: boolean | null\n\t/** \n\t * Address first name (personal).\n\t * @example ```\"John\"```\n\t */\n\tfirst_name?: string | null\n\t/** \n\t * Address last name (personal).\n\t * @example ```\"Smith\"```\n\t */\n\tlast_name?: string | null\n\t/** \n\t * Address company name (business).\n\t * @example ```\"The Red Brand Inc.\"```\n\t */\n\tcompany?: string | null\n\t/** \n\t * Address line 1, i.e. Street address, PO Box.\n\t * @example ```\"2883 Geraldine Lane\"```\n\t */\n\tline_1?: string | null\n\t/** \n\t * Address line 2, i.e. Apartment, Suite, Building.\n\t * @example ```\"Apt.23\"```\n\t */\n\tline_2?: string | null\n\t/** \n\t * Address city.\n\t * @example ```\"New York\"```\n\t */\n\tcity?: string | null\n\t/** \n\t * ZIP or postal code.\n\t * @example ```\"10013\"```\n\t */\n\tzip_code?: string | null\n\t/** \n\t * State, province or region code.\n\t * @example ```\"NY\"```\n\t */\n\tstate_code?: string | null\n\t/** \n\t * The international 2-letter country code as defined by the ISO 3166-1 standard.\n\t * @example ```\"US\"```\n\t */\n\tcountry_code?: string | null\n\t/** \n\t * Phone number (including extension).\n\t * @example ```\"(212) 646-338-1228\"```\n\t */\n\tphone?: string | null\n\t/** \n\t * Email address.\n\t * @example ```\"john@example.com\"```\n\t */\n\temail?: string | null\n\t/** \n\t * A free notes attached to the address. When used as a shipping address, this can be useful to let the customers add specific delivery instructions.\n\t * @example ```\"Please ring the bell twice\"```\n\t */\n\tnotes?: string | null\n\t/** \n\t * The address geocoded latitude. This is automatically generated when creating a shipping/billing address for an order and a valid geocoder is attached to the order's market.\n\t * @example ```40.6971494```\n\t */\n\tlat?: number | null\n\t/** \n\t * The address geocoded longitude. This is automatically generated when creating a shipping/billing address for an order and a valid geocoder is attached to the order's market.\n\t * @example ```-74.2598672```\n\t */\n\tlng?: number | null\n\t/** \n\t * Customer's billing information (i.e. VAT number, codice fiscale).\n\t * @example ```\"VAT ID IT02382940977\"```\n\t */\n\tbilling_info?: string | 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\tgeocoder?: GeocoderRel | null\n\ttags?: TagRel[] | null\n\n}\n\n\nclass Addresses extends ApiResource<Address> {\n\n\tstatic readonly TYPE: AddressType = 'addresses' as const\n\n\tasync create(resource: AddressCreate, params?: QueryParamsRetrieve<Address>, options?: ResourcesConfig): Promise<Address> {\n\t\treturn this.resources.create<AddressCreate, Address>({ ...resource, type: Addresses.TYPE }, params, options)\n\t}\n\n\tasync update(resource: AddressUpdate, params?: QueryParamsRetrieve<Address>, options?: ResourcesConfig): Promise<Address> {\n\t\treturn this.resources.update<AddressUpdate, Address>({ ...resource, type: Addresses.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: Addresses.TYPE } : id, options)\n\t}\n\n\tasync geocoder(addressId: string | Address, params?: QueryParamsRetrieve<Geocoder>, options?: ResourcesConfig): Promise<Geocoder> {\n\t\tconst _addressId = (addressId as Address).id || addressId as string\n\t\treturn this.resources.fetch<Geocoder>({ type: 'geocoders' }, `addresses/${_addressId}/geocoder`, params, options) as unknown as Geocoder\n\t}\n\n\tasync events(addressId: string | Address, params?: QueryParamsList<Event>, options?: ResourcesConfig): Promise<ListResponse<Event>> {\n\t\tconst _addressId = (addressId as Address).id || addressId as string\n\t\treturn this.resources.fetch<Event>({ type: 'events' }, `addresses/${_addressId}/events`, params, options) as unknown as ListResponse<Event>\n\t}\n\n\tasync tags(addressId: string | Address, params?: QueryParamsList<Tag>, options?: ResourcesConfig): Promise<ListResponse<Tag>> {\n\t\tconst _addressId = (addressId as Address).id || addressId as string\n\t\treturn this.resources.fetch<Tag>({ type: 'tags' }, `addresses/${_addressId}/tags`, params, options) as unknown as ListResponse<Tag>\n\t}\n\n\tasync versions(addressId: string | Address, params?: QueryParamsList<Version>, options?: ResourcesConfig): Promise<ListResponse<Version>> {\n\t\tconst _addressId = (addressId as Address).id || addressId as string\n\t\treturn this.resources.fetch<Version>({ type: 'versions' }, `addresses/${_addressId}/versions`, params, options) as unknown as ListResponse<Version>\n\t}\n\n\tasync event_stores(addressId: string | Address, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>> {\n\t\tconst _addressId = (addressId as Address).id || addressId as string\n\t\treturn this.resources.fetch<EventStore>({ type: 'event_stores' }, `addresses/${_addressId}/event_stores`, params, options) as unknown as ListResponse<EventStore>\n\t}\n\n\tasync _add_tags(id: string | Address, triggerValue: string, params?: QueryParamsRetrieve<Address>, options?: ResourcesConfig): Promise<Address> {\n\t\treturn this.resources.update<AddressUpdate, Address>({ id: (typeof id === 'string')? id: id.id, type: Addresses.TYPE, _add_tags: triggerValue }, params, options)\n\t}\n\n\tasync _remove_tags(id: string | Address, triggerValue: string, params?: QueryParamsRetrieve<Address>, options?: ResourcesConfig): Promise<Address> {\n\t\treturn this.resources.update<AddressUpdate, Address>({ id: (typeof id === 'string')? id: id.id, type: Addresses.TYPE, _remove_tags: triggerValue }, params, options)\n\t}\n\n\n\tisAddress(resource: any): resource is Address {\n\t\treturn resource.type && (resource.type === Addresses.TYPE)\n\t}\n\n\n\trelationship(id: string | ResourceId | null): AddressRel {\n\t\treturn super.relationshipOneToOne<AddressRel>(id)\n\t}\n\n\trelationshipToMany(...ids: string[]): AddressRel[] {\n\t\treturn super.relationshipOneToMany<AddressRel>(...ids)\n\t}\n\n\n\ttype(): AddressType {\n\t\treturn Addresses.TYPE\n\t}\n\n}\n\n\nconst instance = new Addresses()\nexport default instance\n\nexport type { Addresses, Address, AddressCreate, AddressUpdate, AddressType }\n"]}