Class: OpenapiClient::TagsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/api/tags_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TagsApi

Returns a new instance of TagsApi.



19
20
21
 
# File 'lib/openapi_client/api/tags_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/openapi_client/api/tags_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_tag(tag_name, opts = {}) ⇒ CreateTagResponseBody

Create a New Tag Create a new Tag for customizing how you track your shipments

Parameters:

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/openapi_client/api/tags_api.rb', line 27

def create_tag(tag_name, opts = {})
  data, _status_code, _headers = create_tag_with_http_info(tag_name, opts)
  data
end

#create_tag_with_http_info(tag_name, opts = {}) ⇒ Array<(CreateTagResponseBody, Integer, Hash)>

Create a New Tag Create a new Tag for customizing how you track your shipments

Parameters:

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

    the optional parameters

Returns:

  • (Array<(CreateTagResponseBody, Integer, Hash)>) —

    CreateTagResponseBody data, response status code and response headers



37
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
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/openapi_client/api/tags_api.rb', line 37

def create_tag_with_http_info(tag_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.create_tag ...'
  end
  # verify the required parameter 'tag_name' is set
  if @api_client.config.client_side_validation && tag_name.nil?
    fail ArgumentError, "Missing the required parameter 'tag_name' when calling TagsApi.create_tag"
  end
  if @api_client.config.client_side_validation && tag_name.to_s.length < 1
    fail ArgumentError, 'invalid value for "tag_name" when calling TagsApi.create_tag, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/tags/{tag_name}'.sub('{' + 'tag_name' + '}', CGI.escape(tag_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'CreateTagResponseBody' 

  # auth_names
  auth_names = opts[:auth_names] || ['api_key']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TagsApi#create_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_tag(tag_name, opts = {}) ⇒ String

Delete Tag Delete a tag that is no longer needed

Parameters:

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

    the optional parameters

Returns:

  • (String) 


93
94
95
96
 
# File 'lib/openapi_client/api/tags_api.rb', line 93

def delete_tag(tag_name, opts = {})
  data, _status_code, _headers = delete_tag_with_http_info(tag_name, opts)
  data
end

#delete_tag_with_http_info(tag_name, opts = {}) ⇒ Array<(String, Integer, Hash)>

Delete Tag Delete a tag that is no longer needed

Parameters:

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

    the optional parameters

Returns:

  • (Array<(String, Integer, Hash)>) —

    String 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
148
149
150
151
152
 
# File 'lib/openapi_client/api/tags_api.rb', line 103

def delete_tag_with_http_info(tag_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.delete_tag ...'
  end
  # verify the required parameter 'tag_name' is set
  if @api_client.config.client_side_validation && tag_name.nil?
    fail ArgumentError, "Missing the required parameter 'tag_name' when calling TagsApi.delete_tag"
  end
  if @api_client.config.client_side_validation && tag_name.to_s.length < 1
    fail ArgumentError, 'invalid value for "tag_name" when calling TagsApi.delete_tag, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/tags/{tag_name}'.sub('{' + 'tag_name' + '}', CGI.escape(tag_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'String' 

  # auth_names
  auth_names = opts[:auth_names] || ['api_key']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TagsApi#delete_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_tags(opts = {}) ⇒ ListTagsResponseBody

Get Tags Get a list of all tags associated with an account.

Parameters:

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

    the optional parameters

Returns:



158
159
160
161
 
# File 'lib/openapi_client/api/tags_api.rb', line 158

def list_tags(opts = {})
  data, _status_code, _headers = list_tags_with_http_info(opts)
  data
end

#list_tags_with_http_info(opts = {}) ⇒ Array<(ListTagsResponseBody, Integer, Hash)>

Get Tags Get a list of all tags associated with an account.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(ListTagsResponseBody, Integer, Hash)>) —

    ListTagsResponseBody data, response status code and response headers



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/openapi_client/api/tags_api.rb', line 167

def list_tags_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.list_tags ...'
  end
  # resource path
  local_var_path = '/v1/tags'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'ListTagsResponseBody' 

  # auth_names
  auth_names = opts[:auth_names] || ['api_key']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TagsApi#list_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#rename_tag(tag_name, new_tag_name, opts = {}) ⇒ String

Update Tag Name Change a tag name while still keeping the relevant shipments attached to it

Parameters:

  • tag_name (String)
  • new_tag_name (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


216
217
218
219
 
# File 'lib/openapi_client/api/tags_api.rb', line 216

def rename_tag(tag_name, new_tag_name, opts = {})
  data, _status_code, _headers = rename_tag_with_http_info(tag_name, new_tag_name, opts)
  data
end

#rename_tag_with_http_info(tag_name, new_tag_name, opts = {}) ⇒ Array<(String, Integer, Hash)>

Update Tag Name Change a tag name while still keeping the relevant shipments attached to it

Parameters:

  • tag_name (String)
  • new_tag_name (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/openapi_client/api/tags_api.rb', line 227

def rename_tag_with_http_info(tag_name, new_tag_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.rename_tag ...'
  end
  # verify the required parameter 'tag_name' is set
  if @api_client.config.client_side_validation && tag_name.nil?
    fail ArgumentError, "Missing the required parameter 'tag_name' when calling TagsApi.rename_tag"
  end
  if @api_client.config.client_side_validation && tag_name.to_s.length < 1
    fail ArgumentError, 'invalid value for "tag_name" when calling TagsApi.rename_tag, the character length must be great than or equal to 1.'
  end

  # verify the required parameter 'new_tag_name' is set
  if @api_client.config.client_side_validation && new_tag_name.nil?
    fail ArgumentError, "Missing the required parameter 'new_tag_name' when calling TagsApi.rename_tag"
  end
  if @api_client.config.client_side_validation && new_tag_name.to_s.length < 1
    fail ArgumentError, 'invalid value for "new_tag_name" when calling TagsApi.rename_tag, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/tags/{tag_name}/{new_tag_name}'.sub('{' + 'tag_name' + '}', CGI.escape(tag_name.to_s)).sub('{' + 'new_tag_name' + '}', CGI.escape(new_tag_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'String' 

  # auth_names
  auth_names = opts[:auth_names] || ['api_key']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TagsApi#rename_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end