BmltClient 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/BmltClient.gemspec +38 -0
- data/Gemfile +9 -0
- data/Makefile +22 -0
- data/README.md +157 -0
- data/Rakefile +10 -0
- data/docs/AuthenticationError.md +18 -0
- data/docs/AuthorizationError.md +18 -0
- data/docs/ErrorTest.md +22 -0
- data/docs/Format.md +24 -0
- data/docs/FormatAllOf.md +18 -0
- data/docs/FormatBase.md +22 -0
- data/docs/FormatCreate.md +22 -0
- data/docs/FormatPartialUpdate.md +22 -0
- data/docs/FormatTranslation.md +24 -0
- data/docs/FormatUpdate.md +22 -0
- data/docs/Meeting.md +90 -0
- data/docs/MeetingBase.md +88 -0
- data/docs/MeetingCreate.md +88 -0
- data/docs/MeetingPartialUpdate.md +88 -0
- data/docs/MeetingUpdate.md +88 -0
- data/docs/NotFoundError.md +18 -0
- data/docs/RootServerApi.md +1958 -0
- data/docs/ServerError.md +18 -0
- data/docs/ServiceBody.md +38 -0
- data/docs/ServiceBodyBase.md +36 -0
- data/docs/ServiceBodyCreate.md +36 -0
- data/docs/ServiceBodyPartialUpdate.md +36 -0
- data/docs/ServiceBodyUpdate.md +36 -0
- data/docs/Token.md +24 -0
- data/docs/TokenCredentials.md +20 -0
- data/docs/User.md +30 -0
- data/docs/UserBase.md +28 -0
- data/docs/UserCreate.md +30 -0
- data/docs/UserCreateAllOf.md +18 -0
- data/docs/UserPartialUpdate.md +30 -0
- data/docs/UserUpdate.md +30 -0
- data/docs/ValidationError.md +20 -0
- data/git_push.sh +57 -0
- data/lib/BmltClient/api/root_server_api.rb +1880 -0
- data/lib/BmltClient/api_client.rb +392 -0
- data/lib/BmltClient/api_error.rb +57 -0
- data/lib/BmltClient/configuration.rb +279 -0
- data/lib/BmltClient/models/authentication_error.rb +224 -0
- data/lib/BmltClient/models/authorization_error.rb +224 -0
- data/lib/BmltClient/models/error_test.rb +237 -0
- data/lib/BmltClient/models/format.rb +276 -0
- data/lib/BmltClient/models/format_all_of.rb +219 -0
- data/lib/BmltClient/models/format_base.rb +239 -0
- data/lib/BmltClient/models/format_create.rb +251 -0
- data/lib/BmltClient/models/format_partial_update.rb +246 -0
- data/lib/BmltClient/models/format_translation.rb +266 -0
- data/lib/BmltClient/models/format_update.rb +251 -0
- data/lib/BmltClient/models/meeting.rb +628 -0
- data/lib/BmltClient/models/meeting_base.rb +536 -0
- data/lib/BmltClient/models/meeting_create.rb +593 -0
- data/lib/BmltClient/models/meeting_partial_update.rb +593 -0
- data/lib/BmltClient/models/meeting_update.rb +593 -0
- data/lib/BmltClient/models/not_found_error.rb +224 -0
- data/lib/BmltClient/models/server_error.rb +224 -0
- data/lib/BmltClient/models/service_body.rb +374 -0
- data/lib/BmltClient/models/service_body_base.rb +302 -0
- data/lib/BmltClient/models/service_body_create.rb +339 -0
- data/lib/BmltClient/models/service_body_partial_update.rb +309 -0
- data/lib/BmltClient/models/service_body_update.rb +339 -0
- data/lib/BmltClient/models/token.rb +266 -0
- data/lib/BmltClient/models/token_credentials.rb +238 -0
- data/lib/BmltClient/models/user.rb +316 -0
- data/lib/BmltClient/models/user_base.rb +264 -0
- data/lib/BmltClient/models/user_create.rb +301 -0
- data/lib/BmltClient/models/user_create_all_of.rb +219 -0
- data/lib/BmltClient/models/user_partial_update.rb +281 -0
- data/lib/BmltClient/models/user_update.rb +296 -0
- data/lib/BmltClient/models/validation_error.rb +240 -0
- data/lib/BmltClient/version.rb +15 -0
- data/lib/BmltClient.rb +71 -0
- data/openapi.json +1 -0
- data/spec/api/root_server_api_spec.rb +377 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/authentication_error_spec.rb +34 -0
- data/spec/models/authorization_error_spec.rb +34 -0
- data/spec/models/error_test_spec.rb +46 -0
- data/spec/models/format_all_of_spec.rb +34 -0
- data/spec/models/format_base_spec.rb +46 -0
- data/spec/models/format_create_spec.rb +46 -0
- data/spec/models/format_partial_update_spec.rb +46 -0
- data/spec/models/format_spec.rb +52 -0
- data/spec/models/format_translation_spec.rb +52 -0
- data/spec/models/format_update_spec.rb +46 -0
- data/spec/models/meeting_base_spec.rb +244 -0
- data/spec/models/meeting_create_spec.rb +244 -0
- data/spec/models/meeting_partial_update_spec.rb +244 -0
- data/spec/models/meeting_spec.rb +250 -0
- data/spec/models/meeting_update_spec.rb +244 -0
- data/spec/models/not_found_error_spec.rb +34 -0
- data/spec/models/server_error_spec.rb +34 -0
- data/spec/models/service_body_base_spec.rb +88 -0
- data/spec/models/service_body_create_spec.rb +88 -0
- data/spec/models/service_body_partial_update_spec.rb +88 -0
- data/spec/models/service_body_spec.rb +94 -0
- data/spec/models/service_body_update_spec.rb +88 -0
- data/spec/models/token_credentials_spec.rb +40 -0
- data/spec/models/token_spec.rb +52 -0
- data/spec/models/user_base_spec.rb +64 -0
- data/spec/models/user_create_all_of_spec.rb +34 -0
- data/spec/models/user_create_spec.rb +70 -0
- data/spec/models/user_partial_update_spec.rb +70 -0
- data/spec/models/user_spec.rb +70 -0
- data/spec/models/user_update_spec.rb +70 -0
- data/spec/models/validation_error_spec.rb +40 -0
- data/spec/spec_helper.rb +111 -0
- metadata +229 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: a941d66b6a05f36540e4eebc8e029ef1fdad90bca513700088f8b6b05b78227c
|
4
|
+
data.tar.gz: a66279673dd0a55aca741dd3dec72ea54d8811c9d29ccec1499bd871c6e83e86
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: d48e62eed46787856ace6aa00a9f82a5a1302fb74af5abed36ca1e2d7419207cec89eb8eccb76302aaab1ca051b71a8262b10a3f354074de033b3a0b62e3fe49
|
7
|
+
data.tar.gz: cdc891b05e4b9d6a04494942ebe073e9610e448fa0a3dc9be519990b07c04c410e3c5e9a07d25f13441c92d0002c164f42fc2a4b9c7ae7055cfd53f8a0f09b34
|
data/BmltClient.gemspec
ADDED
@@ -0,0 +1,38 @@
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
2
|
+
|
3
|
+
=begin
|
4
|
+
#BMLT
|
5
|
+
|
6
|
+
#BMLT Admin API Documentation
|
7
|
+
|
8
|
+
The version of the OpenAPI document: 1.0.0
|
9
|
+
|
10
|
+
Generated by: https://openapi-generator.tech
|
11
|
+
OpenAPI Generator version: 6.2.1-SNAPSHOT
|
12
|
+
|
13
|
+
=end
|
14
|
+
|
15
|
+
$:.push File.expand_path("../lib", __FILE__)
|
16
|
+
require "BmltClient/version"
|
17
|
+
|
18
|
+
Gem::Specification.new do |s|
|
19
|
+
s.name = "BmltClient"
|
20
|
+
s.version = BmltClient::VERSION
|
21
|
+
s.platform = Gem::Platform::RUBY
|
22
|
+
s.authors = ["bmlt-enabled"]
|
23
|
+
s.email = ["admin@bmlt.app"]
|
24
|
+
s.homepage = "https://bmlt.app"
|
25
|
+
s.summary = "BMLT Ruby Gem"
|
26
|
+
s.description = "BMLT Admin API Client"
|
27
|
+
s.license = "MIT"
|
28
|
+
s.required_ruby_version = ">= 2.4"
|
29
|
+
|
30
|
+
s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
|
31
|
+
|
32
|
+
s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
|
33
|
+
|
34
|
+
s.files = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
|
35
|
+
s.test_files = `find spec/*`.split("\n")
|
36
|
+
s.executables = []
|
37
|
+
s.require_paths = ["lib"]
|
38
|
+
end
|
data/Gemfile
ADDED
data/Makefile
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
.PHONY: generate-api-client
|
2
|
+
openapi.json:
|
3
|
+
curl http://localhost:8000/main_server/api/v1/openapi.json > openapi.json
|
4
|
+
|
5
|
+
generate: openapi.json
|
6
|
+
docker run --rm -v "$(shell pwd):/local" -w /local openapitools/openapi-generator-cli generate \
|
7
|
+
-i openapi.json \
|
8
|
+
-g ruby \
|
9
|
+
-p gemAuthor=bmlt-enabled \
|
10
|
+
-p gemAuthorEmail=admin@bmlt.app \
|
11
|
+
-p gemDescription="BMLT Admin API Client" \
|
12
|
+
-p gemHomepage="https://bmlt.app" \
|
13
|
+
-p gemLicense=MIT \
|
14
|
+
-p gemName=BmltClient \
|
15
|
+
-p moduleName=BmltClient \
|
16
|
+
-p gemVersion=1.0.0 \
|
17
|
+
--git-repo-id=bmlt-root-server-ruby-client \
|
18
|
+
--git-user-id=bmlt-enabled \
|
19
|
+
-o .
|
20
|
+
|
21
|
+
clean:
|
22
|
+
rm -f openapi.json
|
data/README.md
ADDED
@@ -0,0 +1,157 @@
|
|
1
|
+
# BmltClient
|
2
|
+
|
3
|
+
BmltClient - the Ruby gem for the BMLT
|
4
|
+
|
5
|
+
BMLT Admin API Documentation
|
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 BmltClient.gemspec
|
21
|
+
```
|
22
|
+
|
23
|
+
Then either install the gem locally:
|
24
|
+
|
25
|
+
```shell
|
26
|
+
gem install ./BmltClient-1.0.0.gem
|
27
|
+
```
|
28
|
+
|
29
|
+
(for development, run `gem install --dev ./BmltClient-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 'BmltClient', '~> 1.0.0'
|
36
|
+
|
37
|
+
### Install from Git
|
38
|
+
|
39
|
+
If the Ruby gem is hosted at a git repository: https://github.com/bmlt-enabled/bmlt-root-server-ruby-client, then add the following in the Gemfile:
|
40
|
+
|
41
|
+
gem 'BmltClient', :git => 'https://github.com/bmlt-enabled/bmlt-root-server-ruby-client.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 'BmltClient'
|
58
|
+
|
59
|
+
# Setup authorization
|
60
|
+
BmltClient.configure do |config|
|
61
|
+
# Configure OAuth2 access token for authorization: bmltToken
|
62
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
63
|
+
end
|
64
|
+
|
65
|
+
api_instance = BmltClient::RootServerApi.new
|
66
|
+
|
67
|
+
begin
|
68
|
+
#Revokes a token
|
69
|
+
api_instance.auth_logout
|
70
|
+
rescue BmltClient::ApiError => e
|
71
|
+
puts "Exception when calling RootServerApi->auth_logout: #{e}"
|
72
|
+
end
|
73
|
+
|
74
|
+
```
|
75
|
+
|
76
|
+
## Documentation for API Endpoints
|
77
|
+
|
78
|
+
All URIs are relative to *http://localhost:8000/main_server*
|
79
|
+
|
80
|
+
Class | Method | HTTP request | Description
|
81
|
+
------------ | ------------- | ------------- | -------------
|
82
|
+
*BmltClient::RootServerApi* | [**auth_logout**](docs/RootServerApi.md#auth_logout) | **POST** /api/v1/auth/logout | Revokes a token
|
83
|
+
*BmltClient::RootServerApi* | [**auth_refresh**](docs/RootServerApi.md#auth_refresh) | **POST** /api/v1/auth/refresh | Revokes and issues a new token
|
84
|
+
*BmltClient::RootServerApi* | [**auth_token**](docs/RootServerApi.md#auth_token) | **POST** /api/v1/auth/token | Creates a token
|
85
|
+
*BmltClient::RootServerApi* | [**create_error_test**](docs/RootServerApi.md#create_error_test) | **POST** /api/v1/errortest | Tests some errors
|
86
|
+
*BmltClient::RootServerApi* | [**create_format**](docs/RootServerApi.md#create_format) | **POST** /api/v1/formats | Creates a format
|
87
|
+
*BmltClient::RootServerApi* | [**create_meeting**](docs/RootServerApi.md#create_meeting) | **POST** /api/v1/meetings | Creates a meeting
|
88
|
+
*BmltClient::RootServerApi* | [**create_service_body**](docs/RootServerApi.md#create_service_body) | **POST** /api/v1/servicebodies | Creates a service body
|
89
|
+
*BmltClient::RootServerApi* | [**create_user**](docs/RootServerApi.md#create_user) | **POST** /api/v1/users | Creates a user
|
90
|
+
*BmltClient::RootServerApi* | [**delete_format**](docs/RootServerApi.md#delete_format) | **DELETE** /api/v1/formats/{formatId} | Deletes a format
|
91
|
+
*BmltClient::RootServerApi* | [**delete_meeting**](docs/RootServerApi.md#delete_meeting) | **DELETE** /api/v1/meetings/{meetingId} | Deletes a meeting
|
92
|
+
*BmltClient::RootServerApi* | [**delete_service_body**](docs/RootServerApi.md#delete_service_body) | **DELETE** /api/v1/servicebodies/{serviceBodyId} | Deletes a service body
|
93
|
+
*BmltClient::RootServerApi* | [**delete_user**](docs/RootServerApi.md#delete_user) | **DELETE** /api/v1/users/{userId} | Deletes a user
|
94
|
+
*BmltClient::RootServerApi* | [**get_format**](docs/RootServerApi.md#get_format) | **GET** /api/v1/formats/{formatId} | Retrieves a format
|
95
|
+
*BmltClient::RootServerApi* | [**get_formats**](docs/RootServerApi.md#get_formats) | **GET** /api/v1/formats | Retrieves formats
|
96
|
+
*BmltClient::RootServerApi* | [**get_meeting**](docs/RootServerApi.md#get_meeting) | **GET** /api/v1/meetings/{meetingId} | Retrieves a meeting
|
97
|
+
*BmltClient::RootServerApi* | [**get_meetings**](docs/RootServerApi.md#get_meetings) | **GET** /api/v1/meetings | Retrieves meetings
|
98
|
+
*BmltClient::RootServerApi* | [**get_service_bodies**](docs/RootServerApi.md#get_service_bodies) | **GET** /api/v1/servicebodies | Retrieves service bodies
|
99
|
+
*BmltClient::RootServerApi* | [**get_service_body**](docs/RootServerApi.md#get_service_body) | **GET** /api/v1/servicebodies/{serviceBodyId} | Retrieves a service body
|
100
|
+
*BmltClient::RootServerApi* | [**get_user**](docs/RootServerApi.md#get_user) | **GET** /api/v1/users/{userId} | Retrieves a single user
|
101
|
+
*BmltClient::RootServerApi* | [**get_users**](docs/RootServerApi.md#get_users) | **GET** /api/v1/users | Retrieves users
|
102
|
+
*BmltClient::RootServerApi* | [**partial_update_user**](docs/RootServerApi.md#partial_update_user) | **PATCH** /api/v1/users/{userId} | Patches a user
|
103
|
+
*BmltClient::RootServerApi* | [**patch_format**](docs/RootServerApi.md#patch_format) | **PATCH** /api/v1/formats/{formatId} | Patches a format
|
104
|
+
*BmltClient::RootServerApi* | [**patch_meeting**](docs/RootServerApi.md#patch_meeting) | **PATCH** /api/v1/meetings/{meetingId} | Patches a meeting
|
105
|
+
*BmltClient::RootServerApi* | [**patch_service_body**](docs/RootServerApi.md#patch_service_body) | **PATCH** /api/v1/servicebodies/{serviceBodyId} | Patches a service body
|
106
|
+
*BmltClient::RootServerApi* | [**update_format**](docs/RootServerApi.md#update_format) | **PUT** /api/v1/formats/{formatId} | Updates a format
|
107
|
+
*BmltClient::RootServerApi* | [**update_meeting**](docs/RootServerApi.md#update_meeting) | **PUT** /api/v1/meetings/{meetingId} | Updates a meeting
|
108
|
+
*BmltClient::RootServerApi* | [**update_service_body**](docs/RootServerApi.md#update_service_body) | **PUT** /api/v1/servicebodies/{serviceBodyId} | Updates a Service Body
|
109
|
+
*BmltClient::RootServerApi* | [**update_user**](docs/RootServerApi.md#update_user) | **PUT** /api/v1/users/{userId} | Update single user
|
110
|
+
|
111
|
+
|
112
|
+
## Documentation for Models
|
113
|
+
|
114
|
+
- [BmltClient::AuthenticationError](docs/AuthenticationError.md)
|
115
|
+
- [BmltClient::AuthorizationError](docs/AuthorizationError.md)
|
116
|
+
- [BmltClient::ErrorTest](docs/ErrorTest.md)
|
117
|
+
- [BmltClient::Format](docs/Format.md)
|
118
|
+
- [BmltClient::FormatAllOf](docs/FormatAllOf.md)
|
119
|
+
- [BmltClient::FormatBase](docs/FormatBase.md)
|
120
|
+
- [BmltClient::FormatCreate](docs/FormatCreate.md)
|
121
|
+
- [BmltClient::FormatPartialUpdate](docs/FormatPartialUpdate.md)
|
122
|
+
- [BmltClient::FormatTranslation](docs/FormatTranslation.md)
|
123
|
+
- [BmltClient::FormatUpdate](docs/FormatUpdate.md)
|
124
|
+
- [BmltClient::Meeting](docs/Meeting.md)
|
125
|
+
- [BmltClient::MeetingBase](docs/MeetingBase.md)
|
126
|
+
- [BmltClient::MeetingCreate](docs/MeetingCreate.md)
|
127
|
+
- [BmltClient::MeetingPartialUpdate](docs/MeetingPartialUpdate.md)
|
128
|
+
- [BmltClient::MeetingUpdate](docs/MeetingUpdate.md)
|
129
|
+
- [BmltClient::NotFoundError](docs/NotFoundError.md)
|
130
|
+
- [BmltClient::ServerError](docs/ServerError.md)
|
131
|
+
- [BmltClient::ServiceBody](docs/ServiceBody.md)
|
132
|
+
- [BmltClient::ServiceBodyBase](docs/ServiceBodyBase.md)
|
133
|
+
- [BmltClient::ServiceBodyCreate](docs/ServiceBodyCreate.md)
|
134
|
+
- [BmltClient::ServiceBodyPartialUpdate](docs/ServiceBodyPartialUpdate.md)
|
135
|
+
- [BmltClient::ServiceBodyUpdate](docs/ServiceBodyUpdate.md)
|
136
|
+
- [BmltClient::Token](docs/Token.md)
|
137
|
+
- [BmltClient::TokenCredentials](docs/TokenCredentials.md)
|
138
|
+
- [BmltClient::User](docs/User.md)
|
139
|
+
- [BmltClient::UserBase](docs/UserBase.md)
|
140
|
+
- [BmltClient::UserCreate](docs/UserCreate.md)
|
141
|
+
- [BmltClient::UserCreateAllOf](docs/UserCreateAllOf.md)
|
142
|
+
- [BmltClient::UserPartialUpdate](docs/UserPartialUpdate.md)
|
143
|
+
- [BmltClient::UserUpdate](docs/UserUpdate.md)
|
144
|
+
- [BmltClient::ValidationError](docs/ValidationError.md)
|
145
|
+
|
146
|
+
|
147
|
+
## Documentation for Authorization
|
148
|
+
|
149
|
+
|
150
|
+
### bmltToken
|
151
|
+
|
152
|
+
|
153
|
+
- **Type**: OAuth
|
154
|
+
- **Flow**: password
|
155
|
+
- **Authorization URL**:
|
156
|
+
- **Scopes**: N/A
|
157
|
+
|
data/Rakefile
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
# BmltClient::AuthenticationError
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **message** | **String** | | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'BmltClient'
|
13
|
+
|
14
|
+
instance = BmltClient::AuthenticationError.new(
|
15
|
+
message: Unauthenticated.
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# BmltClient::AuthorizationError
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **message** | **String** | | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'BmltClient'
|
13
|
+
|
14
|
+
instance = BmltClient::AuthorizationError.new(
|
15
|
+
message: This action is unauthorized.
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
data/docs/ErrorTest.md
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
# BmltClient::ErrorTest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **arbitrary_string** | **String** | | [optional] |
|
8
|
+
| **arbitrary_int** | **Integer** | | [optional] |
|
9
|
+
| **force_server_error** | **Boolean** | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'BmltClient'
|
15
|
+
|
16
|
+
instance = BmltClient::ErrorTest.new(
|
17
|
+
arbitrary_string: string,
|
18
|
+
arbitrary_int: 123,
|
19
|
+
force_server_error: true
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
data/docs/Format.md
ADDED
@@ -0,0 +1,24 @@
|
|
1
|
+
# BmltClient::Format
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **world_id** | **String** | | |
|
8
|
+
| **type** | **String** | | |
|
9
|
+
| **translations** | [**Array<FormatTranslation>**](FormatTranslation.md) | | |
|
10
|
+
| **id** | **Integer** | | |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'BmltClient'
|
16
|
+
|
17
|
+
instance = BmltClient::Format.new(
|
18
|
+
world_id: string,
|
19
|
+
type: string,
|
20
|
+
translations: null,
|
21
|
+
id: 0
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
data/docs/FormatAllOf.md
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
# BmltClient::FormatAllOf
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **Integer** | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'BmltClient'
|
13
|
+
|
14
|
+
instance = BmltClient::FormatAllOf.new(
|
15
|
+
id: 0
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
data/docs/FormatBase.md
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
# BmltClient::FormatBase
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **world_id** | **String** | | [optional] |
|
8
|
+
| **type** | **String** | | [optional] |
|
9
|
+
| **translations** | [**Array<FormatTranslation>**](FormatTranslation.md) | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'BmltClient'
|
15
|
+
|
16
|
+
instance = BmltClient::FormatBase.new(
|
17
|
+
world_id: string,
|
18
|
+
type: string,
|
19
|
+
translations: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# BmltClient::FormatCreate
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **world_id** | **String** | | [optional] |
|
8
|
+
| **type** | **String** | | [optional] |
|
9
|
+
| **translations** | [**Array<FormatTranslation>**](FormatTranslation.md) | | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'BmltClient'
|
15
|
+
|
16
|
+
instance = BmltClient::FormatCreate.new(
|
17
|
+
world_id: string,
|
18
|
+
type: string,
|
19
|
+
translations: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# BmltClient::FormatPartialUpdate
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **world_id** | **String** | | [optional] |
|
8
|
+
| **type** | **String** | | [optional] |
|
9
|
+
| **translations** | [**Array<FormatTranslation>**](FormatTranslation.md) | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'BmltClient'
|
15
|
+
|
16
|
+
instance = BmltClient::FormatPartialUpdate.new(
|
17
|
+
world_id: string,
|
18
|
+
type: string,
|
19
|
+
translations: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# BmltClient::FormatTranslation
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **key** | **String** | | |
|
8
|
+
| **name** | **String** | | |
|
9
|
+
| **description** | **String** | | |
|
10
|
+
| **language** | **String** | | |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'BmltClient'
|
16
|
+
|
17
|
+
instance = BmltClient::FormatTranslation.new(
|
18
|
+
key: null,
|
19
|
+
name: null,
|
20
|
+
description: null,
|
21
|
+
language: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# BmltClient::FormatUpdate
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **world_id** | **String** | | [optional] |
|
8
|
+
| **type** | **String** | | [optional] |
|
9
|
+
| **translations** | [**Array<FormatTranslation>**](FormatTranslation.md) | | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'BmltClient'
|
15
|
+
|
16
|
+
instance = BmltClient::FormatUpdate.new(
|
17
|
+
world_id: string,
|
18
|
+
type: string,
|
19
|
+
translations: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
data/docs/Meeting.md
ADDED
@@ -0,0 +1,90 @@
|
|
1
|
+
# BmltClient::Meeting
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **service_body_id** | **Integer** | | |
|
8
|
+
| **format_ids** | **Array<Integer>** | | |
|
9
|
+
| **venue_type** | **Integer** | | |
|
10
|
+
| **temporarily_virtual** | **Boolean** | | |
|
11
|
+
| **day** | **Integer** | | |
|
12
|
+
| **start_time** | **String** | | |
|
13
|
+
| **duration** | **String** | | |
|
14
|
+
| **time_zone** | **String** | | |
|
15
|
+
| **latitude** | **Float** | | |
|
16
|
+
| **longitude** | **Float** | | |
|
17
|
+
| **published** | **Boolean** | | |
|
18
|
+
| **email** | **String** | | |
|
19
|
+
| **world_id** | **String** | | |
|
20
|
+
| **name** | **String** | | |
|
21
|
+
| **location_text** | **String** | | [optional] |
|
22
|
+
| **location_info** | **String** | | [optional] |
|
23
|
+
| **location_street** | **String** | | [optional] |
|
24
|
+
| **location_neighborhood** | **String** | | [optional] |
|
25
|
+
| **location_city_subsection** | **String** | | [optional] |
|
26
|
+
| **location_municipality** | **String** | | [optional] |
|
27
|
+
| **location_sub_province** | **String** | | [optional] |
|
28
|
+
| **location_province** | **String** | | [optional] |
|
29
|
+
| **location_postal_code_1** | **String** | | [optional] |
|
30
|
+
| **location_nation** | **String** | | [optional] |
|
31
|
+
| **phone_meeting_number** | **String** | | [optional] |
|
32
|
+
| **virtual_meeting_link** | **String** | | [optional] |
|
33
|
+
| **virtual_meeting_additional_info** | **String** | | [optional] |
|
34
|
+
| **contact_name_1** | **String** | | [optional] |
|
35
|
+
| **contact_name_2** | **String** | | [optional] |
|
36
|
+
| **contact_phone_1** | **String** | | [optional] |
|
37
|
+
| **contact_phone_2** | **String** | | [optional] |
|
38
|
+
| **contact_email_1** | **String** | | [optional] |
|
39
|
+
| **contact_email_2** | **String** | | [optional] |
|
40
|
+
| **bus_lines** | **String** | | [optional] |
|
41
|
+
| **train_line** | **String** | | [optional] |
|
42
|
+
| **comments** | **String** | | [optional] |
|
43
|
+
| **id** | **Integer** | | |
|
44
|
+
|
45
|
+
## Example
|
46
|
+
|
47
|
+
```ruby
|
48
|
+
require 'BmltClient'
|
49
|
+
|
50
|
+
instance = BmltClient::Meeting.new(
|
51
|
+
service_body_id: 0,
|
52
|
+
format_ids: null,
|
53
|
+
venue_type: 1,
|
54
|
+
temporarily_virtual: false,
|
55
|
+
day: 0,
|
56
|
+
start_time: string,
|
57
|
+
duration: 01:00,
|
58
|
+
time_zone: America/New_York,
|
59
|
+
latitude: 35.698741,
|
60
|
+
longitude: -81.26273,
|
61
|
+
published: true,
|
62
|
+
email: string,
|
63
|
+
world_id: string,
|
64
|
+
name: string,
|
65
|
+
location_text: string,
|
66
|
+
location_info: string,
|
67
|
+
location_street: string,
|
68
|
+
location_neighborhood: string,
|
69
|
+
location_city_subsection: string,
|
70
|
+
location_municipality: string,
|
71
|
+
location_sub_province: string,
|
72
|
+
location_province: string,
|
73
|
+
location_postal_code_1: string,
|
74
|
+
location_nation: string,
|
75
|
+
phone_meeting_number: string,
|
76
|
+
virtual_meeting_link: string,
|
77
|
+
virtual_meeting_additional_info: string,
|
78
|
+
contact_name_1: string,
|
79
|
+
contact_name_2: string,
|
80
|
+
contact_phone_1: string,
|
81
|
+
contact_phone_2: string,
|
82
|
+
contact_email_1: string,
|
83
|
+
contact_email_2: string,
|
84
|
+
bus_lines: string,
|
85
|
+
train_line: string,
|
86
|
+
comments: string,
|
87
|
+
id: 0
|
88
|
+
)
|
89
|
+
```
|
90
|
+
|
data/docs/MeetingBase.md
ADDED
@@ -0,0 +1,88 @@
|
|
1
|
+
# BmltClient::MeetingBase
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **service_body_id** | **Integer** | | [optional] |
|
8
|
+
| **format_ids** | **Array<Integer>** | | [optional] |
|
9
|
+
| **venue_type** | **Integer** | | [optional] |
|
10
|
+
| **temporarily_virtual** | **Boolean** | | [optional] |
|
11
|
+
| **day** | **Integer** | | [optional] |
|
12
|
+
| **start_time** | **String** | | [optional] |
|
13
|
+
| **duration** | **String** | | [optional] |
|
14
|
+
| **time_zone** | **String** | | [optional] |
|
15
|
+
| **latitude** | **Float** | | [optional] |
|
16
|
+
| **longitude** | **Float** | | [optional] |
|
17
|
+
| **published** | **Boolean** | | [optional] |
|
18
|
+
| **email** | **String** | | [optional] |
|
19
|
+
| **world_id** | **String** | | [optional] |
|
20
|
+
| **name** | **String** | | [optional] |
|
21
|
+
| **location_text** | **String** | | [optional] |
|
22
|
+
| **location_info** | **String** | | [optional] |
|
23
|
+
| **location_street** | **String** | | [optional] |
|
24
|
+
| **location_neighborhood** | **String** | | [optional] |
|
25
|
+
| **location_city_subsection** | **String** | | [optional] |
|
26
|
+
| **location_municipality** | **String** | | [optional] |
|
27
|
+
| **location_sub_province** | **String** | | [optional] |
|
28
|
+
| **location_province** | **String** | | [optional] |
|
29
|
+
| **location_postal_code_1** | **String** | | [optional] |
|
30
|
+
| **location_nation** | **String** | | [optional] |
|
31
|
+
| **phone_meeting_number** | **String** | | [optional] |
|
32
|
+
| **virtual_meeting_link** | **String** | | [optional] |
|
33
|
+
| **virtual_meeting_additional_info** | **String** | | [optional] |
|
34
|
+
| **contact_name_1** | **String** | | [optional] |
|
35
|
+
| **contact_name_2** | **String** | | [optional] |
|
36
|
+
| **contact_phone_1** | **String** | | [optional] |
|
37
|
+
| **contact_phone_2** | **String** | | [optional] |
|
38
|
+
| **contact_email_1** | **String** | | [optional] |
|
39
|
+
| **contact_email_2** | **String** | | [optional] |
|
40
|
+
| **bus_lines** | **String** | | [optional] |
|
41
|
+
| **train_line** | **String** | | [optional] |
|
42
|
+
| **comments** | **String** | | [optional] |
|
43
|
+
|
44
|
+
## Example
|
45
|
+
|
46
|
+
```ruby
|
47
|
+
require 'BmltClient'
|
48
|
+
|
49
|
+
instance = BmltClient::MeetingBase.new(
|
50
|
+
service_body_id: 0,
|
51
|
+
format_ids: null,
|
52
|
+
venue_type: 1,
|
53
|
+
temporarily_virtual: false,
|
54
|
+
day: 0,
|
55
|
+
start_time: string,
|
56
|
+
duration: 01:00,
|
57
|
+
time_zone: America/New_York,
|
58
|
+
latitude: 35.698741,
|
59
|
+
longitude: -81.26273,
|
60
|
+
published: true,
|
61
|
+
email: string,
|
62
|
+
world_id: string,
|
63
|
+
name: string,
|
64
|
+
location_text: string,
|
65
|
+
location_info: string,
|
66
|
+
location_street: string,
|
67
|
+
location_neighborhood: string,
|
68
|
+
location_city_subsection: string,
|
69
|
+
location_municipality: string,
|
70
|
+
location_sub_province: string,
|
71
|
+
location_province: string,
|
72
|
+
location_postal_code_1: string,
|
73
|
+
location_nation: string,
|
74
|
+
phone_meeting_number: string,
|
75
|
+
virtual_meeting_link: string,
|
76
|
+
virtual_meeting_additional_info: string,
|
77
|
+
contact_name_1: string,
|
78
|
+
contact_name_2: string,
|
79
|
+
contact_phone_1: string,
|
80
|
+
contact_phone_2: string,
|
81
|
+
contact_email_1: string,
|
82
|
+
contact_email_2: string,
|
83
|
+
bus_lines: string,
|
84
|
+
train_line: string,
|
85
|
+
comments: string
|
86
|
+
)
|
87
|
+
```
|
88
|
+
|