Class: PlatformAPI::Archive

Inherits:
Object
  • Object
show all
Defined in:
lib/platform-api/client.rb

Overview

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

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Archive

Returns a new instance of Archive.



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

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



1499
1500
1501
# File 'lib/platform-api/client.rb', line 1499

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

#list(enterprise_account_id) ⇒ Object

List existing archives.

Parameters:

  • enterprise_account_id:

    unique identifier of the enterprise account



1506
1507
1508
# File 'lib/platform-api/client.rb', line 1506

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