Class: KoronaClient::TicketCreationApi

Inherits:
Object
  • Object
show all
Defined in:
lib/korona_client/api/ticket_creation_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TicketCreationApi

Returns a new instance of TicketCreationApi.



19
20
21
 
# File 'lib/korona_client/api/ticket_creation_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/korona_client/api/ticket_creation_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_creation_task(korona_account_id, body, opts = {}) ⇒ AddOrUpdateResult

adds a creation task

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • body —

    a single ticket creation task

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/korona_client/api/ticket_creation_api.rb', line 28

def add_creation_task(, body, opts = {})
  data, _status_code, _headers = add_creation_task_with_http_info(, body, opts)
  data
end

#add_creation_task_with_http_info(korona_account_id, body, opts = {}) ⇒ Array<(AddOrUpdateResult, Fixnum, Hash)>

adds a creation task

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • body —

    a single ticket creation task

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

    the optional parameters

Returns:

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

    AddOrUpdateResult data, response status code and response headers



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
77
78
79
80
81
 
# File 'lib/korona_client/api/ticket_creation_api.rb', line 39

def add_creation_task_with_http_info(, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TicketCreationApi.add_creation_task ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling TicketCreationApi.add_creation_task"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TicketCreationApi.add_creation_task"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/ticketCreation'.sub('{' + 'koronaAccountId' + '}', .to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

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

#get_creation_tasks(korona_account_id, opts = {}) ⇒ ResultListCreationTask

creation tasks, personalization will always be empty for technical reasons

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

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

    the optional parameters

Options Hash (opts):

  • :creation_time_from (DateTime) —

    creation time from

  • :creation_time_to (DateTime) —

    creation time to

  • :statuses (Array<String>) —

    creation task statuses

Returns:



90
91
92
93
 
# File 'lib/korona_client/api/ticket_creation_api.rb', line 90

def get_creation_tasks(, opts = {})
  data, _status_code, _headers = get_creation_tasks_with_http_info(, opts)
  data
end

#get_creation_tasks_with_http_info(korona_account_id, opts = {}) ⇒ Array<(ResultListCreationTask, Fixnum, Hash)>

creation tasks, personalization will always be empty for technical reasons

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

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

    the optional parameters

Options Hash (opts):

  • :creation_time_from (DateTime) —

    creation time from

  • :creation_time_to (DateTime) —

    creation time to

  • :statuses (Array<String>) —

    creation task statuses

Returns:

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

    ResultListCreationTask data, response status code and response headers



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
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/korona_client/api/ticket_creation_api.rb', line 103

def get_creation_tasks_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TicketCreationApi.get_creation_tasks ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling TicketCreationApi.get_creation_tasks"
  end
  if @api_client.config.client_side_validation && opts[:'statuses'] && !opts[:'statuses'].all? { |item| ['PREPARED', 'RUNNING', 'FINISHED', 'FAILED'].include?(item) }
    fail ArgumentError, 'invalid value for "statuses", must include one of PREPARED, RUNNING, FINISHED, FAILED'
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/ticketCreation'.sub('{' + 'koronaAccountId' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'creationTimeFrom'] = opts[:'creation_time_from'] if !opts[:'creation_time_from'].nil?
  query_params[:'creationTimeTo'] = opts[:'creation_time_to'] if !opts[:'creation_time_to'].nil?
  query_params[:'statuses'] = @api_client.build_collection_param(opts[:'statuses'], :multi) if !opts[:'statuses'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

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