quake_timesheets_client 0.1.0 → 0.1.1

data/docs/CreateApprovalTypesInput.md

@@ -0,0 +1,22 @@
+# Quake::Timesheets::CreateApprovalTypesInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dataset_id** | **String** | ID of the dataset this approval type is linked to |  |
+| **name** | **String** | The name of the approval type |  |
+| **weight** | **Float** | The weight provided by approvals of this type |  |
+
+## Example
+
+```ruby
+require 'quake_timesheets_client'
+
+instance = Quake::Timesheets::CreateApprovalTypesInput.new(
+  dataset_id: null,
+  name: null,
+  weight: null
+)
+```
+

data/docs/CreateApprovalsInput.md

@@ -0,0 +1,24 @@
+# Quake::Timesheets::CreateApprovalsInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dataset_id** | **String** | ID of the dataset this approval type is linked to |  |
+| **entry_ids** | **Array<String>** | The ID of the Entry this Approval is linked to |  |
+| **approval_type_id** | **String** | The ID of the Approval Type of this Approval |  |
+| **state** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'quake_timesheets_client'
+
+instance = Quake::Timesheets::CreateApprovalsInput.new(
+  dataset_id: null,
+  entry_ids: null,
+  approval_type_id: null,
+  state: null
+)
+```
+

data/docs/CreateDatasetsInput.md

@@ -0,0 +1,18 @@
+# Quake::Timesheets::CreateDatasetsInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name for the Dataset object |  |
+
+## Example
+
+```ruby
+require 'quake_timesheets_client'
+
+instance = Quake::Timesheets::CreateDatasetsInput.new(
+  name: null
+)
+```
+

data/docs/CreateEntriesInput.md

@@ -0,0 +1,28 @@
+# Quake::Timesheets::CreateEntriesInput
+
+## Properties
+
+| 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] |
+
+## Example
+
+```ruby
+require 'quake_timesheets_client'
+
+instance = Quake::Timesheets::CreateEntriesInput.new(
+  person_id: null,
+  start_at: null,
+  end_at: null,
+  quantity: null,
+  unit: null,
+  external_reference: null
+)
+```
+

data/docs/CreatePeopleInput.md

@@ -0,0 +1,20 @@
+# Quake::Timesheets::CreatePeopleInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dataset_id** | **String** | Dataset to which the Person object should belong |  |
+| **name** | **String** | Human readable name for the Person object (usually the subject's real name) |  |
+
+## Example
+
+```ruby
+require 'quake_timesheets_client'
+
+instance = Quake::Timesheets::CreatePeopleInput.new(
+  dataset_id: null,
+  name: null
+)
+```
+

data/docs/DatasetsApi.md

@@ -4,16 +4,16 @@ 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 |
+| [**create_datasets**](DatasetsApi.md#create_datasets) | **POST** /api/v1/datasets | Create a new Dataset record |
+| [**index_datasets**](DatasetsApi.md#index_datasets) | **GET** /api/v1/datasets | List all available datasets |
+| [**show_datasets**](DatasetsApi.md#show_datasets) | **GET** /api/v1/datasets/{id} | Show details about a specific dataset |
 
 
-## get_api_v1_datasets
+## create_datasets
 
-> <Array<Dataset>> get_api_v1_datasets
+> <Dataset> create_datasets(opts)
 
-List all available datasets
+Create a new Dataset record
 
 ### Examples
 
@@ -29,41 +29,46 @@ Quake::Timesheets.configure do |config|
 end
 
 api_instance = Quake::Timesheets::DatasetsApi.new
+opts = {
+  create_datasets_input: Quake::Timesheets::CreateDatasetsInput.new({name: 'name_example'}) # CreateDatasetsInput | 
+}
 
 begin
-  # List all available datasets
-  result = api_instance.get_api_v1_datasets
+  # Create a new Dataset record
+  result = api_instance.create_datasets(opts)
   p result
 rescue Quake::Timesheets::ApiError => e
-  puts "Error when calling DatasetsApi->get_api_v1_datasets: #{e}"
+  puts "Error when calling DatasetsApi->create_datasets: #{e}"
 end
 ```
 
