Class: TripletexRubyClient::CompanysalesmodulesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/tripletex_ruby_client/api/companysalesmodules_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CompanysalesmodulesApi

Returns a new instance of CompanysalesmodulesApi.



19
20
21
 
# File 'lib/tripletex_ruby_client/api/companysalesmodules_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/tripletex_ruby_client/api/companysalesmodules_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get(opts = {}) ⇒ ListResponseSalesModuleDTO

BETA

Get active sales modules.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :from (Integer) —

    From index (default to 0)

  • :count (Integer) —

    Number of elements to return (default to 1000)

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:



30
31
32
33
 
# File 'lib/tripletex_ruby_client/api/companysalesmodules_api.rb', line 30

def get(opts = {})
  data, _status_code, _headers = get_with_http_info(opts)
  data
end

#get_with_http_info(opts = {}) ⇒ Array<(ListResponseSalesModuleDTO, Fixnum, Hash)>

BETA

Get active sales modules.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:

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

    ListResponseSalesModuleDTO data, response status code and response headers



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
 
# File 'lib/tripletex_ruby_client/api/companysalesmodules_api.rb', line 43

def get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CompanysalesmodulesApi.get ...'
  end
  # resource path
  local_var_path = '/company/salesmodules'

  # query parameters
  query_params = {}
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'sorting'] = opts[:'sorting'] if !opts[:'sorting'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['tokenAuthScheme']
  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 => 'ListResponseSalesModuleDTO')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CompanysalesmodulesApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post(opts = {}) ⇒ ResponseWrapperSalesModuleDTO

BETA

Add (activate) a new sales module.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (SalesModuleDTO) —

    JSON representing the new object to be created. Should not have ID and version set.

Returns:



83
84
85
86
 
# File 'lib/tripletex_ruby_client/api/companysalesmodules_api.rb', line 83

def post(opts = {})
  data, _status_code, _headers = post_with_http_info(opts)
  data
end

#post_with_http_info(opts = {}) ⇒ Array<(ResponseWrapperSalesModuleDTO, Fixnum, Hash)>

BETA

Add (activate) a new sales module.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (SalesModuleDTO) —

    JSON representing the new object to be created. Should not have ID and version set.

Returns:



93
94
95
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
 
# File 'lib/tripletex_ruby_client/api/companysalesmodules_api.rb', line 93

def post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CompanysalesmodulesApi.post ...'
  end
  # resource path
  local_var_path = '/company/salesmodules'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  auth_names = ['tokenAuthScheme']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ResponseWrapperSalesModuleDTO')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CompanysalesmodulesApi#post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end