maropost-api 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65c966cdbe544cf0e317c740454efb0f39b5f6d8
-  data.tar.gz: 35cc46edca3426bfd5e9bd05f111893bb720694f
+  metadata.gz: 211695842efe51cb9cad9fd34f899de04eb3e7a8
+  data.tar.gz: 0af58ab0257785ccf166461f399cedfe4f311e79
 SHA512:
-  metadata.gz: 09b2daa87ba1acacdfd2fd58b83ae95fd08db22663a55eb3e047457e3637bb6d46a503be34e61916e85b45b49ab450ce1ef7bd386f876ed5cc2cee296c4857cc
-  data.tar.gz: 46304b217b24685987656402d885684d9d8d2179a31cb6ac5cbdb9efdba47caeccc177b981e900c8416996f2fc2fbbfb9751b92449f49b0fd72c739a4a4c9a7c
+  metadata.gz: 0dddbf3b9edcb4d6956ed192ca00a3a0d182db059e0d09bbb75f669796988c1f41a2e5fceaf06d14a55fd8bf7c9a5d35e19fcc43f27705a94d1f5a3ad60fa5af
+  data.tar.gz: fa457ec6d11c2d2ab4b403eb1aefbac4093c8971861cf0eb428935df6654b72f1a9b7a90201822630760b76e739f47d5e2cf7247dde0bca37a063794f572e46a

data/README.md

@@ -15,19 +15,20 @@ service, execute:
 
     reports = MaropostApi::Reports.new(account_id, auth_token)
     result = reports.Get(1);
