@myparcel-dev/sdk 4.1.0

package/lib/endpoints/private/webhook-subscriptions/DeleteWebhookSubscriptions.d.ts

@@ -0,0 +1,16 @@
+import { AbstractPrivateEndpoint } from '../../../model/endpoint/AbstractPrivateEndpoint';
+import { type CreateDefinition } from '../../../model/endpoint/AbstractEndpoint.types';
+import { type HttpMethod } from '../../../types';
+type DeleteWebhookSubscriptionsDefinition = CreateDefinition<{
+    name: typeof DeleteWebhookSubscriptions.name;
+    path: {
+        ids: string;
+    };
+}>;
+export declare class DeleteWebhookSubscriptions extends AbstractPrivateEndpoint<DeleteWebhookSubscriptionsDefinition> {
+    readonly method: HttpMethod;
+    readonly name = "deleteWebhookSubscriptions";
+    readonly path = "webhook_subscriptions/:ids";
+    readonly property = "webhook_subscriptions";
+}
+export {};

package/lib/endpoints/private/webhook-subscriptions/GetWebhookSubscriptions.d.ts

@@ -0,0 +1,14 @@
+import { type MyParcelWebhook, type WebhookSubscriptionParameters } from './Webhook.types';
+import { AbstractPrivateEndpoint } from '../../../model/endpoint/AbstractPrivateEndpoint';
+import { type CreateDefinition } from '../../../model/endpoint/AbstractEndpoint.types';
+type GetWebhookSubscriptionsDefinition = CreateDefinition<{
+    name: typeof GetWebhookSubscriptions.name;
+    parameters: WebhookSubscriptionParameters;
+    response: MyParcelWebhook[];
+}>;
+export declare class GetWebhookSubscriptions extends AbstractPrivateEndpoint<GetWebhookSubscriptionsDefinition> {
+    readonly name = "getWebhookSubscriptions";
+    readonly path = "webhook_subscriptions";
+    readonly property = "webhook_subscriptions";
+}
+export {};

package/lib/endpoints/private/webhook-subscriptions/PostWebhookSubscriptions.d.ts

@@ -0,0 +1,19 @@
+import { AbstractPrivateEndpoint } from '../../../model/endpoint/AbstractPrivateEndpoint';
+import { type CreateDefinition } from '../../../model/endpoint/AbstractEndpoint.types';
+import { type HttpMethod } from '../../../types';
+import { type MyParcelWebhook } from './Webhook.types';
+type PostWebhookSubscriptionsDefinition = CreateDefinition<{
+    name: typeof PostWebhookSubscriptions.name;
+    body: MyParcelWebhook[];
+    response: {
+        id: number[];
+    };
+}>;
+export declare class PostWebhookSubscriptions extends AbstractPrivateEndpoint<PostWebhookSubscriptionsDefinition> {
+    readonly method: HttpMethod;
+    readonly name = "postWebhookSubscriptions";
+    readonly path = "webhook_subscriptions";
+    readonly property = "webhook_subscriptions";
+    readonly responseProperty = "ids";
+}
+export {};

package/lib/endpoints/private/webhook-subscriptions/Webhook.types.d.ts

@@ -0,0 +1,13 @@
+export type WebhookSubscriptionParameters = {
+    account_id?: number;
+    shop_id?: number;
+    hook?: string;
+    ids?: string;
+};
+export interface MyParcelWebhook {
+    account_id: number;
+    hook: 'shipment_label_created' | 'shipment_status_change';
+    id: number;
+    shop_id: number;
+    url: string;
+}

package/lib/endpoints/private/webhook-subscriptions/index.d.ts

@@ -0,0 +1,4 @@
+export * from './DeleteWebhookSubscriptions';
+export * from './GetWebhookSubscriptions';
+export * from './PostWebhookSubscriptions';
+export * from './Webhook.types';

package/lib/endpoints/public/carriers/Carrier.types.d.ts

@@ -0,0 +1,10 @@
+import { type CarrierId, type CarrierName } from '@myparcel/constants';
+export interface Carrier {
+    id: CarrierId;
+    name: CarrierName;
+    human: string;
+    meta: {
+        logo_svg: string;
+        logo_png: string;
+    };
+}

