Class: WhiteLabelMachineName::DocumentTemplateTypeService

Inherits:
Object
  • Object
show all
Defined in:
lib/whitelabelmachinename-ruby-sdk/api/document_template_type_service_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DocumentTemplateTypeService

Returns a new instance of DocumentTemplateTypeService.



24
25
26
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/document_template_type_service_api.rb', line 24

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



22
23
24
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/document_template_type_service_api.rb', line 22

def api_client
  @api_client
end

Instance Method Details

#all(opts = {}) ⇒ Array<DocumentTemplateType>

All This operation returns all entities which are available.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



32
33
34
35
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/document_template_type_service_api.rb', line 32

def all(opts = {})
  data, _status_code, _headers = all_with_http_info(opts)
  return data
end

#all_with_http_info(opts = {}) ⇒ Array<(Array<DocumentTemplateType>, Fixnum, Hash)>

All This operation returns all entities which are available.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    Array<DocumentTemplateType> data, response status code and response headers



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/document_template_type_service_api.rb', line 41

def all_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DocumentTemplateTypeService.all ..."
  end
  # resource path
  local_var_path = "/document-template-type/all".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['*/*']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # 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 => 'Array<DocumentTemplateType>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DocumentTemplateTypeService#all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#read(id, opts = {}) ⇒ DocumentTemplateType

Read Reads the entity with the given ‘id’ and returns it.

Parameters:

  • id —

    The id of the document template type which should be returned.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



86
87
88
89
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/document_template_type_service_api.rb', line 86

def read(id, opts = {})
  data, _status_code, _headers = read_with_http_info(id, opts)
  return data
end

#read_with_http_info(id, opts = {}) ⇒ Array<(DocumentTemplateType, Fixnum, Hash)>

Read Reads the entity with the given &#39;id&#39; and returns it.

Parameters:

  • id —

    The id of the document template type which should be returned.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    DocumentTemplateType data, response status code and response headers



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/document_template_type_service_api.rb', line 96

def read_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DocumentTemplateTypeService.read ..."
  end
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling DocumentTemplateTypeService.read" if id.nil?
  # resource path
  local_var_path = "/document-template-type/read".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'id'] = id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['*/*']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # 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 => 'DocumentTemplateType')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DocumentTemplateTypeService#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end