Merge f07abf1 into 541b580

src/client.ts

@@ -4,7 +4,9 @@ import {
   ApiAuth,
   ApiResponse,
   ApiResponseProgram,
+  ApiRequestPrograms,
   ApiResponsePrograms,
+  ApiRequestProgramsNow,
   ApiResponseMediaPlayouts,
   Program,
   ProgramPublicationEvent,
@@ -44,7 +46,7 @@ class Client {
     }
   }
 
-  async fetchPrograms (queryOptions: any = {}): Promise<ApiResponsePrograms> {
+  async fetchPrograms (queryOptions: ApiRequestPrograms = {}): Promise<ApiResponsePrograms> {
     const url =
       URI(API_URL)
         .segment('programs')
@@ -57,7 +59,7 @@ class Client {
     return this.retrieveJSONOrError(response);
   }
 
-  async fetchProgramsNow (queryOptions: any= {}): Promise<ApiResponse> {
+  async fetchProgramsNow (queryOptions: ApiRequestProgramsNow = {}): Promise<ApiResponse> {
     const url =
       URI(API_URL)
         .segment('programs')

src/client.types.ts

@@ -93,8 +93,50 @@ export interface ApiResponsePrograms extends ApiResponse {
   data: Program[];
 }
 
+export interface ApiRequestPrograms {
+  id?: string; // Multiple IDs can be passed as a comma separated list.
+  type?: 'program' | 'clip' | 'tvcontent' | 'tvprogram' | 'tvclip' | 'radiocontent' | 'radioprogram' | 'radioclip';
+  q?: string;
+  mediaobject?: 'audio' | 'video';
+  category?: string; // Multiple IDs can be passed as a comma separated list.
+  series?: string; // Multiple IDs can be passed as a comma separated list.
+  availability?: 'ondemand' | 'future-ondemand' | 'future-scheduled' | 'in-future';
+  downloadable?: 'true' | undefined;
+  language?: 'fi' | 'sv';
+  region?: 'fi' | 'world';
+  service?: string; // Multiple service IDs can be passes as a comma separated list.
+  publisher?: string;
+  contentprotection?: string; // Multiple IDs can be passed as a comma separated list.
+  order?: Order;
+  limit?: number;
+  offset?: number;
+}
+
+export interface ApiRequestProgramsNow {
+  service?: string; // Multiple service IDs can be passes as a comma separated list.
+  start?: number; // Allowed values range from -10 to 0. -1 means that the previous program will be included in the response.
+  end?: number; // Allowed values range from 0 to 10. 1 means that the next program will be included in the response.
+  mediaobject?: 'video' | 'audio';
+}
+
 export interface ApiResponseMediaPlayouts extends ApiResponse {
   data: MediaPlayout[];
 }
 
 export type PlayoutProtocol = 'HLS' | 'HDS' | 'PMD' | 'RTMPE';
+
+export type Order =
+  'playcount.6h:asc' |
+  'playcount.6h:desc' |
+  'playcount.24h:asc' |
+  'playcount.24h:desc' |
+  'playcount.week:asc' |
+  'playcount.week:desc' |
+  'playcount.month:asc' |
+  'playcount.month:desc' |
+  'publication.starttime:asc' |
+  'publication.starttime:desc' |
+  'publication.endtime:asc' |
+  'publication.endtime:desc' |
+  'updated:asc' |
+  'updated:desc';

src/cmdline.ts

@@ -44,7 +44,7 @@ program
   .option('-sr, --series <value>', 'Return items containing specific series')
   .option('-s, --service <value>', 'Filter by service')
   .option('-t, --type <type>', 'Filter by type')
-  .action(async (q: string, limit: string, offset: string, options: any) => {
+  .action(async (q: string, limit: number, offset: number, options: any) => {
     const finalOptions = {
       q: q,
       limit: limit,
@@ -69,7 +69,7 @@ program
     } else {
       const programs = response.data;
       const language = finalOptions.language || 'fi';
-      const output = programs.map(program => {
+      const output = programs.map((program: any) => {
         const title = program.title[language];
         const description = program.description[language] || '';
         return `[${program.id}] ${title} ${description}`;