quake_timesheets_client 0.1.0 → 0.1.5
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +74 -0
- data/README.md +27 -21
- data/build.sh +1 -1
- data/docs/ApprovalTypesApi.md +36 -38
- data/docs/ApprovalsApi.md +36 -40
- data/docs/CreateApprovalTypesInput.md +22 -0
- data/docs/CreateApprovalsInput.md +24 -0
- data/docs/CreateDatasetsInput.md +18 -0
- data/docs/CreateEntriesInput.md +30 -0
- data/docs/CreatePeopleInput.md +20 -0
- data/docs/DatasetsApi.md +51 -49
- data/docs/EntriesApi.md +52 -72
- data/docs/Entry.md +2 -0
- data/docs/PeopleApi.md +36 -36
- data/docs/UpdateEntriesInput.md +30 -0
- data/lib/quake_timesheets_client.rb +7 -1
- data/lib/quake_timesheets_client/api/approval_types_api.rb +33 -52
- data/lib/quake_timesheets_client/api/approvals_api.rb +34 -65
- data/lib/quake_timesheets_client/api/datasets_api.rb +45 -50
- data/lib/quake_timesheets_client/api/entries_api.rb +54 -94
- data/lib/quake_timesheets_client/api/people_api.rb +33 -45
- data/lib/quake_timesheets_client/api_client.rb +1 -1
- data/lib/quake_timesheets_client/api_error.rb +1 -1
- data/lib/quake_timesheets_client/configuration.rb +1 -1
- data/lib/quake_timesheets_client/models/approval.rb +1 -1
- data/lib/quake_timesheets_client/models/approval_type.rb +1 -1
- data/lib/quake_timesheets_client/models/create_approval_types_input.rb +254 -0
- data/lib/quake_timesheets_client/models/create_approvals_input.rb +304 -0
- data/lib/quake_timesheets_client/models/create_datasets_input.rb +224 -0
- data/lib/quake_timesheets_client/models/create_entries_input.rb +313 -0
- data/lib/quake_timesheets_client/models/create_people_input.rb +239 -0
- data/lib/quake_timesheets_client/models/dataset.rb +1 -1
- data/lib/quake_timesheets_client/models/entry.rb +19 -2
- data/lib/quake_timesheets_client/models/person.rb +1 -1
- data/lib/quake_timesheets_client/models/update_entries_input.rb +313 -0
- data/lib/quake_timesheets_client/version.rb +2 -2
- data/quake_timesheets_client.gemspec +1 -1
- data/ruby-templates/api.mustache +206 -0
- data/ruby.config.yaml +1 -1
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/create_approval_types_input_spec.rb +46 -0
- data/spec/models/create_approvals_input_spec.rb +56 -0
- data/spec/models/create_datasets_input_spec.rb +34 -0
- data/spec/models/create_entries_input_spec.rb +68 -0
- data/spec/models/create_people_input_spec.rb +40 -0
- data/spec/models/update_entries_input_spec.rb +68 -0
- data/spec/spec_helper.rb +1 -1
- metadata +34 -9
- data/commands +0 -13
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 788e3cdd15937336e276568400bc08afe81744abf069277988b3ff2ebd9847c1
|
4
|
+
data.tar.gz: b7cf8bee5bdd238f8e939ab692962b1a0bcb903a6ab3c5c9c9ed26a4ceae6186
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 8bddad7a94043d2689da7dad28da2034bd31990b391e361ad21ade6ccbf31e20d8739b82b6d8a040450b7711ca6371c812b45b978b1d4cdec1932b0e49cacc9d
|
7
|
+
data.tar.gz: 87f4f84d26e971abb2c49db57c169d554f7f6364163369876e14c948969573ed8b4b0ef10d34f8f8341e00eb69eb1a12663df3f85faaacfd7762ecccfb849300
|
data/Gemfile.lock
ADDED
@@ -0,0 +1,74 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
quake_timesheets_client (0.1.5)
|
5
|
+
faraday (~> 1.0, >= 1.0.1)
|
6
|
+
|
7
|
+
GEM
|
8
|
+
remote: https://rubygems.org/
|
9
|
+
specs:
|
10
|
+
ast (2.4.2)
|
11
|
+
byebug (11.1.3)
|
12
|
+
coderay (1.1.3)
|
13
|
+
diff-lcs (1.4.4)
|
14
|
+
faraday (1.4.1)
|
15
|
+
faraday-excon (~> 1.1)
|
16
|
+
faraday-net_http (~> 1.0)
|
17
|
+
faraday-net_http_persistent (~> 1.1)
|
18
|
+
multipart-post (>= 1.2, < 3)
|
19
|
+
ruby2_keywords (>= 0.0.4)
|
20
|
+
faraday-excon (1.1.0)
|
21
|
+
faraday-net_http (1.0.1)
|
22
|
+
faraday-net_http_persistent (1.1.0)
|
23
|
+
jaro_winkler (1.5.4)
|
24
|
+
method_source (1.0.0)
|
25
|
+
multipart-post (2.1.1)
|
26
|
+
parallel (1.20.1)
|
27
|
+
parser (3.0.1.1)
|
28
|
+
ast (~> 2.4.1)
|
29
|
+
pry (0.13.1)
|
30
|
+
coderay (~> 1.1)
|
31
|
+
method_source (~> 1.0)
|
32
|
+
pry-byebug (3.9.0)
|
33
|
+
byebug (~> 11.0)
|
34
|
+
pry (~> 0.13.0)
|
35
|
+
psych (3.3.1)
|
36
|
+
rainbow (3.0.0)
|
37
|
+
rake (13.0.3)
|
38
|
+
rspec (3.10.0)
|
39
|
+
rspec-core (~> 3.10.0)
|
40
|
+
rspec-expectations (~> 3.10.0)
|
41
|
+
rspec-mocks (~> 3.10.0)
|
42
|
+
rspec-core (3.10.1)
|
43
|
+
rspec-support (~> 3.10.0)
|
44
|
+
rspec-expectations (3.10.1)
|
45
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
46
|
+
rspec-support (~> 3.10.0)
|
47
|
+
rspec-mocks (3.10.2)
|
48
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
49
|
+
rspec-support (~> 3.10.0)
|
50
|
+
rspec-support (3.10.2)
|
51
|
+
rubocop (0.66.0)
|
52
|
+
jaro_winkler (~> 1.5.1)
|
53
|
+
parallel (~> 1.10)
|
54
|
+
parser (>= 2.5, != 2.5.1.1)
|
55
|
+
psych (>= 3.1.0)
|
56
|
+
rainbow (>= 2.2.2, < 4.0)
|
57
|
+
ruby-progressbar (~> 1.7)
|
58
|
+
unicode-display_width (>= 1.4.0, < 1.6)
|
59
|
+
ruby-progressbar (1.11.0)
|
60
|
+
ruby2_keywords (0.0.4)
|
61
|
+
unicode-display_width (1.5.0)
|
62
|
+
|
63
|
+
PLATFORMS
|
64
|
+
x86_64-linux
|
65
|
+
|
66
|
+
DEPENDENCIES
|
67
|
+
pry-byebug
|
68
|
+
quake_timesheets_client!
|
69
|
+
rake (~> 13.0.1)
|
70
|
+
rspec (~> 3.6, >= 3.6.0)
|
71
|
+
rubocop (~> 0.66.0)
|
72
|
+
|
73
|
+
BUNDLED WITH
|
74
|
+
2.2.17
|
data/README.md
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
# quake_timesheets_client
|
2
2
|
|
3
|
-
Quake::Timesheets - the Ruby gem for the TimesheetsApi (params in:
|
3
|
+
Quake::Timesheets - the Ruby gem for the TimesheetsApi (params in:body)
|
4
4
|
|
5
5
|
|
6
6
|
<p>Another API description</p>
|
@@ -9,7 +9,7 @@ Quake::Timesheets - the Ruby gem for the TimesheetsApi (params in:formData)
|
|
9
9
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
10
10
|
|
11
11
|
- API version: 1.0
|
12
|
-
- Package version: 0.1.
|
12
|
+
- Package version: 0.1.5
|
13
13
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
14
14
|
|
15
15
|
## Generating
|
@@ -37,16 +37,16 @@ gem build quake_timesheets_client.gemspec
|
|
37
37
|
Then either install the gem locally:
|
38
38
|
|
39
39
|
```shell
|
40
|
-
gem install ./quake_timesheets_client-0.1.
|
40
|
+
gem install ./quake_timesheets_client-0.1.5.gem
|
41
41
|
```
|
42
42
|
|
43
|
-
(for development, run `gem install --dev ./quake_timesheets_client-0.1.
|
43
|
+
(for development, run `gem install --dev ./quake_timesheets_client-0.1.5.gem` to install the development dependencies)
|
44
44
|
|
45
45
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
46
46
|
|
47
47
|
Finally add this to the Gemfile:
|
48
48
|
|
49
|
-
gem 'quake_timesheets_client', '~> 0.1.
|
49
|
+
gem 'quake_timesheets_client', '~> 0.1.5'
|
50
50
|
|
51
51
|
### Install from Git
|
52
52
|
|
@@ -83,15 +83,15 @@ end
|
|
83
83
|
|
84
84
|
api_instance = Quake::Timesheets::ApprovalTypesApi.new
|
85
85
|
opts = {
|
86
|
-
dataset_id: 'dataset_id_example'
|
86
|
+
create_approval_types_input: Quake::Timesheets::CreateApprovalTypesInput.new({dataset_id: 'dataset_id_example', name: 'name_example', weight: 3.56}) # CreateApprovalTypesInput |
|
87
87
|
}
|
88
88
|
|
89
89
|
begin
|
90
|
-
#
|
91
|
-
result = api_instance.
|
90
|
+
#Create a new Approval Type
|
91
|
+
result = api_instance.create_approval_types(opts)
|
92
92
|
p result
|
93
93
|
rescue Quake::Timesheets::ApiError => e
|
94
|
-
puts "Exception when calling ApprovalTypesApi->
|
94
|
+
puts "Exception when calling ApprovalTypesApi->create_approval_types: #{e}"
|
95
95
|
end
|
96
96
|
|
97
97
|
```
|
@@ -102,27 +102,33 @@ All URIs are relative to *https://timesheetsapi.svc.lumbry.co.uk:443*
|
|
102
102
|
|
103
103
|
Class | Method | HTTP request | Description
|
104
104
|
------------ | ------------- | ------------- | -------------
|
105
|
-
*Quake::Timesheets::ApprovalTypesApi* | [**
|
106
|
-
*Quake::Timesheets::ApprovalTypesApi* | [**
|
107
|
-
*Quake::Timesheets::ApprovalsApi* | [**
|
108
|
-
*Quake::Timesheets::ApprovalsApi* | [**
|
109
|
-
*Quake::Timesheets::DatasetsApi* | [**
|
110
|
-
*Quake::Timesheets::DatasetsApi* | [**
|
111
|
-
*Quake::Timesheets::DatasetsApi* | [**
|
112
|
-
*Quake::Timesheets::EntriesApi* | [**
|
113
|
-
*Quake::Timesheets::EntriesApi* | [**
|
114
|
-
*Quake::Timesheets::EntriesApi* | [**
|
115
|
-
*Quake::Timesheets::PeopleApi* | [**
|
116
|
-
*Quake::Timesheets::PeopleApi* | [**
|
105
|
+
*Quake::Timesheets::ApprovalTypesApi* | [**create_approval_types**](docs/ApprovalTypesApi.md#create_approval_types) | **POST** /api/v1/approval_types | Create a new Approval Type
|
106
|
+
*Quake::Timesheets::ApprovalTypesApi* | [**index_approval_types**](docs/ApprovalTypesApi.md#index_approval_types) | **GET** /api/v1/approval_types | Search for approval types matching filters
|
107
|
+
*Quake::Timesheets::ApprovalsApi* | [**create_approvals**](docs/ApprovalsApi.md#create_approvals) | **POST** /api/v1/approvals | Create a new Approval
|
108
|
+
*Quake::Timesheets::ApprovalsApi* | [**index_approvals**](docs/ApprovalsApi.md#index_approvals) | **GET** /api/v1/approvals | Search for approval types matching filters
|
109
|
+
*Quake::Timesheets::DatasetsApi* | [**create_datasets**](docs/DatasetsApi.md#create_datasets) | **POST** /api/v1/datasets | Create a new Dataset record
|
110
|
+
*Quake::Timesheets::DatasetsApi* | [**index_datasets**](docs/DatasetsApi.md#index_datasets) | **GET** /api/v1/datasets | List all available datasets
|
111
|
+
*Quake::Timesheets::DatasetsApi* | [**show_datasets**](docs/DatasetsApi.md#show_datasets) | **GET** /api/v1/datasets/{id} | Show details about a specific dataset
|
112
|
+
*Quake::Timesheets::EntriesApi* | [**create_entries**](docs/EntriesApi.md#create_entries) | **POST** /api/v1/entries | Create a new Entry
|
113
|
+
*Quake::Timesheets::EntriesApi* | [**index_entries**](docs/EntriesApi.md#index_entries) | **GET** /api/v1/entries | Search for entries matching filters
|
114
|
+
*Quake::Timesheets::EntriesApi* | [**update_entries**](docs/EntriesApi.md#update_entries) | **PATCH** /api/v1/entries/{id} | Update an existing Entry
|
115
|
+
*Quake::Timesheets::PeopleApi* | [**create_people**](docs/PeopleApi.md#create_people) | **POST** /api/v1/people | Create a new Person record
|
116
|
+
*Quake::Timesheets::PeopleApi* | [**index_people**](docs/PeopleApi.md#index_people) | **GET** /api/v1/people | Search for people matching filters
|
117
117
|
|
118
118
|
|
119
119
|
## Documentation for Models
|
120
120
|
|
121
121
|
- [Quake::Timesheets::Approval](docs/Approval.md)
|
122
122
|
- [Quake::Timesheets::ApprovalType](docs/ApprovalType.md)
|
123
|
+
- [Quake::Timesheets::CreateApprovalTypesInput](docs/CreateApprovalTypesInput.md)
|
124
|
+
- [Quake::Timesheets::CreateApprovalsInput](docs/CreateApprovalsInput.md)
|
125
|
+
- [Quake::Timesheets::CreateDatasetsInput](docs/CreateDatasetsInput.md)
|
126
|
+
- [Quake::Timesheets::CreateEntriesInput](docs/CreateEntriesInput.md)
|
127
|
+
- [Quake::Timesheets::CreatePeopleInput](docs/CreatePeopleInput.md)
|
123
128
|
- [Quake::Timesheets::Dataset](docs/Dataset.md)
|
124
129
|
- [Quake::Timesheets::Entry](docs/Entry.md)
|
125
130
|
- [Quake::Timesheets::Person](docs/Person.md)
|
131
|
+
- [Quake::Timesheets::UpdateEntriesInput](docs/UpdateEntriesInput.md)
|
126
132
|
|
127
133
|
|
128
134
|
## Documentation for Authorization
|
data/build.sh
CHANGED
@@ -2,7 +2,7 @@
|
|
2
2
|
|
3
3
|
# passing the parameter "local" builds against the local instance
|
4
4
|
if [ "local" = "$1" ]; then
|
5
|
-
SOURCE='http://localhost:
|
5
|
+
SOURCE='http://localhost:3001/apidocs/1.0.json?type=swagger'
|
6
6
|
else
|
7
7
|
SOURCE='https://timesheetsapi.svc.lumbry.co.uk/apidocs/1.0.json?type=swagger'
|
8
8
|
fi
|
data/docs/ApprovalTypesApi.md
CHANGED
@@ -4,15 +4,15 @@ All URIs are relative to *https://timesheetsapi.svc.lumbry.co.uk:443*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
-
| [**
|
8
|
-
| [**
|
7
|
+
| [**create_approval_types**](ApprovalTypesApi.md#create_approval_types) | **POST** /api/v1/approval_types | Create a new Approval Type |
|
8
|
+
| [**index_approval_types**](ApprovalTypesApi.md#index_approval_types) | **GET** /api/v1/approval_types | Search for approval types matching filters |
|
9
9
|
|
10
10
|
|
11
|
-
##
|
11
|
+
## create_approval_types
|
12
12
|
|
13
|
-
> <
|
13
|
+
> <ApprovalType> create_approval_types(opts)
|
14
14
|
|
15
|
-
|
15
|
+
Create a new Approval Type
|
16
16
|
|
17
17
|
### Examples
|
18
18
|
|
@@ -29,33 +29,33 @@ end
|
|
29
29
|
|
30
30
|
api_instance = Quake::Timesheets::ApprovalTypesApi.new
|
31
31
|
opts = {
|
32
|
-
dataset_id: 'dataset_id_example'
|
32
|
+
create_approval_types_input: Quake::Timesheets::CreateApprovalTypesInput.new({dataset_id: 'dataset_id_example', name: 'name_example', weight: 3.56}) # CreateApprovalTypesInput |
|
33
33
|
}
|
34
34
|
|
35
35
|
begin
|
36
|
-
#
|
37
|
-
result = api_instance.
|
36
|
+
# Create a new Approval Type
|
37
|
+
result = api_instance.create_approval_types(opts)
|
38
38
|
p result
|
39
39
|
rescue Quake::Timesheets::ApiError => e
|
40
|
-
puts "Error when calling ApprovalTypesApi->
|
40
|
+
puts "Error when calling ApprovalTypesApi->create_approval_types: #{e}"
|
41
41
|
end
|
42
42
|
```
|
43
43
|
|
44
|
-
#### Using the
|
44
|
+
#### Using the create_approval_types_with_http_info variant
|
45
45
|
|
46
46
|
This returns an Array which contains the response data, status code and headers.
|
47
47
|
|
48
|
-
> <Array(<
|
48
|
+
> <Array(<ApprovalType>, Integer, Hash)> create_approval_types_with_http_info(opts)
|
49
49
|
|
50
50
|
```ruby
|
51
51
|
begin
|
52
|
-
#
|
53
|
-
data, status_code, headers = api_instance.
|
52
|
+
# Create a new Approval Type
|
53
|
+
data, status_code, headers = api_instance.create_approval_types_with_http_info(opts)
|
54
54
|
p status_code # => 2xx
|
55
55
|
p headers # => { ... }
|
56
|
-
p data # => <
|
56
|
+
p data # => <ApprovalType>
|
57
57
|
rescue Quake::Timesheets::ApiError => e
|
58
|
-
puts "Error when calling ApprovalTypesApi->
|
58
|
+
puts "Error when calling ApprovalTypesApi->create_approval_types_with_http_info: #{e}"
|
59
59
|
end
|
60
60
|
```
|
61
61
|
|
@@ -63,11 +63,11 @@ end
|
|
63
63
|
|
64
64
|
| Name | Type | Description | Notes |
|
65
65
|
| ---- | ---- | ----------- | ----- |
|
66
|
-
| **
|
66
|
+
| **create_approval_types_input** | [**CreateApprovalTypesInput**](CreateApprovalTypesInput.md) | | [optional] |
|
67
67
|
|
68
68
|
### Return type
|
69
69
|
|
70
|
-
[**
|
70
|
+
[**ApprovalType**](ApprovalType.md)
|
71
71
|
|
72
72
|
### Authorization
|
73
73
|
|
@@ -75,15 +75,15 @@ end
|
|
75
75
|
|
76
76
|
### HTTP request headers
|
77
77
|
|
78
|
-
- **Content-Type**:
|
78
|
+
- **Content-Type**: application/json
|
79
79
|
- **Accept**: */*
|
80
80
|
|
81
81
|
|
82
|
-
##
|
82
|
+
## index_approval_types
|
83
83
|
|
84
|
-
> <ApprovalType
|
84
|
+
> <Array<ApprovalType>> index_approval_types(opts)
|
85
85
|
|
86
|
-
|
86
|
+
Search for approval types matching filters
|
87
87
|
|
88
88
|
### Examples
|
89
89
|
|
@@ -99,34 +99,34 @@ Quake::Timesheets.configure do |config|
|
|
99
99
|
end
|
100
100
|
|
101
101
|
api_instance = Quake::Timesheets::ApprovalTypesApi.new
|
102
|
-
|
103
|
-
|
104
|
-
|
102
|
+
opts = {
|
103
|
+
dataset_id: 'dataset_id_example' # String | Filter to the approval types belonging to one of the identified datasets
|
104
|
+
}
|
105
105
|
|
106
106
|
begin
|
107
|
-
#
|
108
|
-
result = api_instance.
|
107
|
+
# Search for approval types matching filters
|
108
|
+
result = api_instance.index_approval_types(opts)
|
109
109
|
p result
|
110
110
|
rescue Quake::Timesheets::ApiError => e
|
111
|
-
puts "Error when calling ApprovalTypesApi->
|
111
|
+
puts "Error when calling ApprovalTypesApi->index_approval_types: #{e}"
|
112
112
|
end
|
113
113
|
```
|
114
114
|
|
115
|
-
#### Using the
|
115
|
+
#### Using the index_approval_types_with_http_info variant
|
116
116
|
|
117
117
|
This returns an Array which contains the response data, status code and headers.
|
118
118
|
|
119
|
-
> <Array(<ApprovalType
|
119
|
+
> <Array(<Array<ApprovalType>>, Integer, Hash)> index_approval_types_with_http_info(opts)
|
120
120
|
|
121
121
|
```ruby
|
122
122
|
begin
|
123
|
-
#
|
124
|
-
data, status_code, headers = api_instance.
|
123
|
+
# Search for approval types matching filters
|
124
|
+
data, status_code, headers = api_instance.index_approval_types_with_http_info(opts)
|
125
125
|
p status_code # => 2xx
|
126
126
|
p headers # => { ... }
|
127
|
-
p data # => <ApprovalType
|
127
|
+
p data # => <Array<ApprovalType>>
|
128
128
|
rescue Quake::Timesheets::ApiError => e
|
129
|
-
puts "Error when calling ApprovalTypesApi->
|
129
|
+
puts "Error when calling ApprovalTypesApi->index_approval_types_with_http_info: #{e}"
|
130
130
|
end
|
131
131
|
```
|
132
132
|
|
@@ -134,13 +134,11 @@ end
|
|
134
134
|
|
135
135
|
| Name | Type | Description | Notes |
|
136
136
|
| ---- | ---- | ----------- | ----- |
|
137
|
-
| **
|
138
|
-
| **name** | **String** | The name of the approval type | |
|
139
|
-
| **dataset_id** | **String** | ID of the dataset this approval type is linked to | |
|
137
|
+
| **dataset_id** | **String** | Filter to the approval types belonging to one of the identified datasets | [optional] |
|
140
138
|
|
141
139
|
### Return type
|
142
140
|
|
143
|
-
[**ApprovalType
|
141
|
+
[**Array<ApprovalType>**](ApprovalType.md)
|
144
142
|
|
145
143
|
### Authorization
|
146
144
|
|
@@ -148,6 +146,6 @@ end
|
|
148
146
|
|
149
147
|
### HTTP request headers
|
150
148
|
|
151
|
-
- **Content-Type**:
|
149
|
+
- **Content-Type**: Not defined
|
152
150
|
- **Accept**: */*
|
153
151
|
|
data/docs/ApprovalsApi.md
CHANGED
@@ -4,15 +4,15 @@ All URIs are relative to *https://timesheetsapi.svc.lumbry.co.uk:443*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
-
| [**
|
8
|
-
| [**
|
7
|
+
| [**create_approvals**](ApprovalsApi.md#create_approvals) | **POST** /api/v1/approvals | Create a new Approval |
|
8
|
+
| [**index_approvals**](ApprovalsApi.md#index_approvals) | **GET** /api/v1/approvals | Search for approval types matching filters |
|
9
9
|
|
10
10
|
|
11
|
-
##
|
11
|
+
## create_approvals
|
12
12
|
|
13
|
-
> <
|
13
|
+
> <Approval> create_approvals(opts)
|
14
14
|
|
15
|
-
|
15
|
+
Create a new Approval
|
16
16
|
|
17
17
|
### Examples
|
18
18
|
|
@@ -28,32 +28,34 @@ Quake::Timesheets.configure do |config|
|
|
28
28
|
end
|
29
29
|
|
30
30
|
api_instance = Quake::Timesheets::ApprovalsApi.new
|
31
|
-
|
31
|
+
opts = {
|
32
|
+
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 |
|
33
|
+
}
|
32
34
|
|
33
35
|
begin
|
34
|
-
#
|
35
|
-
result = api_instance.
|
36
|
+
# Create a new Approval
|
37
|
+
result = api_instance.create_approvals(opts)
|
36
38
|
p result
|
37
39
|
rescue Quake::Timesheets::ApiError => e
|
38
|
-
puts "Error when calling ApprovalsApi->
|
40
|
+
puts "Error when calling ApprovalsApi->create_approvals: #{e}"
|
39
41
|
end
|
40
42
|
```
|
41
43
|
|
42
|
-
#### Using the
|
44
|
+
#### Using the create_approvals_with_http_info variant
|
43
45
|
|
44
46
|
This returns an Array which contains the response data, status code and headers.
|
45
47
|
|
46
|
-
> <Array(<
|
48
|
+
> <Array(<Approval>, Integer, Hash)> create_approvals_with_http_info(opts)
|
47
49
|
|
48
50
|
```ruby
|
49
51
|
begin
|
50
|
-
#
|
51
|
-
data, status_code, headers = api_instance.
|
52
|
+
# Create a new Approval
|
53
|
+
data, status_code, headers = api_instance.create_approvals_with_http_info(opts)
|
52
54
|
p status_code # => 2xx
|
53
55
|
p headers # => { ... }
|
54
|
-
p data # => <
|
56
|
+
p data # => <Approval>
|
55
57
|
rescue Quake::Timesheets::ApiError => e
|
56
|
-
puts "Error when calling ApprovalsApi->
|
58
|
+
puts "Error when calling ApprovalsApi->create_approvals_with_http_info: #{e}"
|
57
59
|
end
|
58
60
|
```
|
59
61
|
|
@@ -61,11 +63,11 @@ end
|
|
61
63
|
|
62
64
|
| Name | Type | Description | Notes |
|
63
65
|
| ---- | ---- | ----------- | ----- |
|
64
|
-
| **
|
66
|
+
| **create_approvals_input** | [**CreateApprovalsInput**](CreateApprovalsInput.md) | | [optional] |
|
65
67
|
|
66
68
|
### Return type
|
67
69
|
|
68
|
-
[**
|
70
|
+
[**Approval**](Approval.md)
|
69
71
|
|
70
72
|
### Authorization
|
71
73
|
|
@@ -73,15 +75,15 @@ end
|
|
73
75
|
|
74
76
|
### HTTP request headers
|
75
77
|
|
76
|
-
- **Content-Type**:
|
78
|
+
- **Content-Type**: application/json
|
77
79
|
- **Accept**: */*
|
78
80
|
|
79
81
|
|
80
|
-
##
|
82
|
+
## index_approvals
|
81
83
|
|
82
|
-
> <Approval
|
84
|
+
> <Array<Approval>> index_approvals(dataset_id)
|
83
85
|
|
84
|
-
|
86
|
+
Search for approval types matching filters
|
85
87
|
|
86
88
|
### Examples
|
87
89
|
|
@@ -97,35 +99,32 @@ Quake::Timesheets.configure do |config|
|
|
97
99
|
end
|
98
100
|
|
99
101
|
api_instance = Quake::Timesheets::ApprovalsApi.new
|
100
|
-
|
101
|
-
approval_type_id = 'approval_type_id_example' # String | The ID of the Approval Type of this Approval
|
102
|
-
entry_ids = ['inner_example'] # Array<String> | The ID of the Entry this Approval is linked to
|
103
|
-
dataset_id = 'dataset_id_example' # String | ID of the dataset this approval type is linked to
|
102
|
+
dataset_id = 'dataset_id_example' # String | Filter to the approvals belonging to one of the identified datasets
|
104
103
|
|
105
104
|
begin
|
106
|
-
#
|
107
|
-
result = api_instance.
|
105
|
+
# Search for approval types matching filters
|
106
|
+
result = api_instance.index_approvals(dataset_id)
|
108
107
|
p result
|
109
108
|
rescue Quake::Timesheets::ApiError => e
|
110
|
-
puts "Error when calling ApprovalsApi->
|
109
|
+
puts "Error when calling ApprovalsApi->index_approvals: #{e}"
|
111
110
|
end
|
112
111
|
```
|
113
112
|
|
114
|
-
#### Using the
|
113
|
+
#### Using the index_approvals_with_http_info variant
|
115
114
|
|
116
115
|
This returns an Array which contains the response data, status code and headers.
|
117
116
|
|
118
|
-
> <Array(<Approval
|
117
|
+
> <Array(<Array<Approval>>, Integer, Hash)> index_approvals_with_http_info(dataset_id)
|
119
118
|
|
120
119
|
```ruby
|
121
120
|
begin
|
122
|
-
#
|
123
|
-
data, status_code, headers = api_instance.
|
121
|
+
# Search for approval types matching filters
|
122
|
+
data, status_code, headers = api_instance.index_approvals_with_http_info(dataset_id)
|
124
123
|
p status_code # => 2xx
|
125
124
|
p headers # => { ... }
|
126
|
-
p data # => <Approval
|
125
|
+
p data # => <Array<Approval>>
|
127
126
|
rescue Quake::Timesheets::ApiError => e
|
128
|
-
puts "Error when calling ApprovalsApi->
|
127
|
+
puts "Error when calling ApprovalsApi->index_approvals_with_http_info: #{e}"
|
129
128
|
end
|
130
129
|
```
|
131
130
|
|
@@ -133,14 +132,11 @@ end
|
|
133
132
|
|
134
133
|
| Name | Type | Description | Notes |
|
135
134
|
| ---- | ---- | ----------- | ----- |
|
136
|
-
| **
|
137
|
-
| **approval_type_id** | **String** | The ID of the Approval Type of this Approval | |
|
138
|
-
| **entry_ids** | [**Array<String>**](String.md) | The ID of the Entry this Approval is linked to | |
|
139
|
-
| **dataset_id** | **String** | ID of the dataset this approval type is linked to | |
|
135
|
+
| **dataset_id** | **String** | Filter to the approvals belonging to one of the identified datasets | |
|
140
136
|
|
141
137
|
### Return type
|
142
138
|
|
143
|
-
[**Approval
|
139
|
+
[**Array<Approval>**](Approval.md)
|
144
140
|
|
145
141
|
### Authorization
|
146
142
|
|
@@ -148,6 +144,6 @@ end
|
|
148
144
|
|
149
145
|
### HTTP request headers
|
150
146
|
|
151
|
-
- **Content-Type**:
|
147
|
+
- **Content-Type**: Not defined
|
152
148
|
- **Accept**: */*
|
153
149
|
|