gnumarcelo-campaigning 0.12.1 → 0.14.0

data/lib/campaigning/soap/generated/default.rb

@@ -215,6 +215,25 @@ class ClientAccessAndBilling
   end
 end
 
+# {http://api.createsend.com/api/}Template
+#   templateID - SOAP::SOAPString
+#   name - SOAP::SOAPString
+#   previewURL - SOAP::SOAPString
+#   screenshotURL - SOAP::SOAPString
+class Template
+  attr_accessor :templateID
+  attr_accessor :name
+  attr_accessor :previewURL
+  attr_accessor :screenshotURL
+
+  def initialize(templateID = nil, name = nil, previewURL = nil, screenshotURL = nil)
+    @templateID = templateID
+    @name = name
+    @previewURL = previewURL
+    @screenshotURL = screenshotURL
+  end
+end
+
 # {http://api.createsend.com/api/}List
 #   listID - SOAP::SOAPString
 #   name - SOAP::SOAPString
@@ -330,6 +349,10 @@ end
 class ArrayOfList < ::Array
 end
 
+# {http://api.createsend.com/api/}ArrayOfTemplate
+class ArrayOfTemplate < ::Array
+end
+
 # {http://api.createsend.com/api/}ArrayOfSubscriberClick
 class ArrayOfSubscriberClick < ::Array
 end
@@ -925,6 +948,29 @@ class ClientGetSuppressionListResponse
   end
 end
 
+# {http://api.createsend.com/api/}Client.GetTemplates
+#   apiKey - SOAP::SOAPString
+#   clientID - SOAP::SOAPString
+class ClientGetTemplates
+  attr_accessor :apiKey
+  attr_accessor :clientID
+
+  def initialize(apiKey = nil, clientID = nil)
+    @apiKey = apiKey
+    @clientID = clientID
+  end
+end
+
+# {http://api.createsend.com/api/}Client.GetTemplatesResponse
+#   client_GetTemplatesResult - (any)
+class ClientGetTemplatesResponse
+  attr_accessor :client_GetTemplatesResult
+
+  def initialize(client_GetTemplatesResult = nil)
+    @client_GetTemplatesResult = client_GetTemplatesResult
+  end
+end
+
 # {http://api.createsend.com/api/}Client.Create
 #   apiKey - SOAP::SOAPString
 #   companyName - SOAP::SOAPString
@@ -1411,6 +1457,122 @@ class CampaignDeleteResponse
   end
 end
 
