services/clients/ts/url/index.ts

import * as m3o from "@m3o/m3o-node";

export class UrlService {
  private client: m3o.Client;

  constructor(token: string) {
    this.client = new m3o.Client({ token: token });
  }
  // List information on all the shortened URLs that you have created
  list(request: ListRequest): Promise<ListResponse> {
    return this.client.call("url", "List", request) as Promise<ListResponse>;
  }
  // Proxy returns the destination URL of a short URL.
  proxy(request: ProxyRequest): Promise<ProxyResponse> {
    return this.client.call("url", "Proxy", request) as Promise<ProxyResponse>;
  }
  // Shortens a destination URL and returns a full short URL.
  shorten(request: ShortenRequest): Promise<ShortenResponse> {
    return this.client.call(
      "url",
      "Shorten",
      request
    ) as Promise<ShortenResponse>;
  }
}

export interface ListRequest {
  // filter by short URL, optional
  shortURL?: string;
}

export interface ListResponse {
  urlPairs?: URLPair;
}

export interface ProxyRequest {
  // short url ID, without the domain, eg. if your short URL is
  // `m3o.one/u/someshorturlid` then pass in `someshorturlid`
  shortURL?: string;
}

export interface ProxyResponse {
  destinationURL?: string;
}

export interface ShortenRequest {
  destinationURL?: string;
}

export interface ShortenResponse {
  shortURL?: string;
}

export interface URLPair {
  created?: number;
  destinationURL?: string;
  // HitCount keeps track many times the short URL has been resolved.
  // Hitcount only gets saved to disk (database) after every 10th hit, so
  // its not intended to be 100% accurate, more like an almost correct estimate.
  hitCount?: number;
  owner?: string;
  shortURL?: string;
}