quake_timesheets_client 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 119ee596e8cc8a04f1d9bd725708df328f45e6a132e0ff12f763ddf61cd0ffc5
-  data.tar.gz: d7626dc544854a7c36266d2b63366a2417beb69cd685fe742c8f5ba26c6c5335
+  metadata.gz: 28dba9dc7e3df7c1eb507daca0c76c92ae3ee2022436ee3cca755ffacf4acf61
+  data.tar.gz: 4e90cdd673cc3e978ba0c2846a2b8fe3e0b99c07bb34f94d716799a83b065a85
 SHA512:
-  metadata.gz: 22b2e259dc75dac178cdf18f7c914798d5c5b4a7437733f2f73db40923ec3534fa0070cdb6005643c669cfab0a6ae2364dc28d7dc733fe8935e58345c8e865d2
-  data.tar.gz: a66d08915cb9e5e6908caea7db6ff4565af70031211d650f48df14497c41f712bbac6de9f17c22e7d406fdcc258dd814ae102076d3c1df4cca10007cdc93d675
+  metadata.gz: 5a850b95b5b021522701c29bc8a0cb2cd70aa120ea0be2a6a05606d35e1a582c873878a5fe0300df090ec58a12cbe6f30c379167948a40a9b89b953d90e4901e
+  data.tar.gz: f80bc788dc97f2c422336e607e092e1720cfa7bcbb0b20dbba5d341c154ee3e6e64af96c2f9070237a20d3d96db51e1337e533141f51105d77e3652031adce13

data/README.md

@@ -1,6 +1,6 @@
 # quake_timesheets_client
 
-Quake::Timesheets - the Ruby gem for the TimesheetsApi (params in:formData)
+Quake::Timesheets - the Ruby gem for the TimesheetsApi (params in:body)
 
 
 <p>Another API description</p>
@@ -9,7 +9,7 @@ Quake::Timesheets - the Ruby gem for the TimesheetsApi (params in:formData)
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 1.0
-- Package version: 0.1.0
+- Package version: 0.1.1
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 ## Generating
@@ -37,16 +37,16 @@ gem build quake_timesheets_client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./quake_timesheets_client-0.1.0.gem
+gem install ./quake_timesheets_client-0.1.1.gem
 ```
 
-(for development, run `gem install --dev ./quake_timesheets_client-0.1.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./quake_timesheets_client-0.1.1.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'quake_timesheets_client', '~> 0.1.0'
+    gem 'quake_timesheets_client', '~> 0.1.1'
 
 ### Install from Git
 
@@ -83,15 +83,15 @@ end
 
 api_instance = Quake::Timesheets::ApprovalTypesApi.new
 opts = {
-  dataset_id: 'dataset_id_example' # String | Filter to the approval types belonging to one of the identified datasets
+  create_approval_types_input: Quake::Timesheets::CreateApprovalTypesInput.new({dataset_id: 'dataset_id_example', name: 'name_example', weight: 3.56}) # CreateApprovalTypesInput | 
 }
 
 begin
-  #Search for approval types matching filters
-  result = api_instance.get_api_v1_approval_types(opts)
+  #Create a new Approval Type
+  result = api_instance.create_approval_types(opts)
   p result
 rescue Quake::Timesheets::ApiError => e
