suggestgrid 0.1.17.pre.SNAPSHOT → 0.1.27

data/lib/suggest_grid/models/users_response.rb

@@ -6,7 +6,11 @@ module SuggestGrid
     # @return [Long]
     attr_accessor :count
 
-    # The number of users in the response.
+    # The total number of users available.
+    # @return [Long]
+    attr_accessor :total_count
+
+    # The total number of users available.
     # @return [List of Metadata]
     attr_accessor :users
 
@@ -15,14 +19,17 @@ module SuggestGrid
       if @hash.nil?
         @hash = {}
         @hash["count"] = "count"
+        @hash["total_count"] = "total_count"
         @hash["users"] = "users"
       end
       @hash
     end
 
     def initialize(count = nil,
+                   total_count = nil,
                    users = nil)
       @count = count
+      @total_count = total_count
       @users = users
     end
 
@@ -33,6 +40,7 @@ module SuggestGrid
       else
         # Extract variables from the hash
         count = hash["count"]
+        total_count = hash["total_count"]
         # Parameter is an array, so we need to iterate through it
         users = nil
         if hash["users"] != nil
@@ -42,6 +50,7 @@ module SuggestGrid
 
         # Create object from extracted values
         UsersResponse.new(count,
+                          total_count,
                           users)
       end
     end

data/lib/suggest_grid.rb

@@ -1,53 +1,53 @@
-# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
-require 'openssl'
-require 'json'
-require 'faraday'
-
-# APIMATIC Helper Files
-require_relative 'suggest_grid/api_helper.rb'
-require_relative 'suggest_grid/configuration.rb'
-require_relative 'suggest_grid/suggest_grid_client.rb'
-
-# Http
-require_relative 'suggest_grid/http/http_call_back.rb'
-require_relative 'suggest_grid/http/http_client.rb'
-require_relative 'suggest_grid/http/http_method_enum.rb'
-require_relative 'suggest_grid/http/http_request.rb'
-require_relative 'suggest_grid/http/http_response.rb'
-require_relative 'suggest_grid/http/http_context.rb'
-require_relative 'suggest_grid/http/unirest_client.rb'
-
-# Models
-require_relative 'suggest_grid/models/base_model.rb'
-require_relative 'suggest_grid/models/action.rb'
-require_relative 'suggest_grid/models/metadata.rb'
-require_relative 'suggest_grid/models/type_request_body.rb'
-require_relative 'suggest_grid/models/get_recommended_users_body.rb'
-require_relative 'suggest_grid/models/get_recommended_items_body.rb'
-require_relative 'suggest_grid/models/get_similar_users_body.rb'
-require_relative 'suggest_grid/models/get_similar_items_body.rb'
-require_relative 'suggest_grid/models/message_response.rb'
-require_relative 'suggest_grid/models/count_response.rb'
-require_relative 'suggest_grid/models/delete_error_response.rb'
-require_relative 'suggest_grid/models/delete_success_response.rb'
-require_relative 'suggest_grid/models/get_types_response.rb'
-require_relative 'suggest_grid/models/get_type_response.rb'
-require_relative 'suggest_grid/models/schema_error_response.rb'
-require_relative 'suggest_grid/models/metadata_information_response.rb'
-require_relative 'suggest_grid/models/users_response.rb'
-require_relative 'suggest_grid/models/items_response.rb'
-
-# Exceptions
-require_relative 'suggest_grid/exceptions/api_exception.rb'
-require_relative 'suggest_grid/exceptions/error_response_exception.rb'
-require_relative 'suggest_grid/exceptions/detailed_error_response_exception.rb'
-require_relative 'suggest_grid/exceptions/limit_exceeded_error_response_exception.rb'
-require_relative 'suggest_grid/exceptions/bulk_schema_error_response_exception.rb'
-
-# Controllers
-require_relative 'suggest_grid/controllers/base_controller.rb'
-require_relative 'suggest_grid/controllers/type_controller.rb'
-require_relative 'suggest_grid/controllers/action_controller.rb'
-require_relative 'suggest_grid/controllers/metadata_controller.rb'
-require_relative 'suggest_grid/controllers/recommendation_controller.rb'
-require_relative 'suggest_grid/controllers/similarity_controller.rb'
+# This file was automatically generated for SuggestGrid by APIMATIC v2.0 ( https://apimatic.io ).
+require 'json'
+require 'faraday'
+require 'certifi'
+
+require_relative 'suggest_grid/api_helper.rb'
+require_relative 'suggest_grid/suggest_grid_client.rb'
+
+# Http
+require_relative 'suggest_grid/http/http_call_back.rb'
+require_relative 'suggest_grid/http/http_client.rb'
+require_relative 'suggest_grid/http/http_method_enum.rb'
+require_relative 'suggest_grid/http/http_request.rb'
+require_relative 'suggest_grid/http/http_response.rb'
+require_relative 'suggest_grid/http/http_context.rb'
+require_relative 'suggest_grid/http/faraday_client.rb'
+require_relative 'suggest_grid/http/auth/basic_auth.rb'
+
+# Models
+require_relative 'suggest_grid/models/base_model.rb'
+require_relative 'suggest_grid/models/action.rb'
+require_relative 'suggest_grid/models/metadata.rb'
+require_relative 'suggest_grid/models/type_request_body.rb'
+require_relative 'suggest_grid/models/get_recommended_users_body.rb'
+require_relative 'suggest_grid/models/get_recommended_items_body.rb'
+require_relative 'suggest_grid/models/get_similar_users_body.rb'
+require_relative 'suggest_grid/models/get_similar_items_body.rb'
+require_relative 'suggest_grid/models/message_response.rb'
+require_relative 'suggest_grid/models/actions_response.rb'
+require_relative 'suggest_grid/models/delete_success_response.rb'
+require_relative 'suggest_grid/models/get_types_response.rb'
+require_relative 'suggest_grid/models/get_type_response.rb'
+require_relative 'suggest_grid/models/bulk_post_response.rb'
+require_relative 'suggest_grid/models/bulk_post_error.rb'
+require_relative 'suggest_grid/models/users_response.rb'
+require_relative 'suggest_grid/models/items_response.rb'
+
+# Exceptions
+require_relative 'suggest_grid/exceptions/api_exception.rb'
+require_relative 'suggest_grid/exceptions/error_response_exception.rb'
+require_relative 'suggest_grid/exceptions/detailed_error_response_exception.rb'
+require_relative 'suggest_grid/exceptions/limit_exceeded_error_response_exception.rb'
+require_relative 'suggest_grid/exceptions/delete_error_response_exception.rb'
+
+require_relative 'suggest_grid/configuration.rb'
+
+# Controllers
+require_relative 'suggest_grid/controllers/base_controller.rb'
+require_relative 'suggest_grid/controllers/type_controller.rb'
+require_relative 'suggest_grid/controllers/action_controller.rb'
+require_relative 'suggest_grid/controllers/metadata_controller.rb'
+require_relative 'suggest_grid/controllers/recommendation_controller.rb'
+require_relative 'suggest_grid/controllers/similarity_controller.rb'

data/spec/swagger.yaml

@@ -2,7 +2,7 @@ swagger: '2.0'
 
 info:
   title: SuggestGrid
-  version: 0.1.17-SNAPSHOT
+  version: 0.1.27
   description: SuggestGrid is a recommendation and personalization service.
   x-codegen-settings:
     appendContentHeaders: true
@@ -44,7 +44,7 @@ tags:
     description: Type Methods
     x-docs-text: |
       Type methods are used for managing SuggestGrid types.
-      For more information on types, refer to [Types concept documentation](http://www.suggestgrid.com/docs/concepts#types).
+      For more information on types, refer to [Types concept documentation](http://www.suggestgrid.com/docs/types).
     x-methods:
       - create_type
       - get_type
@@ -55,7 +55,7 @@ tags:
     description: Action Methods
     x-docs-text: |
       Action methods are for posting and deleting actions.
-      For more information on actions, refer to [Actions concept documentation](http://www.suggestgrid.com/docs/concepts#actions).
+      For more information on actions, refer to [Actions concept documentation](http://www.suggestgrid.com/docs/actions).
     x-methods:
       - post_action
       - post_bulk_actions
@@ -65,15 +65,17 @@ tags:
     description: Metadata Methods
     x-docs-text: |
       Metadata methods are for posting and deleting metadata.
-      For more information on metadata, refer to [Metadata concept documentation ](http://www.suggestgrid.com/docs/concepts#metadata).
+      For more information on metadata, refer to [Metadata concept documentation ](http://www.suggestgrid.com/docs/metadata).
     x-methods:
       - post_user
       - post_bulk_users
+      - get_user
       - get_users
       - delete_user
       - delete_all_users
       - post_item
       - post_bulk_items
+      - get_item
       - get_items
       - delete_item
       - delete_all_items
@@ -81,7 +83,7 @@ tags:
     description: Recommnedation Methods
     x-docs-text: |
       Recommnedation methods are for getting recommended items or users responses from SuggestGrid.
-      For more information on recommendations, refer to [Recommendations concept documentation](http://www.suggestgrid.com/docs/concepts#recommendations).
+      For more information on recommendations, refer to [Recommendations concept documentation](http://www.suggestgrid.com/docs/recommendations).
     x-methods:
       - get_recommended_users
       - get_recommended_items
@@ -89,7 +91,7 @@ tags:
     description: Similarity Methods
     x-docs-text: |
       Similarity methods are for getting similar items or users responses from SuggestGrid.
-      For more information on similars, refer to [Similarities concept documentation](http://www.suggestgrid.com/docs/concepts#similarities).
+      For more information on similars, refer to [Similarities concept documentation](http://www.suggestgrid.com/docs/similarities).
     x-methods:
       - get_similar_users
       - get_similar_items
@@ -120,8 +122,8 @@ definitions:
   Filter:
     type: object
     description: |
-      Contraints on the returned users or items. 
-      Filter structure is defined in [the filter parameter documentation](http://www.suggestgrid.com/docs/concepts#filters-parameter).
+      Contraints on the returned users or items.
+      Filter structure is defined in [the filter parameter documentation](http://www.suggestgrid.com/docs/advanced-features#filters-parameter).
     additionalProperties:
       type:
         - string
@@ -174,6 +176,9 @@ definitions:
         description: The item ids of the query. Exactly one of item id or item ids parameters must be provided.
         items:
           type: string
+      from:
+        type: integer
+        description: The number of most recommended items to be skipped.
       size:
         type: integer
         description: The number of users asked to return in the response.
@@ -215,9 +220,12 @@ definitions:
         description: The user ids of the query. Exactly one of user id or user ids parameters must be provided.
         items:
           type: string
+      from:
+        type: integer
+        description: The number of most recommended items to be skipped.
       size:
         type: integer
-        description: The number of users asked to return in the response.
+        description: The number of items asked to return in the response.
       similar_item_id:
         type: string
         description: Similar item that the response should be similar to.
@@ -230,14 +238,14 @@ definitions:
         type: array
         items:
           type: string
-        description: The metadata fields that are to be included in returned users.
+        description: The metadata fields that are to be included in returned items.
       filter:
         $ref: '#/definitions/Filter'
       except:
         type: array
         items:
           type: string
-        description: These user ids that will not be included in the response.
+        description: These item ids that will not be included in the response.
   GetSimilarUsersBody:
     type: object
     description: The query for similar users.
@@ -256,6 +264,9 @@ definitions:
         description: The user ids of the query. Exactly one of user id or user ids parameters must be provided.
         items:
           type: string
+      from:
+        type: integer
+        description: The number of most similar users to be skipped.
       size:
         type: integer
         description: The number of users asked to return in the response.
@@ -291,21 +302,24 @@ definitions:
           Get similar items to given item ids. Either item id or item ids must be provided.
         items:
           type: string
+      from:
+        type: integer
+        description: The number of most similar items to be skipped.
       size:
         type: integer
-        description: The number of users asked to return in the response.
+        description: The number of items asked to return in the response.
       fields:
         type: array
         items:
           type: string
-        description: The metadata fields that are to be included in returned users.
+        description: The metadata fields that are to be included in returned items.
       filter:
         $ref: '#/definitions/Filter'
       except:
         type: array
         items:
           type: string
-        description: These user ids that will not be included in the response.
+        description: These item ids that will not be included in the response.
   # Responses
   MessageResponse:
     type: object
@@ -314,14 +328,22 @@ definitions:
       message:
         type: string
         description: Message of the response.
-  CountResponse:
+  ActionsResponse:
     type: object
-    description: Count response.
+    description: Paged actions response.
     properties:
       count:
         type: integer
-        format: int32
-        description: The count that is asked in the query.
+        format: int64
+        description: The number of actions in the response.
+      total_count:
+        type: integer
+        format: int64
+        description: The total number of actions.
+      actions:
+        type: array
+        items:
+          $ref: '#/definitions/Action'
   ErrorResponse:
     type: object
     description: Error response.
@@ -436,11 +458,11 @@ definitions:
       rating:
         type: string
         description: Rating type of the type that is either implicit or explicit.
-  BulkSchemaErrorResponse:
+  BulkPostResponse:
     type: object
     description: |
       Bulk error response.
-      Returned on bulk post requests with failures.
+      Returned on all bulk post requests regardless of the number of erroneous or successful posts.
     properties:
       message:
         type: string
@@ -448,10 +470,10 @@ definitions:
       errors:
         type: array
         items:
-          $ref: '#/definitions/SchemaErrorResponse'
-  SchemaErrorResponse:
+          $ref: '#/definitions/BulkPostError'
+  BulkPostError:
     type: object
-    description: Error response returned due to Schema validations.
+    description: Error response returned due to bulk post schema validations.
     properties:
       message:
         type: string
@@ -462,34 +484,34 @@ definitions:
       error:
         type: object
         description: Programatic description of the error.
-  MetadataInformationResponse:
-    type: object
-    description: Metadata iformation response.
-    properties:
-      count:
-        type: integer
-        format: int64
-        description: The number of users or items with metadata.
   UsersResponse:
     type: object
-    description: Users response.
+    description: Get users response.
     properties:
       count:
         type: integer
         format: int64
         description: The number of users in the response.
+      total_count:
+        type: integer
+        format: int64
+        description: The total number of users available.
       users:
         type: array
         items:
           $ref: '#/definitions/Metadata'
   ItemsResponse:
     type: object
-    description: Items response.
+    description: Get items response.
     properties:
       count:
         type: integer
         format: int64
         description: The number of items in the response.
+      total_count:
+        type: integer
+        format: int64
+        description: The total number of items available.
       items:
         type: array
         items:
@@ -688,14 +710,8 @@ paths:
       operationId: get_actions
       summary: Get Actions
       description: |
-        Type must be provided. Additionally,
-
-        * If both `user_id` and `item_id` are supplied it returns the count of the corresponding actions.
-        * If only `user_id` is provided, it returns the count of all the action of the given user.
-        * If only `user_id` is provided, it returns the count of all the action of the given item.
-        * If only `older_than` is provided, it returns the count of actions older than the given timestamp.
-        * If a few of these parameters are provided, it returns the count of the intersection of these parameters.
-        * If none of these are provided, it returns the count of the whole type.
+        Get actions. Defaut responses will be paged by 10 actios each.
+        Type, user id, item id, or older than parameters could be provided.
       parameters:
         - name: type
           in: query
@@ -718,20 +734,34 @@ paths:
         - name: older_than
           in: query
           description: |
-            Delete all actions of a type older than the given timestamp or time.
+            Maxium timestamp of the actions.
             Valid times are 1s, 1m, 1h, 1d, 1M, 1y, or unix timestamp (like 1443798195).
           required: false
           type: string
           format: id
+        - name: size
+          in: query
+          description: |
+            The number of the users response.
+            Defaults to 10. Must be between 1 and 10.000 inclusive.
+            This parameter must be string represetation of an integer like "1".
+          required: false
+          type: integer
+          format: int32
+        - name: from
+          in: query
+          description: |
+            The number of users to be skipped for response.
+            Defaults to 0. Must be bigger than or equal to 0.
+            This parameter must be string represetation of an integer like "1".
+          required: false
+          type: integer
+          format: int32
       responses:
         200:
-          description: Successfully deleted actions.
-          schema:
-            $ref: '#/definitions/CountResponse'
-        400:
-          description: Required `user_id` or `item_id` parameters are missing from the request body.
+          description: Paged actions response.
           schema:
-            $ref: '#/definitions/ErrorResponse'
+            $ref: '#/definitions/ActionsResponse'
         429:
           description: Too many requests.
           schema:
@@ -785,15 +815,15 @@ paths:
         200:
           description: Successfully deleted actions.
           schema:
-            $ref: '#/definitions/MessageResponse'
+            $ref: '#/definitions/DeleteSuccessResponse'
         400:
           description: Required `user_id` or `item_id` parameters are missing from the request body.
           schema:
             $ref: '#/definitions/ErrorResponse'
         404:
-          description: Type does not exists.
+          description: Delete actions not found.
           schema:
-            $ref: '#/definitions/ErrorResponse'
+            $ref: '#/definitions/DeleteErrorResponse'
         422:
           description: No query parameter (`user_id`, `item_id`, or `older_than`) is given.  In order to delete all actionsdelete the type.
           schema:
@@ -835,11 +865,7 @@ paths:
         201:
           description: Bulk action request executed.
           schema:
-            $ref: '#/definitions/MessageResponse'
-        209:
-          description: Some metadata is not uploaded successfully.
-          schema:
-            $ref: '#/definitions/BulkSchemaErrorResponse'
+            $ref: '#/definitions/BulkPostResponse'
         400:
           description: Body is missing.
           schema:
@@ -858,19 +884,38 @@ paths:
             $ref: '#/definitions/ErrorResponse'
   # Metadata Paths
   /v1/users/{user_id}:
+    parameters:
+      - name: user_id
+        in: path
+        description: The user id to delete its metadata.
+        required: true
+        type: string
+        format: id
+    get:
+      tags:
+        - metadata
+      operationId: get_user
+      summary: Get An User
+      description: Returns an user metadata if it exists.
+      responses:
+        200:
+          description: Returns an user metadata.
+          schema:
+            $ref: '#/definitions/Metadata'
+        404:
+          description: User not found.
+          schema:
+            $ref: '#/definitions/ErrorResponse'
+        default:
+          description: Unexpected internal error.
+          schema:
+            $ref: '#/definitions/ErrorResponse'
     delete:
       tags:
         - metadata
       operationId: delete_user
       summary: Delete a User
       description: Deletes a user metadata with the given user id.
-      parameters:
-        - name: user_id
-          in: path
-          description: The user id to delete its metadata.
-          required: true
-          type: string
-          format: id
       responses:
         200:
           description: Deleted a user metadata.
@@ -920,12 +965,33 @@ paths:
         - metadata
       operationId: get_users
       summary: Get Users
-      description: Get information about users. Only returns count at the moment.
+      description: |
+        Get items and total count of items.
+        Page and per-page parameters could be set.
+      parameters:
+        - name: size
+          in: query
+          description: |
+            The number of the users response.
+            Defaults to 10. Must be between 1 and 10.000 inclusive.
+            This parameter must be string represetation of an integer like "1".
+          required: false
+          type: integer
+          format: int32
+        - name: from
+          in: query
+          description: |
+            The number of users to be skipped for response.
+            Defaults to 0. Must be bigger than or equal to 0.
+            This parameter must be string represetation of an integer like "1".
+          required: false
+          type: integer
+          format: int32
       responses:
         200:
-          description: Information on users.
+          description: Get users response.
           schema:
-            $ref: '#/definitions/MetadataInformationResponse'
+            $ref: '#/definitions/UsersResponse'
         429:
           description: Too many requests.
           schema:
@@ -954,19 +1020,38 @@ paths:
           schema:
             $ref: '#/definitions/ErrorResponse'
   /v1/items/{item_id}:
+    parameters:
+      - name: item_id
+        in: path
+        description: The item id to delete its metadata.
+        required: true
+        type: string
+        format: id
+    get:
+      tags:
+        - metadata
+      operationId: get_item
+      summary: Get An Item
+      description: Returns an item metadata if it exists.
+      responses:
+        200:
+          description: Returns an item metadata.
+          schema:
+            $ref: '#/definitions/Metadata'
+        404:
+          description: Item not found.
+          schema:
+            $ref: '#/definitions/ErrorResponse'
+        default:
+          description: Unexpected internal error.
+          schema:
+            $ref: '#/definitions/ErrorResponse'
     delete:
       tags:
         - metadata
       operationId: delete_item
-      summary: Delete an Item
+      summary: Delete An Item
       description: Deletes an item metadata with the given item id.
-      parameters:
-        - name: item_id
-          in: path
-          description: The item id to delete its metadata.
-          required: true
-          type: string
-          format: id
       responses:
         200:
           description: Deleted an item metadata.
@@ -1018,12 +1103,33 @@ paths:
         - metadata
       operationId: get_items
       summary: Get Items
-      description: Get information about items. Only returns count at the moment.
+      description: |
+        Get items and total count of items.
+        Page and per-page parameters could be set.
+      parameters:
+        - name: size
+          in: query
+          description: |
+            The number of the users response.
+            Defaults to 10. Must be between 1 and 10.000 inclusive.
+            This parameter must be string represetation of an integer like "1".
+          required: false
+          type: integer
+          format: int32
+        - name: from
+          in: query
+          description: |
+            The number of users to be skipped for response.
+            Defaults to 0. Must be bigger than or equal to 0.
+            This parameter must be string represetation of an integer like "1".
+          required: false
+          type: integer
+          format: int32
       responses:
         200:
-          description: Information on items.
+          description: Get items response.
           schema:
-            $ref: '#/definitions/MetadataInformationResponse'
+            $ref: '#/definitions/ItemsResponse'
         429:
           description: Too many requests.
           schema:
@@ -1079,11 +1185,7 @@ paths:
         201:
           description: Bulk user metadata request executed.
           schema:
-            $ref: '#/definitions/MessageResponse'
-        209:
-          description: Some metadata is not uploaded successfully.
-          schema:
-            $ref: '#/definitions/BulkSchemaErrorResponse'
+            $ref: '#/definitions/BulkPostResponse'
         400:
           description: Body is missing.
           schema:
@@ -1122,11 +1224,7 @@ paths:
         201:
           description: Bulk item metadata request executed.
           schema:
-            $ref: '#/definitions/MessageResponse'
-        209:
-          description: Some metadata is not uploaded successfully.
-          schema:
-            $ref: '#/definitions/BulkSchemaErrorResponse'
+            $ref: '#/definitions/BulkPostResponse'
         400:
           description: Body is missing.
           schema: