Class: Bfwd::FixedtermdefinitionsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/bf_ruby2/api/fixedtermdefinitions_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ FixedtermdefinitionsApi

Returns a new instance of FixedtermdefinitionsApi.



19
20
21
 
# File 'lib/bf_ruby2/api/fixedtermdefinitions_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/bf_ruby2/api/fixedtermdefinitions_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_fixed_term_definition(fixed_term_definiton, opts = {}) ⇒ FixedTermDefinitionPagedMetadata

Create a new fixed term definition","request":"createFixedTermDefinitionRequest.html","response":"createFixedTermDefinitionResponse.html"

Parameters:

  • fixed_term_definiton —

    The fixed-term-definition object to be updated.

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/bf_ruby2/api/fixedtermdefinitions_api.rb', line 28

def create_fixed_term_definition(fixed_term_definiton, opts = {})
  data, _status_code, _headers = create_fixed_term_definition_with_http_info(fixed_term_definiton, opts)
  return data
end

#create_fixed_term_definition_with_http_info(fixed_term_definiton, opts = {}) ⇒ Array<(FixedTermDefinitionPagedMetadata, Fixnum, Hash)>

Create a new fixed term definition&quot;,&quot;request&quot;:&quot;createFixedTermDefinitionRequest.html&quot;,&quot;response&quot;:&quot;createFixedTermDefinitionResponse.html&quot;

Parameters:

  • fixed_term_definiton —

    The fixed-term-definition object to be updated.

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

    the optional parameters

Returns:



38
39
40
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
 
# File 'lib/bf_ruby2/api/fixedtermdefinitions_api.rb', line 38

def create_fixed_term_definition_with_http_info(fixed_term_definiton, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FixedtermdefinitionsApi.create_fixed_term_definition ..."
  end
  # verify the required parameter 'fixed_term_definiton' is set
  if @api_client.config.client_side_validation && fixed_term_definiton.nil?
    fail ArgumentError, "Missing the required parameter 'fixed_term_definiton' when calling FixedtermdefinitionsApi.create_fixed_term_definition"
  end
  # resource path
  local_var_path = "/fixed-term-definitions"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/xml', 'application/xml', 'application/json; charset=utf-8'])
  # 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(fixed_term_definiton)
  auth_names = []
  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 => 'FixedTermDefinitionPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FixedtermdefinitionsApi#create_fixed_term_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_fixed_term_definition(fixed_term_definiton, opts = {}) ⇒ FixedTermDefinitionPagedMetadata

Update a fixed-term definition","request":"updateFixedTermDefinitionRequest.html","response":"updateFixedTermDefinitionResponse.html"

Parameters:

  • fixed_term_definiton —

    The fixed-term-definition object to be updated.

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

    the optional parameters

Returns:



83
84
85
86
 
# File 'lib/bf_ruby2/api/fixedtermdefinitions_api.rb', line 83

def update_fixed_term_definition(fixed_term_definiton, opts = {})
  data, _status_code, _headers = update_fixed_term_definition_with_http_info(fixed_term_definiton, opts)
  return data
end

#update_fixed_term_definition_with_http_info(fixed_term_definiton, opts = {}) ⇒ Array<(FixedTermDefinitionPagedMetadata, Fixnum, Hash)>

Update a fixed-term definition&quot;,&quot;request&quot;:&quot;updateFixedTermDefinitionRequest.html&quot;,&quot;response&quot;:&quot;updateFixedTermDefinitionResponse.html&quot;

Parameters:

  • fixed_term_definiton —

    The fixed-term-definition object to be updated.

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

    the optional parameters

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
126
127
128
129
130
131
 
# File 'lib/bf_ruby2/api/fixedtermdefinitions_api.rb', line 93

def update_fixed_term_definition_with_http_info(fixed_term_definiton, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FixedtermdefinitionsApi.update_fixed_term_definition ..."
  end
  # verify the required parameter 'fixed_term_definiton' is set
  if @api_client.config.client_side_validation && fixed_term_definiton.nil?
    fail ArgumentError, "Missing the required parameter 'fixed_term_definiton' when calling FixedtermdefinitionsApi.update_fixed_term_definition"
  end
  # resource path
  local_var_path = "/fixed-term-definitions"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/xml', 'application/xml', 'application/json; charset=utf-8'])
  # 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(fixed_term_definiton)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'FixedTermDefinitionPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FixedtermdefinitionsApi#update_fixed_term_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end