Class: Printful::FileLibraryAPIClient

Inherits:
Object
  • Object
show all
Defined in:
lib/printful_client/api/file_library_api_client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ FileLibraryAPIClient

Returns a new instance of FileLibraryAPIClient.



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

def api_client
  @api_client
end

Instance Method Details

#add_file(file, opts = {}) ⇒ AddFile200Response

Add a new file Adds a new File to the library by providing URL of the file. If a file with identical URL already exists, then the original file is returned. If a file does not exist, a new file is created. [See examples](#section/File-Library-API-examples/Add-a-new-file)

Parameters:

  • file (File) —

    POST request body

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

    the optional parameters

Options Hash (opts):

  • :x_pf_store_id (String) —

    Use this to specify which store you want to use (required only for account level token)

Returns:



28
29
30
31
 
# File 'lib/printful_client/api/file_library_api_client.rb', line 28

def add_file(file, opts = {})
  data, _status_code, _headers = add_file_with_http_info(file, opts)
  data
end

#add_file_with_http_info(file, opts = {}) ⇒ Array<(AddFile200Response, Integer, Hash)>

Add a new file Adds a new File to the library by providing URL of the file. If a file with identical URL already exists, then the original file is returned. If a file does not exist, a new file is created. [See examples](#section/File-Library-API-examples/Add-a-new-file)

Parameters:

  • file (File) —

    POST request body

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

    the optional parameters

Options Hash (opts):

  • :x_pf_store_id (String) —

    Use this to specify which store you want to use (required only for account level token)

Returns:

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

    AddFile200Response 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
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/printful_client/api/file_library_api_client.rb', line 39

def add_file_with_http_info(file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FileLibraryAPIClient.add_file ...'
  end
  # verify the required parameter 'file' is set
  if @api_client.config.client_side_validation && file.nil?
    fail ArgumentError, "Missing the required parameter 'file' when calling FileLibraryAPIClient.add_file"
  end
  # resource path
  local_var_path = '/files'

  # 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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'X-PF-Store-Id'] = opts[:'x_pf_store_id'] if !opts[:'x_pf_store_id'].nil?

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(file)

  # return_type
  return_type = opts[:debug_return_type] || 'AddFile200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OAuth']

  new_options = opts.merge(
    :operation => :"FileLibraryAPIClient.add_file",
    :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: FileLibraryAPIClient#add_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_file(id, opts = {}) ⇒ AddFile200Response

Get file Returns information about the given file.

Parameters:

  • id (Integer) —

    File ID.

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

    the optional parameters

Options Hash (opts):

  • :x_pf_store_id (String) —

    Use this to specify which store you want to use (required only for account level token)

Returns:



99
100
101
102
 
# File 'lib/printful_client/api/file_library_api_client.rb', line 99

def get_file(id, opts = {})
  data, _status_code, _headers = get_file_with_http_info(id, opts)
  data
end

#get_file_with_http_info(id, opts = {}) ⇒ Array<(AddFile200Response, Integer, Hash)>

Get file Returns information about the given file.

Parameters:

  • id (Integer) —

    File ID.

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

    the optional parameters

Options Hash (opts):

  • :x_pf_store_id (String) —

    Use this to specify which store you want to use (required only for account level token)

Returns:

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

    AddFile200Response data, response status code and response headers



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
153
154
155
156
157
 
# File 'lib/printful_client/api/file_library_api_client.rb', line 110

def get_file_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FileLibraryAPIClient.get_file ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling FileLibraryAPIClient.get_file"
  end
  # resource path
  local_var_path = '/files/{id}'.sub('{' + 'id' + '}', CGI.escape(id.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'])
  header_params[:'X-PF-Store-Id'] = opts[:'x_pf_store_id'] if !opts[:'x_pf_store_id'].nil?

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'AddFile200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OAuth']

  new_options = opts.merge(
    :operation => :"FileLibraryAPIClient.get_file",
    :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: FileLibraryAPIClient#get_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#thread_colors(thread_colors_request, opts = {}) ⇒ ThreadColors200Response

Return available thread colors from provided image URL Returns colors in hexadecimal format. Returned thread colors are matched as closely as possible to provided image colors. [See examples](#section/File-Library-API-examples/Suggest-thread-colors)

Parameters:

  • thread_colors_request (ThreadColorsRequest) —

    POST request body

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

    the optional parameters

Returns:



164
165
166
167
 
# File 'lib/printful_client/api/file_library_api_client.rb', line 164

def thread_colors(thread_colors_request, opts = {})
  data, _status_code, _headers = thread_colors_with_http_info(thread_colors_request, opts)
  data
end

#thread_colors_with_http_info(thread_colors_request, opts = {}) ⇒ Array<(ThreadColors200Response, Integer, Hash)>

Return available thread colors from provided image URL Returns colors in hexadecimal format. Returned thread colors are matched as closely as possible to provided image colors. [See examples](#section/File-Library-API-examples/Suggest-thread-colors)

Parameters:

  • thread_colors_request (ThreadColorsRequest) —

    POST request body

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

    the optional parameters

Returns:

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

    ThreadColors200Response data, response status code and response headers



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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/printful_client/api/file_library_api_client.rb', line 174

def thread_colors_with_http_info(thread_colors_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FileLibraryAPIClient.thread_colors ...'
  end
  # verify the required parameter 'thread_colors_request' is set
  if @api_client.config.client_side_validation && thread_colors_request.nil?
    fail ArgumentError, "Missing the required parameter 'thread_colors_request' when calling FileLibraryAPIClient.thread_colors"
  end
  # resource path
  local_var_path = '/files/thread-colors'

  # 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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(thread_colors_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ThreadColors200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"FileLibraryAPIClient.thread_colors",
    :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: FileLibraryAPIClient#thread_colors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end