DealMakerAPI 0.0.3 → 0.68.6

data/docs/DefaultApi.md

@@ -0,0 +1,413 @@
+# DealMakerAPI::DefaultApi
+
+All URIs are relative to *http://api.dealmaker.tech*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_webhooks**](DefaultApi.md#get_webhooks) | **GET** /webhooks | Returns a list of webhook subscription which is associated to the user |
+| [**get_webhooks_deal_id**](DefaultApi.md#get_webhooks_deal_id) | **GET** /webhooks/deal/{id} | Finds a deal using the id |
+| [**get_webhooks_deals_search**](DefaultApi.md#get_webhooks_deals_search) | **GET** /webhooks/deals/search | Searches for deals for a given user |
+| [**get_webhooks_security_token**](DefaultApi.md#get_webhooks_security_token) | **GET** /webhooks/security_token | Creates a new security token for webhook subscription |
+| [**post_webhooks**](DefaultApi.md#post_webhooks) | **POST** /webhooks | Creates a webhook subscription which is associated to the user |
+| [**put_webhooks_id**](DefaultApi.md#put_webhooks_id) | **PUT** /webhooks/{id} | Updates webhook subscription and webhooks subcription deals |
+
+
+## get_webhooks
+
+> <V1EntitiesWebhooksSubscription> get_webhooks(opts)
+
+Returns a list of webhook subscription which is associated to the user
+
+Returns a list of webhook subscription
+
+### Examples
+
+```ruby
+require 'time'
+require 'DealMakerAPI'
+# setup authorization
+DealMakerAPI.configure do |config|end
+
+api_instance = DealMakerAPI::DefaultApi.new
+opts = {
+  page: 56, # Integer | Page offset to fetch.
+  per_page: 56, # Integer | Number of results to return per page.
+  offset: 56 # Integer | Pad a number of results.
+}
+
+begin
+  # Returns a list of webhook subscription which is associated to the user
+  result = api_instance.get_webhooks(opts)
+  p result
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling DefaultApi->get_webhooks: #{e}"
+end
+```
+
+#### Using the get_webhooks_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<V1EntitiesWebhooksSubscription>, Integer, Hash)> get_webhooks_with_http_info(opts)
+
+```ruby
+begin
+  # Returns a list of webhook subscription which is associated to the user
+  data, status_code, headers = api_instance.get_webhooks_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <V1EntitiesWebhooksSubscription>
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling DefaultApi->get_webhooks_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** | Page offset to fetch. | [optional][default to 1] |
+| **per_page** | **Integer** | Number of results to return per page. | [optional][default to 25] |
+| **offset** | **Integer** | Pad a number of results. | [optional][default to 0] |
+
+### Return type
+
+[**V1EntitiesWebhooksSubscription**](V1EntitiesWebhooksSubscription.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_webhooks_deal_id
+
+> <V1EntitiesWebhooksDeal> get_webhooks_deal_id(id)
+
+Finds a deal using the id
+
+Returns a deal
+
+### Examples
+
+```ruby
+require 'time'
+require 'DealMakerAPI'
+# setup authorization
+DealMakerAPI.configure do |config|end
+
+api_instance = DealMakerAPI::DefaultApi.new
+id = 56 # Integer | 
+
+begin
+  # Finds a deal using the id
+  result = api_instance.get_webhooks_deal_id(id)
+  p result
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling DefaultApi->get_webhooks_deal_id: #{e}"
+end
+```
+
+#### Using the get_webhooks_deal_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<V1EntitiesWebhooksDeal>, Integer, Hash)> get_webhooks_deal_id_with_http_info(id)
+
+```ruby
+begin
+  # Finds a deal using the id
+  data, status_code, headers = api_instance.get_webhooks_deal_id_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <V1EntitiesWebhooksDeal>
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling DefaultApi->get_webhooks_deal_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  |  |
+
+### Return type
+
+[**V1EntitiesWebhooksDeal**](V1EntitiesWebhooksDeal.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_webhooks_deals_search
+
+> <V1EntitiesWebhooksSecurityToken> get_webhooks_deals_search
+
+Searches for deals for a given user
+
+Searches for deals for a given user
+
+### Examples
+
+```ruby
+require 'time'
+require 'DealMakerAPI'
+# setup authorization
+DealMakerAPI.configure do |config|end
+
+api_instance = DealMakerAPI::DefaultApi.new
+
+begin
+  # Searches for deals for a given user
+  result = api_instance.get_webhooks_deals_search
+  p result
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling DefaultApi->get_webhooks_deals_search: #{e}"
+end
+```
+
+#### Using the get_webhooks_deals_search_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<V1EntitiesWebhooksSecurityToken>, Integer, Hash)> get_webhooks_deals_search_with_http_info
+
+```ruby
+begin
+  # Searches for deals for a given user
+  data, status_code, headers = api_instance.get_webhooks_deals_search_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <V1EntitiesWebhooksSecurityToken>
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling DefaultApi->get_webhooks_deals_search_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**V1EntitiesWebhooksSecurityToken**](V1EntitiesWebhooksSecurityToken.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_webhooks_security_token
+
+> <V1EntitiesWebhooksSecurityToken> get_webhooks_security_token
+
+Creates a new security token for webhook subscription
+
+Creates a new security token for webhook subscription
+
+### Examples
+
+```ruby
+require 'time'
+require 'DealMakerAPI'
+# setup authorization
+DealMakerAPI.configure do |config|end
+
+api_instance = DealMakerAPI::DefaultApi.new
+
+begin
+  # Creates a new security token for webhook subscription
+  result = api_instance.get_webhooks_security_token
+  p result
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling DefaultApi->get_webhooks_security_token: #{e}"
+end
+```
+
+#### Using the get_webhooks_security_token_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<V1EntitiesWebhooksSecurityToken>, Integer, Hash)> get_webhooks_security_token_with_http_info
+
+```ruby
+begin
+  # Creates a new security token for webhook subscription
+  data, status_code, headers = api_instance.get_webhooks_security_token_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <V1EntitiesWebhooksSecurityToken>
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling DefaultApi->get_webhooks_security_token_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**V1EntitiesWebhooksSecurityToken**](V1EntitiesWebhooksSecurityToken.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## post_webhooks
+
+> <V1EntitiesWebhooksSubscription> post_webhooks(post_webhooks_request)
+
+Creates a webhook subscription which is associated to the user
+
+Creates new webhook subscription
+
+### Examples
+
+```ruby
+require 'time'
+require 'DealMakerAPI'
+# setup authorization
+DealMakerAPI.configure do |config|end
+
+api_instance = DealMakerAPI::DefaultApi.new
+post_webhooks_request = DealMakerAPI::PostWebhooksRequest.new({name: 'name_example', enabled: false, webhook_subscription_deals_deal_id: [37]}) # PostWebhooksRequest | 
+
+begin
+  # Creates a webhook subscription which is associated to the user
+  result = api_instance.post_webhooks(post_webhooks_request)
+  p result
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling DefaultApi->post_webhooks: #{e}"
+end
+```
+
+#### Using the post_webhooks_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<V1EntitiesWebhooksSubscription>, Integer, Hash)> post_webhooks_with_http_info(post_webhooks_request)
+
+```ruby
+begin
+  # Creates a webhook subscription which is associated to the user
+  data, status_code, headers = api_instance.post_webhooks_with_http_info(post_webhooks_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <V1EntitiesWebhooksSubscription>
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling DefaultApi->post_webhooks_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **post_webhooks_request** | [**PostWebhooksRequest**](PostWebhooksRequest.md) |  |  |
+
+### Return type
+
+[**V1EntitiesWebhooksSubscription**](V1EntitiesWebhooksSubscription.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## put_webhooks_id
+
+> <V1EntitiesWebhooksSubscription> put_webhooks_id(id, opts)
+
+Updates webhook subscription and webhooks subcription deals
+
+Updates webhook subscription
+
+### Examples
+
+```ruby
+require 'time'
+require 'DealMakerAPI'
+# setup authorization
+DealMakerAPI.configure do |config|end
+
+api_instance = DealMakerAPI::DefaultApi.new
+id = 56 # Integer | 
+opts = {
+  put_webhooks_id_request: DealMakerAPI::PutWebhooksIdRequest.new # PutWebhooksIdRequest | 
+}
+
+begin
+  # Updates webhook subscription and webhooks subcription deals
+  result = api_instance.put_webhooks_id(id, opts)
+  p result
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling DefaultApi->put_webhooks_id: #{e}"
+end
+```
+
+#### Using the put_webhooks_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<V1EntitiesWebhooksSubscription>, Integer, Hash)> put_webhooks_id_with_http_info(id, opts)
+
+```ruby
+begin
+  # Updates webhook subscription and webhooks subcription deals
+  data, status_code, headers = api_instance.put_webhooks_id_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <V1EntitiesWebhooksSubscription>
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling DefaultApi->put_webhooks_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  |  |
+| **put_webhooks_id_request** | [**PutWebhooksIdRequest**](PutWebhooksIdRequest.md) |  | [optional] |
+
+### Return type
+
+[**V1EntitiesWebhooksSubscription**](V1EntitiesWebhooksSubscription.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+