Class: Printful::StoreInformationAPIClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ StoreInformationAPIClient

Returns a new instance of StoreInformationAPIClient.



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

def api_client
  @api_client
end

Instance Method Details

#change_packing_slip(packing_slip, opts = {}) ⇒ ChangePackingSlip200Response

Change packing slip Modifies packing slip information of the currently authorized Printful store.

Parameters:

  • packing_slip (PackingSlip) —

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

def change_packing_slip(packing_slip, opts = {})
  data, _status_code, _headers = change_packing_slip_with_http_info(packing_slip, opts)
  data
end

#change_packing_slip_with_http_info(packing_slip, opts = {}) ⇒ Array<(ChangePackingSlip200Response, Integer, Hash)>

Change packing slip Modifies packing slip information of the currently authorized Printful store.

Parameters:

  • packing_slip (PackingSlip) —

    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
 
# File 'lib/printful_client/api/store_information_api_client.rb', line 39

def change_packing_slip_with_http_info(packing_slip, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StoreInformationAPIClient.change_packing_slip ...'
  end
  # resource path
  local_var_path = '/store/packing-slip'

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

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

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

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

#get_store(id, opts = {}) ⇒ GetStore200Response

Get basic information about a store Get basic information about a store based on provided ID

Parameters:

  • id (Integer) —

    Store ID

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

    the optional parameters

Returns:



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

def get_store(id, opts = {})
  data, _status_code, _headers = get_store_with_http_info(id, opts)
  data
end

#get_store_with_http_info(id, opts = {}) ⇒ Array<(GetStore200Response, Integer, Hash)>

Get basic information about a store Get basic information about a store based on provided ID

Parameters:

  • id (Integer) —

    Store ID

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

    the optional parameters

Returns:

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

    GetStore200Response data, response status code and response headers



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
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/printful_client/api/store_information_api_client.rb', line 104

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

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

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

#get_stores(opts = {}) ⇒ GetStores200Response

Get basic information about stores Get basic information about stores depending on the token access level

Parameters:

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

    the optional parameters

Returns:



156
157
158
159
 
# File 'lib/printful_client/api/store_information_api_client.rb', line 156

def get_stores(opts = {})
  data, _status_code, _headers = get_stores_with_http_info(opts)
  data
end

#get_stores_with_http_info(opts = {}) ⇒ Array<(GetStores200Response, Integer, Hash)>

Get basic information about stores Get basic information about stores depending on the token access level

Parameters:

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

    the optional parameters

Returns:

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

    GetStores200Response data, response status code and response headers



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
204
205
206
207
 
# File 'lib/printful_client/api/store_information_api_client.rb', line 165

def get_stores_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StoreInformationAPIClient.get_stores ...'
  end
  # resource path
  local_var_path = '/stores'

  # 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] || 'GetStores200Response'

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

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