-#### Using the get_api_v1_datasets_with_http_info variant
+#### Using the create_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
+> <Array(<Dataset>, Integer, Hash)> create_datasets_with_http_info(opts)
 
 ```ruby
 begin
-  # List all available datasets
-  data, status_code, headers = api_instance.get_api_v1_datasets_with_http_info
+  # Create a new Dataset record
+  data, status_code, headers = api_instance.create_datasets_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <Array<Dataset>>
+  p data # => <Dataset>
 rescue Quake::Timesheets::ApiError => e
-  puts "Error when calling DatasetsApi->get_api_v1_datasets_with_http_info: #{e}"
+  puts "Error when calling DatasetsApi->create_datasets_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-This endpoint does not need any parameter.
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_datasets_input** | [**CreateDatasetsInput**](CreateDatasetsInput.md) |  | [optional] |
 
 ### Return type
 
-[**Array&lt;Dataset&gt;**](Dataset.md)
+[**Dataset**](Dataset.md)
 
 ### Authorization
 
@@ -71,15 +76,15 @@ This endpoint does not need any parameter.
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
+- **Content-Type**: application/json
 - **Accept**: */*
 
 
-## get_api_v1_datasets_id
+## index_datasets
 
-> <Dataset> get_api_v1_datasets_id(id)
+> <Array<Dataset>> index_datasets
 
-Show details about a specific dataset
+List all available datasets
 
 ### Examples
 
@@ -95,44 +100,41 @@ Quake::Timesheets.configure do |config|
 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)
+  # List all available datasets
+  result = api_instance.index_datasets
   p result
 rescue Quake::Timesheets::ApiError => e
-  puts "Error when calling DatasetsApi->get_api_v1_datasets_id: #{e}"
+  puts "Error when calling DatasetsApi->index_datasets: #{e}"
 end
 ```
 
-#### Using the get_api_v1_datasets_id_with_http_info variant
+#### Using the index_datasets_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)
+> <Array(<Array<Dataset>>, Integer, Hash)> index_datasets_with_http_info
 
 ```ruby
 begin
-  # Show details about a specific dataset
-  data, status_code, headers = api_instance.get_api_v1_datasets_id_with_http_info(id)
+  # List all available datasets
+  data, status_code, headers = api_instance.index_datasets_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <Dataset>
+  p data # => <Array<Dataset>>
 rescue Quake::Timesheets::ApiError => e
-  puts "Error when calling DatasetsApi->get_api_v1_datasets_id_with_http_info: #{e}"
+  puts "Error when calling DatasetsApi->index_datasets_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** | ID of the dataset |  |
+This endpoint does not need any parameter.
 
 ### Return type
 
-[**Dataset**](Dataset.md)
+[**Array&lt;Dataset&gt;**](Dataset.md)
 
 ### Authorization
 
@@ -144,11 +146,11 @@ end
 - **Accept**: */*
 
 
-## post_api_v1_datasets
+## show_datasets
 
-> <Dataset> post_api_v1_datasets(name)
+> <Dataset> show_datasets(id)
 
-Create a new Dataset record
+Show details about a specific dataset
 
 ### Examples
 
@@ -164,32 +166,32 @@ Quake::Timesheets.configure do |config|
 end
 
 api_instance = Quake::Timesheets::DatasetsApi.new
-name = 'name_example' # String | Name for the Dataset object
+id = 'id_example' # String | ID of the dataset
 
 begin
-  # Create a new Dataset record
-  result = api_instance.post_api_v1_datasets(name)
+  # Show details about a specific dataset
+  result = api_instance.show_datasets(id)
   p result
 rescue Quake::Timesheets::ApiError => e
-  puts "Error when calling DatasetsApi->post_api_v1_datasets: #{e}"
+  puts "Error when calling DatasetsApi->show_datasets: #{e}"
 end
 ```
 
-#### Using the post_api_v1_datasets_with_http_info variant
+#### Using the show_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)
+> <Array(<Dataset>, Integer, Hash)> show_datasets_with_http_info(id)
 
 ```ruby
 begin
-  # Create a new Dataset record
-  data, status_code, headers = api_instance.post_api_v1_datasets_with_http_info(name)
+  # Show details about a specific dataset
+  data, status_code, headers = api_instance.show_datasets_with_http_info(id)
   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}"
+  puts "Error when calling DatasetsApi->show_datasets_with_http_info: #{e}"
 end
 ```
 
@@ -197,7 +199,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **name** | **String** | Name for the Dataset object |  |
+| **id** | **String** | ID of the dataset |  |
 
 ### Return type
 
@@ -209,6 +211,6 @@ end
 
 ### HTTP request headers
 
