mints 0.0.17 → 0.0.21

data/lib/user/config/api_keys.rb

@@ -0,0 +1,65 @@
+module ApiKeys
+    ##
+    # == Api keys
+    #
+    
+    # === Get api keys.
+    # Get a collection of api keys.
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_api_keys
+    #
+    # ==== Second Example
+    #     options = { "fields": "id" }
+    #     @data = @mints_user.get_api_keys(options)
+    def get_api_keys(options = nil)
+        return @client.raw("get", "/config/api-keys", options)
+    end
+
+    # === Get api key.
+    # Get an api key info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Api key id.
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_api_key(2)
+    #
+    # ==== Second Example
+    #     options = { "fields": "id" }
+    #     @data = @mints_user.get_api_key(2, options)
+    def get_api_key(id, options = nil)
+        return @client.raw("get", "/config/api-keys/#{id}", options)
+    end
+
+    # === Create api key.
+    # Create an api key with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "description": "New Api Key Description"
+    #     }
+    #     @data = @mints_user.create_api_key(data)
+    def create_api_key(data)
+        return @client.raw("post", "/config/api-keys", nil, data_transform(data))
+    end
+
+    # === Delete api key.
+    # Delete an api key.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Api key id.
+    #
+    # ==== Example
+    #     @data = @mints_user.delete_api_key(2)
+    def delete_api_key(id)
+        return @client.raw("delete", "/config/api-keys/#{id}")
+    end
+end

data/lib/user/config/appointments.rb

@@ -0,0 +1,221 @@
+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_user.get_appointments
+    #
+    # ==== Second Example
+    #     options = {
+    #       "fields": "id"
+    #     }
+    #     @data = @mints_user.get_appointments(options)
+    def get_appointments(options = nil)
+        return @client.raw("get", "/config/appointments", options)
+    end
+    
+    # === Get appointment.
+    # Get an appointment info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Appointment id.
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_appointment(1)
+    #
+    # ==== Second Example
+    #     options = {
+    #       "fields": "id"
+    #     }
+    #     @data = @mints_user.get_appointment(1, options)
+    def get_appointment(id, options = nil)
+        return @client.raw("get", "/config/appointments/#{id}", options)
+    end
+    
+    # === Create appointment.
+    # Create an appointment with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "object_type": "contacts",
+    #       "object_id": 1,
+    #       "title": "New Appointment",
+    #       "start": "2021-09-06T20:29:16+00:00",
+    #       "end": "2022-09-06T20:29:16+00:00",
+    #       "attendee_id": 1
+    #     }
+    #     @data = @mints_user.create_appointment(data)
+    def create_appointment(data)
+        return @client.raw("post", "/config/appointments", nil, data_transform(data))
+    end
+
+    # === Update appointment.
+    # Update an appointment info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Appointment id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "object_id": 2
+    #     }
+    #     @data = @mints_user.update_appointment(1, data)
+    def update_appointment(id, data)
+        return @client.raw("put", "/config/appointments/#{id}", nil, data_transform(data))
+    end
+    
+    # === Delete appointment.
+    # Delete an appointment.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Appointment id.
+    #
+    # ==== Example
+    #     @data = @mints_user.delete_appointment(1)
+    def delete_appointment(id)
+        return @client.raw("delete", "/config/appointments/#{id}")
+    end
+
+    # === Scheduled appointments.
+    # Schedule an appointment.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "object_type": "contacts",
+    #       "object_id": 1,
+    #       "start": "2021-09-06T20:29:16+00:00",
+    #       "end": "2022-09-06T20:29:16+00:00"
+    #     }
+    #     @data = @mints_user.scheduled_appointments(data)
+    def scheduled_appointments(data)
+        return @client.raw("post", "/config/appointments/scheduled-appointments", nil, data_transform(data))
+    end
+    
+    # === Reschedule appointment.
+    # Reschedule an appointment.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "appointment_id": 2,
+    #       "start": "2021-09-06T20:29:16+00:00",
+    #       "end": "2022-09-06T20:29:16+00:00"
+    #     }
+    #     @data = @mints_user.reschedule_appointment(data)
+    def reschedule_appointment(data)
+        return @client.raw("post", "/config/appointments/reschedule-appointment", nil, data_transform(data))
+    end
+    
+    # === Attach invitee.
+    # Attach invitee.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "appointment_id": 2,
+    #       "invitee_ids": [ 2 ]
+    #     }
+    #     @data = @mints_user.attach_invitee(data)
+    def attach_invitee(data)
+        return @client.raw("post", "/config/appointments/attach-invitee", nil, data_transform(data))
+    end
+
+    # === Attach follower.
+    # Attach follower.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "appointment_id": 2,
+    #       "follower_ids": [ 2 ]
+    #     }
+    #     @data = @mints_user.attach_follower(data)
+    def attach_follower(data)
+        return @client.raw("post", "/config/appointments/attach-follower", nil, data_transform(data))
+    end
+    
+    # === Detach invitee.
+    # Detach invitee.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "appointment_id": 2,
+    #       "invitee_ids": [ 2 ]
+    #     }
+    #     @data = @mints_user.detach_invitee(data)
+    def detach_invitee(data)
+        return @client.raw("post", "/config/appointments/detach-invitee", nil, data_transform(data))
+    end
+
+    # === Detach follower.
+    # Detach follower.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "appointment_id": 2,
+    #       "follower_ids": [ 2 ]
+    #     }
+    #     @data = @mints_user.detach_follower(data)
+    def detach_follower(data)
+        return @client.raw("post", "/config/appointments/detach-follower", nil, data_transform(data))
+    end
+    
+    # === Sync invitee.
+    # Sync invitee.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "appointment_id": 2,
+    #       "invitee_ids": [ 2 ]
+    #     }
+    #     @data = @mints_user.sync_invitee(data)
+    def sync_invitee(data)
+        return @client.raw("post", "/config/appointments/sync-invitee", nil, data_transform(data))
+    end
+    
+    # === Sync follower.
+    # Sync follower.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "appointment_id": 2,
+    #       "follower_ids": [ 2 ]
+    #     }
+    #     @data = @mints_user.sync_follower(data)
+    def sync_follower(data)
+        return @client.raw("post", "/config/appointments/sync-follower", nil, data_transform(data))
+    end
+end