-    if result.success {
+    if (result.success) {
         myReports = result.data;
     }
 
-The result object contains two fields:
+The result object contains three fields:
 
 - `success` (bool)
 - `errors` (object)
+- `data` (Hash|Mixed)
 
 If `success` is `false`, then `errors` will have details about the reason for
 failure. If `errors` is not `nil`, then `success` will always be `false`.
 
-The object might also contain one property, `data` (dynamic), which contains whatever
+The object also contains accessor, `data`, which contains whatever
 data the operation itself provides. Some operations, such as `delete()`
 operations, might not provide any data.
 
@@ -39,7 +40,7 @@ The specific APIs contained are:
 - [Transactional Campaigns](#transactional-campaigns)
 - [Contacts](#contacts)
 - [Journeys](#journeys)
-- [Product and Revenue](#product-and-revenue)
+- [Products and Revenue](#products-and-revenue)
 - [Relational Table Rows](#relational-table-rows)
 - [Reports](#reports)
 
@@ -94,26 +95,28 @@ The specific APIs contained are:
 ### Available Methods:
  - `create_ab_test(name, from_email, address, language, campaign_groups_attributes,`
                   `commit, sendAt, brand_id: nil, suppressed_list_ids: [],`
-                  `suppressed_journey_ids: [], suppressed_segment_ids: [], emailPreviewLink: nil,`
+                  `suppressed_journey_ids: [], suppressed_segment_ids: [], email_preview_link: nil,`
                   `decided_by: nil, lists: [], ctags: [], segments: [])`
    * Creates an Ab Test campaign
    - `name`: name of the new campaign
    - `from_email`: default sender email address for campaign emails
    - `address`: default physical address included on campaign emails
    - `language`: ISO 639-1 language code (e.g., "en"). 2 characters
-   - `campaign_groups_attributes`: array of attributes. Each attribute is itself a hash with the following properties (all strings):
+   - `campaign_groups_attributes`: array of attributes. Each attribute is itself a hash with the following fields (all strings):
      - `name`: name of the group
      - `content_id`: content ID
      - `subject`: subject line of emails
      - `from_name`: "from name" on emails
      - `percentage`: percentage of emails that should be send with these settings 
+     - `preheader`:
+     - `sendAt`: DateTime string having the format `YYYY-MM-DD HH:mm:ss`
    - `commit`: allowed values: 'Save as Draft' or 'Send Test' or 'Schedule'
    - `sendAt`: should be in "yyyy-mm-dd %H:%M:%S" where %H - Hour of the day, 24-hour clock (00..23), %M - Minute of the hour (00..59), %S - Second of the minute (00..60)
    - `brand_id`: brand ID as a string
    - `suppressed_list_ids`: array of list IDs in string format
    - `suppressed_journey_ids`: array of journey IDs in string format
    - `suppressed_segment_ids`: array of segment IDs in string format
-   - `email_preview_link`: (string)
+   - `email_preview_link`: "0" for false. "1" for true.
    - `decided_by`: allowed values: ('TopChoice' for Top Choices) or ('Opens' for Highest Open Rate) or ('Clicks' for Highest Click Rate) or ('Manual' for Manual Selection) or ('click_to_open' for Highest Click-to-Open Rate) or ('conversions' for Highest Conversion Rate)
    - `lists`: array of list IDs in string format
    - `ctags`: array of tags in string format
@@ -132,17 +135,17 @@ The specific APIs contained are:
  - `create(name, subject, preheader, from_name, from_email, reply_to,`
            `content_id, email_preview_link, address, language, add_ctags)`
      * Creates a Transactional Campaign
-     - `name` campaign name
-     - `subject` campaign subject
-     - `preheader` campaign preheader
-     - `from_name` sender name in the email
-     - `from_email` sender email address
-     - `reply_to` reply-to email address
-     - `content_id`
-     - `email_preview_link`
-     - `address` physical address
-     - `language` ISO 639-1 language code
-     - `add_ctags` array of campaign tags
+     - `name`: campaign name
+     - `subject`: campaign subject
+     - `preheader`: campaign preheader
+     - `from_name`: sender name in the email
+     - `from_email`: sender email address
+     - `reply_to`: reply-to email address
+     - `content_id`:
+     - `email_preview_link`: boolean. `true` to send email; `false` otherwise.
+     - `address`: physical address
+     - `language`: ISO 639-1 language code (e.g., "en"). 2 characters
+     - `add_ctags`: array of campaign tags
 
  - `send_email(campaign_id,
                  content: {},
@@ -160,7 +163,7 @@ The specific APIs contained are:
      * Sends a transactional campaign email to a recipient contact. Sender's information will be automatically fetched from the transactional campaign, unless provided in the function arguments.
      - `campaign_id`: must be a campaign that already exists when you call `get()`. If you don't have one, first call `create(...)`.
      - `content`: hash with the following fields: `name`, `html_part`, `text_part`
-     - `ignoreDnm`: If true, ignores the Do Not Mail list for the recipient contact.
+     - `ignore_dnm`: If true, ignores the Do Not Mail list for the recipient contact.
      - `contact`: hash defining the recipient with the following fields: `email`, `first_name`, `last_name`, `custom_field`
        - `custom_field`: is a hash of the custom fields.
      - `send_time`: hash with the following string fields: `hour` ("1" - "12") and `minute` ("00" - "59")
@@ -185,7 +188,7 @@ The specific APIs contained are:
 
  - `get_for_email(email)`
    * Gets the contact according to email address 
-   - `email`: email address of the contact
+   * `email`: email address of the contact
 
  - `get_opens(contact_id, page)`
    * Gets the list of opens for the specified contact
@@ -240,52 +243,43 @@ The specific APIs contained are:
      - `remove_tags`: tags to remove from the contact. Simple array of tag names (strings).
      - `remove_from_dnm`: Set this true to subscribe contact to the list, and remove it from DNM.
      - `subscribe`: true to subscribe the contact to the list; false otherwise.
-
- - `create_or_update_contact(email, first_name: nil, last_name: nil, phone: nil, fax: nil, uid: nil,`
-                          `custom_field: nil, add_tags: nil, remove_tags: nil, remove_from_dnm: true, subscribe: true)`
-     * Creates a contact without a list. Updates if already existing email is passed.
-     - `contact_id`: ID of the contact
-     - `email`: Email address for the contact to be created|updated
-     - `first_name`: first name of Contact
-     - `last_name`: last Name of Contact
-     - `phone`: phone number of Contact
-     - `fax`: fax number of Contact
-     - `uid`: UID for the contact
-     - `custom_field`: custom fields passed as associative array. Keys represent the field names while values represent the values
-     - `add_tags`: tags to add to the contact. Simple array of tag names (strings).
-     - `remove_tags`: tags to remove from the contact. Simple array of tag names (strings).
-     - `remove_from_dnm`: set this true to subscribe contact to the list, and remove it from DNM
-	 - `subscribe`: true to subscribe the contact to the list; false otherwise.
-
- - `create_or_update_for_list_and_workflows(email, first_name: nil, last_name: nil, phone: nil, fax: nil, uid: nil,`
-                                          `custom_field: nil, add_tags: nil, remove_tags: nil, remove_from_dnm: false, subscribe_list_ids: nil,`
-                                          `unsubscribe_list_ids: nil, unsubscribe_workflow_ids: nil, unsubscribe_campaign: nil)`
+ 
+ - `create_or_update_for_lists_and_workflows( 
+        email,
+        first_name,
+        last_name,
+        phone,
+        fax,
+        uid = nil,
+        custom_field = {},
+        add_tags = [],
+        remove_tags = [],
+        remove_from_dnm = true,
+        **options
+    )`
      * Creates or updates Contact
         - Multiple lists can be subscribed, unsubscribed. 
         - Multiple workflows can be unsubscribed.
-     - `email`: email address for the contact to be created|updated
-     - `first_name`: first name of Contact
-     - `last_name`: last name of Contact
-     - `phone`: phone number of Contact
-     - `fax`: fax number of Contact
-     - `uid`: UID for the Contact
-     - `custom_field`: custom fields passed as associative array. Keys represent the field names while values represent the values
-     - `add_tags`: tags to add to the contact. Simple array of tag names (strings)
-     - `remove_tags`: tags to remove from the contact. Simple array of tag names (strings)
-     - `remove_from_dnm`: set this true to subscribe contact to the list, and remove it from DNM
-     - `subscribe_list_ids`: simple array of IDs of lists to subscribe the contact to
-     - `unsubscribe_list_ids`: simple array of IDs of Lists to unsubscribe the contact from
-     - `unsubscribe_workflow_ids`: simple array of list of IDs of workflows to unsubscribe the contact from
-     - `unsubscribe_campaign`: campaign_id to unsubscribe the contact from
+     * `email`: [String] must be an email
+     * `first_name`: [String] Contact First Name
+     * `last_name`: [String] Contact Last Name
+     * `phone`: [String] Contact's phone number
+     * `fax`: [String] Contacts' fax number
+     * `uid`: [String] Unique identifier
+     * `custom_field`: [Hash] list of custom_fields addable for the new contact
+     * `add_tags`: [Array] list of tags to be added to the contact
+     * `remove_tags`: [Array] list of tags to be removed from the contact
+     * `remove_from_dnm`: [Boolean] decides whether to remove contact from dnm or not
+     * `options`: [Hash] Key value pairs containing other different properties for the new contact
 
  - `delete_from_all_lists(email)`
      * Deletes specified contact from all lists
-     - `email`: email address of the contact
+     * `email`: email address of the contact
 
- - `delete_from_lists(contact_id, list_ids: nil)`
+ - `delete_from_lists(contact_id, lists_to_delete_from)`
      * Deletes the specified contact from the specified lists
-     - `contact_id`: id of the contact
-     - `list_ids`: simple array of ids of the lists
+     * `contact_id`: id of the contact
+     * `lists_to_delete_from`: simple array of ids of the lists
 
  - `delete_contact_for_uid(uid)`
      * Deletes contact having the specified UID
@@ -298,8 +292,9 @@ The specific APIs contained are:
 
  - `unsubscribe_all(contact_field_value, contact_field_name: "email")`
      * Unsubscribes contact having the specified field name/value.
-     - `contact_field_value`: the value of the field for the contact(s) being unsubscribed
-     - `contact_field_name`: the name of the field being checked for the value. At present, the accepted field names are: 'email' or 'uid'
+     * `contact_field_value`: the value of the field for the contact(s) being unsubscribed
+     * `contact_field_name`: the name of the field being checked for the value. At present, the 
+     accepted field names are: 'email' or 'uid'
 
 ## Journeys
 
@@ -323,44 +318,53 @@ The specific APIs contained are:
 	 - `journey_id`: get contacts filtered with journey_id
      - `page` : page # (>= 1). Up to 200 records returned per page.
 
- - `stop_all(contact_id, recipientEmail, uid, page)`
+ - `stop_all(contact_id: nil, uid: nil, email_recipient: nil)`
      * Stops all journeys, filtered for the matching parameters
-     - `contact_id`: this filter ignored unless greater than 0
-     - `recipientEmail`: this filter ignored if nil
-     - `uid`: this filter ignored if nil
-	 - `page`: page # (>= 1). Up to 200 record returned per page.
+     * `contact_id:`: this filter ignored unless greater than 0
+     * `uid:`: this filter ignored if null
+     * `email_recipient:`: this filter ignored if null
 
- - `pause_journey_for_contact(journey_id, contact_id)`
+ - `pause_for_contact(journey_id, contact_id)`
      * Pause the specified journey for the specified contact
 	 - `journey_id`: journey to pause
 	 - `contact_id`: pause journey for specified contact id
 
- - `pause_journey_for_uid(journey_id, uid)`
+ - `pause_for_uid(journey_id, uid)`
      * Pause the specified journey for the contact having the specified UID
 	 - `journey_id`: journey to pause
 	 - `uid`: pause journey for specified uid
 
- - `reset_journey_for_contact(journey_id, contact_id)`
-     * Reset the specified journey for the specified active/paused contact. Resetting a contact to the beginning of the journeys will result in sending of the same journey campaigns as originally sent.
+ - `reset_for_contact(journey_id, contact_id)`
+     * Reset the specified journey for the specified active/paused contact. 
+     Resetting a contact to the beginning of the journeys will result in 
+     sending of the same journey campaigns as originally sent.
 	 - `journey_id`: journey to reset
 	 - `contact_id`: reset journey for specified contact id
 
- - `reset_journey_for_uid(journey_id, uid)`
-     * Restarts a journey for a paused contact having the specified UID. Adds a new contact in journey. Retriggers the journey for a contact who has finished its journey once. (To retrigger, *make sure* that "Retrigger Journey" option is enabled.)
+ - `reset_for_uid(journey_id, uid)`
+     * Reset the specified journey for the active/paused contact having the 
+     specified UID. Resetting a contact to the beginning of the journeys 
+     will result in sending of the same journey campaigns as originally sent.
 	 - `journey_id`: journey to reset
 	 - `uid`: uid of contact to reset journey
 
- - `start_journey_for_contact(journey_id, contact_id)`
-	* Starts a journey for contact having specified journey_id
+ - `start_for_contact(journey_id, contact_id)`
+     * Restarts a journey for a paused contact. Adds a new contact in 
+     journey. Retriggers the journey for a contact who has finished its 
+     journey once. (To retrigger, *make sure* that "Retrigger Journey" option 
+     is enabled.)
 	- `journey_id`: journey to start
 	- `contact_id`: contact id of contact to start journey
 
- - `start_journey_for_uid(journey_id, uid)`
-	* Starts a journey for contact having specified uid and journey_id
+ - `start_for_uid(journey_id, uid)`
+     * Restarts a journey for a paused contact having the specified UID. 
+     Adds a new contact in journey. Retriggers the journey for a contact 
+     who has finished its journey once. (To retrigger, *make sure* that 
+     "Retrigger Journey" option is enabled.)
 	- 'journey_id': journey to start
 	- 'uid': uid of contact to start journey
 
-## Product and Revenue
+## Products and Revenue
 
 ### Instantiation:
 
@@ -398,34 +402,28 @@ The specific APIs contained are:
      - `campaign_id`: campaign id
      - `coupon_code`: coupon code
 
- - `update_order_for_original_order_id(original_order_id,`
-                                      `order_date_time,`
-                                      `order_status,`
-                                      `order_items,`
-                                      `campaign_id: nil,`
-                                      `coupon_code: nil)`
-     * Updates an existing eCommerce order using unique original_order_id if the details are changed due to partial return or some other update.
-     - `original_order_id`: matches the original_order_id field of the order
-     - `order_date_time`: uses the format: YYYY-MM-DDTHH:MM:SS-05:00
-     - `order_status`: order status
-     - `order_items`: must contain at least one order_item.
-     - `campaign_id`: campaign id
-     - `coupon_code`: coupon code
+ - `update_order_for_original_order_id(original_order_id, order: {})`
+     * Updates an existing eCommerce order using unique original_order_id if the details are changed due to partial
+      return or some other update.
+     * `original_order_id:`: [String] Orginal Order Id of the Order
+     * `order:`: [Hash] Contains the following fields:
+         - `order_date_time`: uses the format: YYYY-MM-DDTHH:MM:SS-05:00
+         - `order_status`: order status
+         - `order_items`: must contain at least one order_item.
+         - `campaign_id`: campaign id
+         - `coupon_code`: coupon code
+
+ - `update_order_for_order_id(order_id, order: {})`
+     * Updates an existing eCommerce order using unique order_id if the details are changed due to partial return or
+     * some other update.
+     * `original_order_id:`: [String] Original Order Id of the Order
+     * `order:`: [Hash] Contains the following fields:
+         - `order_date`: uses the format: YYYY-MM-DDTHH:MM:SS-05:00
+         - `order_status`: order status
+         - `order_items`: must contain at least one order_item.
+         - `campaign_id`: campaign id
+         - `coupon_code`: coupon code
 
- - `update_order_for_order_id(order_id,`
-                              `order_date_time,`
-                              `order_status,`
-                              `order_items,`
-                              `campaign_id: nil,`
-                              `coupon_code: nil)`
-     * Updates an existing eCommerce order using unique order_id if the details are changed due to partial return or some other update.
-     - `order_id`: matches the Maropost order_id field of the order
-     - `order_date_time`: uses the format: YYYY-MM-DDTHH:MM:SS-05:00
-     - `order_status`: order status
-     - `order_items`: must contain at least one order_item.
-     - `campaign_id`: campaign id
-     - `coupon_code`: coupon code
-    
  - `delete_for_original_order_id(original_order_id)`
      * Deletes the complete eCommerce order if the order is cancelled or returned
      - `original_order_id` matches the original_order_id field of the order
@@ -435,14 +433,16 @@ The specific APIs contained are:
      - `id`: Maropost order_id
 
  - `delete_products_for_original_order_id(original_order_id, product_ids)`
-     * Deletes the specified product(s) from a complete eCommerce order if the product(s) is cancelled or returned
-     - `original_order_id`: matches the original_order_id field of the order
-     - `product_ids`: the product(s) to delete from the order
+     * Deletes the specified product(s) from a complete eCommerce order if 
+     the product(s) is cancelled or returned
+     * `original_order_id`: matches the original_order_id field of the order
+     * `product_ids`: the product(s) to delete from the order
 
- - `delete_products_for_order_id(id, product_ids)`
-     * Deletes the specified product(s) from a complete eCommerce order if the product(s) is cancelled or returned
-     - `id`: Maropost order_id
-     - `product_ids`: the product(s) to delete from the order
+ - `delete_products_for_order_id(order_id, product_ids)`
+     * Deletes the specified product(s) from a complete eCommerce order if 
+     the product(s) is cancelled or returned
+     * `order_ids`: Maropost order_id
+     * `product_ids`: the product(s) to delete from the order
 
 ## Relational Table Rows
 
@@ -470,21 +470,21 @@ To switch tables, you do not need to re-instantiate the service. Simply update t
 
  - `create(key_value_col, *key_value_cols)`
      * Adds a record to the Relational Table
-     * `key_value_col`: object hash containing the fields of the
-     record to be created, each item consisting of two fields.
-       - NOTE: One of the fields must represent the unique identifier.
+     * `key_value_col`: object hash representing the unique identifier of the record to add.
+         * hash key represents the column name and the hash value is the column value.  
+     * `*key_value_cols`: other hashes representing other columns to add
 
  - `update(key_value_col, *key_value_cols)`
      * Updates a record in the Relational Table.
-     * `key_value_col`: object hash containing the fields of the
-     record to be created, each item consisting of two fields.
-       - NOTE: One of the KeyValues must represent the unique identifier.
+     * `key_value_col`: object hash representing the unique identifier of the record to add.
+         * hash key represents the column name and the hash value is the column value.  
+     * `*key_value_cols`: other hashes representing other columns to add
 
  - `upsert(key_value_col, *key_value_cols)`
      * Creates or updates a record in the Relational Table.
-     * `key_value_col`: object hash containing the fields of the
-     record to be created, each item consisting of two fields.
-       - NOTE: One of the KeyValues must represent the unique identifier.
+     * `key_value_col`: object hash representing the unique identifier of the record to add.
+         * hash key represents the column name and the hash value is the column value.  
+     * `*key_value_cols`: other hashes representing other columns to add
 
  - `delete(unique_field_name, value)`
      * Deletes the given record of the Relational Table
@@ -610,6 +610,6 @@ To switch tables, you do not need to re-instantiate the service. Simply update t
    * `to`: end of date range filter
    * `per`: gets the mentioned number of reports
 
- - `get_journey(page)`
+ - `get_journeys(page)`
    * returns the list of all Journeys
    * `page`: page # (>= 1). Up to 200 records returned per page.

data/lib/maropost_api/products_and_revenue.rb

@@ -1,40 +1,65 @@
 require 'maropost_api/custom_types/order_item'
 
 module MaropostApi
-  
+
+  ##
+  # Contains methods that will create, update, read and delete the services
+  # provided in the Product and Revenue Api
   class ProductsAndRevenue
-    
+    ##
+    # Creates a new instance of Reports class.
+    # @param account [Integer] is authentic user account id (Integer) provided by maropost.com
+    # @param api_key [String] is the auth token (String) that is validated on the server to authenticate the user
     def initialize(account = ENV["ACCOUNT"], api_key = ENV["API_KEY"])
       MaropostApi.instance_variable_set(:@api_key, api_key)
       MaropostApi.instance_variable_set(:@account, account)
     end
-    
+
+    ##
+    # Gets the order for the specified id
+    # @param id [Integer] unique identifier of the order
     def get_order(id)
       full_path = full_resource_path("/find")
       query_params = MaropostApi.set_query_params({"where[id]" => id})
-      
+
       MaropostApi.get_result(full_path, query_params)
     end
-    
+
+    ##
+    # gets the order for the specified original order id
+    # @param original_order_id [String] A unique identifier that's not changed since the creation date
     def get_order_for_original_order_id(original_order_id)
       full_path = full_resource_path("/#{original_order_id}")
       query_params = MaropostApi.set_query_params
-      
+
       MaropostApi.get_result(full_path, query_params)
     end
-    
+
+    ##
+    # Creates a new order from the given parameters
+    # @param require_unique [Boolean] validates that the order has a unique original_order_id for the given contact.
+    # @param contact [Hash] Named parameter, which if exists, must contain :email as its key
+    # @param order [Hash] Named parameter, which must contain :order_date, :order_status, :original_order_id, :order_items as its keys
+    # @param @order_items [OrderItem] Custom Type containing key value pair to reference an order item
+    # @param add_tags [Array] List of string tags to be added in the new order
+    # @param remove_tags [Array] List of string tags to be removed from the new order
+    # @param uid [String] Unique Identifier
+    # @param list_ids [String|CSV] A csv list fo list ids
+    # @param grand_total [Float] An amount referencing the total of the order
+    # @param campaing_id [Integer] ID of the Campaign the order belongs to
+    # @param coupon_code [String]
     def create_order(
-      require_unique, 
-      contact: {}, 
-      order: {},
-      order_items: [],
-      add_tags: [], 
-      remove_tags: [],
-      uid: nil, 
-      list_ids: nil, 
-      grand_total: nil,
-      campaign_id: nil,
-      coupon_code: nil
+        require_unique,
+        contact: {},
+        order: {},
+        order_items: [],
+        add_tags: [],
+        remove_tags: [],
+        uid: nil,
+        list_ids: nil,
+        grand_total: nil,
+        campaign_id: nil,
+        coupon_code: nil
     )
       # required contacts fields to check for
       [:email,].each do |contact_field|
@@ -59,15 +84,19 @@ module MaropostApi
       params[:grand_total] = grand_total
       params[:campaign_id] = campaign_id
       params[:coupon_code] = coupon_code
-      
+
       full_path = full_resource_path
-      
+
       MaropostApi.post_result(full_path, {"order" => params})
     end
-    
+
+    ##
+    # updates an order fo the given original order id
+    # @param original_order_id [String] Orginal Order Id of the Order
+    # @param order [Hash] Key value pairs that must contain at least :order_date, :order_status and :order_items as its keys
     def update_order_for_original_order_id(original_order_id, order: {})
       raise ArgumentError.new('original_order_id is required') if original_order_id.nil?
-      
+
       [:order_date, :order_status, :order_items].each do |f|
         raise ArgumentError.new("order[:#{f}] is required") unless order.has_key?(f)
       end
@@ -75,16 +104,20 @@ module MaropostApi
         raise TypeError.new('each order item should be a type of ' << OrderItem.class.to_s) unless oi.kind_of? OrderItem
       end
       order[:order_items].map! {|i| i.to_hash }
-      
+
       full_path = full_resource_path("/#{original_order_id}")
       form_body = {order: order}
-      
-      MaropostApi.put_result(full_path, form_body)   
+
+      MaropostApi.put_result(full_path, form_body)
     end
-    
+
+    ##
+    # updates an order fo the given original order id
+    # @param original_order_id [String] Id of the Order
+    # @param order [Hash] Key value pairs that must contain at least :order_date, :order_status and :order_items as its keys
     def update_order_for_order_id(order_id, order: {})
       raise ArgumentError.new('order_id is required') if order_id.nil?
-      
+
       [:order_date, :order_status, :order_items].each do |f|
         raise ArgumentError.new("order[:#{f}] is required") unless order.has_key?(f)
       end
@@ -92,50 +125,61 @@ module MaropostApi
         raise TypeError.new('each order item should be a type of ' << OrderItem.class.to_s) unless oi.kind_of? OrderItem
       end
       order[:order_items].map! {|i| i.to_hash }
-      
+
       full_path = full_resource_path("/find")
       query_params = MaropostApi.set_query_params({"where[id]" => order_id})
-      
+
       MaropostApi.put_result(full_path, {order: order}, query_params)
     end
-    
+
+    ##
+    # deletes an order fo the given original order id
+    # @param original_order_id [String] Orginal Order Id of the Order
     def delete_for_original_order_id(original_order_id)
       full_path = full_resource_path("/#{original_order_id}")
       query_params = MaropostApi.set_query_params
-      
+
       MaropostApi.delete_result(full_path, query_params)
     end
-    
+
     def delete_for_order_id(order_id)
       full_path = full_resource_path('/find')
       query_params = MaropostApi.set_query_params({'where[id]' => order_id})
-      
+
       MaropostApi.delete_result(full_path, query_params)
     end
-    
+
+    ##
+    # deletes products for the given original order id
+    # @param original_order_id [String] Orginal Order Id of the Order
+    # @param product_ids [Array] List of product ids to delete
     def delete_products_for_original_order_id(original_order_id, product_ids)
-      raise TypeError.new('product_ids should be an Array') if ! product_ids.kind_of? Array
+      raise TypeError.new('product_ids should be an Array') until product_ids.is_a? Array
       full_path = full_resource_path("/#{original_order_id}")
       query_params = MaropostApi.set_query_params({"product_ids" => product_ids.join(',')})
-      
+
       MaropostApi.delete_result(full_path, query_params)
     end
-    
+
+    ##
+    # deletes products for the specified order id
+    # @param order_id [Integer] ID of the order
+    # @param product_ids [Array] List of product IDs to be deleted
     def delete_products_for_order_id(order_id, product_ids)
       raise TypeError.new('product_ids should be an Array') if ! product_ids.kind_of? Array
       full_path = full_resource_path("/find")
       query_params = MaropostApi.set_query_params({"product_ids" => product_ids.join(','), 'where[id]' => order_id})
-      
+
       MaropostApi.delete_result(full_path, query_params)
     end
-      
-      private
-      
-      def full_resource_path(specifics = '', root_resource = 'orders')
-        account = MaropostApi.instance_variable_get(:@account)
-        "/accounts/#{account}/#{root_resource}" << specifics
-      end
-    
+
+    private
+
+    def full_resource_path(specifics = '', root_resource = 'orders')
+      account = MaropostApi.instance_variable_get(:@account)
+      "/accounts/#{account}/#{root_resource}" << specifics
+    end
+
   end
-  
+
 end

data/lib/maropost_api/relational_tables.rb

@@ -1,8 +1,17 @@
-module MaropostApi 
+module MaropostApi
+
+  ##
+  # Contains methods to operate various operations like create, update, delete or read
+  # from the Relational Table Api
   class RelationalTableRows
     
     attr_accessor :table_name
-    
+
+    ##
+    # Creates a new instance of Reports class.
+    # @param account [Integer] is authentic user account id (Integer) provided by maropost.com
+    # @param api_key [String] is the auth token (String) that is validated on the server to authenticate the user
+    # @param table_name [String] sets which relational table the service's operations should act against
     def initialize(account = ENV["ACCOUNT"], api_key = ENV["API_KEY"], table_name:)
       MaropostApi.instance_variable_set(:@api_key, api_key)
       MaropostApi.instance_variable_set(:@account, account)
@@ -10,14 +19,20 @@ module MaropostApi
       
       MaropostApi.base_uri "https://rdb.maropost.com/#{account}"
     end
-    
+
+    ##
+    # Gets the records of the relational table
     def get
       full_path = full_resource_path
       query_params = MaropostApi.set_query_params
       
       MaropostApi.get_result(full_path, query_params)
     end
-    
+
+    ##
+    # Gets the specified record from the relational table
+    # @param unique_field_name [String] the name of the field to retrieve
+    # @param value [Mixed] Value of the unique_field_name
     def show(unique_field_name, value)
       raise TypeError.new("#{unique_field_name.inspect} should be a string") unless unique_field_name.is_a? String
       params = {:record => {}}
@@ -26,7 +41,11 @@ module MaropostApi
       
       MaropostApi.post_result(full_path, params)
     end
-    
+
+    ##
+    # Adds a record to the Relational Table
+    # @param key_value_col [Hash] A key value pair to be added to the table
+    # @param key_value_cols [Hash] Other multile key value pairs that can be added at once in the table
     def create(key_value_col, *key_value_cols)
       raise TypeError.new("#{key_value_col.inspect} is not type of Hash") unless key_value_col.kind_of? Hash
       if (key_value_cols)
@@ -38,7 +57,11 @@ module MaropostApi
       
       MaropostApi.post_result(full_path, :record => all_key_values)
     end
-    
+
+    ##
+    # Updates a record in the Relational Table
+    # @param key_value_col [Hash] A key value to be updated in the table
+    # @param key_value_cols [Hash] Rest of the key value pairs to be updated if there are multiple
     def update(key_value_col, *key_value_cols)
       raise TypeError.new("#{key_value_col.inspect} is not type of Hash") unless key_value_col.kind_of? Hash
       if (key_value_cols)
@@ -51,7 +74,11 @@ module MaropostApi
       
       MaropostApi.put_result(full_path, {:record => all_key_values}, query_params)
     end
-    
+
+    ##
+    # Creates or updates a record in the Relational Table
+    # @param key_value_col [Hash] A key value to be updated inthe table
+    # @param key_value_cols [Hash] Rest of the key value pairs to be added/updated in case of multiple fields
     def upsert(key_value_col, *key_value_cols)
       raise TypeError.new("#{key_value_col.inspect} is not type of Hash") unless key_value_col.kind_of? Hash
       if (key_value_cols)
@@ -65,7 +92,11 @@ module MaropostApi
       
       MaropostApi.put_result(full_path, {:record => all_key_values}, query_params)
     end
-    
+
+    ##
+    # Deletes the given record from the Relational Table
+    # @param unique_field_name [String] name of the unique identifier of the record to be deleted
+    # @param value [Mixed] value matching the unique identifier
     def delete(unique_field_name, value)
       raise TypeError.new("#{unique_field_name.inspect} is not a String") unless unique_field_name.is_a? String
       record = {:record => {}}

data/lib/maropost_api/transactional_campaigns.rb

@@ -57,7 +57,9 @@ module MaropostApi
         raise ArgumentError.new('from_email must be a valid email address') until from_email.nil? or from_email.match? email_regex
         raise ArgumentError.new('reply_to must be a valid email address') until reply_to.nil? or reply_to.match? email_regex
         raise ArgumentError.new('add_ctags must be a valid Array of string') until add_ctags.is_a? Array and add_ctags.all?{|t| t.is_a? String }
-        
+        raise ArgumentError.new('send_time must have two keys viz. :hour, :minute') until send_time.has_key?(:hour) and send_time.has_key?(:minute)
+        raise ArgumentError.new('send_time[:hour] must be between 1-12 and send_time[:minute] must be between 0-59') until (1..12).to_a.include?(send_time[:hour]) and (0..59).to_a.include?(send_time[:minute])
+
         params = {}
         method(__method__).parameters.each{|p| params[p[1]] = eval(p[1].to_s)}
         params.reject!{|k,v| v.nil? or (v.respond_to? :empty? and v.empty?) }

data/lib/maropost_api/version.rb

@@ -1,3 +1,3 @@
 module MaropostApi
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: maropost-api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Ashish Acharya
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-08 00:00:00.000000000 Z
+date: 2019-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty