mints 0.0.16 → 0.0.20

data/lib/user/config/taxonomies.rb

@@ -0,0 +1,124 @@
+module Taxonomies
+    ##
+    # == Taxonomies
+    #
+
+    # === Sync taxonomies for object.
+    # Sync taxonomies for object.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "object_type": "contacts",
+    #       "object_id": 1
+    #     }
+    #     @data = @mints_user.sync_taxonomies_for_object(data)
+    def sync_taxonomies_for_object(data)
+        return @client.raw("put", "/config/taxonomies/sync_taxonomies_for_object", nil, data_transform(data))
+    end
+
+    # === Get taxonomies for object.
+    # Get taxonomies for object.
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== Example
+    #     options = {
+    #       "object_type": "contacts",
+    #       "object_id": 1
+    #     }
+    #     @data = @mints_user.get_taxonomies_for_object(options)
+    def get_taxonomies_for_object(options)
+        return @client.raw("get", "/config/taxonomies/get_taxonomies_for_object", options)
+    end
+    
+    # === Get taxonomies support data.
+    # Get support data used in taxonomies.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_taxonomies_support_data
+    def get_taxonomies_support_data
+        return @client.raw("get", "/config/taxonomies/support-data")
+    end
+    
+    #FIXME: Method doesnt exist in TaxonomyController.getUISupportData
+    #def get_ui_taxonomy(id)
+    #  return @client.raw("get", "/config/taxonomies/ui-taxonomies/#{id}")
+    #end
+    
+    # === Get taxonomies.
+    # Get a collection of taxonomies.
+    #
+    # ==== 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_user.get_taxonomies
+    #
+    # ==== Second Example
+    #     options = { "fields": "title" }
+    #     @data = @mints_user.get_taxonomies(options)
+    #
+    # ==== Third Example
+    #     options = { "fields": "title" }
+    #     @data = @mints_user.get_taxonomies(options, false)
+    def get_taxonomies(options = nil, use_post = true)
+        return get_query_results("/config/taxonomies", options, use_post)
+    end
+
+    # === Get taxonomy.
+    # Get a taxonomy info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Taxonomy id.
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_taxonomy(1)
+    #
+    # ==== Second Example
+    #     options = { "fields": "title" }
+    #     @data = @mints_user.get_taxonomy(1, options)
+    def get_taxonomy(id, options = nil)
+        return @client.raw("get", "/config/taxonomies/#{id}", options)
+    end
+
+    # === Create taxonomy.
+    # Create a taxonomy with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New Taxonomy",
+    #       "slug": "new-taxonomy",
+    #       "object_type": "contacts"
+    #     }
+    #     @data = @mints_user.create_taxonomy(data)
+    def create_taxonomy(data)
+        return @client.raw("post", "/config/taxonomies", nil, data_transform(data))
+    end
+    
+    # === Update taxonomy.
+    # Update a taxonomy info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Taxonomy id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New Taxomony Modified",
+    #       "slug": "new-taxonomy",
+    #       "object_type": "contacts"
+    #     }
+    #     @data = @mints_user.update_taxonomy(104, data)
+    def update_taxonomy(id, data)
+        return @client.raw("put", "/config/taxonomies/#{id}", nil, data_transform(data))
+    end
+end

data/lib/user/config/teams.rb

@@ -0,0 +1,70 @@
+module Teams
+    ##
+    # == Teams
+    #
+    
+    # === Get team types.
+    # Get a collection of team types.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_team_types
+    def get_team_types
+        return @client.raw("get", "/config/teams/team-types")
+    end
+    
+    # === Get teams.
+    # Get a collection of teams.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_teams
+    def get_teams
+        return @client.raw("get", "/config/teams")
+    end
+    
+    # === Get team.
+    # Get a team info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Team id.
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_team(1)
+    def get_team(id)
+        return @client.raw("get", "/config/teams/#{id}")
+    end
+
+    # === Create team.
+    # Create a team with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New Team",
+    #       "team_type_enum": 1
+    #     }
+    #     @data = @mints_user.create_team(data)
+    def create_team(data)
+        return @client.raw("post", "/config/teams", nil, data_transform(data))
+    end
+    
+    # === Update team.
+    # Update a team info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Team id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New Team Modified",
+    #       "team_type_enum": 1,
+    #       "members": []
+    #     }
+    #     @data = @mints_user.update_team(5, data)
+    def update_team(id, data)
+        return @client.raw("put", "/config/teams/#{id}", nil, data_transform(data))
+    end
+end

data/lib/user/config/users.rb

@@ -0,0 +1,76 @@
+module Users
+    ##
+    # == Users
+    #
+
+    ##
+    # === Can Users Coach.
+    # Determine if users can coach.
+    #
+    # ==== Example
+    #     @data = @mints_user.can_users_coach
+    def can_users_coach
+        return @client.raw("get", "/config/users/can_coach")
+    end
+
+    # === Get users.
+    # Get a collection of users.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_users
+    def get_users
+        return @client.raw("get", "/config/users")
+    end
+
+    # === Get user.
+    # Get an user info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- User id.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_user(8)
+    def get_user(id)
+        return @client.raw("get", "/config/users/#{id}")
+    end
+    
+    # === Create user.
+    # Create an user with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "name": "New User Name",
+    #       "email": "new_user_email@example.com",
+    #       "is_confirmed": false,
+    #       "set_password": true, 
+    #       "password": "123456",
+    #       "is_coach": false
+    #     }
+    #     @data = @mints_user.create_user(data)
+    def create_user(data)
+        return @client.raw("post", "/config/users", nil, data_transform(data))
+    end
+
+    # === Update user.
+    # Update an user info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- User id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "name": "New User Name Modified",
+    #       "email": "new_user_name@example.com",
+    #       "is_active": true,
+    #       "is_confirmed": false,
+    #       "roles": ""
+    #     }
+    #     @data = @mints_user.update_user(14, data)
+    def update_user(id, data)
+        return @client.raw("put", "/config/users/#{id}", nil, data_transform(data))
+    end
+end

data/lib/user/contacts/contacts.rb

@@ -0,0 +1,21 @@
+module Contacts
+    ##
+    # == Contact Auth
+    #
+    
+    # === Change password no auth.
+    # Change password to an email without auth.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "password": "12345678",
+    #       "email": "email@example.com"
+    #     }
+    #     @data = @mints_user.change_password_no_auth(data)
+    def change_password_no_auth(data)
+        return @client.raw("post", "/contacts/change-password-no-auth", nil, data_transform(data))
+    end
+end

data/lib/user/content/assets.rb

@@ -0,0 +1,98 @@
+module Assets
+    ##
+    # == Assets
+    #
+
+    def upload_asset(data)
+        return @client.raw("post", "/content/assets/upload", nil, data)
+    end
+
+    # === Get asset link info.
+    # Get information of an asset by url.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = { 
+    #       "link": "https://www.example.com/img/img.jpg"
+    #     }
+    #     @data = @mints_user.get_asset_link_info(data.to_json)
+    def get_asset_link_info(data)
+        return @client.raw("post", "/content/assets/getLinkInfo", nil, data)
+    end
+
+    # === Download asset.
+    # Get information of an asset.
+    #
+    # ==== Parameters
+    # * +id+ - [Integer] Asset id.
+    #
+    # ==== Example
+    #     @data = @mints_user.download_asset(2)
+    def download_asset(id) #FIXME: File not found at path, error in result but method works
+        return @client.raw("get", "/content/assets/download/#{id}")
+    end
+
+    def edit_asset_size(data) #TODO: Not tested
+        return @client.raw("post", "/content/assets/editSize", nil, data)
+    end
+
+    def upload_asset_variation(data) #FIXME: Call to a member function guessClientExtension() on null
+        return @client.raw("post", "/content/assets/uploadVariation", nil, data)
+    end
+
+    def create_asset_size(data) #FIXME: Trying to get property 'path' of non-object
+        return @client.raw("post", "/content/assets/createSize", nil, data)
+    end
+
+    def update_asset_variation(id, data) #TODO:
+        return @client.raw("post", "/content/assets/updateVariation/#{id}", nil, data)
+    end
+
+    def get_asset_sizes(id) #FIXME: wrong number of arguments (given 1, expected 0)
+        return @client.raw("get", "/content/assets/sizes/#{id}")
+    end
+
+    def get_original_asset(id) #FIXME: Doesn't return JSON
+        return @client.raw("get", "/content/assets/original/#{id}")
+    end
+
+    def get_asset_variation(id)
+        #FIXME: Id 1 and 4: Trying to get property 'path' of non-object
+        #FIXME: Id 2 and 3: File not found at path maybe doesnt exist
+        return @client.raw("get", "/content/assets/variation/#{id}")
+    end
+
+    def get_asset_sizes(options)
+        return @client.raw("get", "/content/assets/getSizes", options)
+    end
+
+    def get_asset_usage(options)
+        return @client.raw("get", "/content/assets/usage", options)
+    end
+
+    def delete_asset_variation #TODO: Not tested
+        return @client.raw("get", "/content/assets/deleteVariation")
+    end
+
+    def delete_asset_size #TODO: Not tested
+        return @client.raw("get", "/content/assets/deleteSize")
+    end
+
+    def get_asset_info(options)
+        return @client.raw("get", "/content/assets/getAssetInfo", options)
+    end
+
+    def generate_asset_variation(data) #FIXME: Trying to get property 'width' of non-object
+        return @client.raw("post", "/content/assets/generateAssetVariations", nil, data)
+    end
+
+    def get_asset_doc_types
+        return @client.raw("get", "/content/assets/docTypes")
+    end
+
+    def get_asset_public_route
+        return @client.raw("get", "/content/assets/publicRoute")
+    end
+end

data/lib/user/content/content.rb

@@ -0,0 +1,235 @@
+require_relative './assets.rb'
+require_relative './content_instances.rb'
+require_relative './content_templates.rb'
+require_relative './conversations.rb'
+require_relative './dam.rb'
+require_relative './forms.rb'
+require_relative './message_templates.rb'
+require_relative './messages.rb'
+require_relative './pages.rb'
+require_relative './stories.rb'
+require_relative './story_templates.rb'
+
+module Content
+    include Assets
+    include ContentInstances
+    include ContentTemplates
+    include Conversations
+    include DAM
+    include Forms
+    include MessageTemplates
+    include Messages
+    include Pages
+    include Stories
+    include StoryTemplates
+
+    # === Get public images url.
+    # Get public images url.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_public_images_url
+    def get_public_images_url
+        return @client.raw("get", "/content/public-images-url")
+    end
+
+    ##
+    # == Authors
+    #
+
+    # === Get authors.
+    # Get authors.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_authors
+    def get_authors
+        return @client.raw("get", "/content/authors")
+    end
+
+
+    # === Get author.
+    # Get an author.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Author id.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_author(1)
+    def get_author(id)
+        return @client.raw("get", "/content/authors/#{id}")
+    end
+
+    # === Create author.
+    # Create an author with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "Howard Phillips Lovecraft",
+    #       "slug": "howard-phillips-lovecraft"
+    #     }
+    #     @data = @mints_user.create_author(data.to_json)
+    def create_author(data)
+        return @client.raw("post", "/content/authors", nil, data)
+    end
+
+    # === Update author.
+    # Update an author info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Author id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     
+    def update_author(id, data)
+        #FIXME: Author controller doesnt receive data
+        return @client.raw("put", "/content/authors/#{id}", nil, data)
+    end
+
+    ##
+    # == Keywords
+    #
+
+    # === Get keywords.
+    # Get a collection of keywords.
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_keywords
+    #
+    # ==== Second Example
+    #     options = { "fields": "title" }
+    #     @data = @mints_user.get_keywords(options)
+    def get_keywords(options = nil)
+        return @client.raw("get", "/content/keywords", options)
+    end
+    
+    # === Get keyword.
+    # Get a keyword.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Keyword id.
+    #
+    def get_keyword(id)
+        return @client.raw("get", "/content/keywords/#{id}")
+    end
+
+    # === Create keyword.
+    # Create a keyword with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New Keyword"
+    #     }
+    #     @data = @mints_user.create_keyword(data.to_json)
+    def create_keyword(data)
+        return @client.raw("post", "/content/keywords", nil, data)
+    end
+
+    # === Update keyword.
+    # Update a keyword info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Keyword id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     
+    def update_keyword(id, data)
+        #FIXME: Keyword controller doesnt receive data
+        return @client.raw("put", "/content/keywords/#{id}", nil, data)
+    end
+
+    ##
+    # == Stages
+    #    
+
+    # === Get stages.
+    # Get a collection of stages.
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_stages
+    #
+    # ==== Second Example
+    #     options = { "fields": "title" }
+    #     @data = @mints_user.get_stages(options)
+    def get_stages(options = nil)
+        return @client.raw("get", "/content/stages", options)
+    end
+
+    # === Get stage.
+    # Get a stage.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Stage id.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_stage(1)
+    def get_stage(id)
+        return @client.raw("get", "/content/stages/#{id}")
+    end
+
+    # === Create stage.
+    # Create a stage with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     config_json = {
+    #       "count": 1
+    #     }
+    #     event_json = {
+    #       "rset": "DTSTART:20190214T000000Z",
+    #       "duration": 1
+    #     }
+    #     data = {
+    #       "title": "New Stage",
+    #       "description": "New Stage Description",
+    #       "config_json": config_json.to_json,
+    #       "event_json": event_json.to_json
+    #     }
+    #     @data = @mints_user.create_stage(data.to_json)
+    def create_stage(data)
+        return @client.raw("post", "/content/stages", nil, data)
+    end
+
+    # === Update stage.
+    # Update a stage info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Stage id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     config_json = {
+    #       "count": 2
+    #     }
+    #     event_json = {
+    #       "rset": "DTSTART:20190214T000000Z",
+    #       "duration": 2
+    #     }
+    #     data = {
+    #       "stageProps": { 
+    #         "title": "New Stage Modified",
+    #         "description": "New Stage Description Modified"
+    #       },
+    #       "config_json": config_json.to_json,
+    #       "event_json": event_json.to_json
+    #     }
+    #     @data = @mints_user.update_stage(3, data.to_json)
+    def update_stage(id, data)
+        #TODO: Inform StageController.update method has been modified
+        return @client.raw("put", "/content/stages/#{id}", nil, data)
+    end
+end