Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OrganizationsApi

OrganizationsApi - object-oriented interface

export

Hierarchy

Index

Constructors

constructor

Properties

Protected basePath

basePath: string

Protected configuration

configuration: Configuration

Protected fetch

fetch: FetchAPI

Methods

getOrganization

  • Retrieve information about current organization.

    summary

    Get Organization

    throws

    {RequiredError}

    memberof

    OrganizationsApi

    Parameters

    • Optional options: any

    Returns Promise<OrganizationResponse>

getOrganizationCompute

  • getOrganizationCompute(month?: undefined | string, year?: undefined | string, options?: any): Promise<OrgComputeResponse>
  • Retrieve usage levels for current organization.

    summary

    Get Organization Compute Time-Series data

    throws

    {RequiredError}

    memberof

    OrganizationsApi

    Parameters

    • Optional month: undefined | string
    • Optional year: undefined | string
    • Optional options: any

    Returns Promise<OrgComputeResponse>

getOrganizationIngest

  • getOrganizationIngest(month?: undefined | string, year?: undefined | string, options?: any): Promise<OrgIngestResponse>
  • Retrieve usage levels for current organization.

    summary

    Get Organization ingest usage data

    throws

    {RequiredError}

    memberof

    OrganizationsApi

    Parameters

    • Optional month: undefined | string
    • Optional year: undefined | string
    • Optional options: any

    Returns Promise<OrgIngestResponse>

getOrganizationRecentActivity

  • Get information about organization's recent activity.

    summary

    Get Organization Recent Activity

    throws

    {RequiredError}

    memberof

    OrganizationsApi

    Parameters

    • Optional options: any

    Returns Promise<OrgRecentActivityResponse>

getOrganizationSettings

  • Retrieve settings for current organization.

    summary

    Get Organization Settings

    throws

    {RequiredError}

    memberof

    OrganizationsApi

    Parameters

    • Optional options: any

    Returns Promise<OrgSettingsResponse>

getOrganizationStorage

  • getOrganizationStorage(month?: undefined | string, year?: undefined | string, options?: any): Promise<OrgStorageResponse>
  • Retrieve usage levels for current organization.

    summary

    Get Organization Storage Time-Series data

    throws

    {RequiredError}

    memberof

    OrganizationsApi

    Parameters

    • Optional month: undefined | string
    • Optional year: undefined | string
    • Optional options: any

    Returns Promise<OrgStorageResponse>

getOrganizationTrialCredit

  • getOrganizationTrialCredit(month?: undefined | string, year?: undefined | string, options?: any): Promise<OrgTrialUsageResponse>
  • Retrieve usage levels for current organization.

    summary

    Get Organization trial credit usage data

    throws

    {RequiredError}

    memberof

    OrganizationsApi

    Parameters

    • Optional month: undefined | string
    • Optional year: undefined | string
    • Optional options: any

    Returns Promise<OrgTrialUsageResponse>

getOrganizationUsage

  • Retrieve usage levels for current organization.

    summary

    Get Organization Usage

    throws

    {RequiredError}

    memberof

    OrganizationsApi

    Parameters

    • Optional options: any

    Returns Promise<OrgUsageResponse>

getPaymentMethod

  • Get the payment information for your organization.

    summary

    Retrieve payment information about payment method

    throws

    {RequiredError}

    memberof

    OrganizationsApi

    Parameters

    • Optional options: any

    Returns Promise<OrgPaymentMethodResponse>

getPaymentSource

  • Get stored payment information for your organization.

    summary

    Retrieve payment information

    throws

    {RequiredError}

    memberof

    OrganizationsApi

    Parameters

    • Optional options: any

    Returns Promise<OrgInvoicesResponse>

getSsoSettings

  • Get stored sso information for your organization.

    summary

    Retrieve sso settings

    throws

    {RequiredError}

    memberof

    OrganizationsApi

    Parameters

    • Optional options: any

    Returns Promise<OrgSettingsResponse>

updatePaymentSource

updateSsoSettings

Generated using TypeDoc