sib-api-v3-sdk 2.1.3 → 2.1.4

data/lib/sib-api-v3-sdk/api/attributes_api.rb

@@ -20,31 +20,47 @@ module SibApiV3Sdk
       @api_client = api_client
     end
 
-    # Creates contact attributes
+    # Creates contact attribute
     # 
+    # @param attribute_category Category of the attribute
+    # @param attribute_name Name of the attribute
     # @param create_attribute Values to create an attribute
     # @param [Hash] opts the optional parameters
-    # @return [CreateModel]
-    def create_attribute(create_attribute, opts = {})
-      data, _status_code, _headers = create_attribute_with_http_info(create_attribute, opts)
-      return data
+    # @return [nil]
+    def create_attribute(attribute_category, attribute_name, create_attribute, opts = {})
+      create_attribute_with_http_info(attribute_category, attribute_name, create_attribute, opts)
+      return nil
     end
 
-    # Creates contact attributes
+    # Creates contact attribute
     # 
+    # @param attribute_category Category of the attribute
+    # @param attribute_name Name of the attribute
     # @param create_attribute Values to create an attribute
     # @param [Hash] opts the optional parameters
-    # @return [Array<(CreateModel, Fixnum, Hash)>] CreateModel data, response status code and response headers
-    def create_attribute_with_http_info(create_attribute, opts = {})
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def create_attribute_with_http_info(attribute_category, attribute_name, create_attribute, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: AttributesApi.create_attribute ..."
       end
+      # verify the required parameter 'attribute_category' is set
+      if @api_client.config.client_side_validation && attribute_category.nil?
+        fail ArgumentError, "Missing the required parameter 'attribute_category' when calling AttributesApi.create_attribute"
+      end
+      # verify enum value
+      if @api_client.config.client_side_validation && !['normal', 'transactional', 'category', 'calculated', 'global'].include?(attribute_category)
+        fail ArgumentError, "invalid value for 'attribute_category', must be one of normal, transactional, category, calculated, global"
+      end
+      # verify the required parameter 'attribute_name' is set
+      if @api_client.config.client_side_validation && attribute_name.nil?
+        fail ArgumentError, "Missing the required parameter 'attribute_name' when calling AttributesApi.create_attribute"
+      end
       # verify the required parameter 'create_attribute' is set
       if @api_client.config.client_side_validation && create_attribute.nil?
         fail ArgumentError, "Missing the required parameter 'create_attribute' when calling AttributesApi.create_attribute"
       end
       # resource path
-      local_var_path = "/contacts/attributes"
+      local_var_path = "/contacts/attributes/{attributeCategory}/{attributeName}".sub('{' + 'attributeCategory' + '}', attribute_category.to_s).sub('{' + 'attributeName' + '}', attribute_name.to_s)
 
       # query parameters
       query_params = {}
@@ -67,8 +83,7 @@ module SibApiV3Sdk
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'CreateModel')
+        :auth_names => auth_names)
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: AttributesApi#create_attribute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -77,29 +92,39 @@ module SibApiV3Sdk
 
     # Deletes an attribute
     # 
-    # @param attribute_id id of the attribute
+    # @param attribute_category Category of the attribute
+    # @param attribute_name Name of the existing attribute
     # @param [Hash] opts the optional parameters
     # @return [nil]
-    def delete_attribute(attribute_id, opts = {})
-      delete_attribute_with_http_info(attribute_id, opts)
+    def delete_attribute(attribute_category, attribute_name, opts = {})
+      delete_attribute_with_http_info(attribute_category, attribute_name, opts)
       return nil
     end
 
     # Deletes an attribute
     # 
