Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "codegen/api"

Index

Namespaces

Classes

Interfaces

Variables

Functions

Object literals

Variables

Const BASE_PATH

BASE_PATH: string = 'https://api.rs2.usw2.rockset.com'.replace(/\/+$/, '')

Functions

Const AliasesApiFactory

  • AliasesApiFactory(configuration?: Configuration, fetch?: FetchAPI, basePath?: undefined | string): { createAlias: any; deleteAlias: any; getAlias: any; listAliases: any; listQueryLambdasWithAlias: any; updateAlias: any; workspaceAliases: any }

  • AliasesApi - factory interface

    export

    Parameters

    Returns { createAlias: any; deleteAlias: any; getAlias: any; listAliases: any; listQueryLambdasWithAlias: any; updateAlias: any; workspaceAliases: any }

    • createAlias: function
    • deleteAlias: function

      • Delete an alias.

        summary

        Delete Alias

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • alias: string

          name of the alias

        • Optional options: any

        Returns Promise<DeleteAliasResponse>

    • getAlias: function
      • getAlias(workspace: string, alias: string, options?: any): Promise<GetAliasResponse>

      • Get details about a alias

        summary

        Get Alias

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • alias: string

          name of the alias

        • Optional options: any

        Returns Promise<GetAliasResponse>

    • listAliases: function
    • listQueryLambdasWithAlias: function

      • Get all Query Lambdas that hit a specific Rockset Alias.

        summary

        Get Query Lambdas with Alias

        throws

        {RequiredError}

        Parameters

        • workspace: string
        • alias: string
        • Optional options: any

        Returns Promise<ListQueryLambdasResponse>

    • updateAlias: function

      • Update alias in a workspace.

        summary

        Update alias

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • alias: string

          name of the alias

        • body: UpdateAliasRequest

          JSON object

        • Optional options: any

        Returns Promise<GetAliasResponse>

    • workspaceAliases: function

      • Retrieve all aliases in a workspace.

        summary

        List Aliases for Workspace

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • Optional options: any

        Returns Promise<ListAliasesResponse>

Const AliasesApiFetchParamCreator

  • AliasesApiFetchParamCreator(configuration?: Configuration): { createAlias: any; deleteAlias: any; getAlias: any; listAliases: any; listQueryLambdasWithAlias: any; updateAlias: any; workspaceAliases: any }

  • AliasesApi - fetch parameter creator

    export

    Parameters

    Returns { createAlias: any; deleteAlias: any; getAlias: any; listAliases: any; listQueryLambdasWithAlias: any; updateAlias: any; workspaceAliases: any }

    • createAlias: function

      • Create new alias in a workspace.

        summary

        Create alias

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • body: CreateAliasRequest

          JSON object

        • Default value options: any = {}

        Returns FetchArgs

    • deleteAlias: function
      • deleteAlias(workspace: string, alias: string, options?: any): FetchArgs

      • Delete an alias.

        summary

        Delete Alias

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • alias: string

          name of the alias

        • Default value options: any = {}

        Returns FetchArgs

    • getAlias: function
      • getAlias(workspace: string, alias: string, options?: any): FetchArgs

      • Get details about a alias

        summary

        Get Alias

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • alias: string

          name of the alias

        • Default value options: any = {}

        Returns FetchArgs

    • listAliases: function

      • Retrieve all aliases in an organization

        summary

        List Aliases

        throws

        {RequiredError}

        Parameters

        • Default value options: any = {}

        Returns FetchArgs

    • listQueryLambdasWithAlias: function
      • listQueryLambdasWithAlias(workspace: string, alias: string, options?: any): FetchArgs

      • Get all Query Lambdas that hit a specific Rockset Alias.

        summary

        Get Query Lambdas with Alias

        throws

        {RequiredError}

        Parameters

        • workspace: string
        • alias: string
        • Default value options: any = {}

        Returns FetchArgs

    • updateAlias: function

      • Update alias in a workspace.

        summary

        Update alias

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • alias: string

          name of the alias

        • body: UpdateAliasRequest

          JSON object

        • Default value options: any = {}

        Returns FetchArgs

    • workspaceAliases: function
      • workspaceAliases(workspace: string, options?: any): FetchArgs

      • Retrieve all aliases in a workspace.

        summary

        List Aliases for Workspace

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • Default value options: any = {}

        Returns FetchArgs

Const AliasesApiFp

  • AliasesApiFp(configuration?: Configuration): { createAlias: any; deleteAlias: any; getAlias: any; listAliases: any; listQueryLambdasWithAlias: any; updateAlias: any; workspaceAliases: any }

Const ApiKeysApiFactory

  • ApiKeysApiFactory(configuration?: Configuration, fetch?: FetchAPI, basePath?: undefined | string): { createApiKey: any; createApiKeyAdmin: any; deleteApiKey: any; deleteApiKeyAdmin: any; listApiKeys: any; listApiKeysAdmin: any }

  • ApiKeysApi - factory interface

    export

    Parameters

    Returns { createApiKey: any; createApiKeyAdmin: any; deleteApiKey: any; deleteApiKeyAdmin: any; listApiKeys: any; listApiKeysAdmin: any }

Const ApiKeysApiFetchParamCreator

  • ApiKeysApiFetchParamCreator(configuration?: Configuration): { createApiKey: any; createApiKeyAdmin: any; deleteApiKey: any; deleteApiKeyAdmin: any; listApiKeys: any; listApiKeysAdmin: any }

  • ApiKeysApi - fetch parameter creator

    export

    Parameters

    Returns { createApiKey: any; createApiKeyAdmin: any; deleteApiKey: any; deleteApiKeyAdmin: any; listApiKeys: any; listApiKeysAdmin: any }

    • createApiKey: function
    • createApiKeyAdmin: function

      • Create a new API key for any user in your organization. Accessible to Admin users only.

        summary

        Create API Key (any user)

        throws

        {RequiredError}

        Parameters

        • body: CreateApiKeyRequest

          JSON object

        • user: string

          user email

        • Default value options: any = {}

        Returns FetchArgs

    • deleteApiKey: function
      • deleteApiKey(name: string, options?: any): FetchArgs

      • Delete an API key for the authenticated user.

        summary

        Delete API Key

        throws

        {RequiredError}

        Parameters

        • name: string

          name of the API key

        • Default value options: any = {}

        Returns FetchArgs

    • deleteApiKeyAdmin: function
      • deleteApiKeyAdmin(name: string, user: string, options?: any): FetchArgs

      • Delete an API key for any user in your organization. Accessible to Admin users only.

        summary

        Delete API Key (any user)

        throws

        {RequiredError}

        Parameters

        • name: string

          name of the API key

        • user: string

          user email

        • Default value options: any = {}

        Returns FetchArgs

    • listApiKeys: function

      • List all API keys for the authenticated user.

        summary

        List API Keys

        throws

        {RequiredError}

        Parameters

        • Default value options: any = {}

        Returns FetchArgs

    • listApiKeysAdmin: function
      • listApiKeysAdmin(user: string, options?: any): FetchArgs

      • List all API keys for any user in your organization. Accessible to Admin users only.

        summary

        List API Keys (any user)

        throws

        {RequiredError}

        Parameters

        • user: string

          user email

        • Default value options: any = {}

        Returns FetchArgs

Const ApiKeysApiFp

  • ApiKeysApiFp(configuration?: Configuration): { createApiKey: any; createApiKeyAdmin: any; deleteApiKey: any; deleteApiKeyAdmin: any; listApiKeys: any; listApiKeysAdmin: any }

Const CollectionsApiFactory

  • CollectionsApiFactory(configuration?: Configuration, fetch?: FetchAPI, basePath?: undefined | string): { createCollection: any; createPreviewSource: any; deleteCollection: any; getCollection: any; getSamples: any; getSchema: any; getSourceConfigs: any; listAliasesForCollection: any; listCollections: any; listQueryLambdasInCollection: any; previewCollection: any; setCollectionState: any; uploadFile: any; uploadFilePreviewSource: any; workspaceCollections: any }

  • CollectionsApi - factory interface

    export

    Parameters

    Returns { createCollection: any; createPreviewSource: any; deleteCollection: any; getCollection: any; getSamples: any; getSchema: any; getSourceConfigs: any; listAliasesForCollection: any; listCollections: any; listQueryLambdasInCollection: any; previewCollection: any; setCollectionState: any; uploadFile: any; uploadFilePreviewSource: any; workspaceCollections: any }

Const CollectionsApiFetchParamCreator

  • CollectionsApiFetchParamCreator(configuration?: Configuration): { createCollection: any; createPreviewSource: any; deleteCollection: any; getCollection: any; getSamples: any; getSchema: any; getSourceConfigs: any; listAliasesForCollection: any; listCollections: any; listQueryLambdasInCollection: any; previewCollection: any; setCollectionState: any; uploadFile: any; uploadFilePreviewSource: any; workspaceCollections: any }

  • CollectionsApi - fetch parameter creator

    export

    Parameters

    Returns { createCollection: any; createPreviewSource: any; deleteCollection: any; getCollection: any; getSamples: any; getSchema: any; getSourceConfigs: any; listAliasesForCollection: any; listCollections: any; listQueryLambdasInCollection: any; previewCollection: any; setCollectionState: any; uploadFile: any; uploadFilePreviewSource: any; workspaceCollections: any }

    • createCollection: function
    • createPreviewSource: function
    • deleteCollection: function
      • deleteCollection(workspace: string, collection: string, options?: any): FetchArgs

      • Delete a collection and all its documents from Rockset.

        summary

        Delete Collection

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • collection: string

          name of the collection

        • Default value options: any = {}

        Returns FetchArgs

    • getCollection: function
      • getCollection(workspace: string, collection: string, options?: any): FetchArgs

      • Get details about a collection.

        summary

        Get Collection

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • collection: string

          name of the collection

        • Default value options: any = {}

        Returns FetchArgs

    • getSamples: function
      • getSamples(workspace: string, collection: string, options?: any): FetchArgs

      • Get samples for a collection in Rockset.

        summary

        Get Collection Samples

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • collection: string

          name of the collection

        • Default value options: any = {}

        Returns FetchArgs

    • getSchema: function
      • getSchema(workspace: string, collection: string, depth?: undefined | number, options?: any): FetchArgs

      • Get schema for a collection in Rockset.

        summary

        Get Collection Schema

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • collection: string

          name of the collection

        • Optional depth: undefined | number
        • Default value options: any = {}

        Returns FetchArgs

    • getSourceConfigs: function
    • listAliasesForCollection: function
      • listAliasesForCollection(workspace: string, collection: string, options?: any): FetchArgs

      • Get all Aliases for a specific Rockset Collection.

        summary

        Get Aliases for Collection

        throws

        {RequiredError}

        Parameters

        • workspace: string
        • collection: string
        • Default value options: any = {}

        Returns FetchArgs

    • listCollections: function

      • Retrieve all collections in an organization.

        summary

        List Collections

        throws

        {RequiredError}

        Parameters

        • Default value options: any = {}

        Returns FetchArgs

    • listQueryLambdasInCollection: function
      • listQueryLambdasInCollection(workspace: string, collection: string, options?: any): FetchArgs

      • Get all Query Lambdas that hit a specific Rockset Collection.

        summary

        Get Query Lambdas for Collection

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • collection: string

          name of the collection

        • Default value options: any = {}

        Returns FetchArgs

    • previewCollection: function
    • setCollectionState: function
      • setCollectionState(workspace: string, collection: string, state: "READY" | "PAUSED", options?: any): FetchArgs

      • Update state of a collection.

        summary

        Update state of Collection

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • collection: string

          name of the collection

        • state: "READY" | "PAUSED"

          new state of this collection

        • Default value options: any = {}

        Returns FetchArgs

    • uploadFile: function
    • uploadFilePreviewSource: function

      • Upload a file to a preview source that can be used to generate preview docs

        summary

        Upload File to Preview Source

        throws

        {RequiredError}

        Parameters

        • preview_source_id: string

          preview source identifier

        • body: InputStream

          file input stream

        • body2: FormDataContentDisposition

          file metadata

        • Optional body3: undefined | string
        • Default value options: any = {}

        Returns FetchArgs

    • workspaceCollections: function
      • workspaceCollections(workspace: string, options?: any): FetchArgs

      • Retrieve all collections in a workspace.

        summary

        List Collections for Workspace

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • Default value options: any = {}

        Returns FetchArgs

Const CollectionsApiFp

  • CollectionsApiFp(configuration?: Configuration): { createCollection: any; createPreviewSource: any; deleteCollection: any; getCollection: any; getSamples: any; getSchema: any; getSourceConfigs: any; listAliasesForCollection: any; listCollections: any; listQueryLambdasInCollection: any; previewCollection: any; setCollectionState: any; uploadFile: any; uploadFilePreviewSource: any; workspaceCollections: any }

Const ConsoleApiFactory

  • ConsoleApiFactory(configuration?: Configuration, fetch?: FetchAPI, basePath?: undefined | string): { contactSales: any; getActivity: any; recordActivity: any }

Const ConsoleApiFetchParamCreator

  • ConsoleApiFetchParamCreator(configuration?: Configuration): { contactSales: any; getActivity: any; recordActivity: any }

Const ConsoleApiFp

  • ConsoleApiFp(configuration?: Configuration): { contactSales: any; getActivity: any; recordActivity: any }

Const DefaultApiFactory

  • DefaultApiFactory(configuration?: Configuration, fetch?: FetchAPI, basePath?: undefined | string): { receiveKafkaEvent: any; receiveSegmentEvent: any }

  • DefaultApi - factory interface

    export

    Parameters

    Returns { receiveKafkaEvent: any; receiveSegmentEvent: any }

    • receiveKafkaEvent: function
      • receiveKafkaEvent(options?: any): Promise<Response>
      • throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns Promise<Response>

    • receiveSegmentEvent: function
      • receiveSegmentEvent(options?: any): Promise<Response>
      • throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns Promise<Response>

Const DefaultApiFetchParamCreator

  • DefaultApiFetchParamCreator(configuration?: Configuration): { receiveKafkaEvent: any; receiveSegmentEvent: any }

Const DefaultApiFp

  • DefaultApiFp(configuration?: Configuration): { receiveKafkaEvent: any; receiveSegmentEvent: any }

  • DefaultApi - functional programming interface

    export

    Parameters

    Returns { receiveKafkaEvent: any; receiveSegmentEvent: any }

    • receiveKafkaEvent: function
      • receiveKafkaEvent(options?: any): (fetch?: FetchAPI, basePath?: undefined | string) => Promise<Response>
      • throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns (fetch?: FetchAPI, basePath?: undefined | string) => Promise<Response>

          • (fetch?: FetchAPI, basePath?: undefined | string): Promise<Response>

          • Parameters

            • Optional fetch: FetchAPI
            • Optional basePath: undefined | string

            Returns Promise<Response>

    • receiveSegmentEvent: function
      • receiveSegmentEvent(options?: any): (fetch?: FetchAPI, basePath?: undefined | string) => Promise<Response>
      • throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns (fetch?: FetchAPI, basePath?: undefined | string) => Promise<Response>

          • (fetch?: FetchAPI, basePath?: undefined | string): Promise<Response>

          • Parameters

            • Optional fetch: FetchAPI
            • Optional basePath: undefined | string

            Returns Promise<Response>

Const DocumentsApiFactory

  • DocumentsApiFactory(configuration?: Configuration, fetch?: FetchAPI, basePath?: undefined | string): { addDocuments: any; deleteDocuments: any; patchDocuments: any }

