Class: DocuSign_Rooms::GetRoomsOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_rooms/api/rooms_api.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#count ⇒ Object

Number of rooms to return. Defaults to the maximum which is 100.



87
88
89
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 87

def count
  @count
end

#field_data_changed_end_date ⇒ Object

Fields-data changed end DateTime in UTC. Valid formats: yyyy-mm-dd hh:mm:ss or yyyy/mm/dd hh:mm:ss -Time is optional and will default to 00:00:00.



102
103
104
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 102

def field_data_changed_end_date
  @field_data_changed_end_date
end

#field_data_changed_start_date ⇒ Object

Fields data changed start datetime in UTC. Valid formats: yyyy-mm-dd hh:mm:ss or yyyy/mm/dd hh:mm:ss -Time is optional and will default to 00:00:00.



99
100
101
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 99

def field_data_changed_start_date
  @field_data_changed_start_date
end

#office_id ⇒ Object

Only return rooms in this office.



96
97
98
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 96

def office_id
  @office_id
end

#room_closed_end_date ⇒ Object

Room closed end datetime in UTC. Valid formats: yyyy-mm-dd hh:mm:ss or yyyy/mm/dd hh:mm:ss -Time is optional and will default to 00:00:00.



108
109
110
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 108

def room_closed_end_date
  @room_closed_end_date
end

#room_closed_start_date ⇒ Object

Room closed start datetime in UTC. Valid formats: yyyy-mm-dd hh:mm:ss or yyyy/mm/dd hh:mm:ss -Time is optional and will default to 00:00:00.



105
106
107
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 105

def room_closed_start_date
  @room_closed_start_date
end

#room_status ⇒ Object

Status of the rooms to return. Defaults to "Active".



93
94
95
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 93

def room_status
  @room_status
end

#start_position ⇒ Object

Position of the first item in the total results. Defaults to 0.



90
91
92
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 90

def start_position
  @start_position
end

Class Method Details

.default ⇒ Object 



110
111
112
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 110

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