Class: Printful::ProductsAPIClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ProductsAPIClient

Returns a new instance of ProductsAPIClient.



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

def api_client
  @api_client
end

Instance Method Details

#create_sync_product(product1, opts = {}) ⇒ CreateSyncProduct200Response

Create a new Sync Product Creates a new Sync Product together with its Sync Variants ([See examples](#section/Products-API-examples/Create-a-new-Sync-Product)).

Parameters:

  • product1 (Product1) —

    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/products_api_client.rb', line 28

def create_sync_product(product1, opts = {})
  data, _status_code, _headers = create_sync_product_with_http_info(product1, opts)
  data
end

#create_sync_product_with_http_info(product1, opts = {}) ⇒ Array<(CreateSyncProduct200Response, Integer, Hash)>

Create a new Sync Product Creates a new Sync Product together with its Sync Variants ([See examples](#section/Products-API-examples/Create-a-new-Sync-Product)).

Parameters:

  • product1 (Product1) —

    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:



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/products_api_client.rb', line 39

def create_sync_product_with_http_info(product1, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsAPIClient.create_sync_product ...'
  end
  # verify the required parameter 'product1' is set
  if @api_client.config.client_side_validation && product1.nil?
    fail ArgumentError, "Missing the required parameter 'product1' when calling ProductsAPIClient.create_sync_product"
  end
  # resource path
  local_var_path = '/store/products'

  # 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(product1)

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

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

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

#create_sync_variant(id, product1_sync_variants_inner, opts = {}) ⇒ GetSyncVariantById200Response

Create a new Sync Variant Creates a new Sync Variant for an existing Sync Product ([See examples](#section/Products-API-examples/Create-a-new-Sync-Variant)).

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:



100
101
102
103
 
# File 'lib/printful_client/api/products_api_client.rb', line 100

def create_sync_variant(id, product1_sync_variants_inner, opts = {})
  data, _status_code, _headers = create_sync_variant_with_http_info(id, product1_sync_variants_inner, opts)
  data
end

#create_sync_variant_with_http_info(id, product1_sync_variants_inner, opts = {}) ⇒ Array<(GetSyncVariantById200Response, Integer, Hash)>

Create a new Sync Variant Creates a new Sync Variant for an existing Sync Product ([See examples](#section/Products-API-examples/Create-a-new-Sync-Variant)).

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:



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

def create_sync_variant_with_http_info(id, product1_sync_variants_inner, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsAPIClient.create_sync_variant ...'
  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 ProductsAPIClient.create_sync_variant"
  end
  # verify the required parameter 'product1_sync_variants_inner' is set
  if @api_client.config.client_side_validation && product1_sync_variants_inner.nil?
    fail ArgumentError, "Missing the required parameter 'product1_sync_variants_inner' when calling ProductsAPIClient.create_sync_variant"
  end
  # resource path
  local_var_path = '/store/products/{id}/variants'.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'])
  # 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(product1_sync_variants_inner)

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

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

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

#delete_sync_product(id, opts = {}) ⇒ GetSyncProductById200Response

Delete a Sync Product Deletes a Sync Product with all of its Sync Variants

Parameters:

  • id (GetSyncProductByIdIdParameter) —

    Sync Product ID (integer) or External ID (if prefixed with @)

  • 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:



176
177
178
179
 
# File 'lib/printful_client/api/products_api_client.rb', line 176

def delete_sync_product(id, opts = {})
  data, _status_code, _headers = delete_sync_product_with_http_info(id, opts)
  data
end

#delete_sync_product_with_http_info(id, opts = {}) ⇒ Array<(GetSyncProductById200Response, Integer, Hash)>

Delete a Sync Product Deletes a Sync Product with all of its Sync Variants

Parameters:

  • id (GetSyncProductByIdIdParameter) —

    Sync Product ID (integer) or External ID (if prefixed with @)

  • 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:



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
226
227
228
229
230
231
232
233
234
 
# File 'lib/printful_client/api/products_api_client.rb', line 187

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

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

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

#delete_sync_variant(id, opts = {}) ⇒ DeleteSyncVariant200Response

Delete a Sync Variant Deletes a single Sync Variant.

Parameters:

  • id (GetSyncProductByIdIdParameter) —

    Sync Variant ID (integer) or External ID (if prefixed with @)

  • 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:



242
243
244
245
 
# File 'lib/printful_client/api/products_api_client.rb', line 242

def delete_sync_variant(id, opts = {})
  data, _status_code, _headers = delete_sync_variant_with_http_info(id, opts)
  data
end

#delete_sync_variant_with_http_info(id, opts = {}) ⇒ Array<(DeleteSyncVariant200Response, Integer, Hash)>

Delete a Sync Variant Deletes a single Sync Variant.

Parameters:

  • id (GetSyncProductByIdIdParameter) —

    Sync Variant ID (integer) or External ID (if prefixed with @)

  • 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:



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
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/printful_client/api/products_api_client.rb', line 253

def delete_sync_variant_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsAPIClient.delete_sync_variant ...'
  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 ProductsAPIClient.delete_sync_variant"
  end
  # resource path
  local_var_path = '/store/variants/{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] || 'DeleteSyncVariant200Response'

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

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

#get_sync_product_by_id(id, opts = {}) ⇒ GetSyncProductById200Response

Get a Sync Product Get information about a single Sync Product and its Sync Variants.

Parameters:

  • id (GetSyncProductByIdIdParameter) —

    Sync Product ID (integer) or External ID (if prefixed with @)

  • 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:



308
309
310
311
 
# File 'lib/printful_client/api/products_api_client.rb', line 308

def get_sync_product_by_id(id, opts = {})
  data, _status_code, _headers = get_sync_product_by_id_with_http_info(id, opts)
  data
end

#get_sync_product_by_id_with_http_info(id, opts = {}) ⇒ Array<(GetSyncProductById200Response, Integer, Hash)>

Get a Sync Product Get information about a single Sync Product and its Sync Variants.

Parameters:

  • id (GetSyncProductByIdIdParameter) —

    Sync Product ID (integer) or External ID (if prefixed with @)

  • 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:



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/printful_client/api/products_api_client.rb', line 319

def get_sync_product_by_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsAPIClient.get_sync_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 ProductsAPIClient.get_sync_product_by_id"
  end
  # resource path
  local_var_path = '/store/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'])
  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] || 'GetSyncProductById200Response'

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

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

#get_sync_products(opts = {}) ⇒ GetSyncProducts200Response

Get Sync Products Returns a list of Sync Product objects from your custom Printful store.

Parameters:

  • 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)

  • :category_id (String) —

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

Returns:



374
375
376
377
 
# File 'lib/printful_client/api/products_api_client.rb', line 374

def get_sync_products(opts = {})
  data, _status_code, _headers = get_sync_products_with_http_info(opts)
  data
end

#get_sync_products_with_http_info(opts = {}) ⇒ Array<(GetSyncProducts200Response, Integer, Hash)>

Get Sync Products Returns a list of Sync Product objects from your custom Printful store.

Parameters:

  • 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)

  • :category_id (String) —

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

Returns:

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

    GetSyncProducts200Response data, response status code and response headers



385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/printful_client/api/products_api_client.rb', line 385

def get_sync_products_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsAPIClient.get_sync_products ...'
  end
  # resource path
  local_var_path = '/store/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'])
  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] || 'GetSyncProducts200Response'

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

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

#get_sync_variant_by_id(id, opts = {}) ⇒ GetSyncVariantById200Response

Get a Sync Variant Get information about a single Sync Variant.

Parameters:

  • id (GetSyncProductByIdIdParameter) —

    Sync Variant ID (integer) or External ID (if prefixed with @)

  • 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:



437
438
439
440
 
# File 'lib/printful_client/api/products_api_client.rb', line 437

def get_sync_variant_by_id(id, opts = {})
  data, _status_code, _headers = get_sync_variant_by_id_with_http_info(id, opts)
  data
end

#get_sync_variant_by_id_with_http_info(id, opts = {}) ⇒ Array<(GetSyncVariantById200Response, Integer, Hash)>

Get a Sync Variant Get information about a single Sync Variant.

Parameters:

  • id (GetSyncProductByIdIdParameter) —

    Sync Variant ID (integer) or External ID (if prefixed with @)

  • 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:



448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
 
# File 'lib/printful_client/api/products_api_client.rb', line 448

def get_sync_variant_by_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsAPIClient.get_sync_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 ProductsAPIClient.get_sync_variant_by_id"
  end
  # resource path
  local_var_path = '/store/variants/{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] || 'GetSyncVariantById200Response'

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

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

#update_sync_product(id, update_sync_product_request, opts = {}) ⇒ CreateSyncProduct200Response

Modify a Sync Product Modifies an existing Sync Product with its Sync Variants. Please note that in the request body you only need to specify the fields that need to be changed. Furthermore, if you want to update existing sync variants, then in the sync variants array you must specify the IDs of all existing sync variants. All omitted existing sync variants will be deleted. All new sync variants without an ID will be created. See examples for more insights. **Rate limiting:** Up to 10 requests per 60 seconds. A 60 seconds lockout is applied if request count is exceeded. [See examples](#section/Products-API-examples/Modify-a-Sync-Product)

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:



504
505
506
507
 
# File 'lib/printful_client/api/products_api_client.rb', line 504

def update_sync_product(id, update_sync_product_request, opts = {})
  data, _status_code, _headers = update_sync_product_with_http_info(id, update_sync_product_request, opts)
  data
end

#update_sync_product_with_http_info(id, update_sync_product_request, opts = {}) ⇒ Array<(CreateSyncProduct200Response, Integer, Hash)>

Modify a Sync Product Modifies an existing Sync Product with its Sync Variants. Please note that in the request body you only need to specify the fields that need to be changed. Furthermore, if you want to update existing sync variants, then in the sync variants array you must specify the IDs of all existing sync variants. All omitted existing sync variants will be deleted. All new sync variants without an ID will be created. See examples for more insights. **Rate limiting:** Up to 10 requests per 60 seconds. A 60 seconds lockout is applied if request count is exceeded. [See examples](#section/Products-API-examples/Modify-a-Sync-Product)

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:



516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
 
# File 'lib/printful_client/api/products_api_client.rb', line 516

def update_sync_product_with_http_info(id, update_sync_product_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsAPIClient.update_sync_product ...'
  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 ProductsAPIClient.update_sync_product"
  end
  # verify the required parameter 'update_sync_product_request' is set
  if @api_client.config.client_side_validation && update_sync_product_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_sync_product_request' when calling ProductsAPIClient.update_sync_product"
  end
  # resource path
  local_var_path = '/store/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'])
  # 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(update_sync_product_request)

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

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

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

#update_sync_variant(id, update_sync_variant_request, opts = {}) ⇒ GetSyncVariantById200Response

Modify a Sync Variant Modifies an existing Sync Variant. Please note that in the request body you only need to specify the fields that need to be changed. See examples for more insights. [See examples](#section/Products-API-examples/Modify-a-Sync-Variant)

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:



581
582
583
584
 
# File 'lib/printful_client/api/products_api_client.rb', line 581

def update_sync_variant(id, update_sync_variant_request, opts = {})
  data, _status_code, _headers = update_sync_variant_with_http_info(id, update_sync_variant_request, opts)
  data
end

#update_sync_variant_with_http_info(id, update_sync_variant_request, opts = {}) ⇒ Array<(GetSyncVariantById200Response, Integer, Hash)>

Modify a Sync Variant Modifies an existing Sync Variant. Please note that in the request body you only need to specify the fields that need to be changed. See examples for more insights. [See examples](#section/Products-API-examples/Modify-a-Sync-Variant)

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:



593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
 
# File 'lib/printful_client/api/products_api_client.rb', line 593

def update_sync_variant_with_http_info(id, update_sync_variant_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsAPIClient.update_sync_variant ...'
  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 ProductsAPIClient.update_sync_variant"
  end
  # verify the required parameter 'update_sync_variant_request' is set
  if @api_client.config.client_side_validation && update_sync_variant_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_sync_variant_request' when calling ProductsAPIClient.update_sync_variant"
  end
  # resource path
  local_var_path = '/store/variants/{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'])
  # 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(update_sync_variant_request)

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

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

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