Class: Printful::EcommercePlatformSyncAPIClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EcommercePlatformSyncAPIClient

Returns a new instance of EcommercePlatformSyncAPIClient.



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

def api_client
  @api_client
end

Instance Method Details

#delete_store_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:



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

def delete_store_sync_product(id, opts = {})
  data, _status_code, _headers = delete_store_sync_product_with_http_info(id, opts)
  data
end

#delete_store_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:



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/printful_client/api/ecommerce_platform_sync_api_client.rb', line 39

def delete_store_sync_product_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EcommercePlatformSyncAPIClient.delete_store_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 EcommercePlatformSyncAPIClient.delete_store_sync_product"
  end
  # resource path
  local_var_path = '/sync/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 => :"EcommercePlatformSyncAPIClient.delete_store_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: EcommercePlatformSyncAPIClient#delete_store_sync_product\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_store_sync_variant(id, opts = {}) ⇒ GetStoreSyncVariantById200Response

Delete a Sync Variant Deletes configuraton information (‘variant_id`, print files and options) and disables automatic order importing for this 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:



94
95
96
97
 
# File 'lib/printful_client/api/ecommerce_platform_sync_api_client.rb', line 94

def delete_store_sync_variant(id, opts = {})
  data, _status_code, _headers = delete_store_sync_variant_with_http_info(id, opts)
  data
end

#delete_store_sync_variant_with_http_info(id, opts = {}) ⇒ Array<(GetStoreSyncVariantById200Response, Integer, Hash)>

Delete a Sync Variant Deletes configuraton information (&#x60;variant_id&#x60;, print files and options) and disables automatic order importing for this 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:



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/printful_client/api/ecommerce_platform_sync_api_client.rb', line 105

def delete_store_sync_variant_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EcommercePlatformSyncAPIClient.delete_store_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 EcommercePlatformSyncAPIClient.delete_store_sync_variant"
  end
  # resource path
  local_var_path = '/sync/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'])
  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] || 'GetStoreSyncVariantById200Response'

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

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

#get_store_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:



160
161
162
163
 
# File 'lib/printful_client/api/ecommerce_platform_sync_api_client.rb', line 160

def get_store_sync_product_by_id(id, opts = {})
  data, _status_code, _headers = get_store_sync_product_by_id_with_http_info(id, opts)
  data
end

#get_store_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:



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
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/printful_client/api/ecommerce_platform_sync_api_client.rb', line 171

def get_store_sync_product_by_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EcommercePlatformSyncAPIClient.get_store_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 EcommercePlatformSyncAPIClient.get_store_sync_product_by_id"
  end
  # resource path
  local_var_path = '/sync/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 => :"EcommercePlatformSyncAPIClient.get_store_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: EcommercePlatformSyncAPIClient#get_store_sync_product_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_store_sync_products(opts = {}) ⇒ GetSyncProducts200Response

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

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :status (String) —

    Filter by item status (&#x60;synced&#x60;/&#x60;unsynced&#x60;/&#x60;all&#x60;). If only some of the variants are synced,the product is returned by both unsynced and synced filters

  • :search (String) —

    Product search needle

  • :offset (Integer) —

    Result set offset

  • :limit (Integer) —

    Number of items per page (max 100)

  • :x_pf_store_id (String) —

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

Returns:



229
230
231
232
 
# File 'lib/printful_client/api/ecommerce_platform_sync_api_client.rb', line 229

def get_store_sync_products(opts = {})
  data, _status_code, _headers = get_store_sync_products_with_http_info(opts)
  data
end

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

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

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :status (String) —

    Filter by item status (&#x60;synced&#x60;/&#x60;unsynced&#x60;/&#x60;all&#x60;). If only some of the variants are synced,the product is returned by both unsynced and synced filters

  • :search (String) —

    Product search needle

  • :offset (Integer) —

    Result set offset

  • :limit (Integer) —

    Number of items per page (max 100)

  • :x_pf_store_id (String) —

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

Returns:

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

    GetSyncProducts200Response data, response status code and response headers



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
285
286
287
288
289
290
 
# File 'lib/printful_client/api/ecommerce_platform_sync_api_client.rb', line 243

def get_store_sync_products_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EcommercePlatformSyncAPIClient.get_store_sync_products ...'
  end
  # resource path
  local_var_path = '/sync/products'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].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 => :"EcommercePlatformSyncAPIClient.get_store_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: EcommercePlatformSyncAPIClient#get_store_sync_products\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_store_sync_variant_by_id(id, opts = {}) ⇒ GetStoreSyncVariantById200Response

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:



298
299
300
301
 
# File 'lib/printful_client/api/ecommerce_platform_sync_api_client.rb', line 298

def get_store_sync_variant_by_id(id, opts = {})
  data, _status_code, _headers = get_store_sync_variant_by_id_with_http_info(id, opts)
  data
end

#get_store_sync_variant_by_id_with_http_info(id, opts = {}) ⇒ Array<(GetStoreSyncVariantById200Response, 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:



309
310
311
312
313
314
315
316
317
318
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
 
# File 'lib/printful_client/api/ecommerce_platform_sync_api_client.rb', line 309

def get_store_sync_variant_by_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EcommercePlatformSyncAPIClient.get_store_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 EcommercePlatformSyncAPIClient.get_store_sync_variant_by_id"
  end
  # resource path
  local_var_path = '/sync/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'])
  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] || 'GetStoreSyncVariantById200Response'

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

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

#update_store_sync_variant(id, update_sync_variant_request, opts = {}) ⇒ GetStoreSyncVariantById200Response

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/Ecommerce-Platform-Sync-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:



365
366
367
368
 
# File 'lib/printful_client/api/ecommerce_platform_sync_api_client.rb', line 365

def update_store_sync_variant(id, update_sync_variant_request, opts = {})
  data, _status_code, _headers = update_store_sync_variant_with_http_info(id, update_sync_variant_request, opts)
  data
end

#update_store_sync_variant_with_http_info(id, update_sync_variant_request, opts = {}) ⇒ Array<(GetStoreSyncVariantById200Response, 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/Ecommerce-Platform-Sync-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:



377
378
379
380
381
382
383
384
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
430
431
432
433
 
# File 'lib/printful_client/api/ecommerce_platform_sync_api_client.rb', line 377

def update_store_sync_variant_with_http_info(id, update_sync_variant_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EcommercePlatformSyncAPIClient.update_store_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 EcommercePlatformSyncAPIClient.update_store_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 EcommercePlatformSyncAPIClient.update_store_sync_variant"
  end
  # resource path
  local_var_path = '/sync/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'])
  # 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] || 'GetStoreSyncVariantById200Response'

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

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