quake_timesheets_client 0.1.0

data/docs/Entry.md

@@ -0,0 +1,36 @@
+# Quake::Timesheets::Entry
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The ID for the entry |  |
+| **dataset_id** | **String** | ID of the dataset to which this entry is linked |  |
+| **person_id** | **String** | ID of the person to which this entry pertains | [optional] |
+| **start_at** | **String** | Time period at which this entry starts | [optional] |
+| **end_at** | **String** | Time period at which this entry ends | [optional] |
+| **quantity** | **Float** |  | [optional] |
+| **unit** | **String** |  | [optional] |
+| **external_reference** | **String** | Unique identifier of the activity this Entry relates to | [optional] |
+| **created_at** | **String** | Time at which the record was created |  |
+| **updated_at** | **String** | Time at which the record was updated |  |
+
+## Example
+
+```ruby
+require 'quake_timesheets_client'
+
+instance = Quake::Timesheets::Entry.new(
+  id: null,
+  dataset_id: null,
+  person_id: null,
+  start_at: null,
+  end_at: null,
+  quantity: null,
+  unit: null,
+  external_reference: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/PeopleApi.md

@@ -0,0 +1,151 @@
+# Quake::Timesheets::PeopleApi
+
+All URIs are relative to *https://timesheetsapi.svc.lumbry.co.uk:443*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_api_v1_people**](PeopleApi.md#get_api_v1_people) | **GET** /api/v1/people | Search for people matching filters |
+| [**post_api_v1_people**](PeopleApi.md#post_api_v1_people) | **POST** /api/v1/people | Create a new Person record |
+
+
+## get_api_v1_people
+
+> <Array<Person>> get_api_v1_people(opts)
+
+Search for people matching filters
+
+### Examples
+
+```ruby
+require 'time'
+require 'quake_timesheets_client'
+# setup authorization
+Quake::Timesheets.configure do |config|
+  # Configure API key authorization: authToken
+  config.api_key['authToken'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['authToken'] = 'Bearer'
+end
+
+api_instance = Quake::Timesheets::PeopleApi.new
+opts = {
+  dataset_id: 'dataset_id_example' # String | Filter to the people belonging to one of the identified datasets
+}
+
+begin
+  # Search for people matching filters
+  result = api_instance.get_api_v1_people(opts)
+  p result
+rescue Quake::Timesheets::ApiError => e
+  puts "Error when calling PeopleApi->get_api_v1_people: #{e}"
+end
+```
+
+#### Using the get_api_v1_people_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Person>>, Integer, Hash)> get_api_v1_people_with_http_info(opts)
+
+```ruby
+begin
+  # Search for people matching filters
+  data, status_code, headers = api_instance.get_api_v1_people_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Person>>
+rescue Quake::Timesheets::ApiError => e
+  puts "Error when calling PeopleApi->get_api_v1_people_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dataset_id** | **String** | Filter to the people belonging to one of the identified datasets | [optional] |
+
+### Return type
+
+[**Array&lt;Person&gt;**](Person.md)
+
+### Authorization
+
+[authToken](../README.md#authToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: */*
+
+
+## post_api_v1_people
+
+> <Person> post_api_v1_people(name, dataset_id)
+
+Create a new Person record
+
+### Examples
+
+```ruby
+require 'time'
+require 'quake_timesheets_client'
+# setup authorization
+Quake::Timesheets.configure do |config|
+  # Configure API key authorization: authToken
+  config.api_key['authToken'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['authToken'] = 'Bearer'
+end
+
+api_instance = Quake::Timesheets::PeopleApi.new
+name = 'name_example' # String | Human readable name for the Person object (usually the subject's real name)
+dataset_id = 'dataset_id_example' # String | Dataset to which the Person object should belong
+
+begin
+  # Create a new Person record
+  result = api_instance.post_api_v1_people(name, dataset_id)
+  p result
+rescue Quake::Timesheets::ApiError => e
+  puts "Error when calling PeopleApi->post_api_v1_people: #{e}"
+end
+```
+
+#### Using the post_api_v1_people_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Person>, Integer, Hash)> post_api_v1_people_with_http_info(name, dataset_id)
+
+```ruby
+begin
+  # Create a new Person record
+  data, status_code, headers = api_instance.post_api_v1_people_with_http_info(name, dataset_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Person>
+rescue Quake::Timesheets::ApiError => e
+  puts "Error when calling PeopleApi->post_api_v1_people_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Human readable name for the Person object (usually the subject&#39;s real name) |  |
+| **dataset_id** | **String** | Dataset to which the Person object should belong |  |
+
+### Return type
+
+[**Person**](Person.md)
+
+### Authorization
+
+[authToken](../README.md#authToken)
+
+### HTTP request headers
+
+- **Content-Type**: application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: */*
+

data/docs/Person.md

@@ -0,0 +1,22 @@
+# Quake::Timesheets::Person
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The ID of the person |  |
+| **dataset_id** | **String** | ID of the dataset this person is linked to |  |
+| **name** | **String** | The name of the person |  |
+
+## Example
+
+```ruby
+require 'quake_timesheets_client'
+
+instance = Quake::Timesheets::Person.new(
+  id: null,
+  dataset_id: null,
+  name: null
+)
+```
+

data/git_push.sh

@@ -0,0 +1,58 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-pestore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="quake-saas"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="timesheets-client-ruby"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

data/lib/quake_timesheets_client.rb

@@ -0,0 +1,58 @@
+=begin
+#TimesheetsApi (params in:formData)
+
+# <p>Another API description</p> 
+
+The version of the OpenAPI document: 1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.0
+
+=end
+
+# Pre-define base modules
+'Quake::Timesheets'.split('::').reduce(Object) do |previous, mod|
+  if previous.const_defined?(mod.to_sym)
+    previous.const_get(mod.to_sym)
+  else
+    previous.const_set(mod.to_sym, Module.new)
+  end
+end
+
+# Common files
+require 'quake_timesheets_client/api_client'
+require 'quake_timesheets_client/api_error'
+require 'quake_timesheets_client/version'
+require 'quake_timesheets_client/configuration'
+
+# Models
+require 'quake_timesheets_client/models/approval'
+require 'quake_timesheets_client/models/approval_type'
+require 'quake_timesheets_client/models/dataset'
+require 'quake_timesheets_client/models/entry'
+require 'quake_timesheets_client/models/person'
+
+# APIs
+require 'quake_timesheets_client/api/approval_types_api'
+require 'quake_timesheets_client/api/approvals_api'
+require 'quake_timesheets_client/api/datasets_api'
+require 'quake_timesheets_client/api/entries_api'
+require 'quake_timesheets_client/api/people_api'
+
+module Quake::Timesheets
+  class << self
+    # Customize default settings for the SDK using block.
+    #   Quake::Timesheets.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/lib/quake_timesheets_client/api/approval_types_api.rb

@@ -0,0 +1,158 @@
+=begin
+#TimesheetsApi (params in:formData)
+
+# <p>Another API description</p> 
+
+The version of the OpenAPI document: 1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.0
+
+=end
+
+require 'cgi'
+
+module Quake::Timesheets
+  class ApprovalTypesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Search for approval types matching filters
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :dataset_id Filter to the approval types belonging to one of the identified datasets
+    # @return [Array<ApprovalType>]
+    def get_api_v1_approval_types(opts = {})
+      data, _status_code, _headers = get_api_v1_approval_types_with_http_info(opts)
+      data
+    end
+
+    # Search for approval types matching filters
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :dataset_id Filter to the approval types belonging to one of the identified datasets
+    # @return [Array<(Array<ApprovalType>, Integer, Hash)>] Array<ApprovalType> data, response status code and response headers
+    def get_api_v1_approval_types_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApprovalTypesApi.get_api_v1_approval_types ...'
+      end
+      # resource path
+      local_var_path = '/api/v1/approval_types'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'dataset_id'] = opts[:'dataset_id'] if !opts[:'dataset_id'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['*/*'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<ApprovalType>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['authToken']
+
+      new_options = opts.merge(
+        :operation => :"ApprovalTypesApi.get_api_v1_approval_types",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ApprovalTypesApi#get_api_v1_approval_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create a new Approval Type
+    # @param weight [Float] The weight provided by approvals of this type
+    # @param name [String] The name of the approval type
+    # @param dataset_id [String] ID of the dataset this approval type is linked to
+    # @param [Hash] opts the optional parameters
+    # @return [ApprovalType]
+    def post_api_v1_approval_types(weight, name, dataset_id, opts = {})
+      data, _status_code, _headers = post_api_v1_approval_types_with_http_info(weight, name, dataset_id, opts)
+      data
+    end
+
+    # Create a new Approval Type
+    # @param weight [Float] The weight provided by approvals of this type
+    # @param name [String] The name of the approval type
+    # @param dataset_id [String] ID of the dataset this approval type is linked to
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApprovalType, Integer, Hash)>] ApprovalType data, response status code and response headers
+    def post_api_v1_approval_types_with_http_info(weight, name, dataset_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApprovalTypesApi.post_api_v1_approval_types ...'
+      end
+      # verify the required parameter 'weight' is set
+      if @api_client.config.client_side_validation && weight.nil?
+        fail ArgumentError, "Missing the required parameter 'weight' when calling ApprovalTypesApi.post_api_v1_approval_types"
+      end
+      # verify the required parameter 'name' is set
+      if @api_client.config.client_side_validation && name.nil?
+        fail ArgumentError, "Missing the required parameter 'name' when calling ApprovalTypesApi.post_api_v1_approval_types"
+      end
+      # verify the required parameter 'dataset_id' is set
+      if @api_client.config.client_side_validation && dataset_id.nil?
+        fail ArgumentError, "Missing the required parameter 'dataset_id' when calling ApprovalTypesApi.post_api_v1_approval_types"
+      end
+      # resource path
+      local_var_path = '/api/v1/approval_types'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['*/*'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded', 'multipart/form-data'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['weight'] = weight
+      form_params['name'] = name
+      form_params['dataset_id'] = dataset_id
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ApprovalType'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['authToken']
+
+      new_options = opts.merge(
+        :operation => :"ApprovalTypesApi.post_api_v1_approval_types",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ApprovalTypesApi#post_api_v1_approval_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end