mints 0.0.28 → 0.0.30

data/lib/contact/config/appointments.rb

@@ -0,0 +1,201 @@
+# frozen_string_literal: true
+
+module Appointments
+  # Appointments
+
+  ##
+  # === Get Appointments.
+  # Get a collection of appointments.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @mints_contact.get_appointments
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'id, created_at'
+  #     }
+  #     @data = @mints_contact.get_appointments(options)
+  def get_appointments(options = nil)
+    @client.raw('get', '/contacts/appointments', options)
+  end
+
+  ##
+  # === Get Appointment.
+  # Get an appointment info.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @mints_contact.get_appointment(1)
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'id, created_at'
+  #     }
+  #     @data = @mints_contact.get_appointment(1, options)
+  def get_appointment(id, options = nil)
+    @client.raw('get', "/contacts/appointments/#{id}", options)
+  end
+
+  ##
+  # === Create Appointment.
+  # Create an appointment with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       object_model: 'products',
+  #       object_id: 1,
+  #       title: 'New Appointment',
+  #       start: '2021-11-25T14:15:00+00:00',
+  #       end: '2022-01-01T13:00:00+00:00'
+  #     }
+  #     @data = @mints_contact.create_appointment(data)
+  def create_appointment(data)
+    @client.raw('post', '/contacts/appointments', nil, data_transform(data))
+  end
+
+  ##
+  # === Update Appointment.
+  # Update an appointment info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Appointment id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       object_id: 2
+  #     }
+  #     @data = @mints_contact.update_appointment(1, data)
+  def update_appointment(id, data)
+    @client.raw('put', "/contacts/appointments/#{id}", nil, data_transform(data))
+  end
+
+  ##
+  # === Scheduled Appointments.
+  # Get a collection of appointments filtering by object_type, object_id and dates range.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       object_model: 'products',
+  #       object_id: 2,
+  #       start: '2021-11-25T14:15:00+00:00',
+  #       end: '2022-01-01T13:00:00+00:00'
+  #     }
+  #     @data = @mints_contact.scheduled_appointments(data)
+  def scheduled_appointments(data)
+    @client.raw('post', '/contacts/appointments/scheduled-appointments', nil, data_transform(data))
+  end
+
+  ##
+  # === Attach Invitee.
+  # Attach invitee to an appointment.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       appointment_id: 1,
+  #       invitee_ids: 1
+  #     }
+  #     @data = @mints_contact.attach_invitee(data)
+  def attach_invitee(data)
+    @client.raw('post', '/contacts/appointments/attach-invitee', nil, data_transform(data))
+  end
+
+  ##
+  # === Attach Follower.
+  # Attach follower to an appointment.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       appointment_id: 1,
+  #       follower_ids: 1
+  #     }
+  #     @data = @mints_contact.attach_follower(data)
+  def attach_follower(data)
+    @client.raw('post', '/contacts/appointments/attach-follower', nil, data_transform(data))
+  end
+
+  ##
+  # === Detach Invitee.
+  # Detach invitee from an appointment.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       appointment_id: 1,
+  #       invitee_ids: 1
+  #     }
+  #     @data = @mints_contact.detach_invitee(data)
+  def detach_invitee(data)
+    @client.raw('post', '/contacts/appointments/detach-invitee', nil, data_transform(data))
+  end
+
+  ##
+  # === Detach Follower.
+  # Detach follower from an appointment.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       appointment_id: 1,
+  #       follower_ids: 1
+  #     }
+  #     @data = @mints_contact.detach_follower(data)
+  def detach_follower(data)
+    @client.raw('post', '/contacts/appointments/detach-follower', nil, data_transform(data))
+  end
+
+  ##
+  # === Sync Invitee.
+  # Sync an invitee from an appointment.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       appointment_id: 1,
+  #       invitee_ids: 1
+  #     }
+  #     @data = @mints_contact.sync_invitee(data)
+  def sync_invitee(data)
+    @client.raw('post', '/contacts/appointments/sync-invitee', nil, data_transform(data))
+  end
+
+  ##
+  # === Sync Follower.
+  # Sync a follower from an appointment.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       appointment_id: 1,
+  #       follower_ids: 1
+  #     }
+  #     @data = @mints_contact.sync_follower(data)
+  def sync_follower(data)
+    @client.raw('post', '/contacts/appointments/sync-follower', nil, data_transform(data))
+  end
+end

data/lib/contact/config/config.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative './appointments'
+
+module Config
+  include Appointments
+end

data/lib/contact/content/content.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative './conversations'
+
+module Content
+  include Conversations
+end

