Class OneTimeExportService

constructor

• new OneTimeExportService(sdk: SDKInterface): OneTimeExportService

  Creates a client that uses the SDK service address.

  Parameters

  • sdk: SDKInterface

  Returns OneTimeExportService

$type

create

• create(
      request: CreateOneTimeExportRequest,
  ): Request<CreateOneTimeExportRequest, Operation<GetOperationRequest>>

  Creates a new one-time export of billing reports for the requested period.

  Parameters

  • request: CreateOneTimeExportRequest

  Returns Request<CreateOneTimeExportRequest, Operation<GetOperationRequest>>

• create(
      request: CreateOneTimeExportRequest,
      metadata: Metadata,
  ): Request<CreateOneTimeExportRequest, Operation<GetOperationRequest>>

  Creates a new one-time export of billing reports for the requested period.

  Parameters

  • request: CreateOneTimeExportRequest
  • metadata: Metadata

  Returns Request<CreateOneTimeExportRequest, Operation<GetOperationRequest>>

• create(
      request: CreateOneTimeExportRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<CreateOneTimeExportRequest, Operation<GetOperationRequest>>

  Creates a new one-time export of billing reports for the requested period.

  Parameters

  • request: CreateOneTimeExportRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<CreateOneTimeExportRequest, Operation<GetOperationRequest>>

• create(
      request: CreateOneTimeExportRequest,
  ): Request<CreateOneTimeExportRequest, Operation<GetOperationRequest>>

  Creates a new one-time export of billing reports for the requested period.

  Parameters

  • request: CreateOneTimeExportRequest

  Returns Request<CreateOneTimeExportRequest, Operation<GetOperationRequest>>

• create(
      request: CreateOneTimeExportRequest,
      metadata: Metadata,
  ): Request<CreateOneTimeExportRequest, Operation<GetOperationRequest>>

  Creates a new one-time export of billing reports for the requested period.

  Parameters

  • request: CreateOneTimeExportRequest
  • metadata: Metadata

  Returns Request<CreateOneTimeExportRequest, Operation<GetOperationRequest>>

• create(
      request: CreateOneTimeExportRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<CreateOneTimeExportRequest, Operation<GetOperationRequest>>

  Creates a new one-time export of billing reports for the requested period.

  Parameters

  • request: CreateOneTimeExportRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<CreateOneTimeExportRequest, Operation<GetOperationRequest>>

filter

• filter(
      request: ListOneTimeExportsRequest,
      metadata?: Metadata,
      options?: Partial<CallOptions> & RetryOptions,
  ): AsyncGenerator<OneTimeExport>

  Calls the filter method.

  Parameters

  • request: ListOneTimeExportsRequest
  • Optionalmetadata: Metadata
  • Optionaloptions: Partial<CallOptions> & RetryOptions

  Returns AsyncGenerator<OneTimeExport>

• filter(
      request: ListOneTimeExportsRequest,
      metadata?: Metadata,
      options?: Partial<CallOptions> & RetryOptions,
  ): AsyncGenerator<OneTimeExport>

  Yields list items across pages, without changing the supplied request.

  Parameters

  • request: ListOneTimeExportsRequest
  • Optionalmetadata: Metadata
  • Optionaloptions: Partial<CallOptions> & RetryOptions

  Returns AsyncGenerator<OneTimeExport>

get

• get(
      request: GetOneTimeExportRequest,
  ): Request<GetOneTimeExportRequest, OneTimeExport>

  Retrieves details of a specific one-time export. When the export is complete, the response includes a fresh presigned download URL.

  Parameters

  • request: GetOneTimeExportRequest

  Returns Request<GetOneTimeExportRequest, OneTimeExport>

• get(
      request: GetOneTimeExportRequest,
      metadata: Metadata,
  ): Request<GetOneTimeExportRequest, OneTimeExport>

  Retrieves details of a specific one-time export. When the export is complete, the response includes a fresh presigned download URL.

  Parameters

  • request: GetOneTimeExportRequest
  • metadata: Metadata

  Returns Request<GetOneTimeExportRequest, OneTimeExport>

• get(
      request: GetOneTimeExportRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetOneTimeExportRequest, OneTimeExport>

  Retrieves details of a specific one-time export. When the export is complete, the response includes a fresh presigned download URL.

  Parameters

  • request: GetOneTimeExportRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetOneTimeExportRequest, OneTimeExport>

• get(
      request: GetOneTimeExportRequest,
  ): Request<GetOneTimeExportRequest, OneTimeExport>

  Retrieves details of a specific one-time export. When the export is complete, the response includes a fresh presigned download URL.

  Parameters

  • request: GetOneTimeExportRequest

  Returns Request<GetOneTimeExportRequest, OneTimeExport>

• get(
      request: GetOneTimeExportRequest,
      metadata: Metadata,
  ): Request<GetOneTimeExportRequest, OneTimeExport>

  Retrieves details of a specific one-time export. When the export is complete, the response includes a fresh presigned download URL.

  Parameters

  • request: GetOneTimeExportRequest
  • metadata: Metadata

  Returns Request<GetOneTimeExportRequest, OneTimeExport>

• get(
      request: GetOneTimeExportRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetOneTimeExportRequest, OneTimeExport>

  Retrieves details of a specific one-time export. When the export is complete, the response includes a fresh presigned download URL.

  Parameters

  • request: GetOneTimeExportRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetOneTimeExportRequest, OneTimeExport>

getOperationService

• getOperationService(): OperationService

  Returns the operation service for this service address.

  Returns OperationService

list

• list(
      request: ListOneTimeExportsRequest,
  ): Request<ListOneTimeExportsRequest, ListOneTimeExportsResponse>

  Lists one-time exports for a given contract.

  Parameters

  • request: ListOneTimeExportsRequest

  Returns Request<ListOneTimeExportsRequest, ListOneTimeExportsResponse>

• list(
      request: ListOneTimeExportsRequest,
      metadata: Metadata,
  ): Request<ListOneTimeExportsRequest, ListOneTimeExportsResponse>

  Lists one-time exports for a given contract.

  Parameters

  • request: ListOneTimeExportsRequest
  • metadata: Metadata

  Returns Request<ListOneTimeExportsRequest, ListOneTimeExportsResponse>

• list(
      request: ListOneTimeExportsRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListOneTimeExportsRequest, ListOneTimeExportsResponse>

  Lists one-time exports for a given contract.

  Parameters

  • request: ListOneTimeExportsRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListOneTimeExportsRequest, ListOneTimeExportsResponse>

• list(
      request: ListOneTimeExportsRequest,
  ): Request<ListOneTimeExportsRequest, ListOneTimeExportsResponse>

  Lists one-time exports for a given contract.

  Parameters

  • request: ListOneTimeExportsRequest

  Returns Request<ListOneTimeExportsRequest, ListOneTimeExportsResponse>

• list(
      request: ListOneTimeExportsRequest,
      metadata: Metadata,
  ): Request<ListOneTimeExportsRequest, ListOneTimeExportsResponse>

  Lists one-time exports for a given contract.

  Parameters

  • request: ListOneTimeExportsRequest
  • metadata: Metadata

  Returns Request<ListOneTimeExportsRequest, ListOneTimeExportsResponse>

• list(
      request: ListOneTimeExportsRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListOneTimeExportsRequest, ListOneTimeExportsResponse>

  Lists one-time exports for a given contract.

  Parameters

  • request: ListOneTimeExportsRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListOneTimeExportsRequest, ListOneTimeExportsResponse>

listOperations

• listOperations(
      request: ListOperationsRequest,
      metadata?: Metadata,
      options?: Partial<CallOptions> & RetryOptions,
  ): Request<ListOperationsRequest>

  Lists operations for this service address.

  Parameters

  • request: ListOperationsRequest
  • metadata: Metadata = ...
  • options: Partial<CallOptions> & RetryOptions = {}

  Returns Request<ListOperationsRequest>