+# {http://api.createsend.com/api/}Template.Create
+#   apiKey - SOAP::SOAPString
+#   clientID - SOAP::SOAPString
+#   templateName - SOAP::SOAPString
+#   hTMLPageURL - SOAP::SOAPString
+#   zipFileURL - SOAP::SOAPString
+#   screenshotURL - SOAP::SOAPString
+class TemplateCreate
+  attr_accessor :apiKey
+  attr_accessor :clientID
+  attr_accessor :templateName
+  attr_accessor :hTMLPageURL
+  attr_accessor :zipFileURL
+  attr_accessor :screenshotURL
+
+  def initialize(apiKey = nil, clientID = nil, templateName = nil, hTMLPageURL = nil, zipFileURL = nil, screenshotURL = nil)
+    @apiKey = apiKey
+    @clientID = clientID
+    @templateName = templateName
+    @hTMLPageURL = hTMLPageURL
+    @zipFileURL = zipFileURL
+    @screenshotURL = screenshotURL
+  end
+end
+
+# {http://api.createsend.com/api/}Template.CreateResponse
+#   template_CreateResult - (any)
+class TemplateCreateResponse
+  attr_accessor :template_CreateResult
+
+  def initialize(template_CreateResult = nil)
+    @template_CreateResult = template_CreateResult
+  end
+end
+
+# {http://api.createsend.com/api/}Template.GetDetail
+#   apiKey - SOAP::SOAPString
+#   templateID - SOAP::SOAPString
+class TemplateGetDetail
+  attr_accessor :apiKey
+  attr_accessor :templateID
+
+  def initialize(apiKey = nil, templateID = nil)
+    @apiKey = apiKey
+    @templateID = templateID
+  end
+end
+
+# {http://api.createsend.com/api/}Template.GetDetailResponse
+#   template_GetDetailResult - (any)
+class TemplateGetDetailResponse
+  attr_accessor :template_GetDetailResult
+
+  def initialize(template_GetDetailResult = nil)
+    @template_GetDetailResult = template_GetDetailResult
+  end
+end
+
+# {http://api.createsend.com/api/}Template.Update
+#   apiKey - SOAP::SOAPString
+#   templateID - SOAP::SOAPString
+#   templateName - SOAP::SOAPString
+#   hTMLPageURL - SOAP::SOAPString
+#   zipFileURL - SOAP::SOAPString
+#   screenshotURL - SOAP::SOAPString
+class TemplateUpdate
+  attr_accessor :apiKey
+  attr_accessor :templateID
+  attr_accessor :templateName
+  attr_accessor :hTMLPageURL
+  attr_accessor :zipFileURL
+  attr_accessor :screenshotURL
+
+  def initialize(apiKey = nil, templateID = nil, templateName = nil, hTMLPageURL = nil, zipFileURL = nil, screenshotURL = nil)
+    @apiKey = apiKey
+    @templateID = templateID
+    @templateName = templateName
+    @hTMLPageURL = hTMLPageURL
+    @zipFileURL = zipFileURL
+    @screenshotURL = screenshotURL
+  end
+end
+
+# {http://api.createsend.com/api/}Template.UpdateResponse
+#   template_UpdateResult - Campaigning::Result
+class TemplateUpdateResponse
+  attr_accessor :template_UpdateResult
+
+  def initialize(template_UpdateResult = nil)
+    @template_UpdateResult = template_UpdateResult
+  end
+end
+
+# {http://api.createsend.com/api/}Template.Delete
+#   apiKey - SOAP::SOAPString
+#   templateID - SOAP::SOAPString
+class TemplateDelete
+  attr_accessor :apiKey
+  attr_accessor :templateID
+
+  def initialize(apiKey = nil, templateID = nil)
+    @apiKey = apiKey
+    @templateID = templateID
+  end
+end
+
+# {http://api.createsend.com/api/}Template.DeleteResponse
+#   template_DeleteResult - Campaigning::Result
+class TemplateDeleteResponse
+  attr_accessor :template_DeleteResult
+
+  def initialize(template_DeleteResult = nil)
+    @template_DeleteResult = template_DeleteResult
+  end
+end
+
 # {http://api.createsend.com/api/}anyType
 class AnyType < ::String
   def initialize(*arg)

data/lib/campaigning/soap/generated/defaultDriver.rb

@@ -176,6 +176,14 @@ class ApiSoap < ::SOAP::RPC::Driver
         :response_style => :document, :response_use => :literal,
         :faults => {} }
     ],
+    [ "http://api.createsend.com/api/Client.GetTemplates",
+      "getClientTemplates",
+      [ ["in", "parameters", ["::SOAP::SOAPElement", "http://api.createsend.com/api/", "Client.GetTemplates"]],
+        ["out", "parameters", ["::SOAP::SOAPElement", "http://api.createsend.com/api/", "Client.GetTemplatesResponse"]] ],
+      { :request_style =>  :document, :request_use =>  :literal,
+        :response_style => :document, :response_use => :literal,
+        :faults => {} }
+    ],
     [ "http://api.createsend.com/api/Client.Create",
       "createClient",
       [ ["in", "parameters", ["::SOAP::SOAPElement", "http://api.createsend.com/api/", "Client.Create"]],
@@ -319,6 +327,38 @@ class ApiSoap < ::SOAP::RPC::Driver
       { :request_style =>  :document, :request_use =>  :literal,
         :response_style => :document, :response_use => :literal,
         :faults => {} }
+    ],
+    [ "http://api.createsend.com/api/Template.Create",
+      "createTemplate",
+      [ ["in", "parameters", ["::SOAP::SOAPElement", "http://api.createsend.com/api/", "Template.Create"]],
+        ["out", "parameters", ["::SOAP::SOAPElement", "http://api.createsend.com/api/", "Template.CreateResponse"]] ],
+      { :request_style =>  :document, :request_use =>  :literal,
+        :response_style => :document, :response_use => :literal,
+        :faults => {} }
+    ],
+    [ "http://api.createsend.com/api/Template.GetDetail",
+      "getTemplateDetail",
+      [ ["in", "parameters", ["::SOAP::SOAPElement", "http://api.createsend.com/api/", "Template.GetDetail"]],
+        ["out", "parameters", ["::SOAP::SOAPElement", "http://api.createsend.com/api/", "Template.GetDetailResponse"]] ],
+      { :request_style =>  :document, :request_use =>  :literal,
+        :response_style => :document, :response_use => :literal,
+        :faults => {} }
+    ],
+    [ "http://api.createsend.com/api/Template.Update",
+      "updateTemplate",
+      [ ["in", "parameters", ["::SOAP::SOAPElement", "http://api.createsend.com/api/", "Template.Update"]],
+        ["out", "parameters", ["::SOAP::SOAPElement", "http://api.createsend.com/api/", "Template.UpdateResponse"]] ],
+      { :request_style =>  :document, :request_use =>  :literal,
+        :response_style => :document, :response_use => :literal,
+        :faults => {} }
+    ],
+    [ "http://api.createsend.com/api/Template.Delete",
+      "deleteTemplate",
+      [ ["in", "parameters", ["::SOAP::SOAPElement", "http://api.createsend.com/api/", "Template.Delete"]],
+        ["out", "parameters", ["::SOAP::SOAPElement", "http://api.createsend.com/api/", "Template.DeleteResponse"]] ],
+      { :request_style =>  :document, :request_use =>  :literal,
+        :response_style => :document, :response_use => :literal,
+        :faults => {} }
     ]
   ]
 

