Move the geo APIs to account

README.md

@@ -21,9 +21,9 @@ npm install @dolbyio/dolbyio-rest-apis-client
 ## Create a publish token
 
 ```ts
-import { streaming } from '@dolbyio/dolbyio-rest-apis-client'
+import { streaming } from '@dolbyio/dolbyio-rest-apis-client';
 
-const API_KEY = process.env.DOLBYIO_API_SECRET;;
+const API_KEY = process.env.DOLBYIO_API_SECRET;
 
 const publishToken = await streaming.publishToken.create(API_KEY, {
     label: 'My token',

src/streaming/account.ts

@@ -1,6 +1,6 @@
-import { sendGet, sendPut } from './internal/httpHelpers';
+import { sendGet, sendPost, sendPut } from './internal/httpHelpers';
 import * as Urls from '../urls';
-import { AccountGeoCascade } from './types/account';
+import { AccountGeoCascade, GeoRestrictions } from './types/account';
 
 /**
  * Gets account wide geo cascade settings.
@@ -49,3 +49,61 @@ export const updateGeoCascade = async (apiSecret: string, settings: AccountGeoCa
 
     return await sendPut<AccountGeoCascade>(options);
 };
+
+/**
+ * Gets the account geo restrictions.
+ *
+ * If a Token (either Publish or Subscribe) does not define any geo restrictions, the account wide rules are used.
+ *
+ * @link https://docs.dolby.io/streaming-apis/reference/geo_geo
+ *
+ * @param apiSecret The API Secret used to authenticate this request.
+ *
+ * @returns A {@link GeoRestrictions} object through a {@link Promise}.
+ */
+export const readGeoRestrictions = async (apiSecret: string): Promise<GeoRestrictions> => {
+    const options = {
+        hostname: Urls.getRtsHostname(),
+        path: '/api/geo/account',
+        headers: {
+            Accept: 'application/json',
+            Authorization: `Bearer ${apiSecret}`,
+        },
+    };
+
+    return await sendGet<GeoRestrictions>(options);
+};
+
+/**
+ * Updates the account geo restrictions.
+ *
+ * @link https://docs.dolby.io/streaming-apis/reference/geo_updategeo
+ *
+ * @param apiSecret The API Secret used to authenticate this request.
+ * @param allowedCountries The list of allowed countries. An empty array [] removes all rules.
+ * @param deniedCountries The list of denied countries. An empty array [] removes all rules.
+ *
+ * @returns A {@link GeoRestrictions} object through a {@link Promise}.
+ */
+export const updateGeoRestrictions = async (
+    apiSecret: string,
+    allowedCountries: string[] | null = null,
+    deniedCountries: string[] | null = null
+): Promise<GeoRestrictions> => {
+    const body = {};
+    if (allowedCountries) body['updateAllowedCountries'] = allowedCountries;
+    if (deniedCountries) body['updateDeniedCountries'] = deniedCountries;
+
+    const options = {
+        hostname: Urls.getRtsHostname(),
+        path: '/api/geo/account',
+        headers: {
+            Accept: 'application/json',
+            'Content-Type': 'application/json',
+            Authorization: `Bearer ${apiSecret}`,
+        },
+        body: JSON.stringify(body),
+    };
+
+    return await sendPost<GeoRestrictions>(options);
+};

src/streaming/index.ts

@@ -12,7 +12,6 @@ export * as cluster from './cluster';
  */
 export * as transcoders from './transcoders';
 export * as director from './director';
-export * as geo from './geo';
 export * as publishToken from './publishToken';
 export * as recordFiles from './recordFiles';
 export * as stream from './stream';

src/streaming/types/account.ts

@@ -14,3 +14,13 @@ export interface AccountGeoCascade {
      */
     clusters?: string[];
 }
+
+/**
+ * Represents the geo restrictions rules.
+ */
+export interface GeoRestrictions {
+    /** List of allowed countries. */
+    allowedCountries: string[];
+    /** List of restricted countries. */
+    deniedCountries: string[];
+}

src/streaming/types/index.ts

@@ -1,7 +1,6 @@
 export * from './account';
 export * from './cluster';
 export * from './director';
-export * from './geo';
 export * from './publishToken';
 export * from './recordFiles';
 export * from './stream';

src/streaming/types/publishToken.ts

@@ -61,10 +61,16 @@ export interface PublishToken {
     deniedCountries: string[];
     /** Cluster to route specified streams to. */
     originCluster: string;
-    /** Does the publish token require authentication to subscribe to the specified streams */
+    /** Does the publish token require authentication to subscribe to the specified streams. */
     subscribeRequiresAuth: boolean;
-    /** Is the publish token allowed to record the specified streams */
+    /** Is the publish token allowed to record the specified streams. */
     record: boolean;
+    /**
+     * Is the publish token allowed to create clips the specified streams.
+     * @beta
+     * @remarks Live clipping is currently in Beta phase.
+     */
+    clip: boolean;
     /** Is multisource enabled or not. */
     multisource: boolean;
     /** Is low latency mode for RTMP ingest enabled or not. */
@@ -77,6 +83,17 @@ export interface PublishToken {
     srtPassphrase?: string;
     /** Geo cascade settings for cascading stream to other clusters. */
     geoCascade: PublishTokenGeoCascade;
+    /**
+     * List of endpoints to restream the stream.
+     * @beta
+     * @remarks Restream is currently in Beta phase.
+     */
+    restream: {
+        /** The endpoint to restream media */
+        url: string;
+        /** Secret key for restreaming endpoint. */
+        key: string;
+    }[];
     /**
      * Token effective settings for properties that use account default settings.
      * Value for each property will either be token or account level settings.
@@ -145,6 +162,23 @@ export interface UpdatePublishToken {
     displaySrtPassphrase?: boolean;
     /** Update the geo cascading rules for this publish token. */
     updateGeoCascade?: PublishTokenGeoCascade;
+    /**
+     * Allow or disallow to create clips of the specified streams.
+     * @beta
+     * @remarks Live clipping is currently in Beta phase.
+     */
+    clip?: boolean;
+    /**
+     * List of endpoints to restream media.
+     * @beta
+     * @remarks Restream is currently in Beta phase.
+     */
+    updateRestream?: {
+        /** The endpoint to restream the stream */
+        url: string;
+        /** Secret key for restreaming endpoint. */
+        key: string;
+    }[];
 }
 
 /** Represents the information to create a publish token. */
@@ -243,6 +277,17 @@ export interface CreatePublishToken {
      * @remarks Live clipping is currently in Beta phase.
      */
     clip?: boolean;
+    /**
+     * List of endpoints to restream the stream.
+     * @beta
+     * @remarks Restream is currently in Beta phase.
+     */
+    restream?: {
+        /** The endpoint to restream media */
+        url: string;
+        /** Secret key for restreaming endpoint. */
+        key: string;
+    }[];
 }
 
 /**