Class: DocuSign_Monitor::GetStreamOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_monitor/api/data_set_api.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#cursor ⇒ Object

Specifies a pointer into the dataset where your query will begin. You can either provide an ISO DateTime or a string cursor (from the ‘endCursor` value in the response). If no value is provided, the query begins from seven days ago. For example, to fetch event data beginning from January 1, 2022, set this value to `2022-01-01T00:00:00Z`. The response will include data about events starting from that date in chronological order. The response also includes an `endCursor` property. To fetch the next page of event data, call this endpoint again with `cursor` set to the previous `endCursor` value.



18
19
20
 
# File 'lib/docusign_monitor/api/data_set_api.rb', line 18

def cursor
  @cursor
end

#limit ⇒ Object

The maximum number of records to return. The default value is 1000.



21
22
23
 
# File 'lib/docusign_monitor/api/data_set_api.rb', line 21

def limit
  @limit
end

Class Method Details

.default ⇒ Object 



23
24
25
 
# File 'lib/docusign_monitor/api/data_set_api.rb', line 23

def self.default
  @@default ||= GetStreamOptions.new
end