data/lib/contact/content/conversations.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+module Conversations
+  ##
+  # === Get Conversations.
+  # Get a collection of conversations.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  # FIXME: This method doesn't return data.
+  def get_conversations(options = nil)
+    @client.raw('get', '/content/conversations', options, nil, @contact_v1_url)
+  end
+
+  ##
+  # === Get Conversation.
+  # Get a conversation info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Conversation id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  # FIXME: This method doesn't return data.
+  def get_conversation(id, options = nil)
+    @client.raw('get', "/content/conversations/#{id}", options, nil, @contact_v1_url)
+  end
+
+  ##
+  # === Create Conversation.
+  # Create a conversation with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Conversation To Test'
+  #     }
+  #     @data = @mints_contact.create_conversation(data)
+  def create_conversation(data)
+    @client.raw('post', '/content/conversations', nil, data_transform(data), @contact_v1_url)
+  end
+
+  ##
+  # === Update Conversation.
+  # Update a location template info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Conversation id.
+  # data:: (Hash) -- Data to be submitted.
+  # FIXME: This method doesn't locate conversation id to be updated.
+  def update_conversation(id, data)
+    @client.raw('put', "/content/conversations/#{id}", nil, data_transform(data), @contact_v1_url)
+  end
+
+  ##
+  # === Update Conversation Status.
+  # Update a conversation status.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Conversation id.
+  # data:: (Hash) -- Data to be submitted.
+  # FIXME: This method doesn't locate conversation id to be updated.
+  def update_conversation_status(id, data)
+    @client.raw('put', "/content/conversations/#{id}/status", nil, data_transform(data), @contact_v1_url)
+  end
+
+  ##
+  # === Get Conversation Participants.
+  # Update a conversation participants.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Conversation id.
+  # FIXME: This method doesn't locate conversation id to be updated.
+  def get_conversation_participants(id)
+    #TODO: Test if this method needs data in options.
+    @client.raw('get', "/content/conversations/#{id}/participants", nil, nil, @contact_v1_url)
+  end
+
+  ##
+  # === Get Messages.
+  # Get a collection of messages.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  # FIXME: This method doesn't return data.
+  def get_messages(options = nil)
+    @client.raw('get', '/content/messages', options, nil, @contact_v1_url)
+  end
+
+  ##
+  # === Get Message.
+  # Get a message info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Message id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  # FIXME: This method doesn't return data.
+  def get_message(id, options = nil)
+    @client.raw('get', "/content/messages/#{id}", options, nil, @contact_v1_url)
+  end
+
+  ##
+  # === Create Message.
+  # Create a message with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       conversation_id: 3,
+  #       type: 'text',
+  #       value: {
+  #         text: 'Message Text'
+  #       }
+  #     }
+  #     @data = @mints_contact.create_message(data)
+  def create_message(data)
+    @client.raw('post', '/content/messages', nil, data_transform(data), @contact_v1_url)
+  end
+end

data/lib/contact/ecommerce/ecommerce.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative './order_items_groups'
+require_relative './order_items'
+require_relative './orders'
+require_relative './vouchers'
+
+module Ecommerce
+  include OrderItemsGroups
+  include OrderItems
+  include Orders
+  include Vouchers
+
+end

data/lib/contact/ecommerce/order_items.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module OrderItems
+  ##
+  # === Get Order Items.
+  # Get a collection of order items.
+  #TODO: Find a way to show order items.
+  def get_order_items(options = nil)
+    @client.raw('get', '/ecommerce/order-items', options, nil, @contact_v1_url)
+  end
+
+  ##
+  # === Get Order Item.
+  # Get an order item info.
+  # TODO: Find a way to show order items.
+  def get_order_item(id, options = nil)
+    @client.raw('get', "/ecommerce/order-items/#{id}", options, nil, @contact_v1_url)
+  end
+end

data/lib/contact/ecommerce/order_items_groups.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module OrderItemsGroups
+  ##
+  # === Get Order Item Groups.
+  # Get a collection of order item groups.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @mints_contact.get_order_item_groups
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'id'
+  #     }
+  #     @data = @mints_contact.get_order_item_groups(options)
+  def get_order_item_groups(options = nil)
+    @client.raw('get', '/ecommerce/order-items-groups', options, nil, @contact_v1_url)
+  end
+
+  ##
+  # === Get Order Item Group.
+  # Get an order item group info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Order Item Group Id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @mints_contact.get_order_item_group(130)
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'id'
+  #     }
+  #     @data = @mints_contact.get_order_item_group(130, options)
+  def get_order_item_group(id, options = nil)
+    @client.raw('get', "/ecommerce/order-items-groups/#{id}", options, nil, @contact_v1_url)
+  end
+
+  ##
+  # === Create Order Item Group.
+  # Create an order item group with data if you are related to that order.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== First Example
+  #     data = {
+  #       name: 'New Order Item Group',
+  #       quantity: 1,
+  #       order_id: 1,
+  #       on_sale_price: 100
+  #     }
+  #     @data = @mints_contact.create_order_item_group(data)
+  #
+  # ==== Second Example
+  #     data = {
+  #       name: "",
+  #       quantity: 1,
+  #       order_id: 1,
+  #       sku_id: 1
+  #     }
+  #     @data = @mints_contact.create_order_item_group(data)
+  def create_order_item_group(data)
+    @client.raw('post', '/ecommerce/order-items-groups', nil, data_transform(data), @contact_v1_url)
+  end
+
+  ##
+  # === Update Order Item Group.
+  # Update an order item group info if you are related to that order.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Order Item Group Id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== First Example
+  #     data = {
+  #       name: 'New Order Item Group Name Updated'
+  #     }
+  #     @data = @mints_contact.update_order_item_group(130, data)
+  def update_order_item_group(id, data)
+    @client.raw('put', "/ecommerce/order-items-groups/#{id}", nil, data_transform(data), @contact_v1_url)
+  end
+
+  ##
+  # === Delete Order Item Group.
+  # Delete an order item group.
+  # FIXME: This method doesn't work. Throw no action error.
+  def delete_order_item_group(id)
+    @client.raw('delete', "/ecommerce/order-items-groups/#{id}", nil, nil, @contact_v1_url)
+  end
+end

data/lib/contact/ecommerce/orders.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+module Orders
+  ##
+  # === Get Orders.
+  # Get a collection of orders.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  # use_post:: (Boolean) -- Variable to determine if the request is by 'post' or 'get' functions.
+  #
+  # ==== First Example
+  #     @data = @mints_pub.get_orders
+  #
+  # ==== Second Example
+  #     options = { fields: 'title' }
+  #     @data = @mints_pub.get_orders(options)
+  #
+  # ==== Third Example
+  #     options = { fields: 'title' }
+  #     @data = @mints_pub.get_orders(options, false)
+  def get_orders(options = nil, use_post = true)
+    if use_post
+      @client.raw('post', '/ecommerce/orders/query', options, nil, @contact_v1_url)
+    else
+      @client.raw('get', '/ecommerce/orders', options, nil, @contact_v1_url)
+    end
+  end
+
+  ##
+  # === Get Order.
+  # Get an order info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Order id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @mints_pub.get_product(25)
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'title'
+  #     }
+  #     @data = @mints_pub.get_product(25, options)
+  def get_order(id, options = nil)
+    @client.raw('get', "/ecommerce/orders/#{id}", options, nil, @contact_v1_url)
+  end
+
+  ##
+  # === Create Order.
+  # Create a order with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       order_template_id: 1,
+  #       order_status_id: 1,
+  #       sales_channel_id: 1
+  #     }
+  #     @data = @mints_pub.create_order(data)
+  def create_order(data)
+    @client.raw('post', '/ecommerce/orders', nil, data_transform(data), @contact_v1_url)
+  end
+
+  ##
+  # === Update Order.
+  # Update an order info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Order Id
+  # data:: (Hash) -- Data to be submitted.
+  # FIXME: This method doesnt update an order.
+  def update_order(id, data)
+    @client.raw('put', "/ecommerce/orders/#{id}", nil, data_transform(data), @contact_v1_url)
+  end
+
+  # TODO: No tested
+  # === Detach Order Item From Order Item Group.
+  # Detach an order item from an order item group.
+  #
+  # ==== Parameters
+  # orderI_iemI_i:: (Integer) -- Order item id.
+  # group_id:: (Integer) -- Order items group id.
+  #
+  def detach_order_item_from_order_item_group(order_item_id, group_id)
+    @client.raw('put', "/ecommerce/order-items/detach/#{order_item_id}/order-items-groups/#{group_id}", nil, nil, @contact_v1_url)
+  end
+
+  #TODO: No tested
+  # === Update Order Item From Order Item Group.
+  # Update an order item data from an order item group.
+  #
+  # ==== Parameters
+  # orderI_iemI_i:: (Integer) -- Order item id.
+  # group_id:: (Integer) -- Order items group id.
+  #
+  def update_order_item_from_order_item_group(order_item_id, group_id, data)
+    url = "/ecommerce/order-items/update/#{order_item_id}/order-items-groups/#{group_id}"
+    @client.raw('put', url, nil, data_transform(data), @contact_v1_url)
+  end
+
+  ##
+  # === Get My Shopping Cart.
+  # Get a collection of items in the shopping cart.
+  #
+  # ==== Example
+  #     @data = @mints_contact.get_my_shopping_cart
+  def get_my_shopping_cart(options = nil)
+    @client.raw('get', '/ecommerce/my-shopping-cart', options, nil, @contact_v1_url)
+  end
+
+  ##
+  # === Add Item To Shopping Cart.
+  # Add an item into a shopping cart.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       quantity: 1,
+  #       sku_id: 1,
+  #       price_list_id: 1
+  #     }
+  #     @data = @mints_contact.add_item_to_shopping_cart(data)
+  def add_item_to_shopping_cart(data, options = nil)
+    @client.raw('post', '/ecommerce/shopping-cart', options, data_transform(data), @contact_v1_url)
+  end
+end

data/lib/contact/ecommerce/vouchers.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Vouchers
+  ##
+  # === Apply voucher.
+  # Apply voucher code to the existing order, only applies to sale orders.
+  #
+  # ==== Parameters
+  # order_id:: (Integer) -- Order id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = { description: 'This is the transaction description', voucher_code: 'XAZWQ12MP' }
+  #     @data = @mints_contact.apply_voucher(1, data)
+  def apply_voucher(order_id, data)
+    @client.raw('post', "/ecommerce/orders/#{order_id}/voucher", nil, data_transform(data))
+  end
+end