Instance Config Routes

# hide
import os
import nbdev

import domolibrary.routes.bootstrap as bootstrap_routes

token_auth = dmda.DomoTokenAuth(
    domo_instance=os.environ["DOMO_INSTANCE"],
    domo_access_token=os.environ["DOMO_ACCESS_TOKEN"],
)

full_auth = dmda.DomoFullAuth(
    domo_instance=os.environ["DOMO_INSTANCE"],
    domo_username=os.environ["DOMO_USERNAME"],
    domo_password=os.environ["DOMO_PASSWORD"],
)

---

source

get_is_invite_social_users_enabled

 get_is_invite_social_users_enabled
                                     (auth:domolibrary.client.DomoAuth.Dom
                                     oAuth, customer_id:str,
                                     session:httpx.AsyncClient=None,
                                     debug_api:bool=False,
                                     parent_class=None,
                                     return_raw:bool=False,
                                     debug_num_stacks_to_drop=1)

---

source

ToggleSocialUsers_Error

 ToggleSocialUsers_Error
                          (res:domolibrary.client.ResponseGetData.Response
                          GetData, message='failure to toggle social
                          users')

base exception

# import domolibrary.routes.bootstrap as bootstrap_routes

bootstrap_info_res = await bootstrap_routes.get_bootstrap(
    auth=full_auth, debug_api=False  # requires full auth
)
customer_id = bootstrap_info_res.response["currentUser"]["USER_GROUP"]

(
    await get_is_invite_social_users_enabled(
        auth=token_auth, customer_id=customer_id, debug_api=False
    )
).response

{'name': 'free-invite', 'is_enabled': True}

---

source

get_is_user_invite_notifications_enabled

 get_is_user_invite_notifications_enabled
                                           (auth:domolibrary.client.DomoAu
                                           th.DomoFullAuth,
                                           session:httpx.AsyncClient=None,
                                           debug_api:bool=False,
                                           parent_class=None,
                                           debug_num_stacks_to_drop=1,
                                           return_raw:bool=False)

---

source

toggle_is_user_invite_enabled

 toggle_is_user_invite_enabled
                                (auth:domolibrary.client.DomoAuth.DomoFull
                                Auth, is_enabled:bool,
                                session:httpx.AsyncClient=None,
                                debug_api:bool=False,
                                return_raw:bool=False, parent_class=None,
                                debug_num_stacks_to_drop=1)

Admin > Company Settings > Notifications

---

source

ToggleUserInvite_Error

 ToggleUserInvite_Error
                         (res:domolibrary.client.ResponseGetData.ResponseG
                         etData, message='failure to toggle user invite
                         enabled')

base exception

await toggle_is_user_invite_enabled(auth=token_auth, is_enabled=False, debug_api=False)

ResponseGetData(status=200, response={'name': 'user.invite.email.enabled', 'is_enabled': False}, is_success=True, parent_class=None)

# import domolibrary.client.DomoAuth as dmda


await get_is_user_invite_notifications_enabled(
    auth=token_auth, debug_api=False, return_raw=False
)

ResponseGetData(status=200, response={'name': 'user.invite.email.enabled', 'is_enabled': False}, is_success=True, parent_class=None)

---

source

get_allowlist

 get_allowlist (auth:domolibrary.client.DomoAuth.DomoAuth,
                session:httpx.AsyncClient=None, return_raw:bool=False,
                debug_api:bool=False, parent_class=None,
                debug_num_stacks_to_drop=1)

---

source

Config_GET_Error

 Config_GET_Error (res:domolibrary.client.ResponseGetData.ResponseGetData,
                   message:str=None)

base exception

# import domolibrary.client.DomoAuth as dmda


try:
    print(await get_allowlist(auth=token_auth))
except dmda.InvalidAuthTypeError as e:
    print(e)

ResponseGetData(status=200, response={'addresses': ['0.0.0.0/0', '172.182.200.130']}, is_success=True, parent_class=None)

---

source

Allowlist_UnableToUpdate

 Allowlist_UnableToUpdate
                           (res:domolibrary.client.ResponseGetData.Respons
                           eGetData, reason:str=None, message:str=None)

base exception

---

source

set_allowlist

 set_allowlist (auth:domolibrary.client.DomoAuth.DomoAuth,
                ip_address_ls:list[str], debug_api:bool=False,
                return_raw:bool=False, session:httpx.AsyncClient=None,
                parent_class=None, debug_num_stacks_to_drop=1)

companysettings/whitelist API only allows users to SET the allowlist does not allow INSERT or UPDATE

# import domolibrary.client.DomoAuth as dmda

ip_address_ls = ["0.0.0.0/0"]


await set_allowlist(auth=full_auth, ip_address_ls=ip_address_ls, return_raw = False)

ResponseGetData(status=200, response={'addresses': ['0.0.0.0/0', '172.182.200.129']}, is_success=True, parent_class=None)

---

source

get_authorized_domains

 get_authorized_domains (auth:domolibrary.client.DomoAuth.DomoAuth,
                         return_raw:bool=False, debug_api:bool=False,
                         session:httpx.AsyncClient=None,
                         parent_class=None, debug_num_stacks_to_drop=1)

---

source

GetDomains_NotFound

 GetDomains_NotFound
                      (res:domolibrary.client.ResponseGetData.ResponseGetD
                      ata, message:str=None)

base exception

# import domolibrary.client.DomoAuth as dmda

await get_authorized_domains(auth=token_auth, debug_api=False)

ResponseGetData(status=200, response=[], is_success=True, parent_class=None)

---

source

set_authorized_domains

 set_authorized_domains (auth:domolibrary.client.DomoAuth.DomoAuth,
                         authorized_domain_ls:List[str],
                         debug_api:bool=False,
                         session:httpx.AsyncClient=None,
                         parent_class=None, debug_num_stacks_to_drop=1)

---

source

get_is_weekly_digest_enabled

 get_is_weekly_digest_enabled (auth:domolibrary.client.DomoAuth.DomoAuth,
                               return_raw:bool=False,
                               debug_api:bool=False,
                               session:httpx.AsyncClient=None,
                               parent_class=None,
                               debug_num_stacks_to_drop=1)

---

source

InstanceConfig_Error

 InstanceConfig_Error
                       (res:domolibrary.client.ResponseGetData.ResponseGet
                       Data, message:str=None)

base exception

# import domolibrary.client.DomoAuth as dmda

token_auth = dmda.DomoTokenAuth(
    domo_instance="domo-alpha",
    domo_access_token=os.environ["ALPHA_ACCESS_TOKEN"],
)

try:
    print(await get_is_weekly_digest_enabled(token_auth, return_raw=True))

except InstanceConfig_Error as e:
    print(e)

ResponseGetData(status=404, response='Not Found', is_success=False, parent_class=None)

---

source

toggle_is_weekly_digest_enabled

 toggle_is_weekly_digest_enabled
                                  (auth:domolibrary.client.DomoAuth.DomoAu
                                  th, return_raw:bool=False,
                                  debug_api:bool=False,
                                  is_enabled:bool=True,
                                  session:httpx.AsyncClient=None,
                                  parent_class=None,
                                  debug_num_stacks_to_drop=1)

# import domolibrary.client.DomoAuth as dmda

try:
    current_state = await get_is_weekly_digest_enabled(token_auth)


    await toggle_is_weekly_digest_enabled(
        token_auth, is_enabled=current_state.response["is_enabled"]
    )

except InstanceConfig_Error as e:
    print(e)

🛑  InstanceConfig_Error 🛑 - function: get_traceback || status 404 || Not Found at domo-alpha

---

source

get_authorized_custom_app_domains

 get_authorized_custom_app_domains
                                    (auth:domolibrary.client.DomoAuth.Domo
                                    Auth, return_raw:bool=False,
                                    debug_api:bool=False,
                                    session:httpx.AsyncClient=None,
                                    parent_class=None,
                                    debug_num_stacks_to_drop=1)

---

source

GetAppDomains_NotFound

 GetAppDomains_NotFound
                         (res:domolibrary.client.ResponseGetData.ResponseG
                         etData, message:str=None)

base exception

await get_authorized_custom_app_domains(auth=token_auth, debug_api=False)

ResponseGetData(status=200, response=['domo.com', 'salesforce.com', 'facebook.com', 'twitter.com', 'instagram.com', 'youtube.com', 'linkedin.com'], is_success=True, parent_class=None)

---

source

set_authorized_custom_app_domains

 set_authorized_custom_app_domains
                                    (auth:domolibrary.client.DomoAuth.Domo
                                    Auth, authorized_custom_app_domain_ls:
                                    List[str], debug_api:bool=False,
                                    session:httpx.AsyncClient=None,
                                    parent_class=None,
                                    debug_num_stacks_to_drop=1)

authorized_app_domains = (await get_authorized_custom_app_domains(auth=token_auth, debug_api=False)).response

await set_authorized_custom_app_domains(
    auth=token_auth, authorized_custom_app_domain_ls=authorized_app_domains
)

ResponseGetData(status=200, response=['domo.com', 'salesforce.com', 'facebook.com', 'twitter.com', 'instagram.com', 'youtube.com', 'linkedin.com'], is_success=True, parent_class=None)