data/lib/campaigning/soap/generated/defaultMappingRegistry.rb

@@ -148,6 +148,17 @@ module DefaultMappingRegistry
     ]
   )
 
+  EncodedRegistry.register(
+    :class => Campaigning::Template,
+    :schema_type => XSD::QName.new(NsApi, "Template"),
+    :schema_element => [
+      ["templateID", ["SOAP::SOAPString", XSD::QName.new(NsApi, "TemplateID")], [0, 1]],
+      ["name", ["SOAP::SOAPString", XSD::QName.new(NsApi, "Name")], [0, 1]],
+      ["previewURL", ["SOAP::SOAPString", XSD::QName.new(NsApi, "PreviewURL")], [0, 1]],
+      ["screenshotURL", ["SOAP::SOAPString", XSD::QName.new(NsApi, "ScreenshotURL")], [0, 1]]
+    ]
+  )
+
   EncodedRegistry.register(
     :class => Campaigning::List,
     :schema_type => XSD::QName.new(NsApi, "List"),
@@ -243,6 +254,14 @@ module DefaultMappingRegistry
     ]
   )
 
+  EncodedRegistry.register(
+    :class => Campaigning::ArrayOfTemplate,
+    :schema_type => XSD::QName.new(NsApi, "ArrayOfTemplate"),
+    :schema_element => [
+      ["template", ["Campaigning::Template[]", XSD::QName.new(NsApi, "Template")], [0, nil]]
+    ]
+  )
+
   EncodedRegistry.register(
     :class => Campaigning::ArrayOfSubscriberClick,
     :schema_type => XSD::QName.new(NsApi, "ArrayOfSubscriberClick"),
@@ -428,6 +447,17 @@ module DefaultMappingRegistry
     ]
   )
 
+  LiteralRegistry.register(
+    :class => Campaigning::Template,
+    :schema_type => XSD::QName.new(NsApi, "Template"),
+    :schema_element => [
+      ["templateID", ["SOAP::SOAPString", XSD::QName.new(NsApi, "TemplateID")], [0, 1]],
+      ["name", ["SOAP::SOAPString", XSD::QName.new(NsApi, "Name")], [0, 1]],
+      ["previewURL", ["SOAP::SOAPString", XSD::QName.new(NsApi, "PreviewURL")], [0, 1]],
+      ["screenshotURL", ["SOAP::SOAPString", XSD::QName.new(NsApi, "ScreenshotURL")], [0, 1]]
+    ]
+  )
+
   LiteralRegistry.register(
     :class => Campaigning::List,
     :schema_type => XSD::QName.new(NsApi, "List"),
@@ -523,6 +553,14 @@ module DefaultMappingRegistry
     ]
   )
 
+  LiteralRegistry.register(
+    :class => Campaigning::ArrayOfTemplate,
+    :schema_type => XSD::QName.new(NsApi, "ArrayOfTemplate"),
+    :schema_element => [
+      ["template", ["Campaigning::Template[]", XSD::QName.new(NsApi, "Template")], [0, nil]]
+    ]
+  )
+
   LiteralRegistry.register(
     :class => Campaigning::ArrayOfSubscriberClick,
     :schema_type => XSD::QName.new(NsApi, "ArrayOfSubscriberClick"),
@@ -953,6 +991,23 @@ module DefaultMappingRegistry
     ]
   )
 