data/lib/user/config/attribute_groups.rb

@@ -0,0 +1,77 @@
+module AttributeGroups
+    ##
+    # == Attribute Groups
+    #
+
+    # === Get attribute groups data types.
+    # Get data types used in attribute groups.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_attribute_groups_data_types
+    def get_attribute_groups_data_types
+        return @client.raw("get", "/config/attribute-groups/object-types")
+    end
+
+    # === Get attribute groups.
+    # Get a collection of attribute groups.
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_attribute_groups
+    #
+    # ==== Second Example
+    #     options = { "sort": "id" }
+    #     @data = @mints_user.get_attribute_groups(options)
+    def get_attribute_groups(options = nil)
+        return @client.raw("get", "/config/attribute-groups", options)
+    end
+    
+    # === Get attribute group.
+    # Get an attribute group info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Attribute group id.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_attribute_group(10)
+    def get_attribute_group(id)
+        return @client.raw("get", "/config/attribute-groups/#{id}")
+    end
+
+    # === Create attribute group.
+    # Create an attribute group with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New Attribute Group",
+    #       "object_type": "contacts"
+    #     }
+    #     @data = @mints_user.create_attribute_group(data)
+    def create_attribute_group(data)
+        return @client.raw("post", "/config/attribute-groups", nil, data_transform(data))
+    end
+
+    # === Update attribute group.
+    # Update an attribute group info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Attribute group id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New Attribute Group Modified",
+    #       "object_type": "contacts",
+    #       "slug": "new-attribute-group",
+    #       "description": "New description"
+    #     }
+    #     @data = @mints_user.update_attribute_group(36, data)
+    def update_attribute_group(id, data)
+        return @client.raw("put", "/config/attribute-groups/#{id}", nil, data_transform(data))
+    end
+end

data/lib/user/config/attributes.rb

@@ -0,0 +1,86 @@
+module Attributes
+    ##
+    # == Attributes
+    #
+
+    # === Get attributes data types.
+    # Get data types used in attributes.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_attributes_data_types
+    def get_attributes_data_types
+        return @client.raw("get", "/config/attributes/data-types")
+    end
+
+    # === Get sub attributes.
+    # Get sub attributes with a slug.
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== Example
+    #     
+    def get_sub_attributes(options) #TODO: Test, this method has been added recently
+        return @client.raw("get", "/config/attributes/sub-attributes", options)
+    end
+    
+    # === Get attributes.
+    # Get a collection of attributes.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_attributes
+    def get_attributes
+        return @client.raw("get", "/config/attributes")
+    end
+    
+    # === Get attribute.
+    # Get an attribute info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Attribute id.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_attribute(1)
+    def get_attribute(id)
+        return @client.raw("get", "/config/attributes/#{id}")
+    end
+
+    # === Create attribute.
+    # Create an attribute with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New Attribute",
+    #       "object_type": "orders",
+    #       "slug": "new_attribute",
+    #       "attribute_group_id": 1,
+    #       "data_type_enum": 10
+    #     }
+    #     @data = @mints_user.create_attribute(data)
+    def create_attribute(data)
+        return @client.raw("post", "/config/attributes", nil, data_transform(data))
+    end
+
+    # === Update attribute.
+    # Update an attribute info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Attribute id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New Attribute Modified",
+    #       "object_type": "orders",
+    #       "slug": "new_attribute",
+    #       "attribute_group_id": 1,
+    #       "data_type_enum": 10
+    #     }
+    #     @data = @mints_user.update_attribute(292, data)
+    def update_attribute(id, data)
+        return @client.raw("put", "/config/attributes/#{id}", nil, data_transform(data))
+    end
+end

