wcc_ministries_client 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e71df5f928f6fd5460a7b60698857e34ca86db3b4aa3eeaa8efd9df5b4de6b73
+  data.tar.gz: 528af90f91850e658dd5bc71bb9bbad2a7e887554cf46733350ea5259fd486ce
+SHA512:
+  metadata.gz: 50d810987b969b635b6e3999e2aa3ac04928050b7fd7c0accfb1dccf95e0d454d6f26e70b06d18f86262befacb9b9319cdd15ff3875af82397fe79d0e3f0c834
+  data.tar.gz: 2f32e510b65fb72664d81ebffe9499d1bfd5a6099459b152114a28c143eca499b2d9916f518240a3b708abd7741134be598ae13f807ae743a181119476ea07b0

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/Gemfile.lock

@@ -0,0 +1,68 @@
+PATH
+  remote: .
+  specs:
+    wcc_ministries_client (1.0.1)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    ethon (0.15.0)
+      ffi (>= 1.15.0)
+    ffi (1.15.4)
+    jaro_winkler (1.5.4)
+    method_source (1.0.0)
+    parallel (1.21.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    psych (4.0.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (0.66.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    ruby-progressbar (1.11.0)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
+    unicode-display_width (1.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pry-byebug
+  rake (~> 13.0.1)
+  rspec (~> 3.6, >= 3.6.0)
+  rubocop (~> 0.66.0)
+  wcc_ministries_client!
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -0,0 +1,108 @@
+# 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](https://openapi-generator.tech) 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:
+
+```shell
+gem build wcc_ministries_client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+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](https://rubygems.org/).
+
+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:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# 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/ministries*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*WCC::Ministries::Client::MinistryApi* | [**get_ministry**](docs/MinistryApi.md#get_ministry) | **GET** /{id} | Get a single ministry by ID
+*WCC::Ministries::Client::MinistryApi* | [**list_ministries**](docs/MinistryApi.md#list_ministries) | **GET** / | Query for a list of ministries matching some criteria
+
+
+## Documentation for Models
+
+ - [WCC::Ministries::Client::Asset](docs/Asset.md)
+ - [WCC::Ministries::Client::AssetFile](docs/AssetFile.md)
+ - [WCC::Ministries::Client::AssetFileDetails](docs/AssetFileDetails.md)
+ - [WCC::Ministries::Client::AssetFileDetailsImage](docs/AssetFileDetailsImage.md)
+ - [WCC::Ministries::Client::CachingMeta](docs/CachingMeta.md)
+ - [WCC::Ministries::Client::DeletedMinistry](docs/DeletedMinistry.md)
+ - [WCC::Ministries::Client::InlineResponse200](docs/InlineResponse200.md)
+ - [WCC::Ministries::Client::InlineResponse2001](docs/InlineResponse2001.md)
+ - [WCC::Ministries::Client::InlineResponse200Links](docs/InlineResponse200Links.md)
+ - [WCC::Ministries::Client::InlineResponse200Meta](docs/InlineResponse200Meta.md)
+ - [WCC::Ministries::Client::Ministry](docs/Ministry.md)
+ - [WCC::Ministries::Client::MinistryAttributes](docs/MinistryAttributes.md)
+ - [WCC::Ministries::Client::MinistryLinks](docs/MinistryLinks.md)
+ - [WCC::Ministries::Client::MinistryRelationships](docs/MinistryRelationships.md)
+ - [WCC::Ministries::Client::Page](docs/Page.md)
+ - [WCC::Ministries::Client::PageAttributes](docs/PageAttributes.md)
+ - [WCC::Ministries::Client::PageLinks](docs/PageLinks.md)
+ - [WCC::Ministries::Client::PageRelationship](docs/PageRelationship.md)
+ - [WCC::Ministries::Client::PageRelationshipData](docs/PageRelationshipData.md)
+
+
+## Documentation for Authorization
+
+ All endpoints do not require authorization.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/bin/gen

@@ -0,0 +1,32 @@
+#! /usr/bin/env bash
+COLOR_NC='\033[0m' # No Color
+COLOR_RED='\033[0;31m'
+
+# https://stackoverflow.com/a/246128
+SOURCE="${BASH_SOURCE[0]}"
+while [ -h "$SOURCE" ]; do # resolve $SOURCE until the file is no longer a symlink
+  DIR="$( cd -P "$( dirname "$SOURCE" )" >/dev/null && pwd )"
+  SOURCE="$(readlink "$SOURCE")"
+  [[ $SOURCE != /* ]] && SOURCE="$DIR/$SOURCE" # if $SOURCE was a relative symlink, we need to resolve it relative to the path where the symlink file was located
+done
+DIR="$( cd -P "$( dirname "$SOURCE" )" >/dev/null && pwd )"
+
+panic() {
+  >&2 echo -e "${COLOR_RED}$@${COLOR_NC}"
+  exit 255;
+}
+
+cd "$DIR/.."
+
+set -e
+
+SWAGGER_JSON_URL=${1:-"$DIR/../../public/api/v1/ministries/swagger.json"}
+
+echo "Downloading $SWAGGER_JSON_URL"
+if [ -f "$SWAGGER_JSON_URL" ]; then
+  cp "$SWAGGER_JSON_URL" "./swagger.json" 
+else
+  curl --fail -o "./swagger.json" "$SWAGGER_JSON_URL"
+fi
+
+npx @openapitools/openapi-generator-cli generate

data/docs/Asset.md

@@ -0,0 +1,22 @@
+# WCC::Ministries::Client::Asset
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **title** | **String** |  |  |
+| **description** | **String** |  | [optional] |
+| **file** | [**AssetFile**](AssetFile.md) |  |  |
+
+## Example
+
+```ruby
+require 'wcc_ministries_client'
+
+instance = WCC::Ministries::Client::Asset.new(
+  title: Todd Wagner Square Profile Image,
+  description: Todd Wagner,
+  file: null
+)
+```
+

data/docs/AssetFile.md

@@ -0,0 +1,24 @@
+# WCC::Ministries::Client::AssetFile
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** |  |  |
+| **file_name** | **String** |  | [optional] |
+| **content_type** | **String** | MIME type of image | [optional] |
+| **details** | [**AssetFileDetails**](AssetFileDetails.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'wcc_ministries_client'
+
+instance = WCC::Ministries::Client::AssetFile.new(
+  url: //images.ctfassets.net/a/b/Todd-Wagner_2016__1_.jpg,
+  file_name: Todd-Wagner_2016 (1).jpg,
+  content_type: image/jpeg,
+  details: null
+)
+```
+

data/docs/AssetFileDetails.md

@@ -0,0 +1,20 @@
+# WCC::Ministries::Client::AssetFileDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **size** | **Float** | Size of file in bytes | [optional] |
+| **image** | [**AssetFileDetailsImage**](AssetFileDetailsImage.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'wcc_ministries_client'
+
+instance = WCC::Ministries::Client::AssetFileDetails.new(
+  size: 55406,
+  image: null
+)
+```
+

data/docs/AssetFileDetailsImage.md

@@ -0,0 +1,20 @@
+# WCC::Ministries::Client::AssetFileDetailsImage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **width** | **Float** | width of image in pixels |  |
+| **height** | **Float** | height of image in pixels |  |
+
+## Example
+
+```ruby
+require 'wcc_ministries_client'
+
+instance = WCC::Ministries::Client::AssetFileDetailsImage.new(
+  width: 700,
+  height: 700
+)
+```
+

data/docs/CachingMeta.md

@@ -0,0 +1,20 @@
+# WCC::Ministries::Client::CachingMeta
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **e_tag** | **String** | The strong ETag is a digest of this resource.  You can use the 'If-None-Match' HTTP header to do a conditional GET to the 'self' link of this person.  Note the explicit quotation marks in the string - these must be included in the HTTP header. |  |
+| **last_modified** | **String** | A timestamp when this resource was last modified.  You can use the 'If-Modified-Since' HTTP header to do a conditional GET to the 'self' link of this person. |  |
+
+## Example
+
+```ruby
+require 'wcc_ministries_client'
+
+instance = WCC::Ministries::Client::CachingMeta.new(
+  e_tag: "67ca6661a69398674a62a1f2e55465d8",
+  last_modified: Mon, 27 Jul 2020 19:15:30 GMT
+)
+```
+

data/docs/DeletedMinistry.md

@@ -0,0 +1,20 @@
+# WCC::Ministries::Client::DeletedMinistry
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The unique ID of the Ministry. |  |
+| **type** | **String** | Always the literal string 'deletedMinistry'.  This is used as a discriminator. |  |
+
+## Example
+
+```ruby
+require 'wcc_ministries_client'
+
+instance = WCC::Ministries::Client::DeletedMinistry.new(
+  id: 7mUCKHxu0sve8ecXAFLJ21,
+  type: deletedMinistry
+)
+```
+

data/docs/InlineResponse200.md

@@ -0,0 +1,24 @@
+# WCC::Ministries::Client::InlineResponse200
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<Ministry>**](Ministry.md) |  |  |
+| **meta** | [**InlineResponse200Meta**](InlineResponse200Meta.md) |  |  |
+| **links** | [**InlineResponse200Links**](InlineResponse200Links.md) |  |  |
+| **included** | [**Array<Page>**](Page.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'wcc_ministries_client'
+
+instance = WCC::Ministries::Client::InlineResponse200.new(
+  data: null,
+  meta: null,
+  links: null,
+  included: null
+)
+```
+

data/docs/InlineResponse2001.md

@@ -0,0 +1,20 @@
+# WCC::Ministries::Client::InlineResponse2001
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Ministry**](Ministry.md) |  |  |
+| **included** | [**Array<Page>**](Page.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'wcc_ministries_client'
+
+instance = WCC::Ministries::Client::InlineResponse2001.new(
+  data: null,
+  included: null
+)
+```
+

data/docs/InlineResponse200Links.md

@@ -0,0 +1,26 @@
+# WCC::Ministries::Client::InlineResponse200Links
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_self** | **String** | A relative link to get this page of ministries again |  |
+| **first** | **String** | A relative link to get the first page |  |
+| **prev** | **String** | A relative link to get the previous page (null if this is the first page) | [optional] |
+| **_next** | **String** | A relative link to get the next page (null if this is the last page) | [optional] |
+| **last** | **String** | A relative link to get the last page |  |
+
+## Example
+
+```ruby
+require 'wcc_ministries_client'
+
+instance = WCC::Ministries::Client::InlineResponse200Links.new(
+  _self: /api/v1/ministries?limit=10&skip=0,
+  first: /api/v1/ministries?limit=10&skip=0,
+  prev: null,
+  _next: /api/v1/ministries?limit=10&skip=10,
+  last: /api/v1/ministries?limit=10&skip=10
+)
+```
+

data/docs/InlineResponse200Meta.md

@@ -0,0 +1,22 @@
+# WCC::Ministries::Client::InlineResponse200Meta
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **total** | **Float** | The total number of ministries matching the query across all pages |  |
+| **limit** | **Float** | The page size |  |
+| **skip** | **Float** | The offset into the list at which this page starts |  |
+
+## Example
+
+```ruby
+require 'wcc_ministries_client'
+
+instance = WCC::Ministries::Client::InlineResponse200Meta.new(
+  total: 1,
+  limit: 10,
+  skip: 0
+)
+```
+

data/docs/Ministry.md

@@ -0,0 +1,28 @@
+# WCC::Ministries::Client::Ministry
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The unique ID of the Ministry.  Used in the ministriesShow endpoint |  |
+| **type** | **String** | Always the literal string 'ministry'.  This is used as a discriminator. |  |
+| **attributes** | [**MinistryAttributes**](MinistryAttributes.md) |  |  |
+| **relationships** | [**MinistryRelationships**](MinistryRelationships.md) |  |  |
+| **links** | [**MinistryLinks**](MinistryLinks.md) |  |  |
+| **meta** | [**CachingMeta**](CachingMeta.md) |  |  |
+
+## Example
+
+```ruby
+require 'wcc_ministries_client'
+
+instance = WCC::Ministries::Client::Ministry.new(
+  id: 7mUCKHxu0sve8ecXAFLJ21,
+  type: ministry,
+  attributes: null,
+  relationships: null,
+  links: null,
+  meta: null
+)
+```
+

data/docs/MinistryApi.md

@@ -0,0 +1,141 @@
+# WCC::Ministries::Client::MinistryApi
+
+All URIs are relative to *https://www.watermark.org/api/v1/ministries*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_ministry**](MinistryApi.md#get_ministry) | **GET** /{id} | Get a single ministry by ID |
+| [**list_ministries**](MinistryApi.md#list_ministries) | **GET** / | Query for a list of ministries matching some criteria |
+
+
+## get_ministry
+
+> <InlineResponse2001> get_ministry(id)
+
+Get a single ministry by ID
+
+### Examples
+
+```ruby
+require 'time'
+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 "Error when calling MinistryApi->get_ministry: #{e}"
+end
+```
+
+#### Using the get_ministry_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InlineResponse2001>, Integer, Hash)> get_ministry_with_http_info(id)
+
+```ruby
+begin
+  # Get a single ministry by ID
+  data, status_code, headers = api_instance.get_ministry_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InlineResponse2001>
+rescue WCC::Ministries::Client::ApiError => e
+  puts "Error when calling MinistryApi->get_ministry_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The UUID of the ministry |  |
+
+### Return type
+
+[**InlineResponse2001**](InlineResponse2001.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_ministries
+
+> <InlineResponse200> list_ministries(opts)
+
+Query for a list of ministries matching some criteria
+
+Search for ministries by some query parameters 
+
+### Examples
+
+```ruby
+require 'time'
+require 'wcc_ministries_client'
+
+api_instance = WCC::Ministries::Client::MinistryApi.new
+opts = {
+  filter_slug: 'filter_slug_example', # String | Match a single ministry by unique slug
+  skip: 56, # Integer | Number of records to skip for pagination
+  limit: 56 # Integer | Number of records to return in this page
+}
+
+begin
+  # Query for a list of ministries matching some criteria
+  result = api_instance.list_ministries(opts)
+  p result
+rescue WCC::Ministries::Client::ApiError => e
+  puts "Error when calling MinistryApi->list_ministries: #{e}"
+end
+```
+
+#### Using the list_ministries_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InlineResponse200>, Integer, Hash)> list_ministries_with_http_info(opts)
+
+```ruby
+begin
+  # Query for a list of ministries matching some criteria
+  data, status_code, headers = api_instance.list_ministries_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InlineResponse200>
+rescue WCC::Ministries::Client::ApiError => e
+  puts "Error when calling MinistryApi->list_ministries_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **filter_slug** | **String** | Match a single ministry by unique slug | [optional] |
+| **skip** | **Integer** | Number of records to skip for pagination | [optional] |
+| **limit** | **Integer** | Number of records to return in this page | [optional] |
+
+### Return type
+
+[**InlineResponse200**](InlineResponse200.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/MinistryAttributes.md

@@ -0,0 +1,24 @@
+# WCC::Ministries::Client::MinistryAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** |  |  |
+| **title** | **String** |  |  |
+| **descriptive_title** | **String** |  |  |
+| **display_in_internal_search** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'wcc_ministries_client'
+
+instance = WCC::Ministries::Client::MinistryAttributes.new(
+  code: re-generation,
+  title: Re:Generation,
+  descriptive_title: A biblically-based 12-step recovery program,
+  display_in_internal_search: null
+)
+```
+

data/docs/MinistryLinks.md

@@ -0,0 +1,18 @@
+# WCC::Ministries::Client::MinistryLinks
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_self** | **String** | A relative link to get this JSON from the API |  |
+
+## Example
+
+```ruby
+require 'wcc_ministries_client'
+
+instance = WCC::Ministries::Client::MinistryLinks.new(
+  _self: /api/v1/ministries/7mUCKHxu0sve8ecXAFLJ21
+)
+```
+