Const DocumentsApiFetchParamCreator

  • DocumentsApiFetchParamCreator(configuration?: Configuration): { addDocuments: any; deleteDocuments: any; patchDocuments: any }

  • DocumentsApi - fetch parameter creator

    export

    Parameters

    Returns { addDocuments: any; deleteDocuments: any; patchDocuments: any }

    • addDocuments: function

      • Add documents to a collection.

        summary

        Add Documents

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • collection: string

          name of the collection

        • body: AddDocumentsRequest

          JSON object

        • Default value options: any = {}

        Returns FetchArgs

    • deleteDocuments: function

      • Delete documents from a collection.

        summary

        Delete Documents

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • collection: string

          name of the collection

        • body: DeleteDocumentsRequest

          JSON object

        • Default value options: any = {}

        Returns FetchArgs

    • patchDocuments: function

      • Update existing documents in a collection.

        summary

        Patch Documents

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • collection: string

          name of the collection

        • body: PatchDocumentsRequest

          JSON Patch objects

        • Default value options: any = {}

        Returns FetchArgs

Const DocumentsApiFp

  • DocumentsApiFp(configuration?: Configuration): { addDocuments: any; deleteDocuments: any; patchDocuments: any }

Const IntegrationsApiFactory

  • IntegrationsApiFactory(configuration?: Configuration, fetch?: FetchAPI, basePath?: undefined | string): { createIntegration: any; deleteIntegration: any; getIntegration: any; listIntegrations: any; verifyIntegration: any }

Const IntegrationsApiFetchParamCreator

  • IntegrationsApiFetchParamCreator(configuration?: Configuration): { createIntegration: any; deleteIntegration: any; getIntegration: any; listIntegrations: any; verifyIntegration: any }

  • IntegrationsApi - fetch parameter creator

    export

    Parameters

    Returns { createIntegration: any; deleteIntegration: any; getIntegration: any; listIntegrations: any; verifyIntegration: any }

    • createIntegration: function
    • deleteIntegration: function
      • deleteIntegration(integration: string, options?: any): FetchArgs

      • Remove an integration.

        summary

        Delete Integration

        throws

        {RequiredError}

        Parameters

        • integration: string

          name of the integration

        • Default value options: any = {}

        Returns FetchArgs

    • getIntegration: function
      • getIntegration(integration: string, options?: any): FetchArgs

      • Get information about a single integration.

        summary

        Get Integration

        throws

        {RequiredError}

        Parameters

        • integration: string

          name of the integration

        • Default value options: any = {}

        Returns FetchArgs

    • listIntegrations: function

      • List all integrations in an organization.

        summary

        List Integrations

        throws

        {RequiredError}

        Parameters

        • Default value options: any = {}

        Returns FetchArgs

    • verifyIntegration: function
      • verifyIntegration(integration: string, options?: any): FetchArgs

      • Verify that an integration is healthy.

        summary

        Verify Integration

        throws

        {RequiredError}

        Parameters

        • integration: string

          name of the integration

        • Default value options: any = {}

        Returns FetchArgs

Const IntegrationsApiFp

  • IntegrationsApiFp(configuration?: Configuration): { createIntegration: any; deleteIntegration: any; getIntegration: any; listIntegrations: any; verifyIntegration: any }

Const OrganizationsApiFactory

  • OrganizationsApiFactory(configuration?: Configuration, fetch?: FetchAPI, basePath?: undefined | string): { getOrganization: any; getOrganizationCompute: any; getOrganizationIngest: any; getOrganizationRecentActivity: any; getOrganizationSettings: any; getOrganizationStorage: any; getOrganizationTrialCredit: any; getOrganizationUsage: any; getPaymentMethod: any; getPaymentSource: any; getSsoSettings: any; updatePaymentSource: any; updateSsoSettings: any }

  • OrganizationsApi - factory interface

    export

    Parameters

    Returns { getOrganization: any; getOrganizationCompute: any; getOrganizationIngest: any; getOrganizationRecentActivity: any; getOrganizationSettings: any; getOrganizationStorage: any; getOrganizationTrialCredit: any; getOrganizationUsage: any; getPaymentMethod: any; getPaymentSource: any; getSsoSettings: any; updatePaymentSource: any; updateSsoSettings: any }

    • getOrganization: function
    • getOrganizationCompute: function
      • 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}

        Parameters

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

        Returns Promise<OrgComputeResponse>

    • getOrganizationIngest: function
      • 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}

        Parameters

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

        Returns Promise<OrgIngestResponse>

    • getOrganizationRecentActivity: function
    • getOrganizationSettings: function
    • getOrganizationStorage: function
      • 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}

        Parameters

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

        Returns Promise<OrgStorageResponse>

    • getOrganizationTrialCredit: function
      • 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}

        Parameters

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

        Returns Promise<OrgTrialUsageResponse>

    • getOrganizationUsage: function

      • Retrieve usage levels for current organization.

        summary

        Get Organization Usage

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns Promise<OrgUsageResponse>

    • getPaymentMethod: function

      • Get the payment information for your organization.

        summary

        Retrieve payment information about payment method

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns Promise<OrgPaymentMethodResponse>

    • getPaymentSource: function

      • Get stored payment information for your organization.

        summary

        Retrieve payment information

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns Promise<OrgInvoicesResponse>

    • getSsoSettings: function
    • updatePaymentSource: function
    • updateSsoSettings: function

Const OrganizationsApiFetchParamCreator

  • OrganizationsApiFetchParamCreator(configuration?: Configuration): { getOrganization: any; getOrganizationCompute: any; getOrganizationIngest: any; getOrganizationRecentActivity: any; getOrganizationSettings: any; getOrganizationStorage: any; getOrganizationTrialCredit: any; getOrganizationUsage: any; getPaymentMethod: any; getPaymentSource: any; getSsoSettings: any; updatePaymentSource: any; updateSsoSettings: any }

  • OrganizationsApi - fetch parameter creator

    export

    Parameters

    Returns { getOrganization: any; getOrganizationCompute: any; getOrganizationIngest: any; getOrganizationRecentActivity: any; getOrganizationSettings: any; getOrganizationStorage: any; getOrganizationTrialCredit: any; getOrganizationUsage: any; getPaymentMethod: any; getPaymentSource: any; getSsoSettings: any; updatePaymentSource: any; updateSsoSettings: any }

    • getOrganization: function

      • Retrieve information about current organization.

        summary

        Get Organization

        throws

        {RequiredError}

        Parameters

        • Default value options: any = {}

        Returns FetchArgs

    • getOrganizationCompute: function
      • getOrganizationCompute(month?: undefined | string, year?: undefined | string, options?: any): FetchArgs

      • Retrieve usage levels for current organization.

        summary

        Get Organization Compute Time-Series data

        throws

        {RequiredError}

        Parameters

        • Optional month: undefined | string
        • Optional year: undefined | string
        • Default value options: any = {}

        Returns FetchArgs

    • getOrganizationIngest: function
      • getOrganizationIngest(month?: undefined | string, year?: undefined | string, options?: any): FetchArgs

      • Retrieve usage levels for current organization.

        summary

        Get Organization ingest usage data

        throws

        {RequiredError}

        Parameters

        • Optional month: undefined | string
        • Optional year: undefined | string
        • Default value options: any = {}

        Returns FetchArgs

    • getOrganizationRecentActivity: function
      • getOrganizationRecentActivity(options?: any): FetchArgs

      • Get information about organization's recent activity.

        summary

        Get Organization Recent Activity

        throws

        {RequiredError}

        Parameters

        • Default value options: any = {}

        Returns FetchArgs

    • getOrganizationSettings: function
      • getOrganizationSettings(options?: any): FetchArgs

      • Retrieve settings for current organization.

        summary

        Get Organization Settings

        throws

        {RequiredError}

        Parameters

        • Default value options: any = {}

        Returns FetchArgs

    • getOrganizationStorage: function
      • getOrganizationStorage(month?: undefined | string, year?: undefined | string, options?: any): FetchArgs

      • Retrieve usage levels for current organization.

        summary

        Get Organization Storage Time-Series data

        throws

        {RequiredError}

        Parameters

        • Optional month: undefined | string
        • Optional year: undefined | string
        • Default value options: any = {}

        Returns FetchArgs

    • getOrganizationTrialCredit: function
      • getOrganizationTrialCredit(month?: undefined | string, year?: undefined | string, options?: any): FetchArgs

      • Retrieve usage levels for current organization.

        summary

        Get Organization trial credit usage data

        throws

        {RequiredError}

        Parameters

        • Optional month: undefined | string
        • Optional year: undefined | string
        • Default value options: any = {}

        Returns FetchArgs

    • getOrganizationUsage: function
      • getOrganizationUsage(options?: any): FetchArgs

      • Retrieve usage levels for current organization.

        summary

        Get Organization Usage

        throws

        {RequiredError}

        Parameters

        • Default value options: any = {}

        Returns FetchArgs

    • getPaymentMethod: function

      • Get the payment information for your organization.

        summary

        Retrieve payment information about payment method

        throws

        {RequiredError}

        Parameters

        • Default value options: any = {}

        Returns FetchArgs

    • getPaymentSource: function

      • Get stored payment information for your organization.

        summary

        Retrieve payment information

        throws

        {RequiredError}

        Parameters

        • Default value options: any = {}

        Returns FetchArgs

    • getSsoSettings: function

      • Get stored sso information for your organization.

        summary

        Retrieve sso settings

        throws

        {RequiredError}

        Parameters

        • Default value options: any = {}

        Returns FetchArgs

    • updatePaymentSource: function
    • updateSsoSettings: function

Const OrganizationsApiFp

  • OrganizationsApiFp(configuration?: Configuration): { getOrganization: any; getOrganizationCompute: any; getOrganizationIngest: any; getOrganizationRecentActivity: any; getOrganizationSettings: any; getOrganizationStorage: any; getOrganizationTrialCredit: any; getOrganizationUsage: any; getPaymentMethod: any; getPaymentSource: any; getSsoSettings: any; updatePaymentSource: any; updateSsoSettings: any }

Const ProvisionApiFactory

  • ProvisionApiFactory(configuration?: Configuration, fetch?: FetchAPI, basePath?: undefined | string): { provisionOrganization: any; provisionUser: any; verifyEmail: any }

  • ProvisionApi - factory interface

    export

    Parameters

    Returns { provisionOrganization: any; provisionUser: any; verifyEmail: any }

    • provisionOrganization: function
    • provisionUser: function
      • provisionUser(options?: any): Promise<Response>
      • summary

        Provision a user

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns Promise<Response>

    • verifyEmail: function
      • verifyEmail(options?: any): Promise<Response>
      • summary

        Resend verification email

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns Promise<Response>

Const ProvisionApiFetchParamCreator

  • ProvisionApiFetchParamCreator(configuration?: Configuration): { provisionOrganization: any; provisionUser: any; verifyEmail: any }

Const ProvisionApiFp

  • ProvisionApiFp(configuration?: Configuration): { provisionOrganization: any; provisionUser: any; verifyEmail: any }

  • ProvisionApi - functional programming interface

    export

    Parameters

    Returns { provisionOrganization: any; provisionUser: any; verifyEmail: any }

    • provisionOrganization: function
      • summary

        Provision an organization

        throws

        {RequiredError}

        Parameters

        Returns (fetch?: FetchAPI, basePath?: undefined | string) => Promise<Response>

          • (fetch?: FetchAPI, basePath?: undefined | string): Promise<Response>

          • Parameters

            • Optional fetch: FetchAPI
            • Optional basePath: undefined | string

            Returns Promise<Response>

    • provisionUser: function
      • provisionUser(options?: any): (fetch?: FetchAPI, basePath?: undefined | string) => Promise<Response>
      • summary

        Provision a user

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns (fetch?: FetchAPI, basePath?: undefined | string) => Promise<Response>

          • (fetch?: FetchAPI, basePath?: undefined | string): Promise<Response>

          • Parameters

            • Optional fetch: FetchAPI
            • Optional basePath: undefined | string

            Returns Promise<Response>

    • verifyEmail: function
      • verifyEmail(options?: any): (fetch?: FetchAPI, basePath?: undefined | string) => Promise<Response>
      • summary

        Resend verification email

        throws

        {RequiredError}

        Parameters

        • Optional options: any

        Returns (fetch?: FetchAPI, basePath?: undefined | string) => Promise<Response>

          • (fetch?: FetchAPI, basePath?: undefined | string): Promise<Response>

          • Parameters

            • Optional fetch: FetchAPI
            • Optional basePath: undefined | string

            Returns Promise<Response>

Const QueriesApiFactory

  • QueriesApiFactory(configuration?: Configuration, fetch?: FetchAPI, basePath?: undefined | string): { getQueryPlan: any; getQueryStats: any; query: any; validate: any; validateExpression: any }

Const QueriesApiFetchParamCreator

  • QueriesApiFetchParamCreator(configuration?: Configuration): { getQueryPlan: any; getQueryStats: any; query: any; validate: any; validateExpression: any }

  • QueriesApi - fetch parameter creator

    export

    Parameters

    Returns { getQueryPlan: any; getQueryStats: any; query: any; validate: any; validateExpression: any }

Const QueriesApiFp

  • QueriesApiFp(configuration?: Configuration): { getQueryPlan: any; getQueryStats: any; query: any; validate: any; validateExpression: any }

Const QueryLambdasApiFactory

  • QueryLambdasApiFactory(configuration?: Configuration, fetch?: FetchAPI, basePath?: undefined | string): { createQueryLambda: any; createQueryLambdaTag: any; deleteQueryLambda: any; deleteQueryLambdaTag: any; deleteQueryLambdaVersion: any; executeQueryLambda: any; executeQueryLambdaByTag: any; getAggregateQueryLambdaStats: any; getQueryLambdaTagVersion: any; getQueryLambdaVersion: any; listAllQueryLambdas: any; listOrganizationTags: any; listQueryLambdaTagVersions: any; listQueryLambdaTags: any; listQueryLambdaVersions: any; listQueryLambdasInWorkspace: any; updateQueryLambda: any }

  • QueryLambdasApi - factory interface

    export

    Parameters

    Returns { createQueryLambda: any; createQueryLambdaTag: any; deleteQueryLambda: any; deleteQueryLambdaTag: any; deleteQueryLambdaVersion: any; executeQueryLambda: any; executeQueryLambdaByTag: any; getAggregateQueryLambdaStats: any; getQueryLambdaTagVersion: any; getQueryLambdaVersion: any; listAllQueryLambdas: any; listOrganizationTags: any; listQueryLambdaTagVersions: any; listQueryLambdaTags: any; listQueryLambdaVersions: any; listQueryLambdasInWorkspace: any; updateQueryLambda: any }

    • createQueryLambda: function
    • createQueryLambdaTag: function

      • Create a tag for a specific Query Lambda version, or update that tag if it already exists.

        summary

        Create Query Lambda Tag

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • queryLambda: string

          name of the Query Lambda

        • body: CreateQueryLambdaTagRequest

          JSON object

        • Optional options: any

        Returns Promise<QueryLambdaTagResponse>

    • deleteQueryLambda: function

      • Delete a Query Lambda.

        summary

        Delete Query Lambda

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • queryLambda: string

          name of the Query Lambda

        • Optional options: any

        Returns Promise<DeleteQueryLambdaResponse>

    • deleteQueryLambdaTag: function
      • deleteQueryLambdaTag(workspace: string, queryLambda: string, tag: string, options?: any): Promise<QueryLambdaTagResponse>

      • Delete a tag for a specific Query Lambda

        summary

        Delete Query Lambda Tag Version

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • queryLambda: string

          name of the Query Lambda

        • tag: string

          name of the tag

        • Optional options: any

        Returns Promise<QueryLambdaTagResponse>

    • deleteQueryLambdaVersion: function
      • deleteQueryLambdaVersion(workspace: string, queryLambda: string, version: string, options?: any): Promise<QueryLambdaVersionResponse>

      • Delete a Query Lambda version.

        summary

        Delete Query Lambda Version

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • queryLambda: string

          name of the Query Lambda

        • version: string

          version

        • Optional options: any

        Returns Promise<QueryLambdaVersionResponse>

    • executeQueryLambda: function

      • Execute a particular version of a Query Lambda.

        summary

        Execute Query Lambda

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • queryLambda: string

          name of the Query Lambda

        • version: string

          version

        • Optional body: ExecuteQueryLambdaRequest
        • Optional options: any

        Returns Promise<QueryResponse>

    • executeQueryLambdaByTag: function

      • Execute the Query Lambda version associated with a given tag.

        summary

        Execute Query Lambda By Tag

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • queryLambda: string

          name of the Query Lambda

        • tag: string

          tag

        • Optional body: ExecuteQueryLambdaRequest
        • Optional options: any

        Returns Promise<QueryResponse>

    • getAggregateQueryLambdaStats: function
      • getAggregateQueryLambdaStats(workspace: string, queryLambda: string, version: string, start: number, end: number, interval?: undefined | number, options?: any): Promise<AggregateQueryLambdaStatsResponse>

      • Get aggregate Query Lambda usage data for a time window, at requested intervals.

        summary

        Get Query Lambda Stats

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • queryLambda: string

          name of the Query Lambda

        • version: string

          version

        • start: number

          start time (ms)

        • end: number

          end time (ms)

        • Optional interval: undefined | number
        • Optional options: any

        Returns Promise<AggregateQueryLambdaStatsResponse>

    • getQueryLambdaTagVersion: function
      • getQueryLambdaTagVersion(workspace: string, queryLambda: string, tag: string, options?: any): Promise<QueryLambdaTagResponse>

      • Get the Query Lambda version associated with a given tag.

        summary

        Get Query Lambda Tag

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • queryLambda: string

          name of the Query Lambda

        • tag: string

          name of the tag

        • Optional options: any

        Returns Promise<QueryLambdaTagResponse>

    • getQueryLambdaVersion: function
      • getQueryLambdaVersion(workspace: string, queryLambda: string, version: string, options?: any): Promise<QueryLambdaVersionResponse>

      • Get details for a specified version of a Query Lambda.

        summary

        Get Query Lambda Version

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • queryLambda: string

          name of the Query Lambda

        • version: string

          version

        • Optional options: any

        Returns Promise<QueryLambdaVersionResponse>

    • listAllQueryLambdas: function
    • listOrganizationTags: function
    • listQueryLambdaTagVersions: function
    • listQueryLambdaTags: function

      • List all tags associated with a Query Lambda

        summary

        List Query Lambda Tags

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • queryLambda: string

          name of the Query Lambda

        • Optional options: any

        Returns Promise<ListQueryLambdaTagsResponse>

    • listQueryLambdaVersions: function

      • List all versions of a Query Lambda.

        summary

        List Query Lambda Versions

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • queryLambda: string

          name of the Query Lambda

        • Optional options: any

        Returns Promise<ListQueryLambdaVersionsResponse>

    • listQueryLambdasInWorkspace: function

      • List all Query Lambdas under given workspace.

        summary

        List Query Lambdas in Workspace

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • Optional options: any

        Returns Promise<ListQueryLambdasResponse>

    • updateQueryLambda: function

      • Create a new version of a Query Lambda in given workspace.

        summary

        Update Query Lambda

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • queryLambda: string

          name of the Query Lambda

        • body: UpdateQueryLambdaRequest

          JSON object

        • Optional create: undefined | false | true
        • Optional options: any

        Returns Promise<QueryLambdaVersionResponse>

Const QueryLambdasApiFetchParamCreator

  • QueryLambdasApiFetchParamCreator(configuration?: Configuration): { createQueryLambda: any; createQueryLambdaTag: any; deleteQueryLambda: any; deleteQueryLambdaTag: any; deleteQueryLambdaVersion: any; executeQueryLambda: any; executeQueryLambdaByTag: any; getAggregateQueryLambdaStats: any; getQueryLambdaTagVersion: any; getQueryLambdaVersion: any; listAllQueryLambdas: any; listOrganizationTags: any; listQueryLambdaTagVersions: any; listQueryLambdaTags: any; listQueryLambdaVersions: any; listQueryLambdasInWorkspace: any; updateQueryLambda: any }

  • QueryLambdasApi - fetch parameter creator

    export

    Parameters

    Returns { createQueryLambda: any; createQueryLambdaTag: any; deleteQueryLambda: any; deleteQueryLambdaTag: any; deleteQueryLambdaVersion: any; executeQueryLambda: any; executeQueryLambdaByTag: any; getAggregateQueryLambdaStats: any; getQueryLambdaTagVersion: any; getQueryLambdaVersion: any; listAllQueryLambdas: any; listOrganizationTags: any; listQueryLambdaTagVersions: any; listQueryLambdaTags: any; listQueryLambdaVersions: any; listQueryLambdasInWorkspace: any; updateQueryLambda: any }

    • createQueryLambda: function
    • createQueryLambdaTag: function

      • Create a tag for a specific Query Lambda version, or update that tag if it already exists.

        summary

        Create Query Lambda Tag

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • queryLambda: string

          name of the Query Lambda

        • body: CreateQueryLambdaTagRequest

          JSON object

        • Default value options: any = {}

        Returns FetchArgs

    • deleteQueryLambda: function
      • deleteQueryLambda(workspace: string, queryLambda: string, options?: any): FetchArgs

      • Delete a Query Lambda.

        summary

        Delete Query Lambda

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • queryLambda: string

          name of the Query Lambda

        • Default value options: any = {}

        Returns FetchArgs

    • deleteQueryLambdaTag: function
      • deleteQueryLambdaTag(workspace: string, queryLambda: string, tag: string, options?: any): FetchArgs

      • Delete a tag for a specific Query Lambda

        summary

        Delete Query Lambda Tag Version

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • queryLambda: string

          name of the Query Lambda

        • tag: string

          name of the tag

        • Default value options: any = {}

        Returns FetchArgs

    • deleteQueryLambdaVersion: function
      • deleteQueryLambdaVersion(workspace: string, queryLambda: string, version: string, options?: any): FetchArgs

      • Delete a Query Lambda version.

        summary

        Delete Query Lambda Version

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • queryLambda: string

          name of the Query Lambda

        • version: string

          version

        • Default value options: any = {}

        Returns FetchArgs

    • executeQueryLambda: function

      • Execute a particular version of a Query Lambda.

        summary

        Execute Query Lambda

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • queryLambda: string

          name of the Query Lambda

        • version: string

          version

        • Optional body: ExecuteQueryLambdaRequest
        • Default value options: any = {}

        Returns FetchArgs

    • executeQueryLambdaByTag: function

      • Execute the Query Lambda version associated with a given tag.

        summary

        Execute Query Lambda By Tag

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • queryLambda: string

          name of the Query Lambda

        • tag: string

          tag

        • Optional body: ExecuteQueryLambdaRequest
        • Default value options: any = {}

        Returns FetchArgs

    • getAggregateQueryLambdaStats: function
      • getAggregateQueryLambdaStats(workspace: string, queryLambda: string, version: string, start: number, end: number, interval?: undefined | number, options?: any): FetchArgs

      • Get aggregate Query Lambda usage data for a time window, at requested intervals.

        summary

        Get Query Lambda Stats

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • queryLambda: string

          name of the Query Lambda

        • version: string

          version

        • start: number

          start time (ms)

        • end: number

          end time (ms)

        • Optional interval: undefined | number
        • Default value options: any = {}

        Returns FetchArgs

    • getQueryLambdaTagVersion: function
      • getQueryLambdaTagVersion(workspace: string, queryLambda: string, tag: string, options?: any): FetchArgs

      • Get the Query Lambda version associated with a given tag.

        summary

        Get Query Lambda Tag

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • queryLambda: string

          name of the Query Lambda

        • tag: string

          name of the tag

        • Default value options: any = {}

        Returns FetchArgs

    • getQueryLambdaVersion: function
      • getQueryLambdaVersion(workspace: string, queryLambda: string, version: string, options?: any): FetchArgs

      • Get details for a specified version of a Query Lambda.

        summary

        Get Query Lambda Version

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • queryLambda: string

          name of the Query Lambda

        • version: string

          version

        • Default value options: any = {}

        Returns FetchArgs

    • listAllQueryLambdas: function
      • listAllQueryLambdas(options?: any): FetchArgs

      • List all Query Lambdas in an organization.

        summary

        List Query Lambdas

        throws

        {RequiredError}

        Parameters

        • Default value options: any = {}

        Returns FetchArgs

    • listOrganizationTags: function
      • listOrganizationTags(options?: any): FetchArgs

      • List all distinct Query Lambda tags in an organization.

        summary

        List All Query Lambda Tags

        throws

        {RequiredError}

        Parameters

        • Default value options: any = {}

        Returns FetchArgs

    • listQueryLambdaTagVersions: function
      • listQueryLambdaTagVersions(tag: string, options?: any): FetchArgs

      • List all Query Lambda versions associated with a given tag.

        summary

        List Query Lambda Tag Versions

        throws

        {RequiredError}

        Parameters

        • tag: string

          name of the tag

        • Default value options: any = {}

        Returns FetchArgs

    • listQueryLambdaTags: function
      • listQueryLambdaTags(workspace: string, queryLambda: string, options?: any): FetchArgs

      • List all tags associated with a Query Lambda

        summary

        List Query Lambda Tags

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • queryLambda: string

          name of the Query Lambda

        • Default value options: any = {}

        Returns FetchArgs

    • listQueryLambdaVersions: function
      • listQueryLambdaVersions(workspace: string, queryLambda: string, options?: any): FetchArgs

      • List all versions of a Query Lambda.

        summary

        List Query Lambda Versions

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • queryLambda: string

          name of the Query Lambda

        • Default value options: any = {}

        Returns FetchArgs

    • listQueryLambdasInWorkspace: function
      • listQueryLambdasInWorkspace(workspace: string, options?: any): FetchArgs

      • List all Query Lambdas under given workspace.

        summary

        List Query Lambdas in Workspace

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • Default value options: any = {}

        Returns FetchArgs

    • updateQueryLambda: function

      • Create a new version of a Query Lambda in given workspace.

        summary

        Update Query Lambda

        throws

        {RequiredError}

        Parameters

        • workspace: string

          name of the workspace

        • queryLambda: string

          name of the Query Lambda

        • body: UpdateQueryLambdaRequest

          JSON object

        • Optional create: undefined | false | true
        • Default value options: any = {}

        Returns FetchArgs

Const QueryLambdasApiFp

  • QueryLambdasApiFp(configuration?: Configuration): { createQueryLambda: any; createQueryLambdaTag: any; deleteQueryLambda: any; deleteQueryLambdaTag: any; deleteQueryLambdaVersion: any; executeQueryLambda: any; executeQueryLambdaByTag: any; getAggregateQueryLambdaStats: any; getQueryLambdaTagVersion: any; getQueryLambdaVersion: any; listAllQueryLambdas: any; listOrganizationTags: any; listQueryLambdaTagVersions: any; listQueryLambdaTags: any; listQueryLambdaVersions: any; listQueryLambdasInWorkspace: any; updateQueryLambda: any }