vindi 0.0.1

data/lib/vindi/rest/merchant.rb

@@ -0,0 +1,41 @@
+module Vindi
+  module Rest
+
+    # Methods for the merchants API
+    # @see https://vindi.github.io/api-docs/dist/#!/merchants
+    module Merchant
+
+      # List merchants for the authenticate user
+      # @option options [Integer] :page (1) Page number.
+      # @option options [Integer] :merchant Merchant account
+      # @return [Array<Hash>] A list of merchants for a merchant.
+      # @example Get all merchants from merchant vindi
+      #   client.list_merchants
+      def list_merchants(options = {})
+        get('merchants', options)[:merchants]
+      end
+
+      # Get a current merchant for the authenticate user
+      #
+      # @param merchant_id [Integer] ID of the merchant
+      # @return [Hash] The merchant you requested, if it exists
+      # @see https://vindi.github.io/api-docs/dist/#!/merchants/GET_version_merchants_id_format
+      # @example Get a current merchant from vindi
+      #   client.current_merchant
+      def current_merchant
+        get("merchants/current")[:merchant]
+      end
+
+      # Edit a merchant
+      #
+      # @params merchant_id [Integer] ID of the merchant
+      # @option options [Hash] :options merchant attributes
+      # @see https://vindi.github.io/api-docs/dist/#!/merchants/PUT_version_merchants_id_format
+      # @example Get merchant #7 from vindi
+      #   client.merchant(7)
+      def merchant(merchant_id, options = {})
+        get("merchants/#{merchant_id}", options)[:merchant]
+      end
+    end
+  end
+end

data/lib/vindi/rest/merchant_user.rb

@@ -0,0 +1,71 @@
+module Vindi
+  module Rest
+
+    # Methods for the merchant_users API
+    # @see https://vindi.github.io/api-docs/dist/#!/merchant_users
+    module MerchantUser
+
+      # List merchant_user for the authenticate user
+      # @return [Array<Hash>] A list of merchant_users for a merchant.
+      # @example Get all merchant_users from merchant vindi
+      def list_merchant_users(options = {})
+        get('merchant_users', options)[:merchant_users]
+      end
+
+      # Get a single merchant_user from a merchant
+      #
+      # @param merchant_user_id [Integer] ID of the merchant_user
+      # @return [Hash] The merchant_user you requested, if it exists
+      # @see https://vindi.github.io/api-docs/dist/#!/merchant_users/GET_version_merchant_users_id_format
+      # @example Get merchant_user #7 from vindi
+      #   client.merchant_user(7)
+      def merchant_user(merchant_user_id, options = {})
+        get("merchant_users/#{merchant_user_id}", options)[:merchant_user]
+      end
+
+      # Create a merchant_user for a merchant vindi
+      #
+      # @option options [Hash] :options merchant_user attributes
+      # @see https://vindi.github.io/api-docs/dist/#!/merchant_users/POST_version_merchant_users_format
+      # @return [Hash] The merchant_user created
+      # @example Create a merchant_user for a merchant vindi
+      #   client.create_merchant_user(name: 'John Doe', email: 'john.doe@mail.com', role_id: 10)
+      def create_merchant_user(options = {})
+        post('merchant_users', options)[:merchant_user]
+      end
+
+      # Edit a merchant_user
+      #
+      # @params merchant_user_id [Integer] ID of the merchant_user
+      # @option options [Hash] :options merchant_user attributes
+      # @see https://vindi.github.io/api-docs/dist/#!/merchant_users/PUT_version_merchant_users_id_format
+      # @example update merchant_user #7
+      #   client.update_merchant_user(7, name: 'Joana Doe', email: 'johanadoes@mail.com')
+      def update_merchant_user(merchant_user_id, options = {})
+        put("merchant_users/#{merchant_user_id}", options)[:merchant_user]
+      end
+
+      # Delete a merchant_user from merchant vindi
+      #
+      # @params merchant_user_id [Integer] ID of the merchant_user
+      # @option options [Hash] :options merchant_user attributes
+      #
+      # @see https://vindi.github.io/api-docs/dist/#!/merchant_users/DELETE_version_merchant_users_id_format
+      # @example Delete merchant_user #36
+      #   client.delete_merchant_user(36)
+      def delete_merchant_user(merchant_user_id, options = {})
+        delete("merchant_users/#{merchant_user_id}", options)[:merchant_user]
+      end
+
+      # Reactivate a merchant_user for a merchant vindi
+      #
+      # @see https://vindi.github.io/api-docs/dist/#!/merchant_users/POST_version_merchant_users_format
+      # @return [Hash] The merchant_user reactivated
+      # @example Reactivate a merchant_user for a merchant vindi
+      #   client.reactivate_merchant_user(37)
+      def reactivate_merchant_user(merchant_user_id, options = {})
+        post("merchant_users/#{merchant_user_id}/reactivate", options)[:merchant_user]
+      end
+    end
+  end
+end

