Class: StorecoveApi::ShopAccountRequestsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/storecove/api/shop_account_requests_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ShopAccountRequestsApi

Returns a new instance of ShopAccountRequestsApi.



18
19
20
 
# File 'lib/storecove/api/shop_account_requests_api.rb', line 18

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



16
17
18
 
# File 'lib/storecove/api/shop_account_requests_api.rb', line 16

def api_client
  @api_client
end

Instance Method Details

#create_shop_account_request(shop_account_request, opts = {}) ⇒ ShopAccountRequestResult

Create ShopAccountRequest Create a new ShopAccountRequest include::examples/shop_account_requests/create_shop_account_request/tabs.adoc[]

Parameters:

  • shop_account_request —

    ShopAccountRequest to add

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/storecove/api/shop_account_requests_api.rb', line 27

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

#create_shop_account_request_with_http_info(shop_account_request, opts = {}) ⇒ Array<(ShopAccountRequestResult, Fixnum, Hash)>

Create ShopAccountRequest Create a new ShopAccountRequest include::examples/shop_account_requests/create_shop_account_request/tabs.adoc[]

Parameters:

  • shop_account_request —

    ShopAccountRequest to add

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

    the optional parameters

Returns:

  • (Array<(ShopAccountRequestResult, Fixnum, Hash)>) —

    ShopAccountRequestResult data, response status code and response headers



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
 
# File 'lib/storecove/api/shop_account_requests_api.rb', line 37

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ShopAccountRequestsApi.create_shop_account_request ..."
  end
  # verify the required parameter 'shop_account_request' is set
  fail ArgumentError, "Missing the required parameter 'shop_account_request' when calling ShopAccountRequestsApi.create_shop_account_request" if .nil?
  # resource path
  local_var_path = "/shop_account_requests".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body()
  auth_names = ['Bearer']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ShopAccountRequestResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ShopAccountRequestsApi#create_shop_account_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_shop_account_request(id, opts = {}) ⇒ nil

Delete ShopAccountRequest Delete a specific ShopAccountRequest include::examples/shop_account_requests/delete_shop_account_request/tabs.adoc[]

Parameters:

  • id —

    shop_account_request id

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

    the optional parameters

Returns:

  • (nil) 


80
81
82
83
 
# File 'lib/storecove/api/shop_account_requests_api.rb', line 80

def (id, opts = {})
  (id, opts)
  return nil
end

#delete_shop_account_request_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete ShopAccountRequest Delete a specific ShopAccountRequest include::examples/shop_account_requests/delete_shop_account_request/tabs.adoc[]

Parameters:

  • id —

    shop_account_request id

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



90
91
92
93
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
 
# File 'lib/storecove/api/shop_account_requests_api.rb', line 90

def (id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ShopAccountRequestsApi.delete_shop_account_request ..."
  end
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling ShopAccountRequestsApi.delete_shop_account_request" if id.nil?
  # resource path
  local_var_path = "/shop_account_requests/{id}".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['Bearer']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ShopAccountRequestsApi#delete_shop_account_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_shop_account_request(id, opts = {}) ⇒ ShopAccountRequestResult

Get ShopAccountRequest Show a specific ShopAccountRequest include::examples/shop_account_requests/get_shop_account_request/tabs.adoc[]

Parameters:

  • id —

    shop_account_request id

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

    the optional parameters

Returns:



132
133
134
135
 
# File 'lib/storecove/api/shop_account_requests_api.rb', line 132

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

#get_shop_account_request_with_http_info(id, opts = {}) ⇒ Array<(ShopAccountRequestResult, Fixnum, Hash)>

Get ShopAccountRequest Show a specific ShopAccountRequest include::examples/shop_account_requests/get_shop_account_request/tabs.adoc[]

Parameters:

  • id —

    shop_account_request id

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

    the optional parameters

Returns:

  • (Array<(ShopAccountRequestResult, Fixnum, Hash)>) —

    ShopAccountRequestResult data, response status code and response headers



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
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/storecove/api/shop_account_requests_api.rb', line 142

def (id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ShopAccountRequestsApi.get_shop_account_request ..."
  end
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling ShopAccountRequestsApi.get_shop_account_request" if id.nil?
  # resource path
  local_var_path = "/shop_account_requests/{id}".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['Bearer']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ShopAccountRequestResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ShopAccountRequestsApi#get_shop_account_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#shop_account_requests_index(external_user_id, opts = {}) ⇒ Array<ShopAccountRequestResult>

Get ShopAccountRequests Retrieve all active ShopAccountRequests for one of your entities. include::examples/shop_account_requests/shop_account_requests_index/tabs.adoc[]

Parameters:

  • external_user_id —

    Filter by the external_user_id

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

    the optional parameters

Returns:



185
186
187
188
 
# File 'lib/storecove/api/shop_account_requests_api.rb', line 185

def (external_user_id, opts = {})
  data, _status_code, _headers = (external_user_id, opts)
  return data
end

#shop_account_requests_index_with_http_info(external_user_id, opts = {}) ⇒ Array<(Array<ShopAccountRequestResult>, Fixnum, Hash)>

Get ShopAccountRequests Retrieve all active ShopAccountRequests for one of your entities. include::examples/shop_account_requests/shop_account_requests_index/tabs.adoc[]

Parameters:

  • external_user_id —

    Filter by the external_user_id

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

    the optional parameters

Returns:

  • (Array<(Array<ShopAccountRequestResult>, Fixnum, Hash)>) —

    Array<ShopAccountRequestResult> data, response status code and response headers



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
 
# File 'lib/storecove/api/shop_account_requests_api.rb', line 195

def (external_user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ShopAccountRequestsApi.shop_account_requests_index ..."
  end
  # verify the required parameter 'external_user_id' is set
  fail ArgumentError, "Missing the required parameter 'external_user_id' when calling ShopAccountRequestsApi.shop_account_requests_index" if external_user_id.nil?
  # resource path
  local_var_path = "/shop_account_requests".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'external_user_id'] = external_user_id

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['Bearer']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<ShopAccountRequestResult>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ShopAccountRequestsApi#shop_account_requests_index\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_shop_account_request(id, shop_account_request, opts = {}) ⇒ ShopAccountRequestResult

Update ShopAccountRequest Update a specific ShopAccountRequest include::examples/shop_account_requests/update_shop_account_request/tabs.adoc[]

Parameters:

  • id —

    shop_account_request id

  • shop_account_request —

    ShopAccountRequest updates

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

    the optional parameters

Returns:



240
241
242
243
 
# File 'lib/storecove/api/shop_account_requests_api.rb', line 240

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

#update_shop_account_request_with_http_info(id, shop_account_request, opts = {}) ⇒ Array<(ShopAccountRequestResult, Fixnum, Hash)>

Update ShopAccountRequest Update a specific ShopAccountRequest include::examples/shop_account_requests/update_shop_account_request/tabs.adoc[]

Parameters:

  • id —

    shop_account_request id

  • shop_account_request —

    ShopAccountRequest updates

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

    the optional parameters

Returns:

  • (Array<(ShopAccountRequestResult, Fixnum, Hash)>) —

    ShopAccountRequestResult data, response status code and response headers



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
 
# File 'lib/storecove/api/shop_account_requests_api.rb', line 251

def (id, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ShopAccountRequestsApi.update_shop_account_request ..."
  end
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling ShopAccountRequestsApi.update_shop_account_request" if id.nil?
  # verify the required parameter 'shop_account_request' is set
  fail ArgumentError, "Missing the required parameter 'shop_account_request' when calling ShopAccountRequestsApi.update_shop_account_request" if .nil?
  # resource path
  local_var_path = "/shop_account_requests/{id}".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body()
  auth_names = ['Bearer']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ShopAccountRequestResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ShopAccountRequestsApi#update_shop_account_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end