-- **Content-Type**: application/x-www-form-urlencoded, multipart/form-data
+- **Content-Type**: Not defined
 - **Accept**: */*
 

data/docs/EntriesApi.md

@@ -4,16 +4,16 @@ 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 |
+| [**create_entries**](EntriesApi.md#create_entries) | **POST** /api/v1/entries | Create a new Entry |
+| [**index_entries**](EntriesApi.md#index_entries) | **GET** /api/v1/entries | Search for entries matching filters |
+| [**update_entries**](EntriesApi.md#update_entries) | **POST** /api/v1/entries/{id} | Update an existing Entry |
 
 
-## get_api_v1_entries
+## create_entries
 
-> <Array<Entry>> get_api_v1_entries(opts)
+> <Entry> create_entries(opts)
 
-Search for entries matching filters
+Create a new Entry
 
 ### Examples
 
@@ -30,36 +30,33 @@ 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)
+  create_entries_input: Quake::Timesheets::CreateEntriesInput.new # CreateEntriesInput | 
 }
 
 begin
-  # Search for entries matching filters
-  result = api_instance.get_api_v1_entries(opts)
+  # Create a new Entry
+  result = api_instance.create_entries(opts)
   p result
 rescue Quake::Timesheets::ApiError => e
-  puts "Error when calling EntriesApi->get_api_v1_entries: #{e}"
+  puts "Error when calling EntriesApi->create_entries: #{e}"
 end
 ```
 
-#### Using the get_api_v1_entries_with_http_info variant
+#### Using the create_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)
+> <Array(<Entry>, Integer, Hash)> create_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)
+  # Create a new Entry
+  data, status_code, headers = api_instance.create_entries_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <Array<Entry>>
+  p data # => <Entry>
 rescue Quake::Timesheets::ApiError => e
-  puts "Error when calling EntriesApi->get_api_v1_entries_with_http_info: #{e}"
+  puts "Error when calling EntriesApi->create_entries_with_http_info: #{e}"
 end
 ```
 
@@ -67,14 +64,11 @@ end
 
 | 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] |
+| **create_entries_input** | [**CreateEntriesInput**](CreateEntriesInput.md) |  | [optional] |
 
 ### Return type
 
-[**Array&lt;Entry&gt;**](Entry.md)
+[**Entry**](Entry.md)
 
 ### Authorization
 
@@ -82,15 +76,15 @@ end
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
+- **Content-Type**: application/json
 - **Accept**: */*
 
 
-## post_api_v1_entries
+## index_entries
 
-> <Entry> post_api_v1_entries(opts)
+> <Array<Entry>> index_entries(opts)
 
-Create a new Entry
+Search for entries matching filters
 
 ### Examples
 
@@ -107,38 +101,36 @@ 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
+  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
-  # Create a new Entry
-  result = api_instance.post_api_v1_entries(opts)
+  # Search for entries matching filters
+  result = api_instance.index_entries(opts)
   p result
 rescue Quake::Timesheets::ApiError => e
-  puts "Error when calling EntriesApi->post_api_v1_entries: #{e}"
+  puts "Error when calling EntriesApi->index_entries: #{e}"
 end
 ```
 
-#### Using the post_api_v1_entries_with_http_info variant
+#### Using the index_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)
+> <Array(<Array<Entry>>, Integer, Hash)> index_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)
+  # Search for entries matching filters
+  data, status_code, headers = api_instance.index_entries_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <Entry>
+  p data # => <Array<Entry>>
 rescue Quake::Timesheets::ApiError => e
-  puts "Error when calling EntriesApi->post_api_v1_entries_with_http_info: #{e}"
+  puts "Error when calling EntriesApi->index_entries_with_http_info: #{e}"
 end
 ```
 
@@ -146,16 +138,14 @@ end
 
 | 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] |
+| **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
 
-[**Entry**](Entry.md)
+[**Array&lt;Entry&gt;**](Entry.md)
 
 ### Authorization
 
@@ -163,13 +153,13 @@ end
 
 ### HTTP request headers
 
-- **Content-Type**: application/x-www-form-urlencoded, multipart/form-data
+- **Content-Type**: Not defined
 - **Accept**: */*
 
 
-## post_api_v1_entries_id
+## update_entries
 
-> <Entry> post_api_v1_entries_id(id, opts)
+> <Entry> update_entries(id, opts)
 
 Update an existing Entry
 
@@ -189,38 +179,33 @@ 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
+  update_entries_input: Quake::Timesheets::UpdateEntriesInput.new # UpdateEntriesInput | 
 }
 
 begin
   # Update an existing Entry
-  result = api_instance.post_api_v1_entries_id(id, opts)
+  result = api_instance.update_entries(id, opts)
   p result
 rescue Quake::Timesheets::ApiError => e
-  puts "Error when calling EntriesApi->post_api_v1_entries_id: #{e}"
+  puts "Error when calling EntriesApi->update_entries: #{e}"
 end
 ```
 
-#### Using the post_api_v1_entries_id_with_http_info variant
+#### Using the update_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_id_with_http_info(id, opts)
+> <Array(<Entry>, Integer, Hash)> update_entries_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)
+  data, status_code, headers = api_instance.update_entries_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}"
+  puts "Error when calling EntriesApi->update_entries_with_http_info: #{e}"
 end
 ```
 
@@ -229,12 +214,7 @@ end
 | 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] |
+| **update_entries_input** | [**UpdateEntriesInput**](UpdateEntriesInput.md) |  | [optional] |
 
 ### Return type
 
@@ -246,6 +226,6 @@ end
 
 ### HTTP request headers
 
-- **Content-Type**: application/x-www-form-urlencoded, multipart/form-data
+- **Content-Type**: application/json
 - **Accept**: */*