data/lib/vindi/rest/message.rb

@@ -0,0 +1,41 @@
+module Vindi
+  module Rest
+
+    # Methods for the messages API
+    # @see https://vindi.github.io/api-docs/dist/#!/messages
+    module Message
+
+      # List messages for the authenticate user
+      # @option options [Integer] :page (1) Page number.
+      # @option options [Integer] :merchant Merchant account
+      # @return [Array<Hash>] A list of messages for a merchant.
+      # @example Get all messages from merchant vindi
+      def list_messages(options = {})
+        get('messages', options)[:messages]
+      end
+
+      # Get a single message from a merchant
+      #
+      # @param message_id [Integer] ID of the message
+      # @return [Hash] The message you requested, if it exists
+      # @see https://vindi.github.io/api-docs/dist/#!/messages/GET_version_messages_id_format
+      # @example Get message #154 from vindi
+      #   client.message(154)
+      def message(message_id, options = {})
+        get("messages/#{message_id}", options)[:message]
+      end
+
+      # Create a message for a merchant vindi
+      #
+      # @option options [Hash] :options message attributes
+      # @see https://vindi.github.io/api-docs/dist/#!/messages/POST_version_messages_format
+      # @return [Hash] The message created
+      # @example Create a message for a merchant vindi
+      #   client.create_message({ "customer_id": 2, "charge_id": 71,
+      #                           "notification_id": 6, "email": "cliente@email.com" })
+      def create_message(options = {})
+        post('messages', options)[:message]
+      end
+    end
+  end
+end

data/lib/vindi/rest/movement.rb

@@ -0,0 +1,21 @@
+module Vindi
+  module Rest
+
+    # Methods for the Movement API
+    # @see https://vindi.github.io/api-docs/dist/#!/movements
+    module Movement
+
+      # Create a movement for a merchant vindi
+      # 
+      # @option options [Hash] :options movement attributes
+      # @see https://vindi.github.io/api-docs/dist/#!/movements/POST_version_movement_format 
+      # @return [Hash] The movement created
+      # @example Create a movement for a merchant vindi
+      #   client.create_movement(amount: 100, movement_type: "credit",
+      #                          bill_id: 466)
+      def create_movement(options = {})
+        post('movements', options)[:movement]
+      end
+    end
+  end
+end

data/lib/vindi/rest/notification.rb

@@ -0,0 +1,103 @@
+module Vindi
+  module Rest
+
+    # Methods for the notifications API
+    # @see https://vindi.github.io/api-docs/dist/#!/notifications
+    module Notification
+
+      # List notifications for the authenticate user
+      # @return [Array<Hash>] A list of notifications for a merchant.
+      # @example Get all notifications from merchant vindi
+      def list_notifications(options = {})
+        get('notifications', options)[:notifications]
+      end
+
+      # Get a single notification from a merchant
+      #
+      # @param notification_id [Integer] ID of the notification
+      # @return [Hash] The notification you requested, if it exists
+      # @see https://vindi.github.io/api-docs/dist/#!/notifications
+      # @example Get notification #2 from vindi
+      #   client.notification(2)
+      def notification(notification_id, options = {})
+        get("notifications/#{notification_id}", options)[:notification]
+      end
+
+      # Create a notification for a merchant vindi
+      #
+      # @option options [Hash] :options notification attributes
+      # @see https://vindi.github.io/api-docs/dist/#!/notifications
+      # @return [Hash] The notification created
+      # @example Create a notification for a merchant vindi
+      #   client.create_notification(status: "active", notification_type: "email",
+      #                              name: "Hoops", subject: "Hoops",
+      #                              content: "Hey, Hoops!",
+      #                              trigger_type: "charge_created_at",
+      #                              trigger_day: 5, bcc: "")
+      def create_notification(options = {})
+        post('notifications', options)[:notification]
+      end
+
+      # Edit a notification
+      #
+      # @params notification_id [Integer] ID of the notification
+      # @option options [Hash] :options notification attributes
+      # @see https://vindi.github.io/api-docs/dist/#!/notifications
+      # @example update notification #2
+      #   client.update_notification(2, trigger_day: 3)
+      def update_notification(notification_id, options = {})
+        put("notifications/#{notification_id}", options)[:notification]
+      end
+
+      # List notification items for a merchant
+      #
+      # @params notification_id [Integer] ID of the notification
+      # @see https://vindi.github.io/api-docs/dist/#!/notifications
+      # @example notification_items #2
+      #   client.list_notification_items(2)
+      def list_notification_items(notification_id, options = {})
+        url = "notifications/%{id}/notification_items" % { id: notification_id }
+        get(url, options)[:notification_items]
+      end
+
+      # Creates notification items for a merchant
+      #
+      # @params notification_id [Integer] ID of the notification
+      # @see https://vindi.github.io/api-docs/dist/#!/notifications
+      # @example create notification item #2
+      #   client.create_notification_item(2, item_type: "Plan", item_id: 22)
+      def create_notification_item(notification_id, options = {})
+        url = "notifications/%{id}/notification_items" % { id: notification_id }
+        post(url, options)[:notification_item]
+      end
+
+      # Delete a notification from merchant vindi
+      #
+      # @params notification_id [Integer] ID of the notification
+      # @option options [Hash] :options notification attributes
+      #
+      # @see https://vindi.github.io/api-docs/dist/#!/notifications
+      # @example Delete notification #2
+      #   client.delete_notification(2)
+      def delete_notification(notification_id, options = {})
+        delete("notifications/#{notification_id}", options)[:notification]
+      end
+
+      # Delete a notification item from merchant vindi
+      #
+      # @params notification_id [Integer] ID of the notification
+      # @params notification_item_id [Integer] ID of the notification item
+      # @option options [Hash] :options notification attributes
+      #
+      # @see https://vindi.github.io/api-docs/dist/#!/notifications
+      # @example Delete notification item #3
+      #   client.delete_notification_item(2, 3)
+      def delete_notification_item(notification_id, notification_item_id, options = {})
+        url = "notifications/%{id}/notification_items/%{notification_item_id}" % {
+          id: notification_id, notification_item_id: notification_item_id
+        }
+        delete(url, options)[:notification_item]
+      end
+    end
+  end
+end

data/lib/vindi/rest/payment_method.rb

@@ -0,0 +1,29 @@
+module Vindi
+  module Rest
+
+    # Methods for the Payment Methods API
+    # @see https://vindi.github.io/api-docs/dist/#!/payment_methods
+    module PaymentMethod
+
+      # List payment methods for the authenticate user
+      # @option options [Integer] :page (1) Page number.
+      # @option options [Integer] :merchant Merchant account
+      # @return [Array<Hash>] A list of payment_methods for a merchant.
+      # @example Get all payment_methods from merchant vindi
+      def list_payment_methods(options = {})
+        get('payment_methods', options)[:payment_methods]
+      end
+      
+      # Get a single payment_method from a merchant
+      #
+      # @param payment_method_id [Integer] ID of the payment_method
+      # @return [Hash] The payment_method you requested, if it exists
+      # @see https://vindi.github.io/api-docs/dist/#!/payment_methods/GET_version_payment_methods_id_format
+      # @example Get payment_method #2 from vindi
+      #   client.payment_method(2)
+      def payment_method(payment_method_id, options = {})
+        get("payment_methods/#{payment_method_id}", options)[:payment_method]
+      end
+    end
+  end
+end

data/lib/vindi/rest/payment_profile.rb

@@ -0,0 +1,54 @@
+module Vindi
+  module Rest
+
+    # Methods for the Payment profile API
+    # @see https://vindi.github.io/api-docs/dist/#!/payment_profiles
+    module PaymentProfile
+
+      # List payment_profile for the authenticate user
+      # @return [Array<Hash>] A list of payment_profiles for a merchant.
+      # @example Get all payment_profiles from merchant vindi
+      def list_payment_profiles(options = {})
+        get('payment_profiles', options)[:payment_profiles]
+      end
+      
+      # Get a single payment_profile from a merchant
+      #
+      # @param payment_profile_id [Integer] ID of the payment_profile
+      # @return [Hash] The payment_profile you requested, if it exists
+      # @see https://vindi.github.io/api-docs/dist/#!/payment_profiles/GET_version_payment_profiles_id_format
+      # @example Get payment_profile #2 from vindi
+      #   client.payment_profile(2)
+      def payment_profile(payment_profile_id, options = {})
+        get("payment_profiles/#{payment_profile_id}", options)[:payment_profile]
+      end
+
+      # Create a payment_profile for a merchant vindi
+      # 
+      # @option options [Hash] :options payment_profile attributes
+      # @see https://vindi.github.io/api-docs/dist/#!/payment_profiles/POST_version_payment_profiles_format 
+      # @return [Hash] The payment_profile created
+      # @example Create a payment_profile for a merchant vindi
+      #   client.create_payment_profile(holder_name: "Jane Doe", card_cvv: "123",
+      #                                 card_expiration: "12/2018", customer_id: 51)
+      #                                 card_number: "5167454851671773",
+      #                                 payment_method_code: "credit_card",
+      #                                 payment_company_code: "mastercard",
+      def create_payment_profile(options = {})
+        post('payment_profiles', options)[:payment_profile]
+      end
+
+      # Delete a payment_profile from merchant vindi
+      #
+      # @params payment_profile_id [Integer] ID of the payment_profile
+      # @option options [Hash] :options payment_profile attributes
+      #
+      # @see https://vindi.github.io/api-docs/dist/#!/payment_profiles/DELETE_version_payment_profiles_id_format
+      # @example Delete payment_profile #2
+      #   client.delete_payment_profile(2)
+      def delete_payment_profile(payment_profile_id, options = {})
+        delete("payment_profiles/#{payment_profile_id}", options)[:payment_profile]
+      end
+    end
+  end
+end

