Skip to content

Latest commit

 

History

History
281 lines (191 loc) · 8.31 KB

CustomerStoresApi.md

File metadata and controls

281 lines (191 loc) · 8.31 KB

SwaggerClient::CustomerStoresApi

All URIs are relative to https://api.beezup.com/v2

Method HTTP request Description
create_store POST /user/customer/stores Create a new store
delete_store DELETE /user/customer/stores/{storeId} Delete a store
get_store GET /user/customer/stores/{storeId} Get store's information
get_stores GET /user/customer/stores Get store list
update_store PATCH /user/customer/stores/{storeId} Update some store's information.

create_store

LinksGetStoreLink create_store(request)

Create a new store

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
end

api_instance = SwaggerClient::CustomerStoresApi.new

request = SwaggerClient::CreateStoreRequest.new # CreateStoreRequest | 


begin
  #Create a new store
  result = api_instance.create_store(request)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling CustomerStoresApi->create_store: #{e}"
end

Parameters

Name Type Description Notes
request CreateStoreRequest

Return type

LinksGetStoreLink

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

delete_store

delete_store(store_id, )

Delete a store

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
end

api_instance = SwaggerClient::CustomerStoresApi.new

store_id = "store_id_example" # String | Your store identifier


begin
  #Delete a store
  api_instance.delete_store(store_id, )
rescue SwaggerClient::ApiError => e
  puts "Exception when calling CustomerStoresApi->delete_store: #{e}"
end

Parameters

Name Type Description Notes
store_id String Your store identifier

Return type

nil (empty response body)

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

get_store

Store get_store(store_id, , opts)

Get store's information

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
end

api_instance = SwaggerClient::CustomerStoresApi.new

store_id = "store_id_example" # String | Your store identifier

opts = { 
  if_none_match: "if_none_match_example" # String | ETag value to identify the last known version of requested resource.\\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3 
}

begin
  #Get store's information
  result = api_instance.get_store(store_id, , opts)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling CustomerStoresApi->get_store: #{e}"
end

Parameters

Name Type Description Notes
store_id String Your store identifier
if_none_match String ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3 [optional]

Return type

Store

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

get_stores

StoreList get_stores(opts)

Get store list

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
end

api_instance = SwaggerClient::CustomerStoresApi.new

opts = { 
  if_none_match: "if_none_match_example" # String | ETag value to identify the last known version of requested resource.\\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3 
}

begin
  #Get store list
  result = api_instance.get_stores(opts)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling CustomerStoresApi->get_stores: #{e}"
end

Parameters

Name Type Description Notes
if_none_match String ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3 [optional]

Return type

StoreList

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

update_store

update_store(store_id, request)

Update some store's information.

Update some store's information. FYI, you cannot change the country.

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
end

api_instance = SwaggerClient::CustomerStoresApi.new

store_id = "store_id_example" # String | Your store identifier

request = SwaggerClient::UpdateStoreRequest.new # UpdateStoreRequest | 


begin
  #Update some store's information.
  api_instance.update_store(store_id, request)
rescue SwaggerClient::ApiError => e
  puts "Exception when calling CustomerStoresApi->update_store: #{e}"
end

Parameters

Name Type Description Notes
store_id String Your store identifier
request UpdateStoreRequest

Return type

nil (empty response body)

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json