Gifs API (#223)

* gifs service

* Commit from GitHub Actions (Publish APIs & Clients)

Co-authored-by: domwong <domwong@users.noreply.github.com>

clients/ts/gifs/index.ts

@@ -0,0 +1,129 @@
+import * as m3o from "@m3o/m3o-node";
+
+export class GifsService {
+  private client: m3o.Client;
+
+  constructor(token: string) {
+    this.client = new m3o.Client({ token: token });
+  }
+  // Search for a gif
+  search(request: SearchRequest): Promise<SearchResponse> {
+    return this.client.call(
+      "gifs",
+      "Search",
+      request
+    ) as Promise<SearchResponse>;
+  }
+}
+
+export interface Gif {
+  // URL used for embedding the GIF
+  embedUrl?: string;
+  // The ID of the GIF
+  id?: string;
+  // The different formats available for this GIF
+  images?: ImageFormats;
+  // The content rating for the GIF
+  rating?: string;
+  // A short URL for this GIF
+  shortUrl?: string;
+  // The slug used in the GIF's URL
+  slug?: string;
+  // The page on which this GIF was found
+  source?: string;
+  // The title for this GIF
+  title?: string;
+  // The URL for this GIF
+  url?: string;
+}
+
+export interface ImageFormat {
+  // height
+  height?: number;
+  // size of the MP4 version
+  mp4Size?: number;
+  // URL to an MP4 version of the gif
+  mp4Url?: string;
+  // size in bytes
+  size?: number;
+  // URL of the gif
+  url?: string;
+  // size of the webp version
+  webpSize?: number;
+  // URL to a webp version of the gif
+  webpUrl?: string;
+  // width
+  width?: number;
+}
+
+export interface ImageFormats {
+  // A downsized version of the GIF < 2MB
+  downsized?: ImageFormat;
+  // A downsized version of the GIF < 8MB
+  downsizedLarge?: ImageFormat;
+  // A downsized version of the GIF < 5MB
+  downsizedMedium?: ImageFormat;
+  // A downsized version of the GIF < 200kb
+  downsizedSmall?: ImageFormat;
+  // Static image of the downsized version of the GIF
+  downsizedStill?: ImageFormat;
+  // Version of the GIF with fixed height of 200 pixels. Good for mobile use
+  fixedHeight?: ImageFormat;
+  // Version of the GIF with fixed height of 200 pixels and number of frames reduced to 6
+  fixedHeightDownsampled?: ImageFormat;
+  // Version of the GIF with fixed height of 100 pixels. Good for mobile keyboards
+  fixedHeightSmall?: ImageFormat;
+  // Static image of the GIF with fixed height of 100 pixels
+  fixedHeightSmallStill?: ImageFormat;
+  // Static image of the GIF with fixed height of 200 pixels
+  fixedHeightStill?: ImageFormat;
+  // Version of the GIF with fixed width of 200 pixels. Good for mobile use
+  fixedWidth?: ImageFormat;
+  // Version of the GIF with fixed width of 200 pixels and number of frames reduced to 6
+  fixedWidthDownsampled?: ImageFormat;
+  // Version of the GIF with fixed width of 100 pixels. Good for mobile keyboards
+  fixedWidthSmall?: ImageFormat;
+  // Static image of the GIF with fixed width of 100 pixels
+  fixedWidthSmallStill?: ImageFormat;
+  // Static image of the GIF with fixed width of 200 pixels
+  fixedWidthStill?: ImageFormat;
+  // 15 second version of the GIF looping
+  looping?: ImageFormat;
+  // The original GIF. Good for desktop use
+  original?: ImageFormat;
+  // Static image of the original version of the GIF
+  originalStill?: ImageFormat;
+  // mp4 version of the GIF <50kb displaying first 1-2 secs
+  preview?: ImageFormat;
+  // Version of the GIF <50kb displaying first 1-2 secs
+  previewGif?: ImageFormat;
+}
+
+export interface Pagination {
+  // total number returned in this response
+  count?: number;
+  // position in pagination
+  offset?: number;
+  // total number of results available
+  totalCount?: number;
+}
+
+export interface SearchRequest {
+  // ISO 2 letter language code for regional content
+  lang?: string;
+  // Max number of gifs to return. Defaults to 25
+  limit?: number;
+  // The start position of results (used with pagination)
+  offset?: number;
+  // The search term
+  query?: string;
+  // Apply age related content filter. "g", "pg", "pg-13", or "r". Defaults to "g"
+  rating?: string;
+}
+
+export interface SearchResponse {
+  // list of results
+  data?: Gif[];
+  // information on pagination
+  pagination?: { [key: string]: any };
+}

clients/ts/index.ts

@@ -10,6 +10,7 @@ import * as evchargers from "./evchargers";
 import * as file from "./file";
 import * as forex from "./forex";
 import * as geocoding from "./geocoding";
+import * as gifs from "./gifs";
 import * as helloworld from "./helloworld";
 import * as holidays from "./holidays";
 import * as id from "./id";
@@ -51,6 +52,7 @@ export class Client {
     this.fileService = new file.FileService(token);
     this.forexService = new forex.ForexService(token);
     this.geocodingService = new geocoding.GeocodingService(token);
+    this.gifsService = new gifs.GifsService(token);
     this.helloworldService = new helloworld.HelloworldService(token);
     this.holidaysService = new holidays.HolidaysService(token);
     this.idService = new id.IdService(token);
@@ -91,6 +93,7 @@ export class Client {
   fileService: file.FileService;
   forexService: forex.ForexService;
   geocodingService: geocoding.GeocodingService;
+  gifsService: gifs.GifsService;
   helloworldService: helloworld.HelloworldService;
   holidaysService: holidays.HolidaysService;
   idService: id.IdService;

clients/ts/package.json

@@ -21,6 +21,7 @@
   "./file": "./dist/file/index.js",
   "./forex": "./dist/forex/index.js",
   "./geocoding": "./dist/geocoding/index.js",
+  "./gifs": "./dist/gifs/index.js",
   "./helloworld": "./dist/helloworld/index.js",
   "./holidays": "./dist/holidays/index.js",
   "./id": "./dist/id/index.js",
@@ -64,5 +65,5 @@
  },
  "type": "module",
  "types": "dist/index.d.ts",
- "version": "1.0.539"
+ "version": "1.0.540"
 }