+  LiteralRegistry.register(
+    :class => Campaigning::ClientGetTemplates,
+    :schema_name => XSD::QName.new(NsApi, "Client.GetTemplates"),
+    :schema_element => [
+      ["apiKey", ["SOAP::SOAPString", XSD::QName.new(NsApi, "ApiKey")], [0, 1]],
+      ["clientID", ["SOAP::SOAPString", XSD::QName.new(NsApi, "ClientID")], [0, 1]]
+    ]
+  )
+
+  LiteralRegistry.register(
+    :class => Campaigning::ClientGetTemplatesResponse,
+    :schema_name => XSD::QName.new(NsApi, "Client.GetTemplatesResponse"),
+    :schema_element => [
+      ["client_GetTemplatesResult", [nil, XSD::QName.new(NsApi, "Client.GetTemplatesResult")], [0, 1]]
+    ]
+  )
+
   LiteralRegistry.register(
     :class => Campaigning::ClientCreate,
     :schema_name => XSD::QName.new(NsApi, "Client.Create"),
@@ -1283,6 +1338,82 @@ module DefaultMappingRegistry
     ]
   )
 
+  LiteralRegistry.register(
+    :class => Campaigning::TemplateCreate,
+    :schema_name => XSD::QName.new(NsApi, "Template.Create"),
+    :schema_element => [
+      ["apiKey", ["SOAP::SOAPString", XSD::QName.new(NsApi, "ApiKey")], [0, 1]],
+      ["clientID", ["SOAP::SOAPString", XSD::QName.new(NsApi, "ClientID")], [0, 1]],
+      ["templateName", ["SOAP::SOAPString", XSD::QName.new(NsApi, "TemplateName")], [0, 1]],
+      ["hTMLPageURL", ["SOAP::SOAPString", XSD::QName.new(NsApi, "HTMLPageURL")], [0, 1]],
+      ["zipFileURL", ["SOAP::SOAPString", XSD::QName.new(NsApi, "ZipFileURL")], [0, 1]],
+      ["screenshotURL", ["SOAP::SOAPString", XSD::QName.new(NsApi, "ScreenshotURL")], [0, 1]]
+    ]
+  )
+
+  LiteralRegistry.register(
+    :class => Campaigning::TemplateCreateResponse,
+    :schema_name => XSD::QName.new(NsApi, "Template.CreateResponse"),
+    :schema_element => [
+      ["template_CreateResult", [nil, XSD::QName.new(NsApi, "Template.CreateResult")], [0, 1]]
+    ]
+  )
+
+  LiteralRegistry.register(
+    :class => Campaigning::TemplateGetDetail,
+    :schema_name => XSD::QName.new(NsApi, "Template.GetDetail"),
+    :schema_element => [
+      ["apiKey", ["SOAP::SOAPString", XSD::QName.new(NsApi, "ApiKey")], [0, 1]],
+      ["templateID", ["SOAP::SOAPString", XSD::QName.new(NsApi, "TemplateID")], [0, 1]]
+    ]
+  )
+
+  LiteralRegistry.register(
+    :class => Campaigning::TemplateGetDetailResponse,
+    :schema_name => XSD::QName.new(NsApi, "Template.GetDetailResponse"),
+    :schema_element => [
+      ["template_GetDetailResult", [nil, XSD::QName.new(NsApi, "Template.GetDetailResult")], [0, 1]]
+    ]
+  )
+
+  LiteralRegistry.register(
+    :class => Campaigning::TemplateUpdate,
+    :schema_name => XSD::QName.new(NsApi, "Template.Update"),
+    :schema_element => [
+      ["apiKey", ["SOAP::SOAPString", XSD::QName.new(NsApi, "ApiKey")], [0, 1]],
+      ["templateID", ["SOAP::SOAPString", XSD::QName.new(NsApi, "TemplateID")], [0, 1]],
+      ["templateName", ["SOAP::SOAPString", XSD::QName.new(NsApi, "TemplateName")], [0, 1]],
+      ["hTMLPageURL", ["SOAP::SOAPString", XSD::QName.new(NsApi, "HTMLPageURL")], [0, 1]],
+      ["zipFileURL", ["SOAP::SOAPString", XSD::QName.new(NsApi, "ZipFileURL")], [0, 1]],
+      ["screenshotURL", ["SOAP::SOAPString", XSD::QName.new(NsApi, "ScreenshotURL")], [0, 1]]
+    ]
+  )
+
+  LiteralRegistry.register(
+    :class => Campaigning::TemplateUpdateResponse,
+    :schema_name => XSD::QName.new(NsApi, "Template.UpdateResponse"),
+    :schema_element => [
+      ["template_UpdateResult", ["Campaigning::Result", XSD::QName.new(NsApi, "Template.UpdateResult")], [0, 1]]
+    ]
+  )
+
+  LiteralRegistry.register(
+    :class => Campaigning::TemplateDelete,
+    :schema_name => XSD::QName.new(NsApi, "Template.Delete"),
+    :schema_element => [
+      ["apiKey", ["SOAP::SOAPString", XSD::QName.new(NsApi, "ApiKey")], [0, 1]],
+      ["templateID", ["SOAP::SOAPString", XSD::QName.new(NsApi, "TemplateID")], [0, 1]]
+    ]
+  )
+
+  LiteralRegistry.register(
+    :class => Campaigning::TemplateDeleteResponse,
+    :schema_name => XSD::QName.new(NsApi, "Template.DeleteResponse"),
+    :schema_element => [
+      ["template_DeleteResult", ["Campaigning::Result", XSD::QName.new(NsApi, "Template.DeleteResult")], [0, 1]]
+    ]
+  )
+
   LiteralRegistry.register(
     :class => Campaigning::Result,
     :schema_name => XSD::QName.new(NsApi, "Result"),

data/lib/campaigning/subscriber.rb

@@ -11,7 +11,8 @@ module Campaigning
     attr_accessor :state
     attr_accessor :customFields
 
-    def initialize(emailAddress = nil, name = nil, date = nil, state = nil, customFields = nil)
+    def initialize(emailAddress = nil, name = nil, date = nil, state = nil, customFields = nil, opts={})
+      @apiKey = opts[:apiKey] || CAMPAIGN_MONITOR_API_KEY
       @emailAddress = emailAddress
       @name = name
       @date = date
@@ -37,7 +38,7 @@ module Campaigning
     #*Error*: An Exception containing the cause of the error will be raised.
     def add!(list_id, custom_fields={})
       params = {
-        :apiKey => CAMPAIGN_MONITOR_API_KEY,
+        :apiKey => @apiKey,
         :listID => list_id,
         :email => @emailAddress,
         :name => @name
@@ -70,7 +71,7 @@ module Campaigning
     #*Error*: An Exception containing the cause of the error will be raised.
     def add_and_resubscribe!(list_id, custom_fields={})
       params = {
-        :apiKey => CAMPAIGN_MONITOR_API_KEY,
+        :apiKey => @apiKey,
         :listID => list_id,
         :email => @emailAddress,
         :name => @name
@@ -99,15 +100,18 @@ module Campaigning
     #
     #*Error*: An Exception containing the cause of the error will be raised.
     def unsubscribe!(list_id)
-      Subscriber.unsubscribe!(@emailAddress, list_id)
+      Subscriber.unsubscribe!(@emailAddress, list_id, :apiKey=> @apiKey)
     end
 
 
     #Changes the status of an Active Subscriber to an Unsubscribed Subscriber who will no longer receive
     #campaigns sent to that Subscriber List (Same that the instance method with the same name).
-    def self.unsubscribe!(email, list_id)
+    #
+    #Aviable _opts_ arguments are:
+    #   * :apiKey - optional API key to use to make request. Will use CAMPAIGN_MONITOR_API_KEY if not set.
+    def self.unsubscribe!(email, list_id, opts={})
       response = @@soap.unsubscribe(
-      :apiKey => CAMPAIGN_MONITOR_API_KEY,
+      :apiKey => opts[:apiKey] || CAMPAIGN_MONITOR_API_KEY,
       :listID => list_id,
       :email => email
       )
@@ -116,13 +120,16 @@ module Campaigning
 
     #Returns True or False as to the existence of the given email address in the list supplied.
     def is_subscribed?(list_id)
-      Subscriber.is_subscribed?(@emailAddress, list_id)
+      Subscriber.is_subscribed?(@emailAddress, list_id, :apiKey=> @apiKey)
     end
 
     #Returns True or False as to the existence of the given email address in the list supplied.
-    def self.is_subscribed?(email, list_id)
+    #
+    #Aviable _opts_ arguments are:
+    #   * :apiKey - optional API key to use to make request. Will use CAMPAIGN_MONITOR_API_KEY if not set.
+    def self.is_subscribed?(email, list_id, opts={})
       response = @@soap.getIsSubscribed(
-      :apiKey => CAMPAIGN_MONITOR_API_KEY,
+      :apiKey => opts[:apiKey] || CAMPAIGN_MONITOR_API_KEY,
       :listID => list_id,
       :email => email
       )
@@ -148,4 +155,4 @@ module Campaigning
     end
 
   end
-end
+end