eloqua-api-client 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa48c0148490fbb40f2885e1dd6e4f7237691ab80706ef0dd86159d58e8a2d92
-  data.tar.gz: 73e7e4022c43ea49cbaae4a8472f7055b007cde0ca9918323f83e90e1a01a66a
+  metadata.gz: 4c3fc5bff032f46cc7cae69a97a9df5da3fc826c41aadba310b20478b36daffd
+  data.tar.gz: 0f4499f285e575bd85f32a48982820148dc7bdde9cb9aacc52ca7842ed29532f
 SHA512:
-  metadata.gz: 47efeaab9fb0bdcca43474e8bb3a1bce9bee7c5662e701a92fc7c9bb1135006d50600e565c91e64b71ebe325f430a8e38408cf9e084b0342ab3d4227e6433232
-  data.tar.gz: 9d7676d04fb0b3592743065171e4a8edca3a1b476e8a899837e0bef41b9c2577eaa6ab0b6f436a24494cb61a82e728daeef574c98d1bde6fca6468c084098be6
+  metadata.gz: 2a19cd85ca36c6eece0be7443363c0d96a107bab0c133ec067dbd49080a67d11a8dd132234d1ec37c3bd2b27ebc7b181c48ad31500ad9878b4402e2cf0875b90
+  data.tar.gz: 9bb8c2bc313f878bec2861513c9ff102c12ce6e639fba0541345917b3321f41c6f9b2c6ba86423b797c104876bb4fa2b068635b4f7daa9b03a89d6f3b45ce9f1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    eloqua-api (0.1.0)
+    eloqua-api-client (0.1.3)
       httparty
 
 GEM
@@ -14,12 +14,12 @@ GEM
       rexml
     diff-lcs (1.4.4)
     hashdiff (1.0.1)
-    httparty (0.18.1)
+    httparty (0.20.0)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
-    mime-types (3.3.1)
+    mime-types (3.4.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2021.0901)
+    mime-types-data (3.2022.0105)
     multi_xml (0.6.0)
     parallel (1.20.1)
     parser (3.0.2.0)
@@ -67,7 +67,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.17)
-  eloqua-api!
+  eloqua-api-client!
   rake (~> 10.0)
   rspec (~> 3.0)
   rspec_junit_formatter

data/README.md

@@ -1,8 +1,6 @@
-# Eloqua::Api
+# Eloqua Api Client
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/eloqua/api/base`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Eloqua Api Client is a Context Based Ruby Gem for calling Eloqua APIs.
 
 ## Installation
 
@@ -14,70 +12,83 @@ gem 'eloqua-api-client'
 
 And then execute:
 
-    $ bundle
+```ruby
+bundle 
+```
 
 Or install it yourself as:
 
-    $ gem install eloqua-api
+``` ruby
+gem install eloqua-api-client
+```
 
 ## Usage
 
 ```ruby
-# To setup the client for ExternalAssetTypes
-client = ::Eloqua::EloquaExternalAssetsTypes.new(
-        access_token: 'YOUR-ACCESS-TOKEN', # e.g. djbhyghb27t36hbdhbkjn7y7bhk
-        base_url: 'YOUR-BASE-URL') # e.g. 'https://eloqua-api.com/API/REST/{version}'
+# to work with Eloqua Campaigns Initialize Client
+client = Eloqua::Api::Campaign.new(access_token: 'YOUR-TOKEN', base_url: 'YOUR_BASE_URL')
+```
+### Eloqua Campaigns Docs
+To get an idea about ```params```
+
+https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/api-application-2.0-campaigns.html
 
-# Getting all ExternalAssetTypes
+```ruby
+# To Fetch All Campaigns From Eloqua
 client.find_all
