Skip to content

cakeflight/pinwheel-ruby

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
.openapi-generator
.openapi-generator
 
 
docs
docs
 
 
lib
lib
 
 
spec
spec
 
 
.gitignore
.gitignore
 
 
.openapi-generator-ignore
.openapi-generator-ignore
 
 
.rspec
.rspec
 
 
.rubocop.yml
.rubocop.yml
 
 
Gemfile
Gemfile
 
 
Gemfile.lock
Gemfile.lock
 
 
README.md
README.md
 
 
Rakefile
Rakefile
 
 
config.yaml
config.yaml
 
 
generate.sh
generate.sh
 
 
pinwheel.gemspec
pinwheel.gemspec
 
 

Repository files navigation

pinwheel

Pinwheel - the Ruby gem for the Pinwheel

Pinwheel is the API for Payroll

This SDK is automatically generated by the OpenAPI Generator project:

  • API version: v2023-11-22
  • Package version: 1.0.0
  • Generator version: 7.8.0
  • Build package: org.openapitools.codegen.languages.RubyClientCodegen For more information, please visit https://getpinwheel.com

Installation

Build a gem

To build the Ruby code into a gem:

gem build pinwheel.gemspec

Then either install the gem locally:

gem install ./pinwheel-1.0.0.gem

(for development, run gem install --dev ./pinwheel-1.0.0.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 'pinwheel', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'pinwheel', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'pinwheel'

api_instance = Pinwheel::PinwheelApi.new
pinwheel_version = '2023-11-22' # String | Version identifier specifying how the Pinwheel API should behave. See the Change Management page for more information.
create_admin_token_request = Pinwheel::CreateAdminTokenRequest.new({username: 'username_example', password: 'password_example'}) # CreateAdminTokenRequest | 

begin
  #Admin API Authentication
  result = api_instance.auth_v1_admin_token_post(pinwheel_version, create_admin_token_request)
  p result
rescue Pinwheel::ApiError => e
  puts "Exception when calling PinwheelApi->auth_v1_admin_token_post: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.getpinwheel.com/v1

Class Method HTTP request Description
Pinwheel::PinwheelApi auth_v1_admin_token_post POST /admin/token Admin API Authentication
Pinwheel::PinwheelApi create_key_v1_admin_api_keys_post POST /admin/api_keys Create an API Key
Pinwheel::PinwheelApi delete_v1_webhooks_webhook_id_delete DELETE /webhooks/{webhook_id} Delete Webhook
Pinwheel::PinwheelApi disable_monitoring_v1_accounts_account_id_disable_monitoring_post POST /accounts/{account_id}/disable_monitoring Disable monitoring for account
Pinwheel::PinwheelApi disconnect_v1_accounts_account_id_disconnect_post POST /accounts/{account_id}/disconnect Disconnect an account
Pinwheel::PinwheelApi get_account_v1_accounts_account_id_get GET /accounts/{account_id} Get Account
Pinwheel::PinwheelApi get_direct_deposit_allocations_v1_accounts_account_id_direct_deposit_allocations_get GET /accounts/{account_id}/direct_deposit_allocations Get Direct Deposit Allocations
Pinwheel::PinwheelApi get_earnings_stream_payouts_v1_end_users_end_user_id_earnings_stream_payouts_get GET /end_users/{end_user_id}/earnings_stream/payouts Get Earnings Stream Payouts
Pinwheel::PinwheelApi get_employer_v1_employers_employer_id_get GET /employers/{employer_id} Get Employer
Pinwheel::PinwheelApi get_employment_v1_accounts_account_id_employment_get GET /accounts/{account_id}/employment Get Employment
Pinwheel::PinwheelApi get_end_user_accounts_v1_end_users_end_user_id_accounts_get GET /end_users/{end_user_id}/accounts Get all end user accounts
Pinwheel::PinwheelApi get_end_user_document_v1_end_users_end_user_id_documents_document_id_get GET /end_users/{end_user_id}/documents/{document_id} Get Document
Pinwheel::PinwheelApi get_end_user_documents_v1_end_users_end_user_id_documents_get GET /end_users/{end_user_id}/documents List Documents
Pinwheel::PinwheelApi get_end_user_verification_reports_voe_v1_end_users_end_user_id_verification_reports_voe_get GET /end_users/{end_user_id}/verification_reports/voe Get Verification of Employment Report
Pinwheel::PinwheelApi get_end_user_verification_reports_voie_v1_end_users_end_user_id_verification_reports_voie_get GET /end_users/{end_user_id}/verification_reports/voie Get Verification of Income and Employment Report
Pinwheel::PinwheelApi get_identity_v1_accounts_account_id_identity_get GET /accounts/{account_id}/identity Get Identity
Pinwheel::PinwheelApi get_income_v1_accounts_account_id_income_get GET /accounts/{account_id}/income Get Income
Pinwheel::PinwheelApi get_jobs_v1_jobs_get GET /jobs List Completed Jobs
Pinwheel::PinwheelApi get_paystub_v1_accounts_account_id_paystubs_paystub_id_get GET /accounts/{account_id}/paystubs/{paystub_id} Get Paystub
Pinwheel::PinwheelApi get_platform_v1_platforms_platform_id_get GET /platforms/{platform_id} Get Platform
Pinwheel::PinwheelApi get_tax_form_v1_accounts_account_id_tax_forms_tax_form_id_get GET /accounts/{account_id}/tax_forms/{tax_form_id} Get Tax Form
Pinwheel::PinwheelApi get_v1_company_connections_company_connection_id_census_get GET /company_connections/{company_connection_id}/census List Employees
Pinwheel::PinwheelApi get_v1_company_connections_company_connection_id_employments_get GET /company_connections/{company_connection_id}/employments List Employments Data
Pinwheel::PinwheelApi get_v1_company_connections_company_connection_id_get GET /company_connections/{company_connection_id} Get Company Connection
Pinwheel::PinwheelApi get_v1_company_connections_company_connection_id_incomes_get GET /company_connections/{company_connection_id}/incomes List Employee Incomes
Pinwheel::PinwheelApi get_v1_company_connections_company_connection_id_paystubs_employee_external_id_get GET /company_connections/{company_connection_id}/paystubs/{employee_external_id} List Employee Paystubs
Pinwheel::PinwheelApi get_v1_employers_get GET /employers List Employers
Pinwheel::PinwheelApi get_v1_search_get GET /search Search Employers and Platforms
Pinwheel::PinwheelApi get_v1_webhooks_get GET /webhooks List Webhooks
Pinwheel::PinwheelApi get_webhook_by_id_v1_webhooks_webhook_id_get GET /webhooks/{webhook_id} Get Webhook
Pinwheel::PinwheelApi list_accounts_v1_accounts_get GET /accounts List Accounts
Pinwheel::PinwheelApi list_keys_v1_admin_api_keys_get GET /admin/api_keys List API Keys
Pinwheel::PinwheelApi list_paystubs_v1_accounts_account_id_paystubs_get GET /accounts/{account_id}/paystubs List Paystubs
Pinwheel::PinwheelApi list_platforms_v1_platforms_get GET /platforms List Platforms
Pinwheel::PinwheelApi list_shifts_v1_accounts_account_id_shifts_get GET /accounts/{account_id}/shifts List Shifts
Pinwheel::PinwheelApi list_tax_forms_v1_accounts_account_id_tax_forms_get GET /accounts/{account_id}/tax_forms List Tax Forms
Pinwheel::PinwheelApi list_v1_company_connections_get GET /company_connections List Company Connections
Pinwheel::PinwheelApi patch_monitoring_status_v1_sandbox_accounts_account_id_patch PATCH /sandbox/accounts/{account_id} Override an account's monitoring status
Pinwheel::PinwheelApi post_v1_company_connect_link_tokens_post POST /company_connect/link_tokens Create Link Token
Pinwheel::PinwheelApi post_v1_company_connections_post POST /company_connections Create Company Connection
Pinwheel::PinwheelApi post_v1_link_tokens_post POST /link_tokens Create Link Token
Pinwheel::PinwheelApi post_v1_webhooks_post POST /webhooks Create Webhook
Pinwheel::PinwheelApi put_v1_webhooks_webhook_id_put PUT /webhooks/{webhook_id} Update Webhook
Pinwheel::PinwheelApi revoke_key_v1_admin_api_keys_api_key_revoke_post POST /admin/api_keys/{api_key}/revoke Revoke an API Key

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

apiSecret

  • Type: API key
  • API key parameter name: X-API-SECRET
  • Location: HTTP header

bearerAuth

  • Type: Bearer authentication

About

Ruby wrapper for the Pinwheel API

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages