Users

Create User

Request Sample

const result = await mediaviz.users.createUser(
  '<NAME>',
  '<EMAIL>',
  '<ACCOUNT_TYPE>',
  '<COMPANY_ID>',
  '<PROFILE_PICTURE>',
  '<PAYMENT_PLAN_TYPE>'
);
const result = await mediaviz.users.createUser(
  '<NAME>',
  '<EMAIL>',
  '<ACCOUNT_TYPE>',
  '<COMPANY_ID>',
  '<PROFILE_PICTURE>',
  '<PAYMENT_PLAN_TYPE>'
);
$result = $mediaviz->users->createUser(
  '<NAME>',
  '<EMAIL>',
  '<ACCOUNT_TYPE>',
  '<COMPANY_ID>',
  '<PROFILE_PICTURE>',
  '<PAYMENT_PLAN_TYPE>'
);
curl -X POST 'https://api.mediaviz.ai/api/v1/users/' \
  -H 'Authorization: Bearer mvz_sk_live_7K2wQ9pL3mR8xN4vBjH1cT6yF0dZaEuS' \
  -H 'Content-Type: application/json' \
  --data @- <<'JSON'
{
  "name": "<NAME>",
  "email": "<EMAIL>",
  "company_id": "<COMPANY_ID>",
  "profile_picture": "<PROFILE_PICTURE>",
  "payment_plan_type": "<PAYMENT_PLAN_TYPE>",
  "account_type": "<ACCOUNT_TYPE>"
}
JSON

Create User And Company

Request Sample

const result = await mediaviz.users.createUserAndCompany(
  '<NAME>',
  '<EMAIL>',
  '<ACCOUNT_TYPE>',
  '<PASSWORD>',
  '<COMPANY_ID>',
  '<PROFILE_PICTURE>',
  '<PAYMENT_PLAN_TYPE>',
  '<COMPANY_NAME>',
  '<CREDITS>'
);
const result = await mediaviz.users.createUserAndCompany(
  '<NAME>',
  '<EMAIL>',
  '<ACCOUNT_TYPE>',
  '<PASSWORD>',
  '<COMPANY_ID>',
  '<PROFILE_PICTURE>',
  '<PAYMENT_PLAN_TYPE>',
  '<COMPANY_NAME>',
  '<CREDITS>'
);
$result = $mediaviz->users->createUserAndCompany(
  '<NAME>',
  '<EMAIL>',
  '<ACCOUNT_TYPE>',
  '<PASSWORD>',
  '<COMPANY_ID>',
  '<PROFILE_PICTURE>',
  '<PAYMENT_PLAN_TYPE>',
  '<COMPANY_NAME>',
  '<CREDITS>'
);
curl -X POST 'https://api.mediaviz.ai/api/v1/users/new_company' \
  -H 'Content-Type: application/json' \
  --data @- <<'JSON'
{
  "name": "<NAME>",
  "email": "<EMAIL>",
  "company_id": "<COMPANY_ID>",
  "profile_picture": "<PROFILE_PICTURE>",
  "payment_plan_type": "<PAYMENT_PLAN_TYPE>",
  "password": "<PASSWORD>",
  "company_name": "<COMPANY_NAME>",
  "credits": "<CREDITS>"
}
JSON

Change Password

Request Sample

const result = await mediaviz.users.changePassword('<OLD_PASSWORD>', '<NEW_PASSWORD>');
const result = await mediaviz.users.changePassword('<OLD_PASSWORD>', '<NEW_PASSWORD>');
$result = $mediaviz->users->changePassword('<OLD_PASSWORD>', '<NEW_PASSWORD>');
curl -X POST 'https://api.mediaviz.ai/api/v1/user/change_password' \
  -H 'Authorization: Bearer mvz_sk_live_7K2wQ9pL3mR8xN4vBjH1cT6yF0dZaEuS' \
  -H 'Content-Type: application/json' \
  --data @- <<'JSON'
{
  "old_password": "<OLD_PASSWORD>",
  "new_password": "<NEW_PASSWORD>"
}
JSON

Get User Id

Request Sample

// TODO: SDK function users.getUserId — verify name against SDK
// TODO: SDK function users.getUserId — verify name against SDK
# TODO: SDK function users.getUserId
curl -X GET 'https://api.mediaviz.ai/api/v1/users' \
  -H 'Authorization: Bearer mvz_sk_live_7K2wQ9pL3mR8xN4vBjH1cT6yF0dZaEuS'

Get User

Request Sample

const result = await mediaviz.users.getUser('<USER_ID>');
const result = await mediaviz.users.getUser('<USER_ID>');
$result = $mediaviz->users->getUser('<USER_ID>');
curl -X GET 'https://api.mediaviz.ai/api/v1/users/<USER_ID>' \
  -H 'Authorization: Bearer mvz_sk_live_7K2wQ9pL3mR8xN4vBjH1cT6yF0dZaEuS'

Get All Users By Company

Request Sample

const result = await mediaviz.users.getAllUsersByCompany('<COMPANY_ID>');
const result = await mediaviz.users.getAllUsersByCompany('<COMPANY_ID>');
$result = $mediaviz->users->getAllUsersByCompany('<COMPANY_ID>');
curl -X GET 'https://api.mediaviz.ai/api/v1/users/company/<COMPANY_ID>' \
  -H 'Authorization: Bearer mvz_sk_live_7K2wQ9pL3mR8xN4vBjH1cT6yF0dZaEuS'

Update User

Request Sample

const result = await mediaviz.users.updateUser(
  '<USER_ID>',
  '<NAME>',
  '<EMAIL>',
  '<PASSWORD>',
  '<COMPANY_ID>',
  '<ACCOUNT_TYPE>',
  '<PROFILE_PICTURE>',
  '<LOCATION>',
  '<PHONE_NUMBER>',
  '<BIRTHDAY>'
);
const result = await mediaviz.users.updateUser(
  '<USER_ID>',
  '<NAME>',
  '<EMAIL>',
  '<PASSWORD>',
  '<COMPANY_ID>',
  '<ACCOUNT_TYPE>',
  '<PROFILE_PICTURE>',
  '<LOCATION>',
  '<PHONE_NUMBER>',
  '<BIRTHDAY>'
);
$result = $mediaviz->users->updateUser(
  '<USER_ID>',
  '<NAME>',
  '<EMAIL>',
  '<PASSWORD>',
  '<COMPANY_ID>',
  '<ACCOUNT_TYPE>',
  '<PROFILE_PICTURE>',
  '<LOCATION>',
  '<PHONE_NUMBER>',
  '<BIRTHDAY>'
);
curl -X PUT 'https://api.mediaviz.ai/api/v1/users/<USER_ID>' \
  -H 'Authorization: Bearer mvz_sk_live_7K2wQ9pL3mR8xN4vBjH1cT6yF0dZaEuS' \
  -H 'Content-Type: application/json' \
  --data @- <<'JSON'
{
  "name": "<NAME>",
  "email": "<EMAIL>",
  "password": "<PASSWORD>",
  "company_id": "<COMPANY_ID>",
  "account_type": "<ACCOUNT_TYPE>",
  "profile_picture": "<PROFILE_PICTURE>",
  "location": "<LOCATION>",
  "phone_number": "<PHONE_NUMBER>",
  "birthday": "<BIRTHDAY>"
}
JSON

Delete User

Request Sample

const result = await mediaviz.users.deleteUser(
  '<USER_ID>',
  {
    newCompanyOwnerId: '<NEW_COMPANY_OWNER_ID>'
  }
);
const result = await mediaviz.users.deleteUser(
  '<USER_ID>',
  {
    newCompanyOwnerId: '<NEW_COMPANY_OWNER_ID>'
  }
);
$result = $mediaviz->users->deleteUser(
  '<USER_ID>',
  [
    'newCompanyOwnerId' => '<NEW_COMPANY_OWNER_ID>'
  ]
);
curl -X DELETE 'https://api.mediaviz.ai/api/v1/users/delete/<USER_ID>' \
  -H 'Authorization: Bearer mvz_sk_live_7K2wQ9pL3mR8xN4vBjH1cT6yF0dZaEuS'