Merge pull request #23 from sendinblue/feature_updated_swagger_sync

Updated swagger changes for campaign filters

Author: aakanksha-sib

docs/CreateAttribute.md

@@ -5,6 +5,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **value** | **String** | Value of the attribute. Use only if the attribute's category is 'calculated' or 'global' | [optional] 
 **enumeration** | [**Array<CreateAttributeEnumeration>**](CreateAttributeEnumeration.md) | List of values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{'value':1, 'label':'male'}, {'value':2, 'label':'female'}] | [optional] 
-**type** | **String** | Type of the attribute. Use only if the attribute's category is 'normal', 'category' or 'transactional' ( type 'id' is only available if the category is 'transactional' attribute & type 'category' is only available if the category is 'category' attribute ) | [optional] 
+**type** | **String** | Type of the attribute. Use only if the attribute's category is 'normal', 'category' or 'transactional' ( type 'boolean' is only available if the category is 'normal' attribute, type 'id' is only available if the category is 'transactional' attribute & type 'category' is only available if the category is 'category' attribute ) | [optional] 
 
 

docs/EmailCampaignsApi.md

@@ -249,6 +249,8 @@ api_instance = SibApiV3Sdk::EmailCampaignsApi.new
 opts = { 
   type: "type_example", # String | Filter on the type of the campaigns
   status: "status_example", # String | Filter on the status of the campaign
+  start_date: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
+  end_date: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
   limit: 500, # Integer | Number of documents per page
   offset: 0 # Integer | Index of the first document in the page
 }
@@ -268,6 +270,8 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **type** | **String**| Filter on the type of the campaigns | [optional] 
  **status** | **String**| Filter on the status of the campaign | [optional] 
+ **start_date** | **DateTime**| Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) | [optional] 
+ **end_date** | **DateTime**| Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) | [optional] 
  **limit** | **Integer**| Number of documents per page | [optional] [default to 500]
  **offset** | **Integer**| Index of the first document in the page | [optional] [default to 0]
 

docs/GetEmailCampaign.md

@@ -23,6 +23,7 @@ Name | Type | Description | Notes
 **inline_image_activation** | **BOOLEAN** | Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. | [optional] 
 **mirror_active** | **BOOLEAN** | Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign | [optional] 
 **recurring** | **BOOLEAN** | FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times | [optional] 
+**sent_date** | **DateTime** | Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent' | [optional] 
 **recipients** | **Object** |  | 
 **statistics** | **Object** |  | 
 

docs/GetExtendedCampaignOverview.md

@@ -23,5 +23,6 @@ Name | Type | Description | Notes
 **inline_image_activation** | **BOOLEAN** | Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. | [optional] 
 **mirror_active** | **BOOLEAN** | Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign | [optional] 
 **recurring** | **BOOLEAN** | FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times | [optional] 
+**sent_date** | **DateTime** | Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent' | [optional] 
 
 

lib/sib-api-v3-sdk/api/email_campaigns_api.rb

@@ -246,6 +246,8 @@ def get_email_campaign_with_http_info(campaign_id, opts = {})
     # @param [Hash] opts the optional parameters
     # @option opts [String] :type Filter on the type of the campaigns
     # @option opts [String] :status Filter on the status of the campaign
+    # @option opts [DateTime] :start_date Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
+    # @option opts [DateTime] :end_date Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
     # @option opts [Integer] :limit Number of documents per page (default to 500)
     # @option opts [Integer] :offset Index of the first document in the page (default to 0)
     # @return [GetEmailCampaigns]
@@ -259,6 +261,8 @@ def get_email_campaigns(opts = {})
     # @param [Hash] opts the optional parameters
     # @option opts [String] :type Filter on the type of the campaigns
     # @option opts [String] :status Filter on the status of the campaign
+    # @option opts [DateTime] :start_date Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
+    # @option opts [DateTime] :end_date Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
     # @option opts [Integer] :limit Number of documents per page
     # @option opts [Integer] :offset Index of the first document in the page
     # @return [Array<(GetEmailCampaigns, Fixnum, Hash)>] GetEmailCampaigns data, response status code and response headers
@@ -283,6 +287,8 @@ def get_email_campaigns_with_http_info(opts = {})
       query_params = {}
       query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
       query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
+      query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
+      query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
       query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
       query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
 

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

@@ -21,7 +21,7 @@ class CreateAttribute
     # List of values and labels that the attribute can take. Use only if the attribute's category is \"category\". For example, [{'value':1, 'label':'male'}, {'value':2, 'label':'female'}]
     attr_accessor :enumeration
 
-    # Type of the attribute. Use only if the attribute's category is 'normal', 'category' or 'transactional' ( type 'id' is only available if the category is 'transactional' attribute & type 'category' is only available if the category is 'category' attribute )
+    # Type of the attribute. Use only if the attribute's category is 'normal', 'category' or 'transactional' ( type 'boolean' is only available if the category is 'normal' attribute, type 'id' is only available if the category is 'transactional' attribute & type 'category' is only available if the category is 'category' attribute )
     attr_accessor :type
 
     class EnumAttributeValidator
@@ -98,15 +98,15 @@ def list_invalid_properties
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      type_validator = EnumAttributeValidator.new('String', ["text", "date", "float", "id", "category"])
+      type_validator = EnumAttributeValidator.new('String', ["text", "date", "float", "boolean", "id", "category"])
       return false unless type_validator.valid?(@type)
       return true
     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", "category"])
+      validator = EnumAttributeValidator.new('String', ["text", "date", "float", "boolean", "id", "category"])
       unless validator.valid?(type)
         fail ArgumentError, "invalid value for 'type', must be one of #{validator.allowable_values}."
       end

lib/sib-api-v3-sdk/models/get_email_campaign.rb

