Quake::Timesheets - the Ruby gem for the TimesheetsApi (params in:body)
Another API description
This SDK is automatically generated by the OpenAPI Generator project:
- API version: 1.0
- Package version: 0.1.6
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
To re-generate the source for this gem, use the command:
./build.sh
To generate from a local timesheets installation (e.g. during development) use:
./build.sh local
To build the Ruby code into a gem:
gem build quake_timesheets_client.gemspec
Then either install the gem locally:
gem install ./quake_timesheets_client-0.1.6.gem
(for development, run gem install --dev ./quake_timesheets_client-0.1.6.gem
to install the development dependencies)
or publish the gem to a gem hosting service, e.g. RubyGems.
Finally add this to the Gemfile:
gem 'quake_timesheets_client', '~> 0.1.6'
If the Ruby gem is hosted at a git repository: https://github.com/quake-saas/timesheets-client-ruby, then add the following in the Gemfile:
gem 'quake_timesheets_client', :git => 'https://github.com/quake-saas/timesheets-client-ruby.git'
Include the Ruby code directly using -I
as follows:
ruby -Ilib script.rb
Please follow the installation procedure and then run the following code:
# Load the gem
require 'quake_timesheets_client'
# Setup authorization
Quake::Timesheets.configure do |config|
# Configure API key authorization: authToken
config.api_key['authToken'] = 'YOUR API KEY'
end
# Optionally, for local development, you can override the endpoint being used with the below:
Quake::Timesheets.configure do |config|
config.endpoint = 'http://localhost:3000'
end
api_instance = Quake::Timesheets::ApprovalTypesApi.new
opts = {
create_approval_types_input: Quake::Timesheets::CreateApprovalTypesInput.new({dataset_id: 'dataset_id_example', name: 'name_example', weight: 3.56}) # CreateApprovalTypesInput |
}
begin
#Create a new Approval Type
result = api_instance.create_approval_types(opts)
p result
rescue Quake::Timesheets::ApiError => e
puts "Exception when calling ApprovalTypesApi->create_approval_types: #{e}"
end
All URIs are relative to https://timesheetsapi.svc.lumbry.co.uk:443
Class | Method | HTTP request | Description |
---|---|---|---|
Quake::Timesheets::ApprovalTypesApi | create_approval_types | POST /api/v1/approval_types | Create a new Approval Type |
Quake::Timesheets::ApprovalTypesApi | index_approval_types | GET /api/v1/approval_types | Search for approval types matching filters |
Quake::Timesheets::ApprovalsApi | create_approvals | POST /api/v1/approvals | Create a new Approval |
Quake::Timesheets::ApprovalsApi | index_approvals | GET /api/v1/approvals | Search for approval types matching filters |
Quake::Timesheets::DatasetsApi | create_datasets | POST /api/v1/datasets | Create a new Dataset record |
Quake::Timesheets::DatasetsApi | index_datasets | GET /api/v1/datasets | List all available datasets |
Quake::Timesheets::DatasetsApi | show_datasets | GET /api/v1/datasets/{id} | Show details about a specific dataset |
Quake::Timesheets::EntriesApi | create_entries | POST /api/v1/entries | Create a new Entry |
Quake::Timesheets::EntriesApi | index_entries | GET /api/v1/entries | Search for entries matching filters |
Quake::Timesheets::EntriesApi | update_entries | PATCH /api/v1/entries/{id} | Update an existing Entry |
Quake::Timesheets::PeopleApi | create_people | POST /api/v1/people | Create a new Person record |
Quake::Timesheets::PeopleApi | index_people | GET /api/v1/people | Search for people matching filters |
- Quake::Timesheets::Approval
- Quake::Timesheets::ApprovalType
- Quake::Timesheets::CreateApprovalTypesInput
- Quake::Timesheets::CreateApprovalsInput
- Quake::Timesheets::CreateDatasetsInput
- Quake::Timesheets::CreateEntriesInput
- Quake::Timesheets::CreatePeopleInput
- Quake::Timesheets::Dataset
- Quake::Timesheets::Entry
- Quake::Timesheets::EntryTags
- Quake::Timesheets::Person
- Quake::Timesheets::UpdateEntriesInput
- Type: API key
- API key parameter name: authorization
- Location: HTTP header
When enabled, the additional information can be provided to the logger. To enable debug logging:
Quake::Timesheets.configure do |config|
config.debugging = true
end
This gem uses Faraday to manage the underlying http requests. Faraday supports middleware that can interact with the request and response directly before and after they are sent or received. This can be used to provide additional logic such as adding custom logging. See [https://lostisland.github.io/faraday/middleware/] for details
To add a middleware to be used do something like below:
Quake::Timesheets.configure do |config|
config.faraday_middlewares.push(MyMiddleware)
end