Class: Printful::CatalogAPIClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CatalogAPIClient

Returns a new instance of CatalogAPIClient.



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

def api_client
  @api_client
end

Instance Method Details

#get_categories(opts = {}) ⇒ GetCategories200Response

Get Categories Returns list of Catalog Categories available in the Printful

Parameters:

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

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/printful_client/api/catalog_api_client.rb', line 26

def get_categories(opts = {})
  data, _status_code, _headers = get_categories_with_http_info(opts)
  data
end

#get_categories_with_http_info(opts = {}) ⇒ Array<(GetCategories200Response, Integer, Hash)>

Get Categories Returns list of Catalog Categories available in the Printful

Parameters:

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

    the optional parameters

Returns:

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

    GetCategories200Response data, response status code and response headers



35
36
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
 
# File 'lib/printful_client/api/catalog_api_client.rb', line 35

def get_categories_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CatalogAPIClient.get_categories ...'
  end
  # resource path
  local_var_path = '/categories'

  # 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[:debug_body]

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

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

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

#get_category_by_id(id, opts = {}) ⇒ GetCategoryById200Response

Get Category Returns information about a specific category.

Parameters:

  • id (Integer) —

    Category ID

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

    the optional parameters

Returns:



84
85
86
87
 
# File 'lib/printful_client/api/catalog_api_client.rb', line 84

def get_category_by_id(id, opts = {})
  data, _status_code, _headers = get_category_by_id_with_http_info(id, opts)
  data
end

#get_category_by_id_with_http_info(id, opts = {}) ⇒ Array<(GetCategoryById200Response, Integer, Hash)>

Get Category Returns information about a specific category.

Parameters:

  • id (Integer) —

    Category ID

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

    the optional parameters

Returns:

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

    GetCategoryById200Response data, response status code and response headers



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
132
133
134
135
136
137
138
139
140
 
# File 'lib/printful_client/api/catalog_api_client.rb', line 94

def get_category_by_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CatalogAPIClient.get_category_by_id ...'
  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 CatalogAPIClient.get_category_by_id"
  end
  # resource path
  local_var_path = '/categories/{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'])

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

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

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

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

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

#get_product_by_id(id, opts = {}) ⇒ GetProductById200Response

Get Product Returns information about a specific product and a list of variants for this product.

Parameters:

  • id (Integer) —

    Product ID.

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

    the optional parameters

Returns:



147
148
149
150
 
# File 'lib/printful_client/api/catalog_api_client.rb', line 147

def get_product_by_id(id, opts = {})
  data, _status_code, _headers = get_product_by_id_with_http_info(id, opts)
  data
end

#get_product_by_id_with_http_info(id, opts = {}) ⇒ Array<(GetProductById200Response, Integer, Hash)>

Get Product Returns information about a specific product and a list of variants for this product.

Parameters:

  • id (Integer) —

    Product ID.

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

    the optional parameters

Returns:

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

    GetProductById200Response data, response status code and response headers



157
158
159
160
161
162
163
164
165
166
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
 
# File 'lib/printful_client/api/catalog_api_client.rb', line 157

def get_product_by_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CatalogAPIClient.get_product_by_id ...'
  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 CatalogAPIClient.get_product_by_id"
  end
  # resource path
  local_var_path = '/products/{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'])

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

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

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

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

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

#get_product_size_guide_by_id(id, opts = {}) ⇒ GetProductSizeGuideById200Response

Get Product Size Guide Returns information about the size guide for a specific product.

Parameters:

  • id (Integer) —

    Product ID.

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

    the optional parameters

Options Hash (opts):

  • :unit (String) —

    A comma-separated list of measurement unit in which size tables are to be returned (&#x60;inches&#x60; or &#x60;cm&#x60;). The default value is determined based on the locale country. The inches are used for United States, Liberia and Myanmar, for other countries the unit defaults to centimeters.

Returns:



211
212
213
214
 
# File 'lib/printful_client/api/catalog_api_client.rb', line 211

def get_product_size_guide_by_id(id, opts = {})
  data, _status_code, _headers = get_product_size_guide_by_id_with_http_info(id, opts)
  data
end

#get_product_size_guide_by_id_with_http_info(id, opts = {}) ⇒ Array<(GetProductSizeGuideById200Response, Integer, Hash)>

Get Product Size Guide Returns information about the size guide for a specific product.

Parameters:

  • id (Integer) —

    Product ID.

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

    the optional parameters

Options Hash (opts):

  • :unit (String) —

    A comma-separated list of measurement unit in which size tables are to be returned (&#x60;inches&#x60; or &#x60;cm&#x60;). The default value is determined based on the locale country. The inches are used for United States, Liberia and Myanmar, for other countries the unit defaults to centimeters.

Returns:



222
223
224
225
226
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
 
# File 'lib/printful_client/api/catalog_api_client.rb', line 222

def get_product_size_guide_by_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CatalogAPIClient.get_product_size_guide_by_id ...'
  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 CatalogAPIClient.get_product_size_guide_by_id"
  end
  # resource path
  local_var_path = '/products/{id}/sizes'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'unit'] = opts[:'unit'] if !opts[:'unit'].nil?

  # 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[:debug_body]

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

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

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

#get_products(opts = {}) ⇒ GetProducts200Response

Get Products Returns list of Products available in the Printful

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :category_id (String) —

    A comma-separated list of Category IDs of the Products that are to be returned

Returns:



276
277
278
279
 
# File 'lib/printful_client/api/catalog_api_client.rb', line 276

def get_products(opts = {})
  data, _status_code, _headers = get_products_with_http_info(opts)
  data
end

#get_products_with_http_info(opts = {}) ⇒ Array<(GetProducts200Response, Integer, Hash)>

Get Products Returns list of Products available in the Printful

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :category_id (String) —

    A comma-separated list of Category IDs of the Products that are to be returned

Returns:

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

    GetProducts200Response data, response status code and response headers



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/printful_client/api/catalog_api_client.rb', line 286

def get_products_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CatalogAPIClient.get_products ...'
  end
  # resource path
  local_var_path = '/products'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'category_id'] = opts[:'category_id'] if !opts[:'category_id'].nil?

  # 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[:debug_body]

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

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

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

#get_variant_by_id(id, opts = {}) ⇒ GetVariantById200Response

Get Variant Returns information about a specific Variant and its Product

Parameters:

  • id (Integer) —

    Variant id

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

    the optional parameters

Returns:



336
337
338
339
 
# File 'lib/printful_client/api/catalog_api_client.rb', line 336

def get_variant_by_id(id, opts = {})
  data, _status_code, _headers = get_variant_by_id_with_http_info(id, opts)
  data
end

#get_variant_by_id_with_http_info(id, opts = {}) ⇒ Array<(GetVariantById200Response, Integer, Hash)>

Get Variant Returns information about a specific Variant and its Product

Parameters:

  • id (Integer) —

    Variant id

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

    the optional parameters

Returns:

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

    GetVariantById200Response data, response status code and response headers



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/printful_client/api/catalog_api_client.rb', line 346

def get_variant_by_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CatalogAPIClient.get_variant_by_id ...'
  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 CatalogAPIClient.get_variant_by_id"
  end
  # resource path
  local_var_path = '/products/variant/{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'])

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

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

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

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

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