@@ -74,6 +74,9 @@ class GetEmailCampaign
     # FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times
     attr_accessor :recurring
 
+    # Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent'
+    attr_accessor :sent_date
+
     attr_accessor :recipients
 
     attr_accessor :statistics
@@ -123,6 +126,7 @@ def self.attribute_map
         :'inline_image_activation' => :'inlineImageActivation',
         :'mirror_active' => :'mirrorActive',
         :'recurring' => :'recurring',
+        :'sent_date' => :'sentDate',
         :'recipients' => :'recipients',
         :'statistics' => :'statistics'
       }
@@ -151,6 +155,7 @@ def self.swagger_types
         :'inline_image_activation' => :'BOOLEAN',
         :'mirror_active' => :'BOOLEAN',
         :'recurring' => :'BOOLEAN',
+        :'sent_date' => :'DateTime',
         :'recipients' => :'Object',
         :'statistics' => :'Object'
       }
@@ -244,6 +249,10 @@ def initialize(attributes = {})
         self.recurring = attributes[:'recurring']
       end
 
+      if attributes.has_key?(:'sentDate')
+        self.sent_date = attributes[:'sentDate']
+      end
+
       if attributes.has_key?(:'recipients')
         self.recipients = attributes[:'recipients']
       end
@@ -401,6 +410,7 @@ def ==(o)
           inline_image_activation == o.inline_image_activation &&
           mirror_active == o.mirror_active &&
           recurring == o.recurring &&
+          sent_date == o.sent_date &&
           recipients == o.recipients &&
           statistics == o.statistics
     end
@@ -414,7 +424,7 @@ def eql?(o)
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, name, subject, type, status, scheduled_at, test_sent, header, footer, sender, reply_to, to_field, html_content, share_link, tag, created_at, modified_at, inline_image_activation, mirror_active, recurring, recipients, statistics].hash
+      [id, name, subject, type, status, scheduled_at, test_sent, header, footer, sender, reply_to, to_field, html_content, share_link, tag, created_at, modified_at, inline_image_activation, mirror_active, recurring, sent_date, recipients, statistics].hash
     end
 
     # Builds the object from hash

lib/sib-api-v3-sdk/models/get_extended_campaign_overview.rb

@@ -74,6 +74,9 @@ class GetExtendedCampaignOverview
     # FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times
     attr_accessor :recurring
 
+    # Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent'
+    attr_accessor :sent_date
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -118,7 +121,8 @@ def self.attribute_map
         :'modified_at' => :'modifiedAt',
         :'inline_image_activation' => :'inlineImageActivation',
         :'mirror_active' => :'mirrorActive',
-        :'recurring' => :'recurring'
+        :'recurring' => :'recurring',
+        :'sent_date' => :'sentDate'
       }
     end
 
@@ -144,7 +148,8 @@ def self.swagger_types
         :'modified_at' => :'DateTime',
         :'inline_image_activation' => :'BOOLEAN',
         :'mirror_active' => :'BOOLEAN',
-        :'recurring' => :'BOOLEAN'
+        :'recurring' => :'BOOLEAN',
+        :'sent_date' => :'DateTime'
       }
     end
 
@@ -236,6 +241,10 @@ def initialize(attributes = {})
         self.recurring = attributes[:'recurring']
       end
 
+      if attributes.has_key?(:'sentDate')
+        self.sent_date = attributes[:'sentDate']
+      end
+
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -374,7 +383,8 @@ def ==(o)
           modified_at == o.modified_at &&
           inline_image_activation == o.inline_image_activation &&
           mirror_active == o.mirror_active &&
-          recurring == o.recurring
+          recurring == o.recurring &&
+          sent_date == o.sent_date
     end
 
     # @see the `==` method
@@ -386,7 +396,7 @@ def eql?(o)
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, name, subject, type, status, scheduled_at, test_sent, header, footer, sender, reply_to, to_field, html_content, share_link, tag, created_at, modified_at, inline_image_activation, mirror_active, recurring].hash
+      [id, name, subject, type, status, scheduled_at, test_sent, header, footer, sender, reply_to, to_field, html_content, share_link, tag, created_at, modified_at, inline_image_activation, mirror_active, recurring, sent_date].hash
     end
 
     # Builds the object from hash

lib/sib-api-v3-sdk/version.rb

@@ -11,5 +11,5 @@
 =end
 
 module SibApiV3Sdk
-  VERSION = "5.0.1"
+  VERSION = "5.1.0"
 end

spec/api/email_campaigns_api_spec.rb

@@ -87,6 +87,8 @@
   # @param [Hash] opts the optional parameters
   # @option opts [String] :type Filter on the type of the campaigns
   # @option opts [String] :status Filter on the status of the campaign
+  # @option opts [DateTime] :start_date Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
+  # @option opts [DateTime] :end_date Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
   # @option opts [Integer] :limit Number of documents per page
   # @option opts [Integer] :offset Index of the first document in the page
   # @return [GetEmailCampaigns]

spec/models/create_attribute_spec.rb

@@ -47,7 +47,7 @@
   describe 'test attribute "type"' do
     it 'should work' do
        # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-       #validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["text", "date", "float", "id", "category"])
+       #validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["text", "date", "float", "boolean", "id", "category"])
        #validator.allowable_values.each do |value|
        #  expect { @instance.type = value }.not_to raise_error
        #end

spec/models/get_email_campaign_spec.rb

@@ -160,6 +160,12 @@
     end
   end
 
+  describe 'test attribute "sent_date"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   describe 'test attribute "recipients"' do
     it 'should work' do
        # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

spec/models/get_extended_campaign_overview_spec.rb

@@ -160,5 +160,11 @@
     end
   end
 
+  describe 'test attribute "sent_date"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
 end