quake_timesheets_client 0.1.0

data/docs/ApprovalsApi.md

@@ -0,0 +1,153 @@
+# Quake::Timesheets::ApprovalsApi
+
+All URIs are relative to *https://timesheetsapi.svc.lumbry.co.uk:443*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_api_v1_approvals**](ApprovalsApi.md#get_api_v1_approvals) | **GET** /api/v1/approvals | Search for approval types matching filters |
+| [**post_api_v1_approvals**](ApprovalsApi.md#post_api_v1_approvals) | **POST** /api/v1/approvals | Create a new Approval |
+
+
+## get_api_v1_approvals
+
+> <Array<Approval>> get_api_v1_approvals(dataset_id)
+
+Search for approval types 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::ApprovalsApi.new
+dataset_id = 'dataset_id_example' # String | Filter to the approvals belonging to one of the identified datasets
+
+begin
+  # Search for approval types matching filters
+  result = api_instance.get_api_v1_approvals(dataset_id)
+  p result
+rescue Quake::Timesheets::ApiError => e
+  puts "Error when calling ApprovalsApi->get_api_v1_approvals: #{e}"
+end
+```
+
+#### Using the get_api_v1_approvals_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Approval>>, Integer, Hash)> get_api_v1_approvals_with_http_info(dataset_id)
+
+```ruby
+begin
+  # Search for approval types matching filters
+  data, status_code, headers = api_instance.get_api_v1_approvals_with_http_info(dataset_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Approval>>
+rescue Quake::Timesheets::ApiError => e
+  puts "Error when calling ApprovalsApi->get_api_v1_approvals_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dataset_id** | **String** | Filter to the approvals belonging to one of the identified datasets |  |
+
+### Return type
+
+[**Array&lt;Approval&gt;**](Approval.md)
+
+### Authorization
+
+[authToken](../README.md#authToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: */*
+
+
+## post_api_v1_approvals
+
+> <Approval> post_api_v1_approvals(state, approval_type_id, entry_ids, dataset_id)
+
+Create a new Approval
+
+### 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::ApprovalsApi.new
+state = 'requested' # String | 
+approval_type_id = 'approval_type_id_example' # String | The ID of the Approval Type of this Approval
+entry_ids = ['inner_example'] # Array<String> | The ID of the Entry this Approval is linked to
+dataset_id = 'dataset_id_example' # String | ID of the dataset this approval type is linked to
+
+begin
+  # Create a new Approval
+  result = api_instance.post_api_v1_approvals(state, approval_type_id, entry_ids, dataset_id)
+  p result
+rescue Quake::Timesheets::ApiError => e
+  puts "Error when calling ApprovalsApi->post_api_v1_approvals: #{e}"
+end
+```
+
+#### Using the post_api_v1_approvals_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Approval>, Integer, Hash)> post_api_v1_approvals_with_http_info(state, approval_type_id, entry_ids, dataset_id)
+
+```ruby
+begin
+  # Create a new Approval
+  data, status_code, headers = api_instance.post_api_v1_approvals_with_http_info(state, approval_type_id, entry_ids, dataset_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Approval>
+rescue Quake::Timesheets::ApiError => e
+  puts "Error when calling ApprovalsApi->post_api_v1_approvals_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **state** | **String** |  |  |
+| **approval_type_id** | **String** | The ID of the Approval Type of this Approval |  |
+| **entry_ids** | [**Array&lt;String&gt;**](String.md) | The ID of the Entry this Approval is linked to |  |
+| **dataset_id** | **String** | ID of the dataset this approval type is linked to |  |
+
+### Return type
+
+[**Approval**](Approval.md)
+
+### Authorization
+
+[authToken](../README.md#authToken)
+
+### HTTP request headers
+
+- **Content-Type**: application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: */*
+

data/docs/Dataset.md

@@ -0,0 +1,24 @@
+# Quake::Timesheets::Dataset
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The ID for the dataset |  |
+| **name** | **String** |  |  |
+| **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::Dataset.new(
+  id: null,
+  name: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/DatasetsApi.md

@@ -0,0 +1,214 @@
+# Quake::Timesheets::DatasetsApi
+
+All URIs are relative to *https://timesheetsapi.svc.lumbry.co.uk:443*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_api_v1_datasets**](DatasetsApi.md#get_api_v1_datasets) | **GET** /api/v1/datasets | List all available datasets |
+| [**get_api_v1_datasets_id**](DatasetsApi.md#get_api_v1_datasets_id) | **GET** /api/v1/datasets/{id} | Show details about a specific dataset |
+| [**post_api_v1_datasets**](DatasetsApi.md#post_api_v1_datasets) | **POST** /api/v1/datasets | Create a new Dataset record |
+
+
+## get_api_v1_datasets
+
+> <Array<Dataset>> get_api_v1_datasets
+
+List all available datasets
+
+### 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::DatasetsApi.new
+
+begin
+  # List all available datasets
+  result = api_instance.get_api_v1_datasets
+  p result
+rescue Quake::Timesheets::ApiError => e
+  puts "Error when calling DatasetsApi->get_api_v1_datasets: #{e}"
+end
+```
+
+#### Using the get_api_v1_datasets_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Dataset>>, Integer, Hash)> get_api_v1_datasets_with_http_info
+
+```ruby
+begin
+  # List all available datasets
+  data, status_code, headers = api_instance.get_api_v1_datasets_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Dataset>>
+rescue Quake::Timesheets::ApiError => e
+  puts "Error when calling DatasetsApi->get_api_v1_datasets_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array&lt;Dataset&gt;**](Dataset.md)
+
+### Authorization
+
+[authToken](../README.md#authToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: */*
+
+
+## get_api_v1_datasets_id
+
+> <Dataset> get_api_v1_datasets_id(id)
+
+Show details about a specific dataset
+
+### 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::DatasetsApi.new
+id = 'id_example' # String | ID of the dataset
+
+begin
+  # Show details about a specific dataset
+  result = api_instance.get_api_v1_datasets_id(id)
+  p result
+rescue Quake::Timesheets::ApiError => e
+  puts "Error when calling DatasetsApi->get_api_v1_datasets_id: #{e}"
+end
+```
+
+#### Using the get_api_v1_datasets_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Dataset>, Integer, Hash)> get_api_v1_datasets_id_with_http_info(id)
+
+```ruby
+begin
+  # Show details about a specific dataset
+  data, status_code, headers = api_instance.get_api_v1_datasets_id_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Dataset>
+rescue Quake::Timesheets::ApiError => e
+  puts "Error when calling DatasetsApi->get_api_v1_datasets_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | ID of the dataset |  |
+
+### Return type
+
+[**Dataset**](Dataset.md)
+
+### Authorization
+
+[authToken](../README.md#authToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: */*
+
+
+## post_api_v1_datasets
+
+> <Dataset> post_api_v1_datasets(name)
+
+Create a new Dataset 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::DatasetsApi.new
+name = 'name_example' # String | Name for the Dataset object
+
+begin
+  # Create a new Dataset record
+  result = api_instance.post_api_v1_datasets(name)
+  p result
+rescue Quake::Timesheets::ApiError => e
+  puts "Error when calling DatasetsApi->post_api_v1_datasets: #{e}"
+end
+```
+
+#### Using the post_api_v1_datasets_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Dataset>, Integer, Hash)> post_api_v1_datasets_with_http_info(name)
+
+```ruby
+begin
+  # Create a new Dataset record
+  data, status_code, headers = api_instance.post_api_v1_datasets_with_http_info(name)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Dataset>
+rescue Quake::Timesheets::ApiError => e
+  puts "Error when calling DatasetsApi->post_api_v1_datasets_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name for the Dataset object |  |
+
+### Return type
+
+[**Dataset**](Dataset.md)
+
+### Authorization
+
+[authToken](../README.md#authToken)
+
+### HTTP request headers
+
+- **Content-Type**: application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: */*
+

data/docs/EntriesApi.md

@@ -0,0 +1,251 @@
+# Quake::Timesheets::EntriesApi
+
+All URIs are relative to *https://timesheetsapi.svc.lumbry.co.uk:443*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_api_v1_entries**](EntriesApi.md#get_api_v1_entries) | **GET** /api/v1/entries | Search for entries matching filters |
+| [**post_api_v1_entries**](EntriesApi.md#post_api_v1_entries) | **POST** /api/v1/entries | Create a new Entry |
+| [**post_api_v1_entries_id**](EntriesApi.md#post_api_v1_entries_id) | **POST** /api/v1/entries/{id} | Update an existing Entry |
+
+
+## get_api_v1_entries
+
+> <Array<Entry>> get_api_v1_entries(opts)
+
+Search for entries 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::EntriesApi.new
+opts = {
+  dataset_id: 'dataset_id_example', # String | Filter to the entries belonging to one of the identified datasets
+  person_id: 'person_id_example', # String | Filter to the entries belonging to one of the identified people
+  from_date: 'from_date_example', # String | Return only entries after this DateTime (inclusive)
+  to_date: 'to_date_example' # String | Return only entries before this DateTime (inclusive)
+}
+
+begin
+  # Search for entries matching filters
+  result = api_instance.get_api_v1_entries(opts)
+  p result
+rescue Quake::Timesheets::ApiError => e
+  puts "Error when calling EntriesApi->get_api_v1_entries: #{e}"
+end
+```
+
+#### Using the get_api_v1_entries_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Entry>>, Integer, Hash)> get_api_v1_entries_with_http_info(opts)
+
+```ruby
+begin
+  # Search for entries matching filters
+  data, status_code, headers = api_instance.get_api_v1_entries_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Entry>>
+rescue Quake::Timesheets::ApiError => e
+  puts "Error when calling EntriesApi->get_api_v1_entries_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dataset_id** | **String** | Filter to the entries belonging to one of the identified datasets | [optional] |
+| **person_id** | **String** | Filter to the entries belonging to one of the identified people | [optional] |
+| **from_date** | **String** | Return only entries after this DateTime (inclusive) | [optional] |
+| **to_date** | **String** | Return only entries before this DateTime (inclusive) | [optional] |
+
+### Return type
+
+[**Array&lt;Entry&gt;**](Entry.md)
+
+### Authorization
+
+[authToken](../README.md#authToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: */*
+
+
+## post_api_v1_entries
+
+> <Entry> post_api_v1_entries(opts)
+
+Create a new Entry
+
+### 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::EntriesApi.new
+opts = {
+  person_id: 'person_id_example', # String | ID of the person to which this entry pertains
+  start_at: 'start_at_example', # String | Time period at which this entry starts
+  end_at: 'end_at_example', # String | Time period at which this entry ends
+  quantity: 8.14, # Float | 
+  unit: 'hour', # String | 
+  external_reference: 'external_reference_example' # String | Unique identifier of the activity this Entry relates to
+}
+
+begin
+  # Create a new Entry
+  result = api_instance.post_api_v1_entries(opts)
+  p result
+rescue Quake::Timesheets::ApiError => e
+  puts "Error when calling EntriesApi->post_api_v1_entries: #{e}"
+end
+```
+
+#### Using the post_api_v1_entries_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Entry>, Integer, Hash)> post_api_v1_entries_with_http_info(opts)
+
+```ruby
+begin
+  # Create a new Entry
+  data, status_code, headers = api_instance.post_api_v1_entries_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Entry>
+rescue Quake::Timesheets::ApiError => e
+  puts "Error when calling EntriesApi->post_api_v1_entries_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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] |
+
+### Return type
+
+[**Entry**](Entry.md)
+
+### Authorization
+
+[authToken](../README.md#authToken)
+
+### HTTP request headers
+
+- **Content-Type**: application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: */*
+
+
+## post_api_v1_entries_id
+
+> <Entry> post_api_v1_entries_id(id, opts)
+
+Update an existing Entry
+
+### 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::EntriesApi.new
+id = 'id_example' # String | The ID for the Entry
+opts = {
+  person_id: 'person_id_example', # String | ID of the person to which this entry pertains
+  start_at: 'start_at_example', # String | Time period at which this entry starts
+  end_at: 'end_at_example', # String | Time period at which this entry ends
+  quantity: 8.14, # Float | 
+  unit: 'hour', # String | 
+  external_reference: 'external_reference_example' # String | Unique identifier of the activity this Entry relates to
+}
+
+begin
+  # Update an existing Entry
+  result = api_instance.post_api_v1_entries_id(id, opts)
+  p result
+rescue Quake::Timesheets::ApiError => e
+  puts "Error when calling EntriesApi->post_api_v1_entries_id: #{e}"
+end
+```
+
+#### Using the post_api_v1_entries_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Entry>, Integer, Hash)> post_api_v1_entries_id_with_http_info(id, opts)
+
+```ruby
+begin
+  # Update an existing Entry
+  data, status_code, headers = api_instance.post_api_v1_entries_id_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Entry>
+rescue Quake::Timesheets::ApiError => e
+  puts "Error when calling EntriesApi->post_api_v1_entries_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The ID for the Entry |  |
+| **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] |
+
+### Return type
+
+[**Entry**](Entry.md)
+
+### Authorization
+
+[authToken](../README.md#authToken)
+
+### HTTP request headers
+
+- **Content-Type**: application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: */*
+