Class: PlatformAPI::Archive

Inherits:

Object

• Object
• PlatformAPI::Archive

Defined in:

lib/platform-api/client.rb

Overview

An audit trail archive represents a monthly json zipped file containing events

Instance Method Summary

• #info(enterprise_account_id, archive_year, archive_month) ⇒ Object

  Get archive for a single month.

• #initialize(client) ⇒ Archive constructor

  A new instance of Archive.

• #list(enterprise_account_id) ⇒ Object

  List existing archives.

Constructor Details

#initialize(client) ⇒ Archive

Returns a new instance of Archive.

# File 'lib/platform-api/client.rb', line 1476

def initialize(client)
  @client = client
end

Instance Method Details

#info(enterprise_account_id, archive_year, archive_month) ⇒ Object

Get archive for a single month.

Parameters:

• enterprise_account_id: —

  unique identifier of the enterprise account

• archive_year: —

  year of the archive

• archive_month: —

  month of the archive

# File 'lib/platform-api/client.rb', line 1485

def info(enterprise_account_id, archive_year, archive_month)
  @client.archive.info(enterprise_account_id, archive_year, archive_month)
end

#list(enterprise_account_id) ⇒ Object

List existing archives.

Parameters:

• enterprise_account_id: —

  unique identifier of the enterprise account

# File 'lib/platform-api/client.rb', line 1492

def list(enterprise_account_id)
  @client.archive.list(enterprise_account_id)
end