-    # @param attribute_id id of the attribute
+    # @param attribute_category Category of the attribute
+    # @param attribute_name Name of the existing attribute
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
-    def delete_attribute_with_http_info(attribute_id, opts = {})
+    def delete_attribute_with_http_info(attribute_category, attribute_name, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: AttributesApi.delete_attribute ..."
       end
-      # verify the required parameter 'attribute_id' is set
-      if @api_client.config.client_side_validation && attribute_id.nil?
-        fail ArgumentError, "Missing the required parameter 'attribute_id' when calling AttributesApi.delete_attribute"
+      # verify the required parameter 'attribute_category' is set
+      if @api_client.config.client_side_validation && attribute_category.nil?
+        fail ArgumentError, "Missing the required parameter 'attribute_category' when calling AttributesApi.delete_attribute"
+      end
+      # verify enum value
+      if @api_client.config.client_side_validation && !['normal', 'transactional', 'category', 'calculated', 'global'].include?(attribute_category)
+        fail ArgumentError, "invalid value for 'attribute_category', must be one of normal, transactional, category, calculated, global"
+      end
+      # verify the required parameter 'attribute_name' is set
+      if @api_client.config.client_side_validation && attribute_name.nil?
+        fail ArgumentError, "Missing the required parameter 'attribute_name' when calling AttributesApi.delete_attribute"
       end
       # resource path
-      local_var_path = "/contacts/attributes/{attributeId}".sub('{' + 'attributeId' + '}', attribute_id.to_s)
+      local_var_path = "/contacts/attributes/{attributeCategory}/{attributeName}".sub('{' + 'attributeCategory' + '}', attribute_category.to_s).sub('{' + 'attributeName' + '}', attribute_name.to_s)
 
       # query parameters
       query_params = {}
@@ -177,5 +202,75 @@ module SibApiV3Sdk
       end
       return data, status_code, headers
     end
+
+    # Updates contact attribute
+    # 
+    # @param attribute_category Category of the attribute
+    # @param attribute_name Name of the existing attribute
+    # @param update_attribute Values to update an attribute
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def update_attribute(attribute_category, attribute_name, update_attribute, opts = {})
+      update_attribute_with_http_info(attribute_category, attribute_name, update_attribute, opts)
+      return nil
+    end
+
+    # Updates contact attribute
+    # 
+    # @param attribute_category Category of the attribute
+    # @param attribute_name Name of the existing attribute
+    # @param update_attribute Values to update an attribute
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def update_attribute_with_http_info(attribute_category, attribute_name, update_attribute, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: AttributesApi.update_attribute ..."
+      end
+      # verify the required parameter 'attribute_category' is set
+      if @api_client.config.client_side_validation && attribute_category.nil?
+        fail ArgumentError, "Missing the required parameter 'attribute_category' when calling AttributesApi.update_attribute"
+      end
+      # verify enum value
+      if @api_client.config.client_side_validation && !['category', 'calculated', 'global'].include?(attribute_category)
+        fail ArgumentError, "invalid value for 'attribute_category', must be one of category, calculated, global"
+      end
+      # verify the required parameter 'attribute_name' is set
+      if @api_client.config.client_side_validation && attribute_name.nil?
+        fail ArgumentError, "Missing the required parameter 'attribute_name' when calling AttributesApi.update_attribute"
+      end
+      # verify the required parameter 'update_attribute' is set
+      if @api_client.config.client_side_validation && update_attribute.nil?
+        fail ArgumentError, "Missing the required parameter 'update_attribute' when calling AttributesApi.update_attribute"
+      end
+      # resource path
+      local_var_path = "/contacts/attributes/{attributeCategory}/{attributeName}".sub('{' + 'attributeCategory' + '}', attribute_category.to_s).sub('{' + 'attributeName' + '}', attribute_name.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(update_attribute)
+      auth_names = ['api-key']
+      data, status_code, headers = @api_client.call_api(:PUT, 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: AttributesApi#update_attribute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

data/lib/sib-api-v3-sdk/api/contacts_api.rb

@@ -81,31 +81,47 @@ module SibApiV3Sdk
       return data, status_code, headers
     end
 
-    # Creates contact attributes
+    # Creates contact attribute
     # 
+    # @param attribute_category Category of the attribute
+    # @param attribute_name Name of the attribute
     # @param create_attribute Values to create an attribute
     # @param [Hash] opts the optional parameters
-    # @return [CreateModel]
-    def create_attribute(create_attribute, opts = {})
-      data, _status_code, _headers = create_attribute_with_http_info(create_attribute, opts)
-      return data
+    # @return [nil]
+    def create_attribute(attribute_category, attribute_name, create_attribute, opts = {})
+      create_attribute_with_http_info(attribute_category, attribute_name, create_attribute, opts)
+      return nil
     end
 
-    # Creates contact attributes
+    # Creates contact attribute
     # 
+    # @param attribute_category Category of the attribute
+    # @param attribute_name Name of the attribute
     # @param create_attribute Values to create an attribute
     # @param [Hash] opts the optional parameters
-    # @return [Array<(CreateModel, Fixnum, Hash)>] CreateModel data, response status code and response headers
-    def create_attribute_with_http_info(create_attribute, opts = {})
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def create_attribute_with_http_info(attribute_category, attribute_name, create_attribute, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: ContactsApi.create_attribute ..."
       end
+      # verify the required parameter 'attribute_category' is set
+      if @api_client.config.client_side_validation && attribute_category.nil?
+        fail ArgumentError, "Missing the required parameter 'attribute_category' when calling ContactsApi.create_attribute"
+      end
+      # verify enum value
+      if @api_client.config.client_side_validation && !['normal', 'transactional', 'category', 'calculated', 'global'].include?(attribute_category)
+        fail ArgumentError, "invalid value for 'attribute_category', must be one of normal, transactional, category, calculated, global"
+      end
+      # verify the required parameter 'attribute_name' is set
+      if @api_client.config.client_side_validation && attribute_name.nil?
+        fail ArgumentError, "Missing the required parameter 'attribute_name' when calling ContactsApi.create_attribute"
+      end
       # verify the required parameter 'create_attribute' is set
       if @api_client.config.client_side_validation && create_attribute.nil?
         fail ArgumentError, "Missing the required parameter 'create_attribute' when calling ContactsApi.create_attribute"
       end
       # resource path
-      local_var_path = "/contacts/attributes"
+      local_var_path = "/contacts/attributes/{attributeCategory}/{attributeName}".sub('{' + 'attributeCategory' + '}', attribute_category.to_s).sub('{' + 'attributeName' + '}', attribute_name.to_s)
 
       # query parameters
       query_params = {}
@@ -128,8 +144,7 @@ module SibApiV3Sdk
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'CreateModel')
+        :auth_names => auth_names)
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: ContactsApi#create_attribute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -303,29 +318,39 @@ module SibApiV3Sdk
 
     # Deletes an attribute
     # 
-    # @param attribute_id id of the attribute
+    # @param attribute_category Category of the attribute
+    # @param attribute_name Name of the existing attribute
     # @param [Hash] opts the optional parameters
     # @return [nil]
-    def delete_attribute(attribute_id, opts = {})
-      delete_attribute_with_http_info(attribute_id, opts)
+    def delete_attribute(attribute_category, attribute_name, opts = {})
+      delete_attribute_with_http_info(attribute_category, attribute_name, opts)
       return nil
     end
 
     # Deletes an attribute
     # 
-    # @param attribute_id id of the attribute
+    # @param attribute_category Category of the attribute
+    # @param attribute_name Name of the existing attribute
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
-    def delete_attribute_with_http_info(attribute_id, opts = {})
+    def delete_attribute_with_http_info(attribute_category, attribute_name, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: ContactsApi.delete_attribute ..."
       end
-      # verify the required parameter 'attribute_id' is set
-      if @api_client.config.client_side_validation && attribute_id.nil?
-        fail ArgumentError, "Missing the required parameter 'attribute_id' when calling ContactsApi.delete_attribute"
+      # verify the required parameter 'attribute_category' is set
+      if @api_client.config.client_side_validation && attribute_category.nil?
+        fail ArgumentError, "Missing the required parameter 'attribute_category' when calling ContactsApi.delete_attribute"
+      end
+      # verify enum value
+      if @api_client.config.client_side_validation && !['normal', 'transactional', 'category', 'calculated', 'global'].include?(attribute_category)
+        fail ArgumentError, "invalid value for 'attribute_category', must be one of normal, transactional, category, calculated, global"
+      end
+      # verify the required parameter 'attribute_name' is set
+      if @api_client.config.client_side_validation && attribute_name.nil?
+        fail ArgumentError, "Missing the required parameter 'attribute_name' when calling ContactsApi.delete_attribute"
       end
       # resource path
-      local_var_path = "/contacts/attributes/{attributeId}".sub('{' + 'attributeId' + '}', attribute_id.to_s)
+      local_var_path = "/contacts/attributes/{attributeCategory}/{attributeName}".sub('{' + 'attributeCategory' + '}', attribute_category.to_s).sub('{' + 'attributeName' + '}', attribute_name.to_s)
 
       # query parameters
       query_params = {}
@@ -1224,6 +1249,76 @@ module SibApiV3Sdk
       return data, status_code, headers
     end
 
+    # Updates contact attribute
+    # 
+    # @param attribute_category Category of the attribute
+    # @param attribute_name Name of the existing attribute
+    # @param update_attribute Values to update an attribute
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def update_attribute(attribute_category, attribute_name, update_attribute, opts = {})
+      update_attribute_with_http_info(attribute_category, attribute_name, update_attribute, opts)
+      return nil
+    end
+
+    # Updates contact attribute
+    # 
+    # @param attribute_category Category of the attribute
+    # @param attribute_name Name of the existing attribute
+    # @param update_attribute Values to update an attribute
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def update_attribute_with_http_info(attribute_category, attribute_name, update_attribute, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ContactsApi.update_attribute ..."
+      end
+      # verify the required parameter 'attribute_category' is set
+      if @api_client.config.client_side_validation && attribute_category.nil?
+        fail ArgumentError, "Missing the required parameter 'attribute_category' when calling ContactsApi.update_attribute"
+      end
+      # verify enum value
+      if @api_client.config.client_side_validation && !['category', 'calculated', 'global'].include?(attribute_category)
+        fail ArgumentError, "invalid value for 'attribute_category', must be one of category, calculated, global"
+      end
+      # verify the required parameter 'attribute_name' is set
+      if @api_client.config.client_side_validation && attribute_name.nil?
+        fail ArgumentError, "Missing the required parameter 'attribute_name' when calling ContactsApi.update_attribute"
+      end
+      # verify the required parameter 'update_attribute' is set
+      if @api_client.config.client_side_validation && update_attribute.nil?
+        fail ArgumentError, "Missing the required parameter 'update_attribute' when calling ContactsApi.update_attribute"
+      end
+      # resource path
+      local_var_path = "/contacts/attributes/{attributeCategory}/{attributeName}".sub('{' + 'attributeCategory' + '}', attribute_category.to_s).sub('{' + 'attributeName' + '}', attribute_name.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(update_attribute)
+      auth_names = ['api-key']
+      data, status_code, headers = @api_client.call_api(:PUT, 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: ContactsApi#update_attribute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Updates a contact
     # 
     # @param email Email (urlencoded) of the contact

data/lib/sib-api-v3-sdk/models/create_attribute.rb

@@ -15,19 +15,13 @@ require 'date'
 module SibApiV3Sdk
 
   class CreateAttribute
-    # Attribute categorisation.
-    attr_accessor :category
-
-    # Name of the attribute
-    attr_accessor :name
-
-    # Value of the attribute
+    # Value of the attribute. Use only if the attribute's category is calculated or global
     attr_accessor :value
 
     # Values that the attribute can take. Use only if the attribute's category is category
-    attr_accessor :enumemaration
+    attr_accessor :enumeration
 
-    # Type of the attribute
+    # Type of the attribute. Use only if the attribute's category is normal, category or transactional ( type 'id' only available if the category is 'transactional' attribute & type 'category' only available if the category is 'category' attribute )
     attr_accessor :type
 
     class EnumAttributeValidator
@@ -55,10 +49,8 @@ module SibApiV3Sdk
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'category' => :'category',
-        :'name' => :'name',
         :'value' => :'value',
-        :'enumemaration' => :'enumemaration',
+        :'enumeration' => :'enumeration',
         :'type' => :'type'
       }
     end
@@ -66,10 +58,8 @@ module SibApiV3Sdk
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'category' => :'String',
-        :'name' => :'String',
         :'value' => :'String',
-        :'enumemaration' => :'Array<CreateAttributeEnumemaration>',
+        :'enumeration' => :'Array<CreateAttributeEnumeration>',
         :'type' => :'String'
       }
     end
@@ -82,21 +72,13 @@ module SibApiV3Sdk
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
-      if attributes.has_key?(:'category')
-        self.category = attributes[:'category']
-      end
-
-      if attributes.has_key?(:'name')
-        self.name = attributes[:'name']
-      end
-
       if attributes.has_key?(:'value')
         self.value = attributes[:'value']
       end
 
-      if attributes.has_key?(:'enumemaration')
-        if (value = attributes[:'enumemaration']).is_a?(Array)
-          self.enumemaration = value
+      if attributes.has_key?(:'enumeration')
+        if (value = attributes[:'enumeration']).is_a?(Array)
+          self.enumeration = value
         end
       end
 
@@ -110,48 +92,21 @@ module SibApiV3Sdk
     # @return Array for valid properies with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @category.nil?
-        invalid_properties.push("invalid value for 'category', category cannot be nil.")
-      end
-
-      if @name.nil?
-        invalid_properties.push("invalid value for 'name', name cannot be nil.")
-      end
-
-      if @value.nil?
-        invalid_properties.push("invalid value for 'value', value cannot be nil.")
-      end
-
       return 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 @category.nil?
-      category_validator = EnumAttributeValidator.new('String', ["normal", "transactional", "category", "calculated", "global"])
-      return false unless category_validator.valid?(@category)
-      return false if @name.nil?
-      return false if @value.nil?
-      type_validator = EnumAttributeValidator.new('String', ["text", "date", "float", "id"])
+      type_validator = EnumAttributeValidator.new('String', ["text", "date", "float", "id", "category"])
       return false unless type_validator.valid?(@type)
       return true
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] category Object to be assigned
-    def category=(category)
-      validator = EnumAttributeValidator.new('String', ["normal", "transactional", "category", "calculated", "global"])
-      unless validator.valid?(category)
-        fail ArgumentError, "invalid value for 'category', must be one of #{validator.allowable_values}."
-      end
-      @category = category
-    end
-
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
-      validator = EnumAttributeValidator.new('String', ["text", "date", "float", "id"])
+      validator = EnumAttributeValidator.new('String', ["text", "date", "float", "id", "category"])
       unless validator.valid?(type)
         fail ArgumentError, "invalid value for 'type', must be one of #{validator.allowable_values}."
       end
@@ -163,10 +118,8 @@ module SibApiV3Sdk
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          category == o.category &&
-          name == o.name &&
           value == o.value &&
-          enumemaration == o.enumemaration &&
+          enumeration == o.enumeration &&
           type == o.type
     end
 
@@ -179,7 +132,7 @@ module SibApiV3Sdk
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [category, name, value, enumemaration, type].hash
+      [value, enumeration, type].hash
     end
 
     # Builds the object from hash