data/lib/user/config/calendars.rb

@@ -0,0 +1,89 @@
+module Calendars
+    ##
+    # == Calendars
+    #
+
+    # === Get calendars.
+    # Get a collection of calendars.
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_calendars
+    #
+    # ==== Second Example
+    #     options = {
+    #       "fields": "title"
+    #     }
+    #     @data = @mints_user.get_calendars(options)
+    def get_calendars(options = nil)
+        return @client.raw("get", "/config/calendars", options)
+    end
+    
+    # === Get calendar.
+    # Get a calendar info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Calendar id.
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_calendar(1)
+    #
+    # ==== Second Example
+    #     options = {
+    #       "fields": "title"
+    #     }
+    #     @data = @mints_user.get_calendar(1, options)
+    def get_calendar(id, options = nil)
+        return @client.raw("get", "/config/calendars/#{id}", options)
+    end
+    
+    # === Create calendar.
+    # Create a calendar with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = { 
+    #       "title": "New Calendar",
+    #       "object_type": "contacts",
+    #       "object_id": 1
+    #     }
+    #     @data = @mints_user.create_calendar(data)
+    def create_calendar(data)
+        return @client.raw("post", "/config/calendars", nil, data_transform(data))
+    end
+
+    # === Update calendar.
+    # Update a calendar info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Calendar id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = { 
+    #       "title": "New Calendar Modified",
+    #       "object_type": "contacts",
+    #       "object_id": 1
+    #     }
+    #     @data = @mints_user.update_calendar(4, data)
+    def update_calendar(id, data)
+        return @client.raw("put", "/config/calendars/#{id}", nil, data_transform(data))
+    end
+    
+    # === Delete calendar.
+    # Delete a calendar.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Calendar id.
+    #
+    # ==== Example
+    #     @data = @mints_user.delete_calendar(4)
+    def delete_calendar(id)
+        return @client.raw("delete", "/config/calendars/#{id}")
+    end
+end

data/lib/user/config/config.rb

@@ -0,0 +1,65 @@
+require_relative './api_keys.rb'
+require_relative './appointments.rb'
+require_relative './attribute_groups.rb'
+require_relative './attributes.rb'
+require_relative './calendars.rb'
+require_relative './importers.rb'
+require_relative './public_folders.rb'
+require_relative './relationships.rb'
+require_relative './roles.rb'
+require_relative './seeds.rb'
+require_relative './system_settings.rb'
+require_relative './tags.rb'
+require_relative './taxonomies.rb'
+require_relative './teams.rb'
+require_relative './users.rb'
+
+module Config
+    include ApiKeys
+    include Appointments
+    include AttributeGroups
+    include Attributes
+    include Calendars
+    include Importers
+    include PublicFolders
+    include Relationships
+    include Roles
+    include Seeds
+    include SystemSettings
+    include Tags
+    include Taxonomies
+    include Teams
+    include Users
+
+    ##
+    # == Categories
+    #
+
+    # def sync_categories_for_object(data)
+    #  return @client.raw("put", "/config/categories/sync_categories_for_object", nil, data)
+    #end
+
+    # def get_categories_for_object(options)
+    #  return @client.raw("get", "/config/categories/get_categories_for_object", options)
+    #end
+    
+    # def get_categories
+    #  return @client.raw("get", "/config/categories")
+    #end
+
+    # def create_category(data) #TODO: Research if 'visible' is a boolean or int. It accepts smallint
+    #  return @client.raw("post", "/config/categories", nil, data)
+    #end
+
+    # def update_category(id, data)
+    #  return @client.raw("put", "/config/categories/#{id}", nil, data)
+    #end
+
+    # def get_category_support_data(id)
+    #  return @client.raw("get", "/config/categories/support-data/#{id}")
+    #end
+    
+    # def get_category(id)
+    #  return @client.raw("get", "/config/categories/#{id}")
+    #end
+end