data/lib/vindi/rest/period.rb

@@ -0,0 +1,52 @@
+module Vindi
+  module Rest
+
+    # Methods for the periods API
+    # @see https://vindi.github.io/api-docs/dist/#!/periods
+    module Period
+
+      # List periods for the authenticate user
+      # @option options [Integer] :page (1) Page number.
+      # @option options [Integer] :merchant Merchant account
+      # @return [Array<Hash>] A list of periods for a merchant.
+      # @example Get all periods from merchant vindi
+      def list_periods(options = {})
+        get('periods', options)[:periods]
+      end
+      
+      # Get a single period from a merchant
+      #
+      # @param period_id [Integer] ID of the period
+      # @return [Hash] The period you requested, if it exists
+      # @see https://vindi.github.io/api-docs/dist/#!/periods/GET_version_periods_id_format
+      # @example Get period #2 from vindi
+      #   client.period(2)
+      def period(period_id, options = {})
+        get("periods/#{period_id}", options)[:period]
+      end
+
+      # Create a period for a merchant vindi
+      # 
+      # @option options [Hash] :options period attributes
+      # @see https://vindi.github.io/api-docs/dist/#!/periods/POST_version_periods_format 
+      # @param bill_id [Integer] ID of the period to generate a bill
+      # @return [Hash] The period created
+      # @example Create a period for a merchant vindi
+      #   client.create_period_bill(360)
+      def create_period_bill(period_id, options = {})
+        post("periods/#{period_id}/bill", options)
+      end
+
+      # Edit a period
+      #
+      # @params period_id [Integer] ID of the period
+      # @option options [Hash] :options period attributes
+      # @see https://vindi.github.io/api-docs/dist/#!/periods/PUT_version_periods_id_format
+      # @example Update period #2
+      #   client.update_period(2, name: 'My period', interval: 3)
+      def update_period(period_id, options = {})
+        put("periods/#{period_id}", options)[:period]
+      end
+    end
+  end
+end

data/lib/vindi/rest/plan.rb

@@ -0,0 +1,51 @@
+module Vindi
+  module Rest
+
+    # Methods for the Plans API
+    # @see https://vindi.github.io/api-docs/dist/#!/plans
+    module Plan
+
+      # List plans for the authenticate user
+      # @option options [Integer] :page (1) Page number.
+      # @option options [Integer] :merchant Merchant account
+      # @return [Array<Hash>] A list of plans for a merchant.
+      # @example Get all plans from merchant vindi
+      def list_plans(options = {})
+        get('plans', options)[:plans]
+      end
+      
+      # Get a single plan from a merchant
+      #
+      # @param plan_id [Integer] ID of the plan
+      # @return [Hash] The plan you requested, if it exists
+      # @see https://vindi.github.io/api-docs/dist/#!/plans/GET_version_plans_id_format
+      # @example Get plan #2 from vindi
+      #   client.plan(2)
+      def plan(plan_id, options = {})
+        get("plans/#{plan_id}", options)[:plan]
+      end
+
+      # Create a plan for a merchant vindi
+      # 
+      # @option options [Hash] :options Plan attributes
+      # @see https://vindi.github.io/api-docs/dist/#!/plans/POST_version_plans_format 
+      # @return [Hash] The plan created
+      # @example Create a plan for a merchant vindi
+      #   client.create_plan(name: 'My Plan', interval: 12)
+      def create_plan(options = {})
+        post('plans', options)[:plan]
+      end
+
+      # Edit a plan
+      #
+      # @params plan_id [Integer] ID of the plan
+      # @option options [Hash] :options Plan attributes
+      # @see https://vindi.github.io/api-docs/dist/#!/plans/PUT_version_plans_id_format
+      # @example Update plan #2
+      #   client.update_plan(2, name: 'My Plan', interval: 3)
+      def update_plan(plan_id, options = {})
+        put("plans/#{plan_id}", options)[:plan]
+      end
+    end
+  end
+end