-  puts "Exception when calling ApprovalTypesApi->get_api_v1_approval_types: #{e}"
+  puts "Exception when calling ApprovalTypesApi->create_approval_types: #{e}"
 end
 
 ```
@@ -102,27 +102,33 @@ All URIs are relative to *https://timesheetsapi.svc.lumbry.co.uk:443*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
-*Quake::Timesheets::ApprovalTypesApi* | [**get_api_v1_approval_types**](docs/ApprovalTypesApi.md#get_api_v1_approval_types) | **GET** /api/v1/approval_types | Search for approval types matching filters
-*Quake::Timesheets::ApprovalTypesApi* | [**post_api_v1_approval_types**](docs/ApprovalTypesApi.md#post_api_v1_approval_types) | **POST** /api/v1/approval_types | Create a new Approval Type
-*Quake::Timesheets::ApprovalsApi* | [**get_api_v1_approvals**](docs/ApprovalsApi.md#get_api_v1_approvals) | **GET** /api/v1/approvals | Search for approval types matching filters
-*Quake::Timesheets::ApprovalsApi* | [**post_api_v1_approvals**](docs/ApprovalsApi.md#post_api_v1_approvals) | **POST** /api/v1/approvals | Create a new Approval
-*Quake::Timesheets::DatasetsApi* | [**get_api_v1_datasets**](docs/DatasetsApi.md#get_api_v1_datasets) | **GET** /api/v1/datasets | List all available datasets
-*Quake::Timesheets::DatasetsApi* | [**get_api_v1_datasets_id**](docs/DatasetsApi.md#get_api_v1_datasets_id) | **GET** /api/v1/datasets/{id} | Show details about a specific dataset
-*Quake::Timesheets::DatasetsApi* | [**post_api_v1_datasets**](docs/DatasetsApi.md#post_api_v1_datasets) | **POST** /api/v1/datasets | Create a new Dataset record
-*Quake::Timesheets::EntriesApi* | [**get_api_v1_entries**](docs/EntriesApi.md#get_api_v1_entries) | **GET** /api/v1/entries | Search for entries matching filters
-*Quake::Timesheets::EntriesApi* | [**post_api_v1_entries**](docs/EntriesApi.md#post_api_v1_entries) | **POST** /api/v1/entries | Create a new Entry
-*Quake::Timesheets::EntriesApi* | [**post_api_v1_entries_id**](docs/EntriesApi.md#post_api_v1_entries_id) | **POST** /api/v1/entries/{id} | Update an existing Entry
-*Quake::Timesheets::PeopleApi* | [**get_api_v1_people**](docs/PeopleApi.md#get_api_v1_people) | **GET** /api/v1/people | Search for people matching filters
-*Quake::Timesheets::PeopleApi* | [**post_api_v1_people**](docs/PeopleApi.md#post_api_v1_people) | **POST** /api/v1/people | Create a new Person record
+*Quake::Timesheets::ApprovalTypesApi* | [**create_approval_types**](docs/ApprovalTypesApi.md#create_approval_types) | **POST** /api/v1/approval_types | Create a new Approval Type
+*Quake::Timesheets::ApprovalTypesApi* | [**index_approval_types**](docs/ApprovalTypesApi.md#index_approval_types) | **GET** /api/v1/approval_types | Search for approval types matching filters
+*Quake::Timesheets::ApprovalsApi* | [**create_approvals**](docs/ApprovalsApi.md#create_approvals) | **POST** /api/v1/approvals | Create a new Approval
+*Quake::Timesheets::ApprovalsApi* | [**index_approvals**](docs/ApprovalsApi.md#index_approvals) | **GET** /api/v1/approvals | Search for approval types matching filters
+*Quake::Timesheets::DatasetsApi* | [**create_datasets**](docs/DatasetsApi.md#create_datasets) | **POST** /api/v1/datasets | Create a new Dataset record
+*Quake::Timesheets::DatasetsApi* | [**index_datasets**](docs/DatasetsApi.md#index_datasets) | **GET** /api/v1/datasets | List all available datasets
+*Quake::Timesheets::DatasetsApi* | [**show_datasets**](docs/DatasetsApi.md#show_datasets) | **GET** /api/v1/datasets/{id} | Show details about a specific dataset
+*Quake::Timesheets::EntriesApi* | [**create_entries**](docs/EntriesApi.md#create_entries) | **POST** /api/v1/entries | Create a new Entry
+*Quake::Timesheets::EntriesApi* | [**index_entries**](docs/EntriesApi.md#index_entries) | **GET** /api/v1/entries | Search for entries matching filters
+*Quake::Timesheets::EntriesApi* | [**update_entries**](docs/EntriesApi.md#update_entries) | **POST** /api/v1/entries/{id} | Update an existing Entry
+*Quake::Timesheets::PeopleApi* | [**create_people**](docs/PeopleApi.md#create_people) | **POST** /api/v1/people | Create a new Person record
+*Quake::Timesheets::PeopleApi* | [**index_people**](docs/PeopleApi.md#index_people) | **GET** /api/v1/people | Search for people matching filters
 
 
 ## Documentation for Models
 
  - [Quake::Timesheets::Approval](docs/Approval.md)
  - [Quake::Timesheets::ApprovalType](docs/ApprovalType.md)
+ - [Quake::Timesheets::CreateApprovalTypesInput](docs/CreateApprovalTypesInput.md)
+ - [Quake::Timesheets::CreateApprovalsInput](docs/CreateApprovalsInput.md)
+ - [Quake::Timesheets::CreateDatasetsInput](docs/CreateDatasetsInput.md)
+ - [Quake::Timesheets::CreateEntriesInput](docs/CreateEntriesInput.md)
+ - [Quake::Timesheets::CreatePeopleInput](docs/CreatePeopleInput.md)
  - [Quake::Timesheets::Dataset](docs/Dataset.md)
  - [Quake::Timesheets::Entry](docs/Entry.md)
  - [Quake::Timesheets::Person](docs/Person.md)
+ - [Quake::Timesheets::UpdateEntriesInput](docs/UpdateEntriesInput.md)
 
 
 ## Documentation for Authorization

data/build.sh

@@ -2,7 +2,7 @@
 
 # passing the parameter "local" builds against the local instance
 if [ "local" = "$1" ]; then
-  SOURCE='http://localhost:3000/apidocs/1.0.json?type=swagger'
+  SOURCE='http://localhost:3001/apidocs/1.0.json?type=swagger'
 else
   SOURCE='https://timesheetsapi.svc.lumbry.co.uk/apidocs/1.0.json?type=swagger'
 fi

data/docs/ApprovalTypesApi.md

@@ -4,15 +4,15 @@ All URIs are relative to *https://timesheetsapi.svc.lumbry.co.uk:443*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**get_api_v1_approval_types**](ApprovalTypesApi.md#get_api_v1_approval_types) | **GET** /api/v1/approval_types | Search for approval types matching filters |
-| [**post_api_v1_approval_types**](ApprovalTypesApi.md#post_api_v1_approval_types) | **POST** /api/v1/approval_types | Create a new Approval Type |
+| [**create_approval_types**](ApprovalTypesApi.md#create_approval_types) | **POST** /api/v1/approval_types | Create a new Approval Type |
+| [**index_approval_types**](ApprovalTypesApi.md#index_approval_types) | **GET** /api/v1/approval_types | Search for approval types matching filters |
 
 
-## get_api_v1_approval_types
+## create_approval_types
 
-> <Array<ApprovalType>> get_api_v1_approval_types(opts)
+> <ApprovalType> create_approval_types(opts)
 
-Search for approval types matching filters
+Create a new Approval Type
 
 ### Examples
 
@@ -29,33 +29,33 @@ end
 
 api_instance = Quake::Timesheets::ApprovalTypesApi.new
 opts = {
-  dataset_id: 'dataset_id_example' # String | Filter to the approval types belonging to one of the identified datasets
+  create_approval_types_input: Quake::Timesheets::CreateApprovalTypesInput.new({dataset_id: 'dataset_id_example', name: 'name_example', weight: 3.56}) # CreateApprovalTypesInput | 
 }
 
 begin
-  # Search for approval types matching filters
-  result = api_instance.get_api_v1_approval_types(opts)
+  # Create a new Approval Type
+  result = api_instance.create_approval_types(opts)
   p result
 rescue Quake::Timesheets::ApiError => e
-  puts "Error when calling ApprovalTypesApi->get_api_v1_approval_types: #{e}"
+  puts "Error when calling ApprovalTypesApi->create_approval_types: #{e}"
 end
 ```
 
-#### Using the get_api_v1_approval_types_with_http_info variant
+#### Using the create_approval_types_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<Array<ApprovalType>>, Integer, Hash)> get_api_v1_approval_types_with_http_info(opts)
+> <Array(<ApprovalType>, Integer, Hash)> create_approval_types_with_http_info(opts)
 
 ```ruby
 begin
-  # Search for approval types matching filters
-  data, status_code, headers = api_instance.get_api_v1_approval_types_with_http_info(opts)
+  # Create a new Approval Type
+  data, status_code, headers = api_instance.create_approval_types_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <Array<ApprovalType>>
+  p data # => <ApprovalType>
 rescue Quake::Timesheets::ApiError => e
-  puts "Error when calling ApprovalTypesApi->get_api_v1_approval_types_with_http_info: #{e}"
+  puts "Error when calling ApprovalTypesApi->create_approval_types_with_http_info: #{e}"
 end
 ```
 
@@ -63,11 +63,11 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **dataset_id** | **String** | Filter to the approval types belonging to one of the identified datasets | [optional] |
+| **create_approval_types_input** | [**CreateApprovalTypesInput**](CreateApprovalTypesInput.md) |  | [optional] |
 
 ### Return type
 
-[**Array&lt;ApprovalType&gt;**](ApprovalType.md)
+[**ApprovalType**](ApprovalType.md)
 
 ### Authorization
 
@@ -75,15 +75,15 @@ end
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
+- **Content-Type**: application/json
 - **Accept**: */*
 
 
-## post_api_v1_approval_types
+## index_approval_types
 
-> <ApprovalType> post_api_v1_approval_types(weight, name, dataset_id)
+> <Array<ApprovalType>> index_approval_types(opts)
 
-Create a new Approval Type
+Search for approval types matching filters
 
 ### Examples
 
@@ -99,34 +99,34 @@ Quake::Timesheets.configure do |config|
 end
 
 api_instance = Quake::Timesheets::ApprovalTypesApi.new
-weight = 8.14 # Float | The weight provided by approvals of this type
-name = 'name_example' # String | The name of the approval type
-dataset_id = 'dataset_id_example' # String | ID of the dataset this approval type is linked to
+opts = {
+  dataset_id: 'dataset_id_example' # String | Filter to the approval types belonging to one of the identified datasets
+}
 
 begin
-  # Create a new Approval Type
-  result = api_instance.post_api_v1_approval_types(weight, name, dataset_id)
+  # Search for approval types matching filters
+  result = api_instance.index_approval_types(opts)
   p result
 rescue Quake::Timesheets::ApiError => e
-  puts "Error when calling ApprovalTypesApi->post_api_v1_approval_types: #{e}"
+  puts "Error when calling ApprovalTypesApi->index_approval_types: #{e}"
 end
 ```
 
-#### Using the post_api_v1_approval_types_with_http_info variant
+#### Using the index_approval_types_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<ApprovalType>, Integer, Hash)> post_api_v1_approval_types_with_http_info(weight, name, dataset_id)
+> <Array(<Array<ApprovalType>>, Integer, Hash)> index_approval_types_with_http_info(opts)
 
 ```ruby
 begin
-  # Create a new Approval Type
-  data, status_code, headers = api_instance.post_api_v1_approval_types_with_http_info(weight, name, dataset_id)
+  # Search for approval types matching filters
+  data, status_code, headers = api_instance.index_approval_types_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <ApprovalType>
+  p data # => <Array<ApprovalType>>
 rescue Quake::Timesheets::ApiError => e
-  puts "Error when calling ApprovalTypesApi->post_api_v1_approval_types_with_http_info: #{e}"
+  puts "Error when calling ApprovalTypesApi->index_approval_types_with_http_info: #{e}"
 end
 ```
 
@@ -134,13 +134,11 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **weight** | **Float** | The weight provided by approvals of this type |  |
-| **name** | **String** | The name of the approval type |  |
-| **dataset_id** | **String** | ID of the dataset this approval type is linked to |  |
+| **dataset_id** | **String** | Filter to the approval types belonging to one of the identified datasets | [optional] |
 
 ### Return type
 
-[**ApprovalType**](ApprovalType.md)
+[**Array&lt;ApprovalType&gt;**](ApprovalType.md)
 
 ### Authorization
 
@@ -148,6 +146,6 @@ end
 
 ### HTTP request headers
 
-- **Content-Type**: application/x-www-form-urlencoded, multipart/form-data
+- **Content-Type**: Not defined
 - **Accept**: */*
 

data/docs/ApprovalsApi.md

