@mediaviz/sdk 0.1.0

package/MediaViz.js

@@ -0,0 +1,126 @@
+// Auto-generated — do not edit
+import { OAuthClient } from './_oauth.js';
+import { AiModelCredits } from './ai_model_credits.js';
+import { Admin } from './admin.js';
+import { Company } from './company.js';
+import { CuratedAlbums } from './curated_albums.js';
+import { CustomAlbums } from './custom_albums.js';
+import { EmailTokens } from './email_tokens.js';
+import { Health } from './health.js';
+import { Keywords } from './keywords.js';
+import { OauthAuthorization } from './oauth_authorization.js';
+import { OauthClients } from './oauth_clients.js';
+import { OauthToken } from './oauth_token.js';
+import { OauthLogin } from './oauth_login.js';
+import { Person } from './person.js';
+import { Photoupload } from './photoupload.js';
+import { Photos } from './photos.js';
+import { Projects } from './projects.js';
+import { Search } from './search.js';
+import { Users } from './users.js';
+
+function _env(key) {
+  if (typeof process !== 'undefined' && process.env) return process.env[key];
+  return undefined;
+}
+
+class _Context {
+  constructor(mv) { this._mv = mv; }
+  get client() { return this._mv._oauthClient; }
+  get accessToken() { return this._mv._accessToken; }
+  get refreshToken() { return this._mv._refreshToken; }
+  get baseUrl() { return this._mv._config.baseUrl; }
+  get hosts() { return this._mv._hosts; }
+  requireHost(key) {
+    const url = this._mv._hosts[key];
+    if (!url) throw new Error(`Host '${key}' not configured. Pass hosts.${key} in MediaViz constructor or set the corresponding env var.`);
+    return url;
+  }
+  requireTokens() {
+    if (!this._mv._accessToken) throw new Error('Not authenticated. Call authenticate(), handleCallback(), or setTokens() first.');
+  }
+}
+
+class _TokenTrackingClient {
+  constructor(mv, inner) { this._mv = mv; this._inner = inner; }
+  async request(url, method, accessToken, refreshToken, body) {
+    const onRefreshSuccess = (newTokens) => {
+      this._mv._accessToken = newTokens.access_token;
+      this._mv._refreshToken = newTokens.refresh_token;
+      if (this._mv._onTokenRefresh) this._mv._onTokenRefresh(newTokens);
+    };
+    return this._inner.request(url, method, accessToken, refreshToken, body, onRefreshSuccess);
+  }
+}
+
+export class MediaViz {
+  constructor(config = {}) {
+    this._config = {
+      clientId: config.clientId ?? _env('MEDIAVIZ_CLIENT_ID'),
+      clientSecret: config.clientSecret ?? _env('MEDIAVIZ_CLIENT_SECRET'),
+      baseUrl: config.baseUrl ?? _env('MEDIAVIZ_BASE_URL') ?? 'https://api.mediaviz.ai',
+      redirectUri: config.redirectUri ?? _env('MEDIAVIZ_REDIRECT_URI'),
+    };
+    this._hosts = {
+      photoUpload: config.hosts?.photoUpload ?? _env('MEDIAVIZ_PHOTO_UPLOAD_URL'),
+      ...(config.hosts || {}),
+    };
+    this._accessToken = config.accessToken ?? null;
+    this._refreshToken = config.refreshToken ?? null;
+    this._onTokenRefresh = config.onTokenRefresh ?? null;
+
+    const _inner = new OAuthClient({
+      clientId: this._config.clientId,
+      clientSecret: this._config.clientSecret,
+      baseUrl: this._config.baseUrl,
+      redirectUri: this._config.redirectUri,
+    });
+    this._oauthClient = new _TokenTrackingClient(this, _inner);
+
+    const _ctx = new _Context(this);
+    this.aiModelCredits = new AiModelCredits(_ctx);
+    this.admin = new Admin(_ctx);
+    this.company = new Company(_ctx);
+    this.curatedAlbums = new CuratedAlbums(_ctx);
+    this.customAlbums = new CustomAlbums(_ctx);
+    this.emailTokens = new EmailTokens(_ctx);
+    this.health = new Health(_ctx);
+    this.keywords = new Keywords(_ctx);
+    this.oAuthAuthorization = new OauthAuthorization(_ctx);
+    this.oAuthClients = new OauthClients(_ctx);
+    this.oAuthToken = new OauthToken(_ctx);
+    this.oauthLogin = new OauthLogin(_ctx);
+    this.person = new Person(_ctx);
+    this.photoUpload = new Photoupload(_ctx);
+    this.photos = new Photos(_ctx);
+    this.projects = new Projects(_ctx);
+    this.search = new Search(_ctx);
+    this.users = new Users(_ctx);
+  }
+
+  async authenticate() {
+    const tokens = await this._oauthClient._inner.getClientCredentialsToken();
+    this._accessToken = tokens.access_token;
+    this._refreshToken = tokens.refresh_token ?? null;
+    return tokens;
+  }
+
+  async getAuthorizationUrl(state) {
+    return this._oauthClient._inner.generateAuthorizationUrl(state);
+  }
+
+  async handleCallback(code, codeVerifier) {
+    const tokens = await this._oauthClient._inner.exchangeCode(code, codeVerifier);
+    this._accessToken = tokens.access_token;
+    this._refreshToken = tokens.refresh_token;
+    return tokens;
+  }
+
+  setTokens(accessToken, refreshToken) {
+    this._accessToken = accessToken;
+    this._refreshToken = refreshToken;
+  }
+
+  get accessToken() { return this._accessToken; }
+  get refreshToken() { return this._refreshToken; }
+}

package/_oauth.js

@@ -0,0 +1,3 @@
+// Auto-generated — do not edit
+import _oauth from './oauth/src/index.js';
+export const { OAuthClient, OAuthError, OAuthErrorCode } = _oauth;

package/admin.js

@@ -0,0 +1,93 @@
+export class Admin {
+  constructor(ctx) { this._ctx = ctx; }
+
+  async insertLabelCategoryMatrix() {
+    this._ctx.requireTokens();
+    const path = `/api/v1/admin/insert_label_category_matrix`;
+    const { data } = await this._ctx.client.request(path, 'GET', this._ctx.accessToken, this._ctx.refreshToken);
+    return data;
+  }
+
+  async generateMidLevelCategoryKeywordAlignment() {
+    this._ctx.requireTokens();
+    const path = `/api/v1/admin/generate_mid_level_category_keyword_alignment`;
+    const { data } = await this._ctx.client.request(path, 'GET', this._ctx.accessToken, this._ctx.refreshToken);
+    return data;
+  }
+
+  async getCategoryLabels(category) {
+    this._ctx.requireTokens();
+    const path = `/api/v1/admin/category_labels/${encodeURIComponent(category)}`;
+    const { data } = await this._ctx.client.request(path, 'GET', this._ctx.accessToken, this._ctx.refreshToken);
+    return data;
+  }
+
+  async adminDumpCompanyNlpIndex(companyId) {
+    this._ctx.requireTokens();
+    const path = `/api/v1/admin/dump_company_nlp_index/${encodeURIComponent(companyId)}`;
+    const { data } = await this._ctx.client.request(path, 'GET', this._ctx.accessToken, this._ctx.refreshToken);
+    return data;
+  }
+
+  async getAllKeywordGroupsAndSubgroups() {
+    this._ctx.requireTokens();
+    const path = `/api/v1/admin/keyword_group`;
+    const { data } = await this._ctx.client.request(path, 'GET', this._ctx.accessToken, this._ctx.refreshToken);
+    return data;
+  }
+
+  async getKeywordGroupsLabelsByKeywordGroup(keywordGroup, { subgroup } = {}) {
+    this._ctx.requireTokens();
+    let path = `/api/v1/admin/keyword_group/${encodeURIComponent(keywordGroup)}/`;
+    const query = new URLSearchParams();
+    if (subgroup !== undefined) (Array.isArray(subgroup) ? subgroup : [subgroup]).forEach(v => query.append('subgroup', v));
+    const qs = query.toString();
+    if (qs) path += '?' + qs;
+    const { data } = await this._ctx.client.request(path, 'GET', this._ctx.accessToken, this._ctx.refreshToken);
+    return data;
+  }
+
+  async adminCreateCompanyNlpIndexes({ companyIds } = {}) {
+    this._ctx.requireTokens();
+    let path = `/api/v1/admin/create_company_nlp_indexes/`;
+    const query = new URLSearchParams();
+    if (companyIds !== undefined) (Array.isArray(companyIds) ? companyIds : [companyIds]).forEach(v => query.append('company_ids', v));
+    const qs = query.toString();
+    if (qs) path += '?' + qs;
+    const { data } = await this._ctx.client.request(path, 'POST', this._ctx.accessToken, this._ctx.refreshToken);
+    return data;
+  }
+
+  async adminDeleteCompanyNlpIndexes({ companyIds } = {}) {
+    this._ctx.requireTokens();
+    let path = `/api/v1/admin/delete_company_nlp_indexes/`;
+    const query = new URLSearchParams();
+    if (companyIds !== undefined) (Array.isArray(companyIds) ? companyIds : [companyIds]).forEach(v => query.append('company_ids', v));
+    const qs = query.toString();
+    if (qs) path += '?' + qs;
+    const { data } = await this._ctx.client.request(path, 'DELETE', this._ctx.accessToken, this._ctx.refreshToken);
+    return data;
+  }
+
+  async adminDeleteUserProjects({ userIds } = {}) {
+    this._ctx.requireTokens();
+    let path = `/api/v1/admin/delete_user_projects/`;
+    const query = new URLSearchParams();
+    if (userIds !== undefined) (Array.isArray(userIds) ? userIds : [userIds]).forEach(v => query.append('user_ids', v));
+    const qs = query.toString();
+    if (qs) path += '?' + qs;
+    const { data } = await this._ctx.client.request(path, 'DELETE', this._ctx.accessToken, this._ctx.refreshToken);
+    return data;
+  }
+
+  async adminDeleteUser({ userIds } = {}) {
+    this._ctx.requireTokens();
+    let path = `/api/v1/admin/delete_user/`;
+    const query = new URLSearchParams();
+    if (userIds !== undefined) (Array.isArray(userIds) ? userIds : [userIds]).forEach(v => query.append('user_ids', v));
+    const qs = query.toString();
+    if (qs) path += '?' + qs;
+    const { data } = await this._ctx.client.request(path, 'DELETE', this._ctx.accessToken, this._ctx.refreshToken);
+    return data;
+  }
+}

package/ai_model_credits.js

@@ -0,0 +1,22 @@
+export class AiModelCredits {
+  constructor(ctx) { this._ctx = ctx; }
+
+  async getModelCreditRelationship(modelName) {
+    this._ctx.requireTokens();
+    const path = `/api/v1/model_credit/${encodeURIComponent(modelName)}`;
+    const { data } = await this._ctx.client.request(path, 'GET', this._ctx.accessToken, this._ctx.refreshToken);
+    return data;
+  }
+
+  async upsertModelCreditRelationship({ modelName, newCreditValue } = {}) {
+    this._ctx.requireTokens();
+    let path = `/api/v1/model_credit/upsert`;
+    const query = new URLSearchParams();
+    if (modelName !== undefined) (Array.isArray(modelName) ? modelName : [modelName]).forEach(v => query.append('model_name', v));
+    if (newCreditValue !== undefined) (Array.isArray(newCreditValue) ? newCreditValue : [newCreditValue]).forEach(v => query.append('new_credit_value', v));
+    const qs = query.toString();
+    if (qs) path += '?' + qs;
+    const { data } = await this._ctx.client.request(path, 'POST', this._ctx.accessToken, this._ctx.refreshToken);
+    return data;
+  }
+}

package/company.js

@@ -0,0 +1,54 @@
+export class Company {
+  constructor(ctx) { this._ctx = ctx; }
+
+  async getAllCompanies() {
+    this._ctx.requireTokens();
+    const path = `/api/v1/company/`;
+    const { data } = await this._ctx.client.request(path, 'GET', this._ctx.accessToken, this._ctx.refreshToken);
+    return data;
+  }
+
+  async getCompanyById(companyId) {
+    this._ctx.requireTokens();
+    const path = `/api/v1/company/${encodeURIComponent(companyId)}`;
+    const { data } = await this._ctx.client.request(path, 'GET', this._ctx.accessToken, this._ctx.refreshToken);
+    return data;
+  }
+
+  async confirmCompanyCreditBalance(companyId, { photoCount, modelsList } = {}) {
+    this._ctx.requireTokens();
+    let path = `/api/v1/company/credit_balance/${encodeURIComponent(companyId)}`;
+    const query = new URLSearchParams();
+    if (photoCount !== undefined) (Array.isArray(photoCount) ? photoCount : [photoCount]).forEach(v => query.append('photo_count', v));
+    if (modelsList !== undefined) (Array.isArray(modelsList) ? modelsList : [modelsList]).forEach(v => query.append('models_list', v));
+    const qs = query.toString();
+    if (qs) path += '?' + qs;
+    const { data } = await this._ctx.client.request(path, 'GET', this._ctx.accessToken, this._ctx.refreshToken);
+    return data;
+  }
+
+  async adminListActiveCompanyTokens() {
+    this._ctx.requireTokens();
+    const path = `/api/v1/company/admin_create/`;
+    const { data } = await this._ctx.client.request(path, 'GET', this._ctx.accessToken, this._ctx.refreshToken);
+    return data;
+  }
+
+  async adminCreateCompanyToken({ email } = {}) {
+    this._ctx.requireTokens();
+    let path = `/api/v1/company/admin_create/`;
+    const query = new URLSearchParams();
+    if (email !== undefined) (Array.isArray(email) ? email : [email]).forEach(v => query.append('email', v));
+    const qs = query.toString();
+    if (qs) path += '?' + qs;
+    const { data } = await this._ctx.client.request(path, 'POST', this._ctx.accessToken, this._ctx.refreshToken);
+    return data;
+  }
+
+  async adminRevokeCompanyToken(tokenId) {
+    this._ctx.requireTokens();
+    const path = `/api/v1/company/admin_create/${encodeURIComponent(tokenId)}/revoke/`;
+    const { data } = await this._ctx.client.request(path, 'POST', this._ctx.accessToken, this._ctx.refreshToken);
+    return data;
+  }
+}

package/curated_albums.js

@@ -0,0 +1,85 @@
+function stripUndef(o) { const r = {}; for (const k in o) if (o[k] !== undefined) r[k] = o[k]; return r; }
+
+export class CuratedAlbums {
+  constructor(ctx) { this._ctx = ctx; }
+
+  async createCuratedAlbum(projectTableName, name, description = undefined, confidenceValue = undefined) {
+    this._ctx.requireTokens();
+    const path = `/api/v1/curated_album/project/${encodeURIComponent(projectTableName)}`;
+    const body = stripUndef({
+      name: name,
+      description: description,
+      confidence_value: confidenceValue,
+    });
+    const { data } = await this._ctx.client.request(path, 'POST', this._ctx.accessToken, this._ctx.refreshToken, body);
+    return data;
+  }
+
+  async getAllProjectCuratedAlbums(projectTableName) {
+    this._ctx.requireTokens();
+    const path = `/api/v1/curated_album/project/${encodeURIComponent(projectTableName)}`;
+    const { data } = await this._ctx.client.request(path, 'GET', this._ctx.accessToken, this._ctx.refreshToken);
+    return data;
+  }
+
+  async getCuratedAlbumPhotos(albumId, { ascOrDesc, lastId, limit, confidenceValue } = {}) {
+    this._ctx.requireTokens();
+    let path = `/api/v1/curated_album/photos/${encodeURIComponent(albumId)}/`;
+    const query = new URLSearchParams();
+    if (ascOrDesc !== undefined) (Array.isArray(ascOrDesc) ? ascOrDesc : [ascOrDesc]).forEach(v => query.append('asc_or_desc', v));
+    if (lastId !== undefined) (Array.isArray(lastId) ? lastId : [lastId]).forEach(v => query.append('last_id', v));
+    if (limit !== undefined) (Array.isArray(limit) ? limit : [limit]).forEach(v => query.append('limit', v));
+    if (confidenceValue !== undefined) (Array.isArray(confidenceValue) ? confidenceValue : [confidenceValue]).forEach(v => query.append('confidence_value', v));
+    const qs = query.toString();
+    if (qs) path += '?' + qs;
+    const { data } = await this._ctx.client.request(path, 'GET', this._ctx.accessToken, this._ctx.refreshToken);
+    return data;
+  }
+
+  async getCuratedAlbumPhotosRanked(albumId, { ascOrDesc, lastId, limit, confidenceValue } = {}) {
+    this._ctx.requireTokens();
+    let path = `/api/v1/curated_album/photos/ranked/${encodeURIComponent(albumId)}/`;
+    const query = new URLSearchParams();
+    if (ascOrDesc !== undefined) (Array.isArray(ascOrDesc) ? ascOrDesc : [ascOrDesc]).forEach(v => query.append('asc_or_desc', v));
+    if (lastId !== undefined) (Array.isArray(lastId) ? lastId : [lastId]).forEach(v => query.append('last_id', v));
+    if (limit !== undefined) (Array.isArray(limit) ? limit : [limit]).forEach(v => query.append('limit', v));
+    if (confidenceValue !== undefined) (Array.isArray(confidenceValue) ? confidenceValue : [confidenceValue]).forEach(v => query.append('confidence_value', v));
+    const qs = query.toString();
+    if (qs) path += '?' + qs;
+    const { data } = await this._ctx.client.request(path, 'GET', this._ctx.accessToken, this._ctx.refreshToken);
+    return data;
+  }
+
+  async getCuratedAlbumById(albumId) {
+    this._ctx.requireTokens();
+    const path = `/api/v1/curated_album/${encodeURIComponent(albumId)}`;
+    const { data } = await this._ctx.client.request(path, 'GET', this._ctx.accessToken, this._ctx.refreshToken);
+    return data;
+  }
+
+  async updateCuratedAlbum(albumId, { name, description, confidenceValue } = {}) {
+    this._ctx.requireTokens();
+    const path = `/api/v1/curated_album/${encodeURIComponent(albumId)}`;
+    const body = stripUndef({
+      name: name,
+      description: description,
+      confidence_value: confidenceValue,
+    });
+    const { data } = await this._ctx.client.request(path, 'PUT', this._ctx.accessToken, this._ctx.refreshToken, body);
+    return data;
+  }
+
+  async deleteCuratedAlbum(albumId) {
+    this._ctx.requireTokens();
+    const path = `/api/v1/curated_album/${encodeURIComponent(albumId)}`;
+    const { data } = await this._ctx.client.request(path, 'DELETE', this._ctx.accessToken, this._ctx.refreshToken);
+    return data;
+  }
+
+  async convertCuratedAlbumToCustom(albumId) {
+    this._ctx.requireTokens();
+    const path = `/api/v1/curated_album/${encodeURIComponent(albumId)}/convert`;
+    const { data } = await this._ctx.client.request(path, 'POST', this._ctx.accessToken, this._ctx.refreshToken);
+    return data;
+  }
+}

package/custom_albums.js

@@ -0,0 +1,78 @@
+function stripUndef(o) { const r = {}; for (const k in o) if (o[k] !== undefined) r[k] = o[k]; return r; }
+
+export class CustomAlbums {
+  constructor(ctx) { this._ctx = ctx; }
+
+  async getCustomAlbumDetailById(customAlbumId) {
+    this._ctx.requireTokens();
+    const path = `/api/v1/custom_album/${encodeURIComponent(customAlbumId)}`;
+    const { data } = await this._ctx.client.request(path, 'GET', this._ctx.accessToken, this._ctx.refreshToken);
+    return data;
+  }
+
+  async getAllProjectCustomAlbums(projectTableName) {
+    this._ctx.requireTokens();
+    const path = `/api/v1/custom_album/project/${encodeURIComponent(projectTableName)}`;
+    const { data } = await this._ctx.client.request(path, 'GET', this._ctx.accessToken, this._ctx.refreshToken);
+    return data;
+  }
+
+  async getCustomAlbumPhotosById(customAlbumId, { ascOrDesc, lastId, limit } = {}) {
+    this._ctx.requireTokens();
+    let path = `/api/v1/custom_album/photos/${encodeURIComponent(customAlbumId)}/`;
+    const query = new URLSearchParams();
+    if (ascOrDesc !== undefined) (Array.isArray(ascOrDesc) ? ascOrDesc : [ascOrDesc]).forEach(v => query.append('asc_or_desc', v));
+    if (lastId !== undefined) (Array.isArray(lastId) ? lastId : [lastId]).forEach(v => query.append('last_id', v));
+    if (limit !== undefined) (Array.isArray(limit) ? limit : [limit]).forEach(v => query.append('limit', v));
+    const qs = query.toString();
+    if (qs) path += '?' + qs;
+    const { data } = await this._ctx.client.request(path, 'GET', this._ctx.accessToken, this._ctx.refreshToken);
+    return data;
+  }
+
+  async getRankedCustomAlbumById(customAlbumId, { ascOrDesc, lastId, limit } = {}) {
+    this._ctx.requireTokens();
+    let path = `/api/v1/custom_album/photos/ranked/${encodeURIComponent(customAlbumId)}/`;
+    const query = new URLSearchParams();
+    if (ascOrDesc !== undefined) (Array.isArray(ascOrDesc) ? ascOrDesc : [ascOrDesc]).forEach(v => query.append('asc_or_desc', v));
+    if (lastId !== undefined) (Array.isArray(lastId) ? lastId : [lastId]).forEach(v => query.append('last_id', v));
+    if (limit !== undefined) (Array.isArray(limit) ? limit : [limit]).forEach(v => query.append('limit', v));
+    const qs = query.toString();
+    if (qs) path += '?' + qs;
+    const { data } = await this._ctx.client.request(path, 'GET', this._ctx.accessToken, this._ctx.refreshToken);
+    return data;
+  }
+
+  async createProjectCustomAlbum(projectTableName, { name, description, photoIdInclusionList, photoIdRemovalList } = {}) {
+    this._ctx.requireTokens();
+    const path = `/api/v1/custom_album/project/${encodeURIComponent(projectTableName)}`;
+    const body = stripUndef({
+      name: name,
+      description: description,
+      photo_id_inclusion_list: photoIdInclusionList,
+      photo_id_removal_list: photoIdRemovalList,
+    });
+    const { data } = await this._ctx.client.request(path, 'POST', this._ctx.accessToken, this._ctx.refreshToken, body);
+    return data;
+  }
+
+  async updateCustomAlbum(albumId, { name, description, photoIdInclusionList, photoIdRemovalList } = {}) {
+    this._ctx.requireTokens();
+    const path = `/api/v1/custom_album/${encodeURIComponent(albumId)}`;
+    const body = stripUndef({
+      name: name,
+      description: description,
+      photo_id_inclusion_list: photoIdInclusionList,
+      photo_id_removal_list: photoIdRemovalList,
+    });
+    const { data } = await this._ctx.client.request(path, 'PUT', this._ctx.accessToken, this._ctx.refreshToken, body);
+    return data;
+  }
+
+  async deleteCustomAlbum(albumId) {
+    this._ctx.requireTokens();
+    const path = `/api/v1/custom_album/${encodeURIComponent(albumId)}`;
+    const { data } = await this._ctx.client.request(path, 'DELETE', this._ctx.accessToken, this._ctx.refreshToken);
+    return data;
+  }
+}