-# Finding based on some condition like fetching campaigns having active status or 
-# based on name or paginated campaigns you can use optional params 
-
-find_all method accepts two optional params
-    1- query_params # mostly for pagination
-    2- search_params # for fetching ExternalAssetType objects based on some conditions
-    
-# Example below fetchs all the ASSET TYPES by paginating them
-    client.find_all(query_params: { page: 1, count: 100 })
-
-# similarly search_params: {} will search for the specific keys added in the hash
-
-# If we want to fetch the Specific ASSET ACTIVITIES simply hit
-    client.find(id: 'my asset_type_id')
-
-# To setup the client for Campaigns
-
-client = ::Eloqua::Campaign.new(
-        access_token: 'YOUR-ACCESS-TOKEN', # e.g. djbhyghb27t36hbdhbkjn7y7bhk
-        base_url: 'YOUR-BASE-URL') # e.g. 'https://eloqua-api.com/API/REST/{version}'
-        
-# Same here to get all the campaigns 
-    
-    client.find_all
-
-# find_all method accepts two optional params
-    1- query_params # mostly for pagination
-    
-    2- search_params # for fetching campaigns based on some conditions
-
-# If Campaigns based on some condtions are needed to be fetched 
-    
-# Lets Say we want to get all active campaigns
-    
-    client.find_all(search_params: { currentStatus: 1 })
-    # It will get all the campaigns which are active similarly you can add other 
-    # query key values based on searchable from eloqua documentation
-    
-    # https://docs.oracle.com/en/cloud/saas/marketing/eloqua-develop/Developers/RESTAPI/Tutorials/search_parameter.htm?cshid=SearchParam
-    
-    # If we want to fetch all those campaigns which are active and name like 'some-name'
-    client.find_all(search_params: { currentStatus: 1, name: 'some-name' })
-    
-    # Every time we pass search_params it will do a partials searching
-
-# To Fetch Only a Specific Campaign 
-
-    client.find(id: 'campaign_id')
+# To Fetch All Campaigns Based On Pagination pass named param query_params to find_all
+# I want to get campaigns such that each page has 100 campaigns on it 
+# I will pass the page and the count in query param to achieve that
+client.find_all(query_params: { page: 1, count: 100 })
+
+# Similarly to fetch campaigns based on NAME, status etc
+client.find_all(search_params: { name: 'My Gem', currentStatus: 1 })
+
+# Both saerch_params and query_params are optional can be used together also
+
+```
+### Note
+In the Gem All ```find_all``` accepts two optional ```HASH Params``` ```search_params: {}``` and ```query_params: {}```
+
+### Find Campaign
+```ruby
+# returns Campaign against provided Id 
+client.find(id: 'campaign_id')
+# id is required param
+```
+### Create Campaign
+```ruby
+# returns created campaign 
+client.create(payload: { name: 'my eloqua campaign', startAt: 1234444, endAt: 120987,...})
+# parload is required param
+```
+
+### Update Campaign
+```ruby
+# returns updated campaign
+client.update(id: 'id',payload: { name: 'new name', startAt: 1234444, endAt: 12098 })
+# id and parload both are required params.
+# please have a look at eloqua documentation for payload 
+```
+
+### Activate Campaign
+```ruby
+# returns activated campaign
+client.activate(id: 'id', query_params: { activate: true })
+# id and query_params both are required params. 
+```
+
+### DeActivate Campaign
+```ruby
+# returns deactivate campaign
+client.deactivate(id: 'id')
+# id is required param. 
+```
+
+### Delete A Campaign
+```ruby
+client.destroy(id: 'id')
+# id is required param. 
 ```
 
 
@@ -89,12 +100,8 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/osama-inayat/eloqua-api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/osama-inayat/eloqua-api. This project is intended to be a safe, welcoming space for collaboration.
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Eloqua::Api::Wrapper project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/osama-inayat/eloqua-api/blob/master/CODE_OF_CONDUCT.md).

data/lib/constants/eloqua_endpoints.rb

@@ -34,5 +34,9 @@ ELOQUA_ENDPOINTS = {
   delete_campaign: {
     endpoint: '/assets/campaign/{id}',
     method: :delete
+  }.freeze,
+  create_external_activity: {
+    endpoint: '/data/activity',
+    method: :post
   }.freeze
 }.freeze

data/lib/eloqua/api/eloqua_external_assets_types.rb

@@ -10,6 +10,10 @@ module Eloqua
       def find(id:)
         load_and_execute(api: 'single_asset_activities', id: id)
       end
+
+      def create_external_activity(payload:)
+        load_and_execute(api: 'create_external_activity', payload: payload)
+      end
     end
   end
 end

data/lib/eloqua/api/wrapper/version.rb

@@ -1,7 +1,7 @@
 module Eloqua
   module Api
     module Wrapper
-      VERSION = "0.1.2"
+      VERSION = "0.1.3"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eloqua-api-client
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Osama Inayat
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-27 00:00:00.000000000 Z
+date: 2022-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,7 +108,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - 83946734+osama-inayat@users.noreply.github.com
 executables: []
@@ -146,7 +146,7 @@ homepage: https://github.com/osama-inayat/eloqua-api
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -161,8 +161,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: For Communicating with the eloqua api's .
 test_files: []