Class: Printful::WarehouseProductsAPIClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ WarehouseProductsAPIClient

Returns a new instance of WarehouseProductsAPIClient.



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

def api_client
  @api_client
end

Instance Method Details

#get_warehouse_product(id, opts = {}) ⇒ GetWarehouseProduct200Response

Get warehouse product data Returns warehouse product data by ID

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

def get_warehouse_product(id, opts = {})
  data, _status_code, _headers = get_warehouse_product_with_http_info(id, opts)
  data
end

#get_warehouse_product_with_http_info(id, opts = {}) ⇒ Array<(GetWarehouseProduct200Response, Integer, Hash)>

Get warehouse product data Returns warehouse product data by ID

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

def get_warehouse_product_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WarehouseProductsAPIClient.get_warehouse_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 WarehouseProductsAPIClient.get_warehouse_product"
  end
  # resource path
  local_var_path = '/warehouse/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] || 'GetWarehouseProduct200Response'

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

  new_options = opts.merge(
    :operation => :"WarehouseProductsAPIClient.get_warehouse_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(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WarehouseProductsAPIClient#get_warehouse_product\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_warehouse_products(opts = {}) ⇒ GetWarehouseProducts200Response

Get a list of your warehouse products Returns a list of warehouse products from your store

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :query (String) —

    Filter by partial or full product name

  • :limit (Integer) —

    Number of items per page (max 100)

  • :offset (Integer) —

    Result set offset

  • :x_pf_store_id (String) —

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

Returns:



96
97
98
99
 
# File 'lib/printful_client/api/warehouse_products_api_client.rb', line 96

def get_warehouse_products(opts = {})
  data, _status_code, _headers = get_warehouse_products_with_http_info(opts)
  data
end

#get_warehouse_products_with_http_info(opts = {}) ⇒ Array<(GetWarehouseProducts200Response, Integer, Hash)>

Get a list of your warehouse products Returns a list of warehouse products from your store

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :query (String) —

    Filter by partial or full product name

  • :limit (Integer) —

    Number of items per page (max 100)

  • :offset (Integer) —

    Result set offset

  • :x_pf_store_id (String) —

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

Returns:



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
153
154
155
 
# File 'lib/printful_client/api/warehouse_products_api_client.rb', line 109

def get_warehouse_products_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WarehouseProductsAPIClient.get_warehouse_products ...'
  end
  # resource path
  local_var_path = '/warehouse/products'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].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] || 'GetWarehouseProducts200Response'

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

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