wheniwork-ruby 1.0.0

data/docs/DefaultApi.md

@@ -0,0 +1,240 @@
+# WhenIWork::Api
+
+All URIs are relative to *https://api.wheniwork.com/2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_positions**](Api.md#get_positions) | **GET** /positions |
+[**get_shift**](Api.md#get_shift) | **GET** /shifts/{shift-id} |
+[**get_shifts**](Api.md#get_shifts) | **GET** /shifts |
+[**get_user**](Api.md#get_user) | **GET** /users/{user-id} |
+
+
+# **get_positions**
+> InlineResponse200 get_positions(opts)
+
+
+
+This method allows you to get a list of all positions in your account.
+
+### Example
+```ruby
+# load the gem
+require 'wheniwork-ruby'
+# setup authorization
+WhenIWork.configure do |config|
+  # Configure API key authorization: apiKey
+  config.api_key['W-Token'] = '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['W-Token'] = 'Bearer'
+end
+
+api_instance = WhenIWork::Api.new
+
+opts = {
+  show_deleted: true # BOOLEAN | Whether to show positions that have been deleted.
+}
+
+begin
+  result = api_instance.get_positions(opts)
+  p result
+rescue WhenIWork::ApiError => e
+  puts "Exception when calling Api->get_positions: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **show_deleted** | **BOOLEAN**| Whether to show positions that have been deleted. | [optional]
+
+### Return type
+
+[**InlineResponse200**](InlineResponse200.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_shift**
+> InlineResponse2002 get_shift(shift_id)
+
+
+
+Gets the details of an existing shift.
+
+### Example
+```ruby
+# load the gem
+require 'wheniwork-ruby'
+# setup authorization
+WhenIWork.configure do |config|
+  # Configure API key authorization: apiKey
+  config.api_key['W-Token'] = '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['W-Token'] = 'Bearer'
+end
+
+api_instance = WhenIWork::Api.new
+
+shift_id = 56 # Integer | max records to return
+
+
+begin
+  result = api_instance.get_shift(shift_id)
+  p result
+rescue WhenIWork::ApiError => e
+  puts "Exception when calling Api->get_shift: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **shift_id** | **Integer**| max records to return |
+
+### Return type
+
+[**InlineResponse2002**](InlineResponse2002.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_shifts**
+> InlineResponse2001 get_shifts(opts)
+
+
+
+Get a list of shifts.
+
+### Example
+```ruby
+# load the gem
+require 'wheniwork-ruby'
+# setup authorization
+WhenIWork.configure do |config|
+  # Configure API key authorization: apiKey
+  config.api_key['W-Token'] = '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['W-Token'] = 'Bearer'
+end
+
+api_instance = WhenIWork::Api.new
+
+opts = {
+  user_id: "user_id_example", # String | The ID of the user to get shifts for. For multiple users, enter a list of user IDs separated by commas (e.g. 1,5,3).
+  start: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | Start time for the search window. The default is the current date and time
+  _end: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | End time for the search window. The default is exactly three days from the start time.
+  location_id: "location_id_example", # String | The ID of the location to get shifts for. For multiple locations, enter a list of location IDs separated by commas.
+  position_id: "position_id_example", # String | The ID of the position to get shifts for. For multiple position, enter a list of position IDs separated by commas.
+  include_open: true, # BOOLEAN | Whether to include OpenShifts in the results.
+  include_onlyopen: true, # BOOLEAN | Whether to include OpenShifts in the results.
+  unpublished: true # BOOLEAN | Whether unpublished shifts should be included in the results.
+}
+
+begin
+  result = api_instance.get_shifts(opts)
+  p result
+rescue WhenIWork::ApiError => e
+  puts "Exception when calling Api->get_shifts: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **String**| The ID of the user to get shifts for. For multiple users, enter a list of user IDs separated by commas (e.g. 1,5,3). | [optional]
+ **start** | **DateTime**| Start time for the search window. The default is the current date and time | [optional]
+ **_end** | **DateTime**| End time for the search window. The default is exactly three days from the start time. | [optional]
+ **location_id** | **String**| The ID of the location to get shifts for. For multiple locations, enter a list of location IDs separated by commas. | [optional]
+ **position_id** | **String**| The ID of the position to get shifts for. For multiple position, enter a list of position IDs separated by commas. | [optional]
+ **include_open** | **BOOLEAN**| Whether to include OpenShifts in the results. | [optional]
+ **include_onlyopen** | **BOOLEAN**| Whether to include OpenShifts in the results. | [optional]
+ **unpublished** | **BOOLEAN**| Whether unpublished shifts should be included in the results. | [optional]
+
+### Return type
+
+[**InlineResponse2001**](InlineResponse2001.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_user**
+> InlineResponse2003 get_user(user_id)
+
+
+
+Get a specific user by their ID.
+
+### Example
+```ruby
+# load the gem
+require 'wheniwork-ruby'
+# setup authorization
+WhenIWork.configure do |config|
+  # Configure API key authorization: apiKey
+  config.api_key['W-Token'] = '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['W-Token'] = 'Bearer'
+end
+
+api_instance = WhenIWork::Api.new
+
+user_id = 56 # Integer | The user identifier number
+
+
+begin
+  result = api_instance.get_user(user_id)
+  p result
+rescue WhenIWork::ApiError => e
+  puts "Exception when calling Api->get_user: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **Integer**| The user identifier number |
+
+### Return type
+
+[**InlineResponse2003**](InlineResponse2003.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/InlineResponse200.md

@@ -0,0 +1,8 @@
+# WhenIWork::InlineResponse200
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**positions** | [**Array<Position>**](Position.md) |  | [optional] 
+
+

data/docs/InlineResponse2001.md

@@ -0,0 +1,10 @@
+# WhenIWork::InlineResponse2001
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**start** | **DateTime** |  | [optional] 
+**_end** | **DateTime** |  | [optional] 
+**shifts** | [**Array<Shift>**](Shift.md) |  | [optional] 
+
+

data/docs/InlineResponse2002.md

@@ -0,0 +1,8 @@
+# WhenIWork::InlineResponse2002
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**shift** | [**Shift**](Shift.md) |  | [optional] 
+
+

data/docs/InlineResponse2003.md

@@ -0,0 +1,8 @@
+# WhenIWork::InlineResponse2003
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user** | [**User**](User.md) |  | [optional] 
+
+

data/docs/Position.md

@@ -0,0 +1,11 @@
+# WhenIWork::Position
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**name** | **String** |  | [optional] 
+**color** | **String** |  | [optional] 
+**sort** | **Integer** |  | [optional] 
+
+

data/docs/Shift.md

@@ -0,0 +1,20 @@
+# WhenIWork::Shift
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**start_time** | **DateTime** |  | [optional] 
+**end_time** | **DateTime** |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+**notified_at** | **DateTime** |  | [optional] 
+**id** | **Integer** |  | [optional] 
+**account_id** | **Integer** |  | [optional] 
+**user_id** | **Integer** |  | [optional] 
+**location_id** | **Integer** |  | [optional] 
+**alerted** | **BOOLEAN** |  | [optional] 
+**is_open** | **BOOLEAN** |  | [optional] 
+**acknowledged** | **Integer** |  | [optional] 
+**notes** | **String** |  | [optional] 
+
+

data/docs/User.md

@@ -0,0 +1,17 @@
+# WhenIWork::User
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**account_id** | **Integer** |  | [optional] 
+**role** | **Integer** |  | [optional] 
+**email** | **String** |  | [optional] 
+**first_name** | **String** |  | [optional] 
+**last_name** | **String** |  | [optional] 
+**phone_number** | **String** |  | [optional] 
+**employee_code** | **String** |  | [optional] 
+**positions** | **Array<Integer>** |  | [optional] 
+**locations** | **Array<Integer>** |  | [optional] 
+
+

data/git_push.sh

@@ -0,0 +1,67 @@
+#!/bin/sh
+#
+# Generated by: https://github.com/swagger-api/swagger-codegen.git
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git crediential in your environment."
+        git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

data/lib/wheniwork-ruby.rb

@@ -0,0 +1,56 @@
+=begin
+Wheniwork
+
+OpenAPI spec version: v2
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+=end
+
+# Common files
+require 'wheniwork-ruby/api_client'
+require 'wheniwork-ruby/api_error'
+require 'wheniwork-ruby/version'
+require 'wheniwork-ruby/configuration'
+
+# Models
+require 'wheniwork-ruby/models/inline_response_200'
+require 'wheniwork-ruby/models/inline_response_200_1'
+require 'wheniwork-ruby/models/inline_response_200_2'
+require 'wheniwork-ruby/models/inline_response_200_3'
+require 'wheniwork-ruby/models/position'
+require 'wheniwork-ruby/models/shift'
+require 'wheniwork-ruby/models/user'
+
+# APIs
+require 'wheniwork-ruby/api/api'
+
+module WhenIWork
+  class << self
+    # Customize default settings for the SDK using block.
+    #   WhenIWork.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end