package/lib/endpoints/public/carriers/GetCarrier.d.ts

@@ -0,0 +1,19 @@
+import { type CarrierNameOrId } from '@myparcel/constants';
+import { AbstractPublicEndpoint } from '../../../model/endpoint/AbstractPublicEndpoint';
+import { type CreateDefinition } from '../../../model/endpoint/AbstractEndpoint.types';
+import { type Carrier } from './Carrier.types';
+export type GetCarrierDefinition = CreateDefinition<{
+    name: typeof GetCarrier.name;
+    path: {
+        carrier: CarrierNameOrId;
+    };
+    response: [Carrier];
+}>;
+/**
+ * Get a single carrier.
+ */
+export declare class GetCarrier extends AbstractPublicEndpoint<GetCarrierDefinition> {
+    readonly name = "getCarrier";
+    readonly path = "carriers/:carrier";
+    readonly property = "carriers";
+}

package/lib/endpoints/public/carriers/GetCarriers.d.ts

@@ -0,0 +1,15 @@
+import { AbstractPublicEndpoint } from '../../../model/endpoint/AbstractPublicEndpoint';
+import { type CreateDefinition } from '../../../model/endpoint/AbstractEndpoint.types';
+import { type Carrier } from './Carrier.types';
+export type GetCarriersDefinition = CreateDefinition<{
+    name: typeof GetCarriers.name;
+    response: Carrier[];
+}>;
+/**
+ * Get all carriers.
+ */
+export declare class GetCarriers extends AbstractPublicEndpoint<GetCarriersDefinition> {
+    readonly name = "getCarriers";
+    readonly path = "carriers";
+    readonly property = "carriers";
+}

package/lib/endpoints/public/carriers/index.d.ts

@@ -0,0 +1,3 @@
+export * from './Carrier.types';
+export * from './GetCarrier';
+export * from './GetCarriers';

package/lib/endpoints/public/delivery-options/DeliveryOption.types.d.ts

@@ -0,0 +1,22 @@
+import { type DeliveryTypeName, type PackageTypeName, type ShipmentOptionName } from '@myparcel/constants';
+import { type EnumSchema, type Timestamp } from '../../../types';
+interface PossibleShipmentOption {
+    name: ShipmentOptionName;
+    schema: EnumSchema<boolean>;
+}
+export interface DeliveryOption {
+    date: Timestamp;
+    possibilities: DeliveryPossibility[];
+}
+export interface DeliveryPossibility {
+    collect_date?: string;
+    delivery_time_frames: [DeliveryTimeFrame<'start'>, DeliveryTimeFrame<'end'>];
+    package_type: PackageTypeName;
+    shipment_options: PossibleShipmentOption[];
+    type: DeliveryTypeName;
+}
+export interface DeliveryTimeFrame<Type = 'start' | 'end'> {
+    date_time: Timestamp;
+    type: Type;
+}
+export {};

package/lib/endpoints/public/delivery-options/GetDeliveryOptions.d.ts

@@ -0,0 +1,49 @@
+import { type CarrierNameOrId, type DeliveryTypeId, type PackageTypeName, type PlatformNameOrId } from '@myparcel/constants';
+import { type RequestHeaders } from '../../../types/request.types';
+import { type WithRequired } from '../../../types/global.types';
+import { AbstractPublicEndpoint } from '../../../model/endpoint/AbstractPublicEndpoint';
+import { type CreateDefinition } from '../../../model/endpoint/AbstractEndpoint.types';
+import { type DeliveryOption } from './DeliveryOption.types';
+type Parameters = {
+    carrier: CarrierNameOrId;
+    cc: string;
+    platform: PlatformNameOrId;
+    postal_code: string;
+    city?: string;
+    cutoff_time?: string;
+    delivery_date?: string;
+    delivery_time?: string;
+    deliverydays_window?: number;
+    dropoff_days?: string;
+    dropoff_delay?: number;
+    exclude_delivery_type?: DeliveryTypeId;
+    exclude_parcel_lockers?: boolean;
+    include?: 'shipment_options' | string;
+    latitude?: string;
+    longitude?: string;
+    monday_delivery?: boolean;
+    number?: number;
+    package_type?: PackageTypeName;
+    saturday_delivery?: boolean;
+    same_day_delivery?: boolean;
+    street?: string;
+};
+/**
+ * Either number or full street is required.
+ */
+export type DeliveryOptionsParameters = WithRequired<Parameters, 'number'> | WithRequired<Parameters, 'street'>;
+type GetDeliveryOptionsDefinition = CreateDefinition<{
+    name: typeof GetDeliveryOptions.name;
+    parameters: DeliveryOptionsParameters;
+    response: DeliveryOption[];
+}>;
+/**
+ * Get available delivery options for given location. Note: This calls version 2 of the endpoint.
+ */
+export declare class GetDeliveryOptions extends AbstractPublicEndpoint<GetDeliveryOptionsDefinition> {
+    readonly name = "getDeliveryOptions";
+    readonly path = "delivery_options";
+    readonly property = "deliveries";
+    getHeaders(): RequestHeaders;
+}
+export {};

package/lib/endpoints/public/delivery-options/index.d.ts

@@ -0,0 +1,2 @@
+export * from './DeliveryOption.types';
+export * from './GetDeliveryOptions';

package/lib/endpoints/public/index.d.ts

@@ -0,0 +1,3 @@
+export * from './carriers';
+export * from './delivery-options';
+export * from './pickup-locations';

package/lib/endpoints/public/pickup-locations/GetPickupLocations.d.ts

@@ -0,0 +1,17 @@
+import { AbstractPublicEndpoint } from '../../../model/endpoint/AbstractPublicEndpoint';
+import { type CreateDefinition } from '../../../model/endpoint/AbstractEndpoint.types';
+import { type PickupLocation } from './PickupLocation.types';
+import { type DeliveryOptionsParameters } from '../..';
+export type GetPickupLocationsDefinition = CreateDefinition<{
+    name: typeof GetPickupLocations.name;
+    parameters: DeliveryOptionsParameters;
+    response: PickupLocation[];
+}>;
+/**
+ * Get available pickup locations for given location.
+ */
+export declare class GetPickupLocations extends AbstractPublicEndpoint<GetPickupLocationsDefinition> {
+    readonly name = "getPickupLocations";
+    readonly path = "pickup_locations";
+    readonly property = "pickup_locations";
+}

package/lib/endpoints/public/pickup-locations/PickupLocation.types.d.ts

@@ -0,0 +1,31 @@
+import { type DeliveryTypeId, type DeliveryTypeName } from '@myparcel/constants';
+import { type StartEndDate, type Timestamp, type Weekday } from '../../../types';
+export interface PickupLocation {
+    address: {
+        cc: string;
+        city: string;
+        number: string;
+        number_suffix: string;
+        postal_code: string;
+        street: string;
+    };
+    location: {
+        distance: string;
+        latitude: string;
+        location_code: string;
+        location_name: string;
+        longitude: string;
+        opening_hours: Record<Weekday, StartEndDate[]>;
+        phone_number: string | null;
+        retail_network_id: string;
+    };
+    possibilities: PickupPossibility[];
+}
+export interface PickupPossibility {
+    delivery_type_id: DeliveryTypeId;
+    delivery_type_name: DeliveryTypeName;
+    moment: {
+        start: Timestamp;
+    };
+    price?: number;
+}

package/lib/endpoints/public/pickup-locations/index.d.ts

@@ -0,0 +1,2 @@
+export * from './GetPickupLocations';
+export * from './PickupLocation.types';

package/lib/index.cjs

@@ -0,0 +1 @@
+"use strict";var C=Object.defineProperty;var G=(s,t,r)=>t in s?C(s,t,{enumerable:!0,configurable:!0,writable:!0,value:r}):s[t]=r;var e=(s,t,r)=>(G(s,typeof t!="symbol"?t+"":t,r),r);Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const m=require("@myparcel/ts-utils");class c extends Error{constructor(r){super(r);e(this,"name","user");Object.setPrototypeOf(this,c.prototype),this.name="UserException"}}class l extends Error{constructor(r){super(r.message);e(this,"data");Object.setPrototypeOf(this,l.prototype),this.name="ApiException",this.data=r}}const x=(s,t)=>{if(t){const r=Object.entries(t).map(([a,i])=>`${a}=${i}`);r.length&&(s+=`?${r.join("&")}`)}return s},O="https://api.myparcel.nl",_=["POST","PUT"];class T{constructor(t){e(this,"baseUrl");e(this,"headers");e(this,"parameters");e(this,"options");e(this,"_requiredHeaders",[]);this.baseUrl=((t==null?void 0:t.baseUrl)??O).replace(/\/+$/,""),this.headers=(t==null?void 0:t.headers)??{},this.parameters=(t==null?void 0:t.parameters)??{},this.options=(t==null?void 0:t.options)??{}}get requiredHeaders(){return this._requiredHeaders}set requiredHeaders(t){this._requiredHeaders=t}async doRequest(t,r){const a=this.normalizeOptions(t,{...r,...this.options});this.validateHeaders(t,a);const i=await this.request(t,a);if(m.isOfType(i,"errors"))throw new l(i);return this.getResponseBody(t,i)}getResponseBody(t,r){if(!m.isOfType(r,"data"))return r;const a=t.getResponseProperty();if(!a)return r.data;const{page:i,size:n,results:p}=r.data;return i===void 0&&n===void 0&&p===void 0?r.data[a]:{[a]:r.data[a],...i!==void 0&&{page:i},...n!==void 0&&{size:n},...p!==void 0&&{results:p}}}getHeaders(){return{Accept:"application/json",...this.headers}}createUrl(t,r){let a=t.getPath();if(a.length&&!a.startsWith("/")&&(a=`/${a}`),r!=null&&r.path&&(a=this.substitutePath(a,r.path)),a.includes("/:"))throw new c(`One or more path variables are missing in ${a}`);return r!=null&&r.parameters&&(a=x(a,r.parameters)),this.baseUrl+a}substitutePath(t,r){if(r&&Object.entries(r).forEach(([a,i])=>{t=t.replace(`:${a}`,String(i))}),t.includes(":")){const a=t.match(/:\w+?\?/g);a==null||a.forEach(i=>{t=t.replace(`/${i}`,"")})}return t}validateHeaders(t,r){const a=Object.entries(r.headers).reduce((n,[p,d])=>({...n,[p.toLowerCase()]:d}),{}),i=this.requiredHeaders.filter(n=>!(n.toLowerCase()in a));if(i.length)throw new c(`Required headers are missing: ${i.join(", ")}`)}normalizeOptions(t,r){const a={...r,parameters:{...this.parameters,...r.parameters,...t.getParameters()},headers:{..._.includes(t.method)?{"Content-Type":"application/json"}:{},...this.getHeaders(),...r.headers,...t.getHeaders()}};if(m.isOfType(r,"body")){const i=t.getProperty();if(r.body instanceof FormData)return a.body=r.body,delete a.headers["Content-Type"],a;i===void 0?a.body={data:r.body}:a.body={data:{[i]:r.body}}}return a}}const A=s=>{try{return JSON.parse(s),!0}catch{return!1}};class k extends T{constructor(r){super(r);e(this,"request",async(r,a)=>{var P,g;const i=r.getTimeout()??a.timeout,n=new AbortController,p=setTimeout(()=>n.abort(),i),d={method:r.method,headers:a.headers,...i&&{signal:n.signal}};m.isOfType(a,"body")&&(a.body instanceof FormData?d.body=a.body:d.body=JSON.stringify(a.body));const h=await fetch(this.createUrl(r,a),d);if(clearTimeout(p),h.body){if((P=h.headers.get("Content-Disposition"))!=null&&P.includes("attachment"))return h.blob();const y=await h.text();return(g=h.headers.get("Content-Type"))!=null&&g.includes("application/json")&&A(y)?JSON.parse(y):y}})}}class b{constructor(t){e(this,"method","GET");e(this,"property");e(this,"responseProperty");e(this,"timeout");e(this,"headers");e(this,"parameters");this.headers=(t==null?void 0:t.headers)??{},this.parameters=(t==null?void 0:t.parameters)??{}}getHeaders(){return this.headers}getParameters(){return this.parameters}getPath(){return this.path}getProperty(){return this.property}getResponseProperty(){return this.responseProperty??this.property}getTimeout(){return this.timeout}}class o extends b{}class u extends b{}function S(s,t){if(!t.length)throw new c("At least one endpoint must be passed.");return t.reduce((r,a)=>({...r,[a.name]:async i=>s.doRequest(a,i??{})}),{})}const E=(s,t)=>(s.requiredHeaders=["Authorization"],S(s,t)),v=(s,t)=>S(s,t);class w extends o{constructor(){super(...arguments);e(this,"method","DELETE");e(this,"name","deleteAccountMessage");e(this,"path","account_messages/:id");e(this,"property","messages")}}class D extends o{constructor(){super(...arguments);e(this,"name","getAccountMessages");e(this,"path","account_messages");e(this,"property","messages")}}class H extends o{constructor(){super(...arguments);e(this,"name","getAccount");e(this,"path","accounts/:id");e(this,"property","accounts")}}class f extends o{constructor(){super(...arguments);e(this,"name","getAccounts");e(this,"path","accounts");e(this,"property","accounts")}}class U extends o{constructor(){super(...arguments);e(this,"method","PUT");e(this,"name","putAccount");e(this,"path","accounts");e(this,"property","accounts")}}class L extends o{constructor(){super(...arguments);e(this,"name","getApiKeys");e(this,"path","keys");e(this,"property","api_keys")}}class j extends o{constructor(){super(...arguments);e(this,"method","POST");e(this,"name","postApiKeys");e(this,"path","keys");e(this,"property","api_keys")}}class q extends o{constructor(){super(...arguments);e(this,"method","DELETE");e(this,"name","deleteCarrierOption");e(this,"path","accounts/:account_id/carrier_options/:contract_id");e(this,"property","carrier_options")}}class M extends o{constructor(){super(...arguments);e(this,"name","getCarrierOptions");e(this,"path","carrier_management/accounts/:account_id/carrier_options");e(this,"property","carrier_options")}}class W extends o{constructor(){super(...arguments);e(this,"method","POST");e(this,"name","postCarrierOptions");e(this,"path","accounts/:account_id/carrier_options");e(this,"property","carrier_options");e(this,"responseProperty","ids")}}class R extends o{constructor(){super(...arguments);e(this,"name","putCarrierOptions");e(this,"path","carrier_management/accounts/:account_id/carrier_options");e(this,"property","carrier_options");e(this,"method","PUT")}}class $ extends o{constructor(){super(...arguments);e(this,"name","getLocations");e(this,"path","locations");e(this,"property","locations")}}class K extends o{constructor(){super(...arguments);e(this,"name","getShipment");e(this,"path","shipments/:id");e(this,"property","shipments")}}class J extends o{constructor(){super(...arguments);e(this,"name","getShipments");e(this,"path","shipments");e(this,"property","shipments")}}class N extends o{constructor(){super(...arguments);e(this,"method","POST");e(this,"name","postShipments");e(this,"path","shipments");e(this,"property","shipments");e(this,"responseProperty","ids")}getHeaders(){return{...super.getHeaders(),"Content-Type":"application/vnd.shipment+json;charset=utf-8;version=1.1"}}}class z extends o{constructor(){super(...arguments);e(this,"name","getShop");e(this,"path","shops/:id");e(this,"property","shops")}}class B extends o{constructor(){super(...arguments);e(this,"method","POST");e(this,"name","postShop");e(this,"path","shops/duplicate");e(this,"property","shops");e(this,"responseProperty","ids")}}class F extends o{constructor(){super(...arguments);e(this,"method","PUT");e(this,"name","putShop");e(this,"path","shops");e(this,"property","shops")}}class I extends o{constructor(){super(...arguments);e(this,"method","POST");e(this,"name","postShopDuplicate");e(this,"path","shops/duplicate");e(this,"property","ids")}}class Q extends o{constructor(){super(...arguments);e(this,"name","getSubscriptionsCapabilities");e(this,"path","subscriptions/capabilities");e(this,"property","capabilities")}}class X extends o{constructor(){super(...arguments);e(this,"method","DELETE");e(this,"name","deleteSubscription");e(this,"path","subscriptions/:id");e(this,"property","subscriptions")}}class Y extends o{constructor(){super(...arguments);e(this,"name","getSubscriptions");e(this,"path","subscriptions");e(this,"property","subscriptions")}}class Z extends o{constructor(){super(...arguments);e(this,"method","PATCH");e(this,"name","patchSubscriptions");e(this,"path","subscriptions");e(this,"property","subscriptions");e(this,"responseProperty","ids")}}class V extends o{constructor(){super(...arguments);e(this,"method","POST");e(this,"name","postSubscriptions");e(this,"path","subscriptions");e(this,"property","subscriptions");e(this,"responseProperty","ids")}}class ee extends o{constructor(){super(...arguments);e(this,"name","getSystemCountryCodes");e(this,"path","system_country_codes");e(this,"property","countries")}}class te extends o{constructor(){super(...arguments);e(this,"name","getSystemMessages");e(this,"path","system_messages");e(this,"property","messages")}}class se extends o{constructor(){super(...arguments);e(this,"name","getTrackAndTrace");e(this,"path","tracktraces/:shipment_id");e(this,"property","tracktraces")}}class re extends o{constructor(){super(...arguments);e(this,"method","DELETE");e(this,"name","deleteWebhookSubscriptions");e(this,"path","webhook_subscriptions/:ids");e(this,"property","webhook_subscriptions")}}class ae extends o{constructor(){super(...arguments);e(this,"name","getWebhookSubscriptions");e(this,"path","webhook_subscriptions");e(this,"property","webhook_subscriptions")}}class oe extends o{constructor(){super(...arguments);e(this,"method","POST");e(this,"name","postWebhookSubscriptions");e(this,"path","webhook_subscriptions");e(this,"property","webhook_subscriptions");e(this,"responseProperty","ids")}}class ie extends u{constructor(){super(...arguments);e(this,"name","getCarrier");e(this,"path","carriers/:carrier");e(this,"property","carriers")}}class ne extends u{constructor(){super(...arguments);e(this,"name","getCarriers");e(this,"path","carriers");e(this,"property","carriers")}}class pe extends u{constructor(){super(...arguments);e(this,"name","getDeliveryOptions");e(this,"path","delivery_options");e(this,"property","deliveries")}getHeaders(){return{...super.getHeaders(),Accept:"application/json;version=2.0"}}}class ce extends u{constructor(){super(...arguments);e(this,"name","getPickupLocations");e(this,"path","pickup_locations");e(this,"property","pickup_locations")}}exports.AbstractClient=T;exports.AbstractEndpoint=b;exports.AbstractPrivateEndpoint=o;exports.AbstractPublicEndpoint=u;exports.ApiException=l;exports.BASE_URL=O;exports.DeleteAccountMessage=w;exports.DeleteCarrierOptions=q;exports.DeleteSubscription=X;exports.DeleteWebhookSubscriptions=re;exports.FetchClient=k;exports.GetAccount=H;exports.GetAccountMessages=D;exports.GetAccounts=f;exports.GetApiKeys=L;exports.GetCarrier=ie;exports.GetCarrierOptions=M;exports.GetCarriers=ne;exports.GetDeliveryOptions=pe;exports.GetLocations=$;exports.GetPickupLocations=ce;exports.GetShipment=K;exports.GetShipments=J;exports.GetShop=z;exports.GetSubscriptions=Y;exports.GetSubscriptionsCapabilities=Q;exports.GetSystemCountryCodes=ee;exports.GetSystemMessages=te;exports.GetTrackAndTrace=se;exports.GetWebhookSubscriptions=ae;exports.PatchSubscriptions=Z;exports.PostApiKeys=j;exports.PostCarrierOptions=W;exports.PostShipments=N;exports.PostShop=B;exports.PostShopDuplicate=I;exports.PostSubscriptions=V;exports.PostWebhookSubscriptions=oe;exports.PutAccount=U;exports.PutCarrierOptions=R;exports.PutShop=F;exports.UserException=c;exports.addParameters=x;exports.createMyParcelSdk=S;exports.createPrivateSdk=E;exports.createPublicSdk=v;exports.isJson=A;

package/lib/index.d.ts

@@ -0,0 +1,6 @@
+export * from './createMyParcelSdk';
+export * from './createPrivateSdk';
+export * from './createPublicSdk';
+export * from './endpoints';
+export * from './model';
+export * from './types';