Class: DocuSign_Rooms::RoomTemplatesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = RoomTemplatesApi.default) ⇒ RoomTemplatesApi

Returns a new instance of RoomTemplatesApi.



41
42
43
 
# File 'lib/docusign_rooms/api/room_templates_api.rb', line 41

def initialize(api_client = RoomTemplatesApi.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



39
40
41
 
# File 'lib/docusign_rooms/api/room_templates_api.rb', line 39

def api_client
  @api_client
end

Instance Method Details

#get_room_templates(account_id, options = DocuSign_Rooms::GetRoomTemplatesOptions.default) ⇒ RoomTemplatesSummaryList

Returns all room templates that the active user has access to This method returns a list of room templates that the user can use to create a new room. The response includes company and region-level templates

Parameters:

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

  • DocuSign_Rooms::GetRoomTemplatesOptions —

    Options for modifying the behavior of the function.

Returns:



50
51
52
53
 
# File 'lib/docusign_rooms/api/room_templates_api.rb', line 50

def get_room_templates(, options = DocuSign_Rooms::GetRoomTemplatesOptions.default)
  data, _status_code, _headers = get_room_templates_with_http_info(, options)
  return data
end

#get_room_templates_with_http_info(account_id, options = DocuSign_Rooms::GetRoomTemplatesOptions.default) ⇒ Array<(RoomTemplatesSummaryList, Fixnum, Hash)>

Returns all room templates that the active user has access to This method returns a list of room templates that the user can use to create a new room. The response includes company and region-level templates

Parameters:

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

  • DocuSign_Rooms::GetRoomTemplatesOptions —

    Options for modifying the behavior of the function.

Returns:

  • (Array<(RoomTemplatesSummaryList, Fixnum, Hash)>) —

    RoomTemplatesSummaryList data, response status code and response headers



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/docusign_rooms/api/room_templates_api.rb', line 60

def get_room_templates_with_http_info(, options = DocuSign_Rooms::GetRoomTemplatesOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoomTemplatesApi.get_room_templates ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling RoomTemplatesApi.get_room_templates" if .nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/room_templates".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'officeId'] = options.office_id if !options.office_id.nil?
  query_params[:'onlyAssignable'] = options.only_assignable if !options.only_assignable.nil?
  query_params[:'onlyEnabled'] = options.only_enabled if !options.only_enabled.nil?
  query_params[:'count'] = options.count if !options.count.nil?
  query_params[:'startPosition'] = options.start_position if !options.start_position.nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', 'application/*+json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RoomTemplatesSummaryList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoomTemplatesApi#get_room_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end