wcc_ministries_client
WCC::Ministries::Client - the Ruby gem for the WCC Ministries API
WCC Ministries API
This SDK is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
Installation
Build a gem
To build the Ruby code into a gem:
gem build wcc_ministries_client.gemspec
Then either install the gem locally:
gem install ./wcc_ministries_client-1.0.0.gem
(for development, run gem install --dev ./wcc_ministries_client-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 'wcc_ministries_client', '~> 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 'wcc_ministries_client', :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 'wcc_ministries_client'
api_instance = WCC::Ministries::Client::MinistryApi.new
id = 'id_example' # String | The UUID of the ministry
begin
#Get a single ministry by ID
result = api_instance.get_ministry(id)
p result
rescue WCC::Ministries::Client::ApiError => e
puts "Exception when calling MinistryApi->get_ministry: #{e}"
end
Documentation for API Endpoints
All URIs are relative to https://www.watermark.org/api/v1
Class | Method | HTTP request | Description |
---|---|---|---|
WCC::Ministries::Client::MinistryApi | get_ministry | GET /ministries/id | Get a single ministry by ID |
WCC::Ministries::Client::MinistryApi | list_ministries | GET /ministries | Query for a list of ministries matching some criteria |
Documentation for Models
- WCC::Ministries::Client::Asset
- WCC::Ministries::Client::AssetFile
- WCC::Ministries::Client::AssetFileDetails
- WCC::Ministries::Client::AssetFileDetailsImage
- WCC::Ministries::Client::CachingMeta
- WCC::Ministries::Client::DeletedMinistry
- WCC::Ministries::Client::InlineResponse200
- WCC::Ministries::Client::InlineResponse2001
- WCC::Ministries::Client::InlineResponse200Links
- WCC::Ministries::Client::InlineResponse200Meta
- WCC::Ministries::Client::Ministry
- WCC::Ministries::Client::MinistryAttributes
- WCC::Ministries::Client::MinistryLinks
- WCC::Ministries::Client::MinistryRelationships
- WCC::Ministries::Client::Page
- WCC::Ministries::Client::PageAttributes
- WCC::Ministries::Client::PageLinks
- WCC::Ministries::Client::PageRelationship
- WCC::Ministries::Client::PageRelationshipData
Documentation for Authorization
All endpoints do not require authorization.