wcc_ministries_client 1.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/Gemfile.lock +68 -0
- data/README.md +108 -0
- data/Rakefile +10 -0
- data/bin/gen +32 -0
- data/docs/Asset.md +22 -0
- data/docs/AssetFile.md +24 -0
- data/docs/AssetFileDetails.md +20 -0
- data/docs/AssetFileDetailsImage.md +20 -0
- data/docs/CachingMeta.md +20 -0
- data/docs/DeletedMinistry.md +20 -0
- data/docs/InlineResponse200.md +24 -0
- data/docs/InlineResponse2001.md +20 -0
- data/docs/InlineResponse200Links.md +26 -0
- data/docs/InlineResponse200Meta.md +22 -0
- data/docs/Ministry.md +28 -0
- data/docs/MinistryApi.md +141 -0
- data/docs/MinistryAttributes.md +24 -0
- data/docs/MinistryLinks.md +18 -0
- data/docs/MinistryRelationships.md +18 -0
- data/docs/Page.md +26 -0
- data/docs/PageAttributes.md +24 -0
- data/docs/PageLinks.md +18 -0
- data/docs/PageRelationship.md +18 -0
- data/docs/PageRelationshipData.md +20 -0
- data/git_push.sh +58 -0
- data/lib/wcc_ministries_client/api/ministry_api.rb +149 -0
- data/lib/wcc_ministries_client/api_client.rb +389 -0
- data/lib/wcc_ministries_client/api_error.rb +57 -0
- data/lib/wcc_ministries_client/configuration.rb +270 -0
- data/lib/wcc_ministries_client/models/asset.rb +244 -0
- data/lib/wcc_ministries_client/models/asset_file.rb +249 -0
- data/lib/wcc_ministries_client/models/asset_file_details.rb +226 -0
- data/lib/wcc_ministries_client/models/asset_file_details_image.rb +237 -0
- data/lib/wcc_ministries_client/models/caching_meta.rb +237 -0
- data/lib/wcc_ministries_client/models/deleted_ministry.rb +271 -0
- data/lib/wcc_ministries_client/models/inline_response200.rb +262 -0
- data/lib/wcc_ministries_client/models/inline_response2001.rb +232 -0
- data/lib/wcc_ministries_client/models/inline_response200_links.rb +272 -0
- data/lib/wcc_ministries_client/models/inline_response200_meta.rb +252 -0
- data/lib/wcc_ministries_client/models/ministry.rb +327 -0
- data/lib/wcc_ministries_client/models/ministry_attributes.rb +258 -0
- data/lib/wcc_ministries_client/models/ministry_links.rb +222 -0
- data/lib/wcc_ministries_client/models/ministry_relationships.rb +216 -0
- data/lib/wcc_ministries_client/models/page.rb +313 -0
- data/lib/wcc_ministries_client/models/page_attributes.rb +263 -0
- data/lib/wcc_ministries_client/models/page_links.rb +222 -0
- data/lib/wcc_ministries_client/models/page_relationship.rb +221 -0
- data/lib/wcc_ministries_client/models/page_relationship_data.rb +269 -0
- data/lib/wcc_ministries_client/version.rb +19 -0
- data/lib/wcc_ministries_client.rb +59 -0
- data/openapitools.json +23 -0
- data/pkg/wcc_ministries_client-1.0.0.gem +0 -0
- data/spec/api/ministry_api_spec.rb +60 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/asset_file_details_image_spec.rb +40 -0
- data/spec/models/asset_file_details_spec.rb +40 -0
- data/spec/models/asset_file_spec.rb +52 -0
- data/spec/models/asset_spec.rb +46 -0
- data/spec/models/caching_meta_spec.rb +40 -0
- data/spec/models/deleted_ministry_spec.rb +44 -0
- data/spec/models/inline_response2001_spec.rb +40 -0
- data/spec/models/inline_response200_links_spec.rb +58 -0
- data/spec/models/inline_response200_meta_spec.rb +46 -0
- data/spec/models/inline_response200_spec.rb +52 -0
- data/spec/models/ministry_attributes_spec.rb +52 -0
- data/spec/models/ministry_links_spec.rb +34 -0
- data/spec/models/ministry_relationships_spec.rb +34 -0
- data/spec/models/ministry_spec.rb +68 -0
- data/spec/models/page_attributes_spec.rb +52 -0
- data/spec/models/page_links_spec.rb +34 -0
- data/spec/models/page_relationship_data_spec.rb +44 -0
- data/spec/models/page_relationship_spec.rb +34 -0
- data/spec/models/page_spec.rb +62 -0
- data/spec/spec_helper.rb +111 -0
- data/swagger.json +425 -0
- data/wcc_ministries_client.gemspec +38 -0
- metadata +185 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: e71df5f928f6fd5460a7b60698857e34ca86db3b4aa3eeaa8efd9df5b4de6b73
|
4
|
+
data.tar.gz: 528af90f91850e658dd5bc71bb9bbad2a7e887554cf46733350ea5259fd486ce
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 50d810987b969b635b6e3999e2aa3ac04928050b7fd7c0accfb1dccf95e0d454d6f26e70b06d18f86262befacb9b9319cdd15ff3875af82397fe79d0e3f0c834
|
7
|
+
data.tar.gz: 2f32e510b65fb72664d81ebffe9499d1bfd5a6099459b152114a28c143eca499b2d9916f518240a3b708abd7741134be598ae13f807ae743a181119476ea07b0
|
data/Gemfile
ADDED
data/Gemfile.lock
ADDED
@@ -0,0 +1,68 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
wcc_ministries_client (1.0.1)
|
5
|
+
typhoeus (~> 1.0, >= 1.0.1)
|
6
|
+
|
7
|
+
GEM
|
8
|
+
remote: https://rubygems.org/
|
9
|
+
specs:
|
10
|
+
ast (2.4.2)
|
11
|
+
byebug (11.1.3)
|
12
|
+
coderay (1.1.3)
|
13
|
+
diff-lcs (1.4.4)
|
14
|
+
ethon (0.15.0)
|
15
|
+
ffi (>= 1.15.0)
|
16
|
+
ffi (1.15.4)
|
17
|
+
jaro_winkler (1.5.4)
|
18
|
+
method_source (1.0.0)
|
19
|
+
parallel (1.21.0)
|
20
|
+
parser (3.0.2.0)
|
21
|
+
ast (~> 2.4.1)
|
22
|
+
pry (0.13.1)
|
23
|
+
coderay (~> 1.1)
|
24
|
+
method_source (~> 1.0)
|
25
|
+
pry-byebug (3.9.0)
|
26
|
+
byebug (~> 11.0)
|
27
|
+
pry (~> 0.13.0)
|
28
|
+
psych (4.0.1)
|
29
|
+
rainbow (3.0.0)
|
30
|
+
rake (13.0.6)
|
31
|
+
rspec (3.10.0)
|
32
|
+
rspec-core (~> 3.10.0)
|
33
|
+
rspec-expectations (~> 3.10.0)
|
34
|
+
rspec-mocks (~> 3.10.0)
|
35
|
+
rspec-core (3.10.1)
|
36
|
+
rspec-support (~> 3.10.0)
|
37
|
+
rspec-expectations (3.10.1)
|
38
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
39
|
+
rspec-support (~> 3.10.0)
|
40
|
+
rspec-mocks (3.10.2)
|
41
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
42
|
+
rspec-support (~> 3.10.0)
|
43
|
+
rspec-support (3.10.2)
|
44
|
+
rubocop (0.66.0)
|
45
|
+
jaro_winkler (~> 1.5.1)
|
46
|
+
parallel (~> 1.10)
|
47
|
+
parser (>= 2.5, != 2.5.1.1)
|
48
|
+
psych (>= 3.1.0)
|
49
|
+
rainbow (>= 2.2.2, < 4.0)
|
50
|
+
ruby-progressbar (~> 1.7)
|
51
|
+
unicode-display_width (>= 1.4.0, < 1.6)
|
52
|
+
ruby-progressbar (1.11.0)
|
53
|
+
typhoeus (1.4.0)
|
54
|
+
ethon (>= 0.9.0)
|
55
|
+
unicode-display_width (1.5.0)
|
56
|
+
|
57
|
+
PLATFORMS
|
58
|
+
ruby
|
59
|
+
|
60
|
+
DEPENDENCIES
|
61
|
+
pry-byebug
|
62
|
+
rake (~> 13.0.1)
|
63
|
+
rspec (~> 3.6, >= 3.6.0)
|
64
|
+
rubocop (~> 0.66.0)
|
65
|
+
wcc_ministries_client!
|
66
|
+
|
67
|
+
BUNDLED WITH
|
68
|
+
1.17.3
|
data/README.md
ADDED
@@ -0,0 +1,108 @@
|
|
1
|
+
# wcc_ministries_client
|
2
|
+
|
3
|
+
WCC::Ministries::Client - the Ruby gem for the WCC Ministries API
|
4
|
+
|
5
|
+
WCC Ministries API
|
6
|
+
|
7
|
+
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
|
+
|
9
|
+
- API version: 1.0.0
|
10
|
+
- Package version: 1.0.0
|
11
|
+
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
|
+
|
13
|
+
## Installation
|
14
|
+
|
15
|
+
### Build a gem
|
16
|
+
|
17
|
+
To build the Ruby code into a gem:
|
18
|
+
|
19
|
+
```shell
|
20
|
+
gem build wcc_ministries_client.gemspec
|
21
|
+
```
|
22
|
+
|
23
|
+
Then either install the gem locally:
|
24
|
+
|
25
|
+
```shell
|
26
|
+
gem install ./wcc_ministries_client-1.0.0.gem
|
27
|
+
```
|
28
|
+
|
29
|
+
(for development, run `gem install --dev ./wcc_ministries_client-1.0.0.gem` to install the development dependencies)
|
30
|
+
|
31
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
32
|
+
|
33
|
+
Finally add this to the Gemfile:
|
34
|
+
|
35
|
+
gem 'wcc_ministries_client', '~> 1.0.0'
|
36
|
+
|
37
|
+
### Install from Git
|
38
|
+
|
39
|
+
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:
|
40
|
+
|
41
|
+
gem 'wcc_ministries_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
|
42
|
+
|
43
|
+
### Include the Ruby code directly
|
44
|
+
|
45
|
+
Include the Ruby code directly using `-I` as follows:
|
46
|
+
|
47
|
+
```shell
|
48
|
+
ruby -Ilib script.rb
|
49
|
+
```
|
50
|
+
|
51
|
+
## Getting Started
|
52
|
+
|
53
|
+
Please follow the [installation](#installation) procedure and then run the following code:
|
54
|
+
|
55
|
+
```ruby
|
56
|
+
# Load the gem
|
57
|
+
require 'wcc_ministries_client'
|
58
|
+
|
59
|
+
api_instance = WCC::Ministries::Client::MinistryApi.new
|
60
|
+
id = 'id_example' # String | The UUID of the ministry
|
61
|
+
|
62
|
+
begin
|
63
|
+
#Get a single ministry by ID
|
64
|
+
result = api_instance.get_ministry(id)
|
65
|
+
p result
|
66
|
+
rescue WCC::Ministries::Client::ApiError => e
|
67
|
+
puts "Exception when calling MinistryApi->get_ministry: #{e}"
|
68
|
+
end
|
69
|
+
|
70
|
+
```
|
71
|
+
|
72
|
+
## Documentation for API Endpoints
|
73
|
+
|
74
|
+
All URIs are relative to *https://www.watermark.org/api/v1/ministries*
|
75
|
+
|
76
|
+
Class | Method | HTTP request | Description
|
77
|
+
------------ | ------------- | ------------- | -------------
|
78
|
+
*WCC::Ministries::Client::MinistryApi* | [**get_ministry**](docs/MinistryApi.md#get_ministry) | **GET** /{id} | Get a single ministry by ID
|
79
|
+
*WCC::Ministries::Client::MinistryApi* | [**list_ministries**](docs/MinistryApi.md#list_ministries) | **GET** / | Query for a list of ministries matching some criteria
|
80
|
+
|
81
|
+
|
82
|
+
## Documentation for Models
|
83
|
+
|
84
|
+
- [WCC::Ministries::Client::Asset](docs/Asset.md)
|
85
|
+
- [WCC::Ministries::Client::AssetFile](docs/AssetFile.md)
|
86
|
+
- [WCC::Ministries::Client::AssetFileDetails](docs/AssetFileDetails.md)
|
87
|
+
- [WCC::Ministries::Client::AssetFileDetailsImage](docs/AssetFileDetailsImage.md)
|
88
|
+
- [WCC::Ministries::Client::CachingMeta](docs/CachingMeta.md)
|
89
|
+
- [WCC::Ministries::Client::DeletedMinistry](docs/DeletedMinistry.md)
|
90
|
+
- [WCC::Ministries::Client::InlineResponse200](docs/InlineResponse200.md)
|
91
|
+
- [WCC::Ministries::Client::InlineResponse2001](docs/InlineResponse2001.md)
|
92
|
+
- [WCC::Ministries::Client::InlineResponse200Links](docs/InlineResponse200Links.md)
|
93
|
+
- [WCC::Ministries::Client::InlineResponse200Meta](docs/InlineResponse200Meta.md)
|
94
|
+
- [WCC::Ministries::Client::Ministry](docs/Ministry.md)
|
95
|
+
- [WCC::Ministries::Client::MinistryAttributes](docs/MinistryAttributes.md)
|
96
|
+
- [WCC::Ministries::Client::MinistryLinks](docs/MinistryLinks.md)
|
97
|
+
- [WCC::Ministries::Client::MinistryRelationships](docs/MinistryRelationships.md)
|
98
|
+
- [WCC::Ministries::Client::Page](docs/Page.md)
|
99
|
+
- [WCC::Ministries::Client::PageAttributes](docs/PageAttributes.md)
|
100
|
+
- [WCC::Ministries::Client::PageLinks](docs/PageLinks.md)
|
101
|
+
- [WCC::Ministries::Client::PageRelationship](docs/PageRelationship.md)
|
102
|
+
- [WCC::Ministries::Client::PageRelationshipData](docs/PageRelationshipData.md)
|
103
|
+
|
104
|
+
|
105
|
+
## Documentation for Authorization
|
106
|
+
|
107
|
+
All endpoints do not require authorization.
|
108
|
+
|
data/Rakefile
ADDED
data/bin/gen
ADDED
@@ -0,0 +1,32 @@
|
|
1
|
+
#! /usr/bin/env bash
|
2
|
+
COLOR_NC='\033[0m' # No Color
|
3
|
+
COLOR_RED='\033[0;31m'
|
4
|
+
|
5
|
+
# https://stackoverflow.com/a/246128
|
6
|
+
SOURCE="${BASH_SOURCE[0]}"
|
7
|
+
while [ -h "$SOURCE" ]; do # resolve $SOURCE until the file is no longer a symlink
|
8
|
+
DIR="$( cd -P "$( dirname "$SOURCE" )" >/dev/null && pwd )"
|
9
|
+
SOURCE="$(readlink "$SOURCE")"
|
10
|
+
[[ $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
|
11
|
+
done
|
12
|
+
DIR="$( cd -P "$( dirname "$SOURCE" )" >/dev/null && pwd )"
|
13
|
+
|
14
|
+
panic() {
|
15
|
+
>&2 echo -e "${COLOR_RED}$@${COLOR_NC}"
|
16
|
+
exit 255;
|
17
|
+
}
|
18
|
+
|
19
|
+
cd "$DIR/.."
|
20
|
+
|
21
|
+
set -e
|
22
|
+
|
23
|
+
SWAGGER_JSON_URL=${1:-"$DIR/../../public/api/v1/ministries/swagger.json"}
|
24
|
+
|
25
|
+
echo "Downloading $SWAGGER_JSON_URL"
|
26
|
+
if [ -f "$SWAGGER_JSON_URL" ]; then
|
27
|
+
cp "$SWAGGER_JSON_URL" "./swagger.json"
|
28
|
+
else
|
29
|
+
curl --fail -o "./swagger.json" "$SWAGGER_JSON_URL"
|
30
|
+
fi
|
31
|
+
|
32
|
+
npx @openapitools/openapi-generator-cli generate
|
data/docs/Asset.md
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
# WCC::Ministries::Client::Asset
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **title** | **String** | | |
|
8
|
+
| **description** | **String** | | [optional] |
|
9
|
+
| **file** | [**AssetFile**](AssetFile.md) | | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'wcc_ministries_client'
|
15
|
+
|
16
|
+
instance = WCC::Ministries::Client::Asset.new(
|
17
|
+
title: Todd Wagner Square Profile Image,
|
18
|
+
description: Todd Wagner,
|
19
|
+
file: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
data/docs/AssetFile.md
ADDED
@@ -0,0 +1,24 @@
|
|
1
|
+
# WCC::Ministries::Client::AssetFile
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **url** | **String** | | |
|
8
|
+
| **file_name** | **String** | | [optional] |
|
9
|
+
| **content_type** | **String** | MIME type of image | [optional] |
|
10
|
+
| **details** | [**AssetFileDetails**](AssetFileDetails.md) | | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'wcc_ministries_client'
|
16
|
+
|
17
|
+
instance = WCC::Ministries::Client::AssetFile.new(
|
18
|
+
url: //images.ctfassets.net/a/b/Todd-Wagner_2016__1_.jpg,
|
19
|
+
file_name: Todd-Wagner_2016 (1).jpg,
|
20
|
+
content_type: image/jpeg,
|
21
|
+
details: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# WCC::Ministries::Client::AssetFileDetails
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **size** | **Float** | Size of file in bytes | [optional] |
|
8
|
+
| **image** | [**AssetFileDetailsImage**](AssetFileDetailsImage.md) | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'wcc_ministries_client'
|
14
|
+
|
15
|
+
instance = WCC::Ministries::Client::AssetFileDetails.new(
|
16
|
+
size: 55406,
|
17
|
+
image: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# WCC::Ministries::Client::AssetFileDetailsImage
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **width** | **Float** | width of image in pixels | |
|
8
|
+
| **height** | **Float** | height of image in pixels | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'wcc_ministries_client'
|
14
|
+
|
15
|
+
instance = WCC::Ministries::Client::AssetFileDetailsImage.new(
|
16
|
+
width: 700,
|
17
|
+
height: 700
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
data/docs/CachingMeta.md
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
# WCC::Ministries::Client::CachingMeta
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **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. | |
|
8
|
+
| **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. | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'wcc_ministries_client'
|
14
|
+
|
15
|
+
instance = WCC::Ministries::Client::CachingMeta.new(
|
16
|
+
e_tag: "67ca6661a69398674a62a1f2e55465d8",
|
17
|
+
last_modified: Mon, 27 Jul 2020 19:15:30 GMT
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# WCC::Ministries::Client::DeletedMinistry
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | The unique ID of the Ministry. | |
|
8
|
+
| **type** | **String** | Always the literal string 'deletedMinistry'. This is used as a discriminator. | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'wcc_ministries_client'
|
14
|
+
|
15
|
+
instance = WCC::Ministries::Client::DeletedMinistry.new(
|
16
|
+
id: 7mUCKHxu0sve8ecXAFLJ21,
|
17
|
+
type: deletedMinistry
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# WCC::Ministries::Client::InlineResponse200
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**Array<Ministry>**](Ministry.md) | | |
|
8
|
+
| **meta** | [**InlineResponse200Meta**](InlineResponse200Meta.md) | | |
|
9
|
+
| **links** | [**InlineResponse200Links**](InlineResponse200Links.md) | | |
|
10
|
+
| **included** | [**Array<Page>**](Page.md) | | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'wcc_ministries_client'
|
16
|
+
|
17
|
+
instance = WCC::Ministries::Client::InlineResponse200.new(
|
18
|
+
data: null,
|
19
|
+
meta: null,
|
20
|
+
links: null,
|
21
|
+
included: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# WCC::Ministries::Client::InlineResponse2001
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**Ministry**](Ministry.md) | | |
|
8
|
+
| **included** | [**Array<Page>**](Page.md) | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'wcc_ministries_client'
|
14
|
+
|
15
|
+
instance = WCC::Ministries::Client::InlineResponse2001.new(
|
16
|
+
data: null,
|
17
|
+
included: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# WCC::Ministries::Client::InlineResponse200Links
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **_self** | **String** | A relative link to get this page of ministries again | |
|
8
|
+
| **first** | **String** | A relative link to get the first page | |
|
9
|
+
| **prev** | **String** | A relative link to get the previous page (null if this is the first page) | [optional] |
|
10
|
+
| **_next** | **String** | A relative link to get the next page (null if this is the last page) | [optional] |
|
11
|
+
| **last** | **String** | A relative link to get the last page | |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'wcc_ministries_client'
|
17
|
+
|
18
|
+
instance = WCC::Ministries::Client::InlineResponse200Links.new(
|
19
|
+
_self: /api/v1/ministries?limit=10&skip=0,
|
20
|
+
first: /api/v1/ministries?limit=10&skip=0,
|
21
|
+
prev: null,
|
22
|
+
_next: /api/v1/ministries?limit=10&skip=10,
|
23
|
+
last: /api/v1/ministries?limit=10&skip=10
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# WCC::Ministries::Client::InlineResponse200Meta
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **total** | **Float** | The total number of ministries matching the query across all pages | |
|
8
|
+
| **limit** | **Float** | The page size | |
|
9
|
+
| **skip** | **Float** | The offset into the list at which this page starts | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'wcc_ministries_client'
|
15
|
+
|
16
|
+
instance = WCC::Ministries::Client::InlineResponse200Meta.new(
|
17
|
+
total: 1,
|
18
|
+
limit: 10,
|
19
|
+
skip: 0
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
data/docs/Ministry.md
ADDED
@@ -0,0 +1,28 @@
|
|
1
|
+
# WCC::Ministries::Client::Ministry
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | The unique ID of the Ministry. Used in the ministriesShow endpoint | |
|
8
|
+
| **type** | **String** | Always the literal string 'ministry'. This is used as a discriminator. | |
|
9
|
+
| **attributes** | [**MinistryAttributes**](MinistryAttributes.md) | | |
|
10
|
+
| **relationships** | [**MinistryRelationships**](MinistryRelationships.md) | | |
|
11
|
+
| **links** | [**MinistryLinks**](MinistryLinks.md) | | |
|
12
|
+
| **meta** | [**CachingMeta**](CachingMeta.md) | | |
|
13
|
+
|
14
|
+
## Example
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'wcc_ministries_client'
|
18
|
+
|
19
|
+
instance = WCC::Ministries::Client::Ministry.new(
|
20
|
+
id: 7mUCKHxu0sve8ecXAFLJ21,
|
21
|
+
type: ministry,
|
22
|
+
attributes: null,
|
23
|
+
relationships: null,
|
24
|
+
links: null,
|
25
|
+
meta: null
|
26
|
+
)
|
27
|
+
```
|
28
|
+
|
data/docs/MinistryApi.md
ADDED
@@ -0,0 +1,141 @@
|
|
1
|
+
# WCC::Ministries::Client::MinistryApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://www.watermark.org/api/v1/ministries*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**get_ministry**](MinistryApi.md#get_ministry) | **GET** /{id} | Get a single ministry by ID |
|
8
|
+
| [**list_ministries**](MinistryApi.md#list_ministries) | **GET** / | Query for a list of ministries matching some criteria |
|
9
|
+
|
10
|
+
|
11
|
+
## get_ministry
|
12
|
+
|
13
|
+
> <InlineResponse2001> get_ministry(id)
|
14
|
+
|
15
|
+
Get a single ministry by ID
|
16
|
+
|
17
|
+
### Examples
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'time'
|
21
|
+
require 'wcc_ministries_client'
|
22
|
+
|
23
|
+
api_instance = WCC::Ministries::Client::MinistryApi.new
|
24
|
+
id = 'id_example' # String | The UUID of the ministry
|
25
|
+
|
26
|
+
begin
|
27
|
+
# Get a single ministry by ID
|
28
|
+
result = api_instance.get_ministry(id)
|
29
|
+
p result
|
30
|
+
rescue WCC::Ministries::Client::ApiError => e
|
31
|
+
puts "Error when calling MinistryApi->get_ministry: #{e}"
|
32
|
+
end
|
33
|
+
```
|
34
|
+
|
35
|
+
#### Using the get_ministry_with_http_info variant
|
36
|
+
|
37
|
+
This returns an Array which contains the response data, status code and headers.
|
38
|
+
|
39
|
+
> <Array(<InlineResponse2001>, Integer, Hash)> get_ministry_with_http_info(id)
|
40
|
+
|
41
|
+
```ruby
|
42
|
+
begin
|
43
|
+
# Get a single ministry by ID
|
44
|
+
data, status_code, headers = api_instance.get_ministry_with_http_info(id)
|
45
|
+
p status_code # => 2xx
|
46
|
+
p headers # => { ... }
|
47
|
+
p data # => <InlineResponse2001>
|
48
|
+
rescue WCC::Ministries::Client::ApiError => e
|
49
|
+
puts "Error when calling MinistryApi->get_ministry_with_http_info: #{e}"
|
50
|
+
end
|
51
|
+
```
|
52
|
+
|
53
|
+
### Parameters
|
54
|
+
|
55
|
+
| Name | Type | Description | Notes |
|
56
|
+
| ---- | ---- | ----------- | ----- |
|
57
|
+
| **id** | **String** | The UUID of the ministry | |
|
58
|
+
|
59
|
+
### Return type
|
60
|
+
|
61
|
+
[**InlineResponse2001**](InlineResponse2001.md)
|
62
|
+
|
63
|
+
### Authorization
|
64
|
+
|
65
|
+
No authorization required
|
66
|
+
|
67
|
+
### HTTP request headers
|
68
|
+
|
69
|
+
- **Content-Type**: Not defined
|
70
|
+
- **Accept**: application/json
|
71
|
+
|
72
|
+
|
73
|
+
## list_ministries
|
74
|
+
|
75
|
+
> <InlineResponse200> list_ministries(opts)
|
76
|
+
|
77
|
+
Query for a list of ministries matching some criteria
|
78
|
+
|
79
|
+
Search for ministries by some query parameters
|
80
|
+
|
81
|
+
### Examples
|
82
|
+
|
83
|
+
```ruby
|
84
|
+
require 'time'
|
85
|
+
require 'wcc_ministries_client'
|
86
|
+
|
87
|
+
api_instance = WCC::Ministries::Client::MinistryApi.new
|
88
|
+
opts = {
|
89
|
+
filter_slug: 'filter_slug_example', # String | Match a single ministry by unique slug
|
90
|
+
skip: 56, # Integer | Number of records to skip for pagination
|
91
|
+
limit: 56 # Integer | Number of records to return in this page
|
92
|
+
}
|
93
|
+
|
94
|
+
begin
|
95
|
+
# Query for a list of ministries matching some criteria
|
96
|
+
result = api_instance.list_ministries(opts)
|
97
|
+
p result
|
98
|
+
rescue WCC::Ministries::Client::ApiError => e
|
99
|
+
puts "Error when calling MinistryApi->list_ministries: #{e}"
|
100
|
+
end
|
101
|
+
```
|
102
|
+
|
103
|
+
#### Using the list_ministries_with_http_info variant
|
104
|
+
|
105
|
+
This returns an Array which contains the response data, status code and headers.
|
106
|
+
|
107
|
+
> <Array(<InlineResponse200>, Integer, Hash)> list_ministries_with_http_info(opts)
|
108
|
+
|
109
|
+
```ruby
|
110
|
+
begin
|
111
|
+
# Query for a list of ministries matching some criteria
|
112
|
+
data, status_code, headers = api_instance.list_ministries_with_http_info(opts)
|
113
|
+
p status_code # => 2xx
|
114
|
+
p headers # => { ... }
|
115
|
+
p data # => <InlineResponse200>
|
116
|
+
rescue WCC::Ministries::Client::ApiError => e
|
117
|
+
puts "Error when calling MinistryApi->list_ministries_with_http_info: #{e}"
|
118
|
+
end
|
119
|
+
```
|
120
|
+
|
121
|
+
### Parameters
|
122
|
+
|
123
|
+
| Name | Type | Description | Notes |
|
124
|
+
| ---- | ---- | ----------- | ----- |
|
125
|
+
| **filter_slug** | **String** | Match a single ministry by unique slug | [optional] |
|
126
|
+
| **skip** | **Integer** | Number of records to skip for pagination | [optional] |
|
127
|
+
| **limit** | **Integer** | Number of records to return in this page | [optional] |
|
128
|
+
|
129
|
+
### Return type
|
130
|
+
|
131
|
+
[**InlineResponse200**](InlineResponse200.md)
|
132
|
+
|
133
|
+
### Authorization
|
134
|
+
|
135
|
+
No authorization required
|
136
|
+
|
137
|
+
### HTTP request headers
|
138
|
+
|
139
|
+
- **Content-Type**: Not defined
|
140
|
+
- **Accept**: application/json
|
141
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# WCC::Ministries::Client::MinistryAttributes
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **code** | **String** | | |
|
8
|
+
| **title** | **String** | | |
|
9
|
+
| **descriptive_title** | **String** | | |
|
10
|
+
| **display_in_internal_search** | **Boolean** | | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'wcc_ministries_client'
|
16
|
+
|
17
|
+
instance = WCC::Ministries::Client::MinistryAttributes.new(
|
18
|
+
code: re-generation,
|
19
|
+
title: Re:Generation,
|
20
|
+
descriptive_title: A biblically-based 12-step recovery program,
|
21
|
+
display_in_internal_search: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# WCC::Ministries::Client::MinistryLinks
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **_self** | **String** | A relative link to get this JSON from the API | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'wcc_ministries_client'
|
13
|
+
|
14
|
+
instance = WCC::Ministries::Client::MinistryLinks.new(
|
15
|
+
_self: /api/v1/ministries/7mUCKHxu0sve8ecXAFLJ21
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|