budgea_client 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1ec043e81509da439e460c10aca0b9e6894b4e7b63816e59386e7fceff98b24
-  data.tar.gz: 14fb09eec18ff1efb4c7485fd7e5f8df4742a3078947a4deab0aa178f4329b49
+  metadata.gz: 8cd8784e37d32038438d73ad2131f6de46de51e7051e5057c0ed5ec59e97091b
+  data.tar.gz: c77c4ea49e33e73fa437629b80ec2afcccaf134462fe8f49689f13406d21f27e
 SHA512:
-  metadata.gz: 616b0bb0531e13056ea3371acddfc10fdaa291b5ffec7d4d35007b1fbbf63e41689efe0abae6650e33473f2c067c9757c6d79c3998721ab1b6103fa66a4b9857
-  data.tar.gz: d22ff9b43b4ce1aff5d2f0863c6422e8edcac127a6798d60ee6d3e9675719622e32cbb892a40379d15456251e07520587f45783af499c4ec342223a896f370f8
+  metadata.gz: 12bedcb431c5c588485c6da04124730498830e38ecbe9a0f3e6e64731d1066759eb22572d72cb468d1d53c57e1c950efceac5c75c5d2a0ae088c819d907c6c3e
+  data.tar.gz: dc4cbe6abed193e9a2a9a4828283a2d828e84f7096edd7d037b1215addb0fb23bfe0c675a92f049cfdbd5a1d7442746e16460a036de9577e2a9c2ddb195bcae1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    budgea_client (2.0.1)
+    budgea_client (2.0.2)
       json (~> 2.1, >= 2.1.0)
       typhoeus (~> 1.0, >= 1.0.1)
 

data/Rakefile

@@ -1,9 +1,13 @@
 begin
   require 'rspec/core/rake_task'
-  require 'bundler/gem_tasks'
 
   RSpec::Core::RakeTask.new(:spec)
   task default: :spec
 rescue LoadError
   # no rspec available
 end
+begin
+  require 'bundler/gem_tasks'
+rescue LoadError
+  # no rspec available
+end

data/docs/AuthProvider.md

@@ -0,0 +1,10 @@
+# BudgeaClient::AuthProvider
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | 
+**name** | **String** | Name to differentiate the authentication type | 
+**type** | **String** | Authentication type to use when pushing the webhook | 
+
+

data/docs/ConfigLog.md

@@ -0,0 +1,13 @@
+# BudgeaClient::ConfigLog
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | 
+**key** | **String** |  | 
+**previous_value** | **String** |  | [optional] 
+**new_value** | **String** |  | [optional] 
+**type** | **String** | Action done on the config: add, update or delete | 
+**timestamp** | **DateTime** | Timestamp of when the configuration key was changed | 
+
+

data/docs/HUBApi.md

@@ -0,0 +1,62 @@
+# BudgeaClient::HUBApi
+
+All URIs are relative to *https://demo.biapi.pro/2.0/*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**webhooks_id_webhook_add_to_data_post**](HUBApi.md#webhooks_id_webhook_add_to_data_post) | **POST** /webhooks/{id_webhook}/add_to_data | Setup a field to store in user config when calling the endpoint
+
+
+# **webhooks_id_webhook_add_to_data_post**
+> webhooks_id_webhook_add_to_data_post(id_webhook)
+
+Setup a field to store in user config when calling the endpoint
+
+For each parameter, a value will be added in the webhook data. Use the key to set the name of the field. The values that can be added are to be found in the user configuration.<br><br>
+
+### Example
+```ruby
+# load the gem
+require 'budgea_client'
+# setup authorization
+BudgeaClient.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = BudgeaClient::HUBApi.new
+
+id_webhook = 56 # Integer | 
+
+
+begin
+  #Setup a field to store in user config when calling the endpoint
+  api_instance.webhooks_id_webhook_add_to_data_post(id_webhook)
+rescue BudgeaClient::ApiError => e
+  puts "Exception when calling HUBApi->webhooks_id_webhook_add_to_data_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id_webhook** | **Integer**|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, multipart/form-data
+ - **Accept**: application/json
+
+
+

data/docs/InlineResponse20037.md

@@ -0,0 +1,8 @@
+# BudgeaClient::InlineResponse20037
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**authproviders** | [**Array<AuthProvider>**](AuthProvider.md) |  | 
+
+

data/docs/InlineResponse20038.md

@@ -0,0 +1,8 @@
+# BudgeaClient::InlineResponse20038
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**webhooklogs** | [**Array<WebhookLog>**](WebhookLog.md) |  | 
+
+

data/docs/Keyword.md

@@ -0,0 +1,12 @@
+# BudgeaClient::Keyword
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | 
+**keyword** | **String** |  | 
+**id_category** | **Integer** |  | 
+**priority** | **Integer** |  | 
+**income** | **BOOLEAN** |  | 
+
+

data/docs/WebhookData.md

@@ -0,0 +1,16 @@
+# BudgeaClient::WebhookData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | ID of the webhook data | 
+**id_webhook** | **Integer** | ID of the webhook | 
+**id_service** | **Integer** | ID of the recipient service | [optional] 
+**id_user** | **Integer** | ID of the emitter user | 
+**id_resource** | **Integer** | a changing ID used to filter webhookdata depending on the event triggered | [optional] 
+**data** | **String** | Data emitted | [optional] 
+**mimetype** | **String** | Mimetype of the data | [optional] 
+**created** | **DateTime** | Timestamp when the hook data was generated | 
+**success** | **DateTime** | Timestamp when the hook has been successfully called | [optional] 
+
+

data/lib/budgea_client/api/hub_api.rb

@@ -0,0 +1,76 @@
+=begin
+#Budgea API Documentation
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: 2.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.1
+
+=end
+
+require 'uri'
+
+module BudgeaClient
+  class HUBApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Setup a field to store in user config when calling the endpoint
+    # For each parameter, a value will be added in the webhook data. Use the key to set the name of the field. The values that can be added are to be found in the user configuration.<br><br>
+    # @param id_webhook 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def webhooks_id_webhook_add_to_data_post(id_webhook, opts = {})
+      webhooks_id_webhook_add_to_data_post_with_http_info(id_webhook, opts)
+      nil
+    end
+
+    # Setup a field to store in user config when calling the endpoint
+    # For each parameter, a value will be added in the webhook data. Use the key to set the name of the field. The values that can be added are to be found in the user configuration.&lt;br&gt;&lt;br&gt;
+    # @param id_webhook 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def webhooks_id_webhook_add_to_data_post_with_http_info(id_webhook, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: HUBApi.webhooks_id_webhook_add_to_data_post ...'
+      end
+      # verify the required parameter 'id_webhook' is set
+      if @api_client.config.client_side_validation && id_webhook.nil?
+        fail ArgumentError, "Missing the required parameter 'id_webhook' when calling HUBApi.webhooks_id_webhook_add_to_data_post"
+      end
+      # resource path
+      local_var_path = '/webhooks/{id_webhook}/add_to_data'.sub('{' + 'id_webhook' + '}', id_webhook.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', 'multipart/form-data'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['api_key']
+      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)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: HUBApi#webhooks_id_webhook_add_to_data_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/budgea_client/models/auth_provider.rb

@@ -0,0 +1,218 @@
+=begin
+#Budgea API Documentation
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: 2.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.1
+
+=end
+
+require 'date'
+
+module BudgeaClient
+  class AuthProvider
+    attr_accessor :id
+
+    # Name to differentiate the authentication type
+    attr_accessor :name
+
+    # Authentication type to use when pushing the webhook
+    attr_accessor :type
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'name' => :'name',
+        :'type' => :'type'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'id' => :'Integer',
+        :'name' => :'String',
+        :'type' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.has_key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.has_key?(:'type')
+        self.type = attributes[:'type']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @id.nil?
+      return false if @name.nil?
+      return false if @type.nil?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          id == o.id &&
+          name == o.name &&
+          type == o.type
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [id, name, type].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = BudgeaClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end