Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "src/rest/organization"

Index

Functions

Functions

Const createApiKeyForUser

  • Parameters

    Returns Promise<any>

Const createDomainForUser

Const createOrganizationSourceForUser

  • createOrganizationSourceForUser(userId: string | ApiKeyResponse, organizationId: string, card: any, locals?: Locals): Promise<object>

  • Parameters

    Returns Promise<object>

Const createOrganizationSubscriptionForUser

  • createOrganizationSubscriptionForUser(userId: string | ApiKeyResponse, organizationId: string, params: object, locals?: Locals): Promise<object>

  • Parameters

    • userId: string | ApiKeyResponse
    • organizationId: string
    • params: object
      • [index: string]: any
      • plan: string
    • Optional locals: Locals

    Returns Promise<object>

Const createWebhookForUser

Const deleteApiKeyForUser

  • deleteApiKeyForUser(userId: string | ApiKeyResponse, organizationId: string, apiKeyId: string, locals: Locals): Promise<any>

  • Parameters

    Returns Promise<any>

Const deleteDomainForUser

  • deleteDomainForUser(userId: string | ApiKeyResponse, organizationId: string, domainId: string, locals: Locals): Promise<any>

  • Parameters

    Returns Promise<any>

Const deleteOrganizationForUser

  • deleteOrganizationForUser(userId: string | ApiKeyResponse, organizationId: string, locals: Locals): Promise<void>

  • Parameters

    Returns Promise<void>

Const deleteOrganizationMembershipForUser

  • deleteOrganizationMembershipForUser(userId: string | ApiKeyResponse, organizationId: string, membershipId: string): Promise<any>

  • Parameters

    • userId: string | ApiKeyResponse
    • organizationId: string
    • membershipId: string

    Returns Promise<any>

Const deleteOrganizationSourceForUser

  • deleteOrganizationSourceForUser(userId: string | ApiKeyResponse, organizationId: string, sourceId: string, locals?: Locals): Promise<object>

  • Parameters

    Returns Promise<object>

Const deleteWebhookForUser

  • deleteWebhookForUser(userId: string | ApiKeyResponse, organizationId: string, webhookId: string, locals: Locals): Promise<any>

  • Parameters

    Returns Promise<any>

Const getAllOrganizationDataForUser

  • getAllOrganizationDataForUser(userId: string | ApiKeyResponse, organizationId: string): Promise<object>

  • Parameters

    Returns Promise<object>

Const getOrganizationApiKeyForUser

  • getOrganizationApiKeyForUser(userId: string | ApiKeyResponse, organizationId: string, apiKeyId: string): Promise<ApiKey>

  • Parameters

    • userId: string | ApiKeyResponse
    • organizationId: string
    • apiKeyId: string

    Returns Promise<ApiKey>

Const getOrganizationApiKeyLogsForUser

  • getOrganizationApiKeyLogsForUser(userId: string | ApiKeyResponse, organizationId: string, apiKeyId: string, query: KeyValue): Promise<any>

  • Parameters

    Returns Promise<any>

Const getOrganizationApiKeysForUser

  • getOrganizationApiKeysForUser(userId: string | ApiKeyResponse, organizationId: string, query: KeyValue): Promise<object>

  • Parameters

    Returns Promise<object>

Const getOrganizationBillingForUser

  • getOrganizationBillingForUser(userId: string | ApiKeyResponse, organizationId: string): Promise<ICustomer>

  • Parameters

    Returns Promise<ICustomer>

Const getOrganizationDomainForUser

  • getOrganizationDomainForUser(userId: string | ApiKeyResponse, organizationId: string, domainId: string): Promise<Domain>

  • Parameters

    • userId: string | ApiKeyResponse
    • organizationId: string
    • domainId: string

    Returns Promise<Domain>

Const getOrganizationDomainsForUser

  • getOrganizationDomainsForUser(userId: string | ApiKeyResponse, organizationId: string, query: KeyValue): Promise<object>

  • Parameters

    Returns Promise<object>

Const getOrganizationForUser

  • Parameters

    Returns Promise<Organization>

Const getOrganizationInvoiceForUser

  • getOrganizationInvoiceForUser(userId: string | ApiKeyResponse, organizationId: string, invoiceId: string): Promise<IInvoice>

  • Parameters

    • userId: string | ApiKeyResponse
    • organizationId: string
    • invoiceId: string

    Returns Promise<IInvoice>

Const getOrganizationInvoicesForUser

  • getOrganizationInvoicesForUser(userId: string | ApiKeyResponse, organizationId: string, params: KeyValue): Promise<any>

  • Parameters

    Returns Promise<any>

Const getOrganizationMembershipForUser

  • getOrganizationMembershipForUser(userId: string | ApiKeyResponse, organizationId: string, membershipId: string): Promise<any>

  • Parameters

    • userId: string | ApiKeyResponse
    • organizationId: string
    • membershipId: string

    Returns Promise<any>

Const getOrganizationMembershipsForUser

  • getOrganizationMembershipsForUser(userId: string | ApiKeyResponse, organizationId: string, query?: KeyValue): Promise<any>

  • Parameters

    Returns Promise<any>

Const getOrganizationPricingPlansForUser

  • getOrganizationPricingPlansForUser(userId: string | ApiKeyResponse, organizationId: string): Promise<IList<IPlan>>

  • Parameters

    Returns Promise<IList<IPlan>>

Const getOrganizationSourceForUser

  • getOrganizationSourceForUser(userId: string | ApiKeyResponse, organizationId: string, sourceId: string): Promise<ICard | IBitcoinReceiver | IBankAccount | ISource>

  • Parameters

    • userId: string | ApiKeyResponse
    • organizationId: string
    • sourceId: string

    Returns Promise<ICard | IBitcoinReceiver | IBankAccount | ISource>

Const getOrganizationSourcesForUser

  • getOrganizationSourcesForUser(userId: string | ApiKeyResponse, organizationId: string, params: KeyValue): Promise<any>

  • Parameters

    Returns Promise<any>

Const getOrganizationSubscriptionForUser

  • getOrganizationSubscriptionForUser(userId: string | ApiKeyResponse, organizationId: string, subscriptionId: string): Promise<ISubscription>

  • Parameters

    • userId: string | ApiKeyResponse
    • organizationId: string
    • subscriptionId: string

    Returns Promise<ISubscription>

Const getOrganizationSubscriptionsForUser

  • getOrganizationSubscriptionsForUser(userId: string | ApiKeyResponse, organizationId: string, params: KeyValue): Promise<any>

  • Parameters

    Returns Promise<any>

Const getOrganizationWebhookForUser

  • getOrganizationWebhookForUser(userId: string | ApiKeyResponse, organizationId: string, webhookId: string): Promise<Webhook>

  • Parameters

    • userId: string | ApiKeyResponse
    • organizationId: string
    • webhookId: string

    Returns Promise<Webhook>

Const getOrganizationWebhooksForUser

  • getOrganizationWebhooksForUser(userId: string | ApiKeyResponse, organizationId: string, query: KeyValue): Promise<object>

  • Parameters

    Returns Promise<object>

Const inviteMemberToOrganization

  • inviteMemberToOrganization(userId: string | ApiKeyResponse, organizationId: string, newMemberName: string, newMemberEmail: string, role: MembershipRole, locals: Locals): Promise<void>

  • Parameters

    Returns Promise<void>

Const newOrganizationForUser

  • newOrganizationForUser(userId: string, organization: Organization, locals: Locals): Promise<void>

  • Parameters

    Returns Promise<void>

Const updateApiKeyForUser

  • updateApiKeyForUser(userId: string | ApiKeyResponse, organizationId: string, apiKeyId: string, data: KeyValue, locals: Locals): Promise<any>

  • Parameters

    Returns Promise<any>

Const updateDomainForUser

  • updateDomainForUser(userId: string | ApiKeyResponse, organizationId: string, domainId: string, data: KeyValue, locals: Locals): Promise<any>

  • Parameters

    Returns Promise<any>

Const updateOrganizationBillingForUser

  • updateOrganizationBillingForUser(userId: string | ApiKeyResponse, organizationId: string, data: any, locals: Locals): Promise<object>

  • Parameters

    Returns Promise<object>

Const updateOrganizationForUser

  • Parameters

    Returns Promise<void>

Const updateOrganizationMembershipForUser

  • updateOrganizationMembershipForUser(userId: string | ApiKeyResponse, organizationId: string, membershipId: string, data: KeyValue): Promise<any>

  • Parameters

    Returns Promise<any>

Const updateOrganizationSourceForUser

  • updateOrganizationSourceForUser(userId: string | ApiKeyResponse, organizationId: string, sourceId: string, data: any, locals?: Locals): Promise<object>

  • Parameters

    • userId: string | ApiKeyResponse
    • organizationId: string
    • sourceId: string
    • data: any
    • Optional locals: Locals

    Returns Promise<object>

Const updateOrganizationSubscriptionForUser

  • updateOrganizationSubscriptionForUser(userId: string | ApiKeyResponse, organizationId: string, subscriptionId: string, data: KeyValue, locals?: Locals): Promise<object>

  • Parameters

    Returns Promise<object>

Const updateWebhookForUser

  • updateWebhookForUser(userId: string | ApiKeyResponse, organizationId: string, webhookId: string, data: KeyValue, locals: Locals): Promise<any>

  • Parameters

    Returns Promise<any>

Const verifyDomainForUser

  • verifyDomainForUser(userId: string | ApiKeyResponse, organizationId: string, domainId: string, method: "dns" | "file", locals: Locals): Promise<any>

  • Parameters

    • userId: string | ApiKeyResponse
    • organizationId: string
    • domainId: string
    • method: "dns" | "file"
    • locals: Locals

    Returns Promise<any>

Generated using TypeDoc