Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "src/crud/organization"

Index

Functions

Functions

Const checkDomainAvailability

  • checkDomainAvailability(username: string): Promise<boolean>

  • Get a user by their username

    Parameters

    • username: string

    Returns Promise<boolean>

Const createApiKey

  • createApiKey(apiKey: ApiKey): Promise<any>

  • Create an API key

    Parameters

    Returns Promise<any>

Const createDomain

  • Create a domain

    Parameters

    Returns Promise<InsertResult>

Const createOrganization

  • createOrganization(organization: Organization): Promise<any>

  • Parameters

    Returns Promise<any>

Const createWebhook

  • Create a webhook

    Parameters

    Returns Promise<InsertResult>

Const deleteAllOrganizationMemberships

  • deleteAllOrganizationMemberships(organizationId: string): Promise<any>

  • Parameters

    • organizationId: string

    Returns Promise<any>

Const deleteApiKey

  • deleteApiKey(organizationId: string, apiKeyId: string): Promise<any>

  • Delete an API key

    Parameters

    • organizationId: string
    • apiKeyId: string

    Returns Promise<any>

Const deleteDomain

  • deleteDomain(organizationId: string, domainId: string): Promise<any>

  • Delete a domain

    Parameters

    • organizationId: string
    • domainId: string

    Returns Promise<any>

Const deleteOrganization

  • deleteOrganization(id: string): Promise<any>

  • Parameters

    • id: string

    Returns Promise<any>

Const deleteOrganizationMembership

  • deleteOrganizationMembership(organizationId: string, id: string): Promise<any>

  • Parameters

    • organizationId: string
    • id: string

    Returns Promise<any>

Const deleteWebhook

  • deleteWebhook(organizationId: string, webhookId: string): Promise<any>

  • Delete a webhook

    Parameters

    • organizationId: string
    • webhookId: string

    Returns Promise<any>

Const getAllOrganizations

  • Returns Promise<Organization[]>

Const getApiKey

  • getApiKey(organizationId: string, apiKeyId: string): Promise<ApiKey>

  • Get an API key

    Parameters

    • organizationId: string
    • apiKeyId: string

    Returns Promise<ApiKey>

Const getApiKeyLogs

  • getApiKeyLogs(organizationId: string, apiKeyId: string, query: KeyValue): Promise<any>

  • Get an API key

    Parameters

    • organizationId: string
    • apiKeyId: string
    • query: KeyValue

    Returns Promise<any>

Const getDomain

  • getDomain(organizationId: string, domainId: string): Promise<Domain>

  • Get a domain

    Parameters

    • organizationId: string
    • domainId: string

    Returns Promise<Domain>

Const getDomainByDomainName

  • getDomainByDomainName(domain: string): Promise<Domain>

  • Get a domain

    Parameters

    • domain: string

    Returns Promise<Domain>

Const getOrganization

  • Parameters

    • id: string

    Returns Promise<Organization>

Const getOrganizationApiKeys

  • getOrganizationApiKeys(organizationId: string, query: KeyValue): Promise<object>

  • Get a list of all approved locations of a user

    Parameters

    • organizationId: string
    • query: KeyValue

    Returns Promise<object>

Const getOrganizationDomains

  • getOrganizationDomains(organizationId: string, query: KeyValue): Promise<object>

  • Get a list of domains for an organization

    Parameters

    • organizationId: string
    • query: KeyValue

    Returns Promise<object>

Const getOrganizationEventWebhooks

  • getOrganizationEventWebhooks(organizationId: string, event: Webhooks): Promise<Webhook[]>

  • Get a webhook

    Parameters

    • organizationId: string
    • event: Webhooks

    Returns Promise<Webhook[]>

Const getOrganizationIdFromUsername

  • getOrganizationIdFromUsername(username: string): Promise<string>

  • Parameters

    • username: string

    Returns Promise<string>

Const getOrganizationMembership

  • getOrganizationMembership(organizationId: string, id: string): Promise<Membership>

  • Parameters

    • organizationId: string
    • id: string

    Returns Promise<Membership>

Const getOrganizationMembershipDetailed

  • getOrganizationMembershipDetailed(organizationId: string, id: string): Promise<any>

  • Parameters

    • organizationId: string
    • id: string

    Returns Promise<any>

Const getOrganizationMemberships

  • getOrganizationMemberships(organizationId: string, query?: KeyValue): Promise<any>

  • Parameters

    • organizationId: string
    • Optional query: KeyValue

    Returns Promise<any>

Const getOrganizationWebhooks

  • getOrganizationWebhooks(organizationId: string, query: KeyValue): Promise<object>

  • Get a list of webhooks for an organization

    Parameters

    • organizationId: string
    • query: KeyValue

    Returns Promise<object>

Const getWebhook

  • getWebhook(organizationId: string, webhookId: string): Promise<Webhook>

  • Get a webhook

    Parameters

    • organizationId: string
    • webhookId: string

    Returns Promise<Webhook>

Const updateApiKey

  • updateApiKey(organizationId: string, apiKeyId: string, data: KeyValue): Promise<any>

  • Update a user's details

    Parameters

    • organizationId: string
    • apiKeyId: string
    • data: KeyValue

    Returns Promise<any>

Const updateDomain

  • updateDomain(organizationId: string, domainId: string, data: KeyValue): Promise<any>

  • Update a domain

    Parameters

    • organizationId: string
    • domainId: string
    • data: KeyValue

    Returns Promise<any>

Const updateOrganization

  • updateOrganization(id: string, organization: KeyValue): Promise<any>

  • Parameters

    Returns Promise<any>

Const updateOrganizationMembership

  • updateOrganizationMembership(organizationId: string, id: string, membership: KeyValue): Promise<any>

  • Parameters

    • organizationId: string
    • id: string
    • membership: KeyValue

    Returns Promise<any>

Const updateOrganizationProfilePicture

  • updateOrganizationProfilePicture(organizationId: string): Promise<any>

  • Parameters

    • organizationId: string

    Returns Promise<any>

Const updateWebhook

  • updateWebhook(organizationId: string, webhookId: string, data: KeyValue): Promise<any>

  • Update a webhook

    Parameters

    • organizationId: string
    • webhookId: string
    • data: KeyValue

    Returns Promise<any>

Generated using TypeDoc