@@ -4,15 +4,15 @@ 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 |
+| [**create_approvals**](ApprovalsApi.md#create_approvals) | **POST** /api/v1/approvals | Create a new Approval |
+| [**index_approvals**](ApprovalsApi.md#index_approvals) | **GET** /api/v1/approvals | Search for approval types matching filters |
 
 
-## get_api_v1_approvals
+## create_approvals
 
-> <Array<Approval>> get_api_v1_approvals(dataset_id)
+> <Approval> create_approvals(opts)
 
-Search for approval types matching filters
+Create a new Approval
 
 ### Examples
 
@@ -28,32 +28,34 @@ Quake::Timesheets.configure do |config|
 end
 
 api_instance = Quake::Timesheets::ApprovalsApi.new
-dataset_id = 'dataset_id_example' # String | Filter to the approvals belonging to one of the identified datasets
+opts = {
+  create_approvals_input: Quake::Timesheets::CreateApprovalsInput.new({dataset_id: 'dataset_id_example', entry_ids: ['entry_ids_example'], approval_type_id: 'approval_type_id_example', state: 'requested'}) # CreateApprovalsInput | 
+}
 
 begin
-  # Search for approval types matching filters
-  result = api_instance.get_api_v1_approvals(dataset_id)
+  # Create a new Approval
+  result = api_instance.create_approvals(opts)
   p result
 rescue Quake::Timesheets::ApiError => e
-  puts "Error when calling ApprovalsApi->get_api_v1_approvals: #{e}"
+  puts "Error when calling ApprovalsApi->create_approvals: #{e}"
 end
 ```
 
-#### Using the get_api_v1_approvals_with_http_info variant
+#### Using the create_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)
+> <Array(<Approval>, Integer, Hash)> create_approvals_with_http_info(opts)
 
 ```ruby
 begin
-  # Search for approval types matching filters
-  data, status_code, headers = api_instance.get_api_v1_approvals_with_http_info(dataset_id)
+  # Create a new Approval
+  data, status_code, headers = api_instance.create_approvals_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <Array<Approval>>
+  p data # => <Approval>
 rescue Quake::Timesheets::ApiError => e
-  puts "Error when calling ApprovalsApi->get_api_v1_approvals_with_http_info: #{e}"
+  puts "Error when calling ApprovalsApi->create_approvals_with_http_info: #{e}"
 end
 ```
 
@@ -61,11 +63,11 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **dataset_id** | **String** | Filter to the approvals belonging to one of the identified datasets |  |
+| **create_approvals_input** | [**CreateApprovalsInput**](CreateApprovalsInput.md) |  | [optional] |
 
 ### Return type
 
-[**Array&lt;Approval&gt;**](Approval.md)
+[**Approval**](Approval.md)
 
 ### Authorization
 
@@ -73,15 +75,15 @@ end
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
+- **Content-Type**: application/json
 - **Accept**: */*
 
 
-## post_api_v1_approvals
+## index_approvals
 
-> <Approval> post_api_v1_approvals(state, approval_type_id, entry_ids, dataset_id)
+> <Array<Approval>> index_approvals(dataset_id)
 
-Create a new Approval
+Search for approval types matching filters
 
 ### Examples
 
@@ -97,35 +99,32 @@ Quake::Timesheets.configure do |config|
 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
+dataset_id = 'dataset_id_example' # String | Filter to the approvals belonging to one of the identified datasets
 
 begin
-  # Create a new Approval
-  result = api_instance.post_api_v1_approvals(state, approval_type_id, entry_ids, dataset_id)
+  # Search for approval types matching filters
+  result = api_instance.index_approvals(dataset_id)
   p result
 rescue Quake::Timesheets::ApiError => e
-  puts "Error when calling ApprovalsApi->post_api_v1_approvals: #{e}"
+  puts "Error when calling ApprovalsApi->index_approvals: #{e}"
 end
 ```
 
-#### Using the post_api_v1_approvals_with_http_info variant
+#### Using the index_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)
+> <Array(<Array<Approval>>, Integer, Hash)> index_approvals_with_http_info(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)
+  # Search for approval types matching filters
+  data, status_code, headers = api_instance.index_approvals_with_http_info(dataset_id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <Approval>
+  p data # => <Array<Approval>>
 rescue Quake::Timesheets::ApiError => e
-  puts "Error when calling ApprovalsApi->post_api_v1_approvals_with_http_info: #{e}"
+  puts "Error when calling ApprovalsApi->index_approvals_with_http_info: #{e}"
 end
 ```
 
@@ -133,14 +132,11 @@ end
 
 | 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 |  |
+| **dataset_id** | **String** | Filter to the approvals belonging to one of the identified datasets |  |
 
 ### Return type
 
-[**Approval**](Approval.md)
+[**Array&lt;Approval&gt;**](Approval.md)
 
 ### Authorization
 
@@ -148,6 +144,6 @@ end
 
 ### HTTP request headers
 
-- **Content-Type**: application/x-www-form-urlencoded, multipart/form-data
+- **Content-Type**: Not defined
 - **Accept**: */*