class Nilpart::Nilpart
Constants
- PRODUCTION_SERVER
- SANDBOX_SERVER
Attributes
conn[RW]
my_api_key[RW]
production[RW]
Public Class Methods
new(params)
click to toggle source
api_key
your api_key mode
“production” or “sandbox”
# File lib/nilpart/nilpart.rb, line 18 def initialize(params) @my_api_key = params[:api_key] raise ':api_key is required !' if @my_api_key.to_s.empty? raise ':mode params must be "production" or "sandbox"' unless ['production', 'sandbox'].include?(params[:mode]) @production = params[:mode].to_s == 'production' @conn = Faraday.new do |f| f.response :follow_redirects end end
Public Instance Methods
api_key_get(id)
click to toggle source
# File lib/nilpart/nilpart.rb, line 81 def api_key_get(id) get_request("api_keys/#{id}") end
api_key_revoke(id)
click to toggle source
# File lib/nilpart/nilpart.rb, line 89 def api_key_revoke(id) post_request("api_keys/revoke/#{id}") end
api_key_update(id, params = {})
click to toggle source
# File lib/nilpart/nilpart.rb, line 85 def api_key_update(id, params = {}) put_request("api_keys/#{id}", params) end
api_keys(params = {})
click to toggle source
Api-Key
# File lib/nilpart/nilpart.rb, line 77 def api_keys(params = {}) get_request('api_keys', params) end
boost_invitation_search(params = {})
click to toggle source
# File lib/nilpart/nilpart.rb, line 378 def boost_invitation_search(params = {}) get_request("review_booster/search-invitation", params) end
boost_invitation_status(params = {})
click to toggle source
# File lib/nilpart/nilpart.rb, line 374 def boost_invitation_status(params = {}) get_request("review_booster/invitation_status", params) end
boost_send_invitation(params = {})
click to toggle source
Boosts
# File lib/nilpart/nilpart.rb, line 370 def boost_send_invitation(params = {}) post_request("review_booster/send_invitation", params) end
business_connections_stats()
click to toggle source
# File lib/nilpart/nilpart.rb, line 145 def business_connections_stats get_request("business/connections_stats") end
business_create(params = {})
click to toggle source
# File lib/nilpart/nilpart.rb, line 141 def business_create(params = {}) post_request("business", params) end
business_delete(id)
click to toggle source
# File lib/nilpart/nilpart.rb, line 157 def business_delete(id) delete_request("business/#{id}") end
business_fields_for_business(id)
click to toggle source
Business Fields
# File lib/nilpart/nilpart.rb, line 193 def business_fields_for_business(id) get_request("business/#{id}/business_fields") end
Also aliased as: business_get_business_fields
business_fields_for_organization(id)
click to toggle source
# File lib/nilpart/nilpart.rb, line 198 def business_fields_for_organization(id) get_request("business/#{id}/business_fields") end
Also aliased as: organization_get_business_fields
business_fields_for_provider(id)
click to toggle source
# File lib/nilpart/nilpart.rb, line 203 def business_fields_for_provider(id) get_request("business/#{id}/business_fields") end
Also aliased as: provider_get_business_fields
business_get(id)
click to toggle source
# File lib/nilpart/nilpart.rb, line 149 def business_get(id) get_request("business/#{id}") end
business_get_additional_data(id)
click to toggle source
# File lib/nilpart/nilpart.rb, line 173 def business_get_additional_data(id) get_request("business/#{id}/additional_data") end
business_get_google_attributes(id, params = {})
click to toggle source
# File lib/nilpart/nilpart.rb, line 181 def business_get_google_attributes(id, params = {}) get_request("business/#{id}/attributes", params) end
business_integration_data(id)
click to toggle source
# File lib/nilpart/nilpart.rb, line 165 def business_integration_data(id) get_request("business/#{id}/integration_status") end
business_partner_urls(id)
click to toggle source
# File lib/nilpart/nilpart.rb, line 161 def business_partner_urls(id) get_request("business/#{id}/partner_urls") end
business_set_additional_data(id, params = {})
click to toggle source
# File lib/nilpart/nilpart.rb, line 177 def business_set_additional_data(id, params = {}) post_request("business/#{id}/additional_data", params) end
business_set_google_attributes(id, params = {})
click to toggle source
# File lib/nilpart/nilpart.rb, line 185 def business_set_google_attributes(id, params = {}) post_request("business/#{id}/attributes", params) end
business_subscription(id)
click to toggle source
# File lib/nilpart/nilpart.rb, line 169 def business_subscription(id) get_request("business/#{id}/subscription") end
business_update(id, params = {})
click to toggle source
# File lib/nilpart/nilpart.rb, line 153 def business_update(id, params = {}) post_request("business/#{id}", params) end
businesses_search(params = {})
click to toggle source
BUSINESS
# File lib/nilpart/nilpart.rb, line 137 def businesses_search(params = {}) get_request("business/search", params) end
category_get(id, params = {})
click to toggle source
Categories
# File lib/nilpart/nilpart.rb, line 354 def category_get(id, params = {}) get_request("category/#{id}", params) end
connection_check_token(params = {})
click to toggle source
# File lib/nilpart/nilpart.rb, line 105 def connection_check_token(params = {}) get_request("connection/check_token", params) end
connection_generate_token(params = {})
click to toggle source
Connection Tokens
# File lib/nilpart/nilpart.rb, line 97 def connection_generate_token(params = {}) post_request("connection/generate_token", params) end
connection_revoke_token(params = {})
click to toggle source
# File lib/nilpart/nilpart.rb, line 101 def connection_revoke_token(params = {}) post_request("connection/revoke_token", params) end
custom_field_create(params = {})
click to toggle source
Custom Fields
# File lib/nilpart/nilpart.rb, line 434 def custom_field_create(params = {}) post_request("custom_fields", params) end
custom_field_delete(id)
click to toggle source
# File lib/nilpart/nilpart.rb, line 442 def custom_field_delete(id) delete_request("custom_fields/#{id}") end
custom_field_update(id, params = {})
click to toggle source
# File lib/nilpart/nilpart.rb, line 438 def custom_field_update(id, params = {}) put_request("custom_fields/#{id}", params) end
custom_fields_order(params = {})
click to toggle source
# File lib/nilpart/nilpart.rb, line 446 def custom_fields_order(params = {}) post_request("custom_fields/order", params) end
delete_request(path, params = {})
click to toggle source
# File lib/nilpart/nilpart.rb, line 43 def delete_request(path, params = {}) response = @conn.delete("#{self.server_url}#{path}", params, { 'x-APIKey' => @my_api_key }) if response.status != 200 # Faraday has not constante for status 200 puts "#{__method__} : Path => #{path} : Status => #{response.status}" end return JSON.parse(response.body) end
get_request(path, params = {})
click to toggle source
# File lib/nilpart/nilpart.rb, line 35 def get_request(path, params = {}) response = @conn.get("#{self.server_url}#{path}", params, { 'x-APIKey' => @my_api_key }) if response.status != 200 # Faraday has not constante for status 200 puts "#{__method__} : Path => #{path} : Status => #{response.status}" end return JSON.parse(response.body) end
gmb_attributes_list(params = {})
click to toggle source
GMB Attributes
# File lib/nilpart/nilpart.rb, line 454 def gmb_attributes_list(params = {}) get_request("attributes/list", params) end
google_post_create(params = {})
click to toggle source
# File lib/nilpart/nilpart.rb, line 414 def google_post_create(params = {}) post_request("google_posts", params) end
google_post_delete(id)
click to toggle source
# File lib/nilpart/nilpart.rb, line 426 def google_post_delete(id) delete_request("google_posts/#{id}") end
google_post_get(id)
click to toggle source
# File lib/nilpart/nilpart.rb, line 418 def google_post_get(id) get_request("google_posts/#{id}") end
google_post_update(id, params = {})
click to toggle source
# File lib/nilpart/nilpart.rb, line 422 def google_post_update(id, params = {}) put_request("google_posts/#{id}", params) end
google_posts_search(params = {})
click to toggle source
Google post
# File lib/nilpart/nilpart.rb, line 410 def google_posts_search(params = {}) get_request("google_posts", params) end
group_create(params = {})
click to toggle source
# File lib/nilpart/nilpart.rb, line 256 def group_create(params = {}) post_request("groups", params) end
group_delete(id)
click to toggle source
# File lib/nilpart/nilpart.rb, line 268 def group_delete(id) delete_request("groups/#{id}") end
group_get(id)
click to toggle source
# File lib/nilpart/nilpart.rb, line 260 def group_get(id) get_request("groups/#{id}") end
group_get_businesses(id)
click to toggle source
# File lib/nilpart/nilpart.rb, line 272 def group_get_businesses(id) get_request("groups/#{id}/businesses") end
group_manage_businesses(id, params = {})
click to toggle source
# File lib/nilpart/nilpart.rb, line 276 def group_manage_businesses(id, params = {}) put_request("groups/#{id}/businesses", params) end
group_update(id, params = {})
click to toggle source
# File lib/nilpart/nilpart.rb, line 264 def group_update(id, params = {}) put_request("groups/#{id}", params) end
groups_get()
click to toggle source
Groups
# File lib/nilpart/nilpart.rb, line 252 def groups_get get_request("groups") end
organisation_create(params = {})
click to toggle source
# File lib/nilpart/nilpart.rb, line 121 def organisation_create(params = {}) post_request("org", params) end
organisation_delete(id, params = {})
click to toggle source
# File lib/nilpart/nilpart.rb, line 129 def organisation_delete(id, params = {}) delete_request("org/#{id}", params) end
organisation_get(id)
click to toggle source
# File lib/nilpart/nilpart.rb, line 117 def organisation_get(id) get_request("org/#{id}") end
organisation_search(params = {})
click to toggle source
ORGANISATION
# File lib/nilpart/nilpart.rb, line 113 def organisation_search(params = {}) get_request("org/search", params) end
organisation_update(id, params = {})
click to toggle source
# File lib/nilpart/nilpart.rb, line 125 def organisation_update(id, params = {}) post_request("org/#{id}", params) end
post_request(path, body = {})
click to toggle source
# File lib/nilpart/nilpart.rb, line 51 def post_request(path, body = {}) response = @conn.post("#{self.server_url}#{path}", body.to_json, { 'x-APIKey' => @my_api_key, "Content-Type" => "application/json" }) if response.status != 200 # Faraday has not constante for status 200 puts "#{__method__} : Path => #{path} : Status => #{response.status}" end return JSON.parse(response.body) end
presence_analytics_export(params = {})
click to toggle source
# File lib/nilpart/nilpart.rb, line 402 def presence_analytics_export(params = {}) get_request("presence_analytics_export", params) end
presence_analytics_get(params = {})
click to toggle source
Presence analytics
# File lib/nilpart/nilpart.rb, line 398 def presence_analytics_get(params = {}) get_request("presence_analytics", params) end
presence_business_info(params = {})
click to toggle source
Presence
# File lib/nilpart/nilpart.rb, line 386 def presence_business_info(params = {}) get_request("publisher_states/business_info", params) end
presence_businesses_info(params = {})
click to toggle source
# File lib/nilpart/nilpart.rb, line 390 def presence_businesses_info(params = {}) get_request("publisher_states/businesses_info", params) end
put_request(path, body = {})
click to toggle source
# File lib/nilpart/nilpart.rb, line 59 def put_request(path, body = {}) response = @conn.put("#{self.server_url}#{path}", body.to_json, { 'x-APIKey' => @my_api_key, "Content-Type" => "application/json" }) if response.status != 200 # Faraday has not constante for status 200 puts "#{__method__} : Path => #{path} : Status => #{response.status}" end return JSON.parse(response.body) end
reply_template_create(params = {})
click to toggle source
# File lib/nilpart/nilpart.rb, line 322 def reply_template_create(params = {}) post_request("reviews/template", params) end
reply_template_delete(id)
click to toggle source
# File lib/nilpart/nilpart.rb, line 326 def reply_template_delete(id) delete_request("reviews/template/#{id}") end
reply_templates_placeholders()
click to toggle source
# File lib/nilpart/nilpart.rb, line 330 def reply_templates_placeholders get_request("reviews/templates/placeholders") end
reply_templates_search(params = {})
click to toggle source
Reply templates
# File lib/nilpart/nilpart.rb, line 318 def reply_templates_search(params = {}) get_request("reviews/templates/search", params) end
review_delete_a_reply(id)
click to toggle source
# File lib/nilpart/nilpart.rb, line 310 def review_delete_a_reply(id) delete_request("comments/#{id}") end
review_modify_a_reply(id, params = {})
click to toggle source
# File lib/nilpart/nilpart.rb, line 306 def review_modify_a_reply(id, params = {}) put_request("comments/#{id}", params) end
review_post_a_reply(params = {})
click to toggle source
# File lib/nilpart/nilpart.rb, line 302 def review_post_a_reply(params = {}) post_request("comments", params) end
reviews_qualitative_evolution(params = {})
click to toggle source
# File lib/nilpart/nilpart.rb, line 342 def reviews_qualitative_evolution(params = {}) get_request("reviews/qualitative-evolution", params) end
reviews_quantitative_evolution(params = {})
click to toggle source
# File lib/nilpart/nilpart.rb, line 346 def reviews_quantitative_evolution(params = {}) get_request("reviews/quantitative-evolution", params) end
reviews_search(params = {})
click to toggle source
Reviews
# File lib/nilpart/nilpart.rb, line 298 def reviews_search(params = {}) get_request("reviews", params) end
reviews_statistics(params = {})
click to toggle source
Reviews Analytics
# File lib/nilpart/nilpart.rb, line 338 def reviews_statistics(params = {}) get_request("reviews/stats", params) end
server_url()
click to toggle source
# File lib/nilpart/nilpart.rb, line 31 def server_url @production ? PRODUCTION_SERVER : SANDBOX_SERVER end
subscribe_a_business(id)
click to toggle source
Subscriptions
# File lib/nilpart/nilpart.rb, line 284 def subscribe_a_business(id) post_request("business/#{id}/subscribe") end
Also aliased as: business_subscribe
unsubscribe_a_business(id)
click to toggle source
# File lib/nilpart/nilpart.rb, line 289 def unsubscribe_a_business(id) post_request("business/#{id}/unsubscribe") end
Also aliased as: business_unsubscribe
user_create(params = {})
click to toggle source
# File lib/nilpart/nilpart.rb, line 216 def user_create(params = {}) post_request("user", params) end
user_delete(id, params = {})
click to toggle source
# File lib/nilpart/nilpart.rb, line 228 def user_delete(id, params = {}) delete_request("user/#{id}", params) end
user_get(id)
click to toggle source
# File lib/nilpart/nilpart.rb, line 220 def user_get(id) get_request("user/#{id}") end
user_get_businesses(id)
click to toggle source
# File lib/nilpart/nilpart.rb, line 244 def user_get_businesses(id) get_request("user/#{id}/businesses") end
user_me()
click to toggle source
Users
# File lib/nilpart/nilpart.rb, line 212 def user_me get_request("user/me") end
user_reinvite(id)
click to toggle source
# File lib/nilpart/nilpart.rb, line 240 def user_reinvite(id) post_request("user/#{id}/invite") end
user_update(id, params = {})
click to toggle source
# File lib/nilpart/nilpart.rb, line 224 def user_update(id, params = {}) post_request("user/#{id}", params) end
users_count(params = {})
click to toggle source
# File lib/nilpart/nilpart.rb, line 236 def users_count(params = {}) get_request("user/search/count", params) end
users_search(params = {})
click to toggle source
# File lib/nilpart/nilpart.rb, line 232 def users_search(params = {}) get_request("user/search", params) end