RubyGems - plaid - Versions diffs - 44.1.0 → 45.0.0 - Mend

plaid 44.1.0 → 45.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1999) hide show

data/lib/plaid.rb CHANGED Viewed

@@ -3,7 +3,7 @@
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
-The version of the OpenAPI document: 2020-09-14_1.670.0
+The version of the OpenAPI document: 2020-09-14_1.680.0
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.3.0
@@ -64,6 +64,7 @@ Plaid.autoload :AddressNullable, 'plaid/models/address_nullable'
 Plaid.autoload :AddressPurposeLabel, 'plaid/models/address_purpose_label'
 Plaid.autoload :AffordabilityInsights, 'plaid/models/affordability_insights'
 Plaid.autoload :AmountWithCurrency, 'plaid/models/amount_with_currency'
+Plaid.autoload :AmountWithCurrencyWithMonthlyAverage, 'plaid/models/amount_with_currency_with_monthly_average'
 Plaid.autoload :Application, 'plaid/models/application'
 Plaid.autoload :ApplicationGetRequest, 'plaid/models/application_get_request'
 Plaid.autoload :ApplicationGetResponse, 'plaid/models/application_get_response'
@@ -261,6 +262,8 @@ Plaid.autoload :BeaconUserStatusUpdatedWebhook, 'plaid/models/beacon_user_status
 Plaid.autoload :BeaconUserUpdateRequest, 'plaid/models/beacon_user_update_request'
 Plaid.autoload :BeaconUserUpdateRequestData, 'plaid/models/beacon_user_update_request_data'
 Plaid.autoload :BeaconUserUpdateResponse, 'plaid/models/beacon_user_update_response'
+Plaid.autoload :BetaEwaReportV1GetRequest, 'plaid/models/beta_ewa_report_v1_get_request'
+Plaid.autoload :BetaEwaReportV1GetResponse, 'plaid/models/beta_ewa_report_v1_get_response'
 Plaid.autoload :BetaPartnerCustomerV1CreateRequest, 'plaid/models/beta_partner_customer_v1_create_request'
 Plaid.autoload :BetaPartnerCustomerV1CreateResponse, 'plaid/models/beta_partner_customer_v1_create_response'
 Plaid.autoload :BetaPartnerCustomerV1EnableRequest, 'plaid/models/beta_partner_customer_v1_enable_request'
@@ -273,10 +276,29 @@ Plaid.autoload :BetaPartnerEndCustomer, 'plaid/models/beta_partner_end_customer'
 Plaid.autoload :BetaPartnerEndCustomerWithSecrets, 'plaid/models/beta_partner_end_customer_with_secrets'
 Plaid.autoload :BusinessAccount, 'plaid/models/business_account'
 Plaid.autoload :BusinessAccountAllOf, 'plaid/models/business_account_all_of'
+Plaid.autoload :BusinessEmailAddress, 'plaid/models/business_email_address'
+Plaid.autoload :BusinessEntityType, 'plaid/models/business_entity_type'
+Plaid.autoload :BusinessFieldMatchSummary, 'plaid/models/business_field_match_summary'
 Plaid.autoload :BusinessFinanceCategory, 'plaid/models/business_finance_category'
+Plaid.autoload :BusinessKYBCheck, 'plaid/models/business_kyb_check'
+Plaid.autoload :BusinessKYBMatchDetails, 'plaid/models/business_kyb_match_details'
+Plaid.autoload :BusinessPhoneNumber, 'plaid/models/business_phone_number'
+Plaid.autoload :BusinessRiskCheck, 'plaid/models/business_risk_check'
+Plaid.autoload :BusinessSearchTerms, 'plaid/models/business_search_terms'
+Plaid.autoload :BusinessVerificationCreateRequest, 'plaid/models/business_verification_create_request'
+Plaid.autoload :BusinessVerificationCreateRequestBusiness, 'plaid/models/business_verification_create_request_business'
+Plaid.autoload :BusinessVerificationCreateResponse, 'plaid/models/business_verification_create_response'
+Plaid.autoload :BusinessVerificationGetRequest, 'plaid/models/business_verification_get_request'
+Plaid.autoload :BusinessVerificationGetResponse, 'plaid/models/business_verification_get_response'
+Plaid.autoload :BusinessVerificationStatusKYBCheck, 'plaid/models/business_verification_status_kyb_check'
+Plaid.autoload :BusinessVerificationStatusOverall, 'plaid/models/business_verification_status_overall'
+Plaid.autoload :BusinessVerificationStatusRiskCheck, 'plaid/models/business_verification_status_risk_check'
+Plaid.autoload :BusinessWebsite, 'plaid/models/business_website'
 Plaid.autoload :CRALoansRegisterRequest, 'plaid/models/cra_loans_register_request'
+Plaid.autoload :CashFlowInsight, 'plaid/models/cash_flow_insight'
 Plaid.autoload :CashFlowUpdatesEventWebhookCodes, 'plaid/models/cash_flow_updates_event_webhook_codes'
 Plaid.autoload :CashFlowUpdatesExpectedDepositMissedWebhook, 'plaid/models/cash_flow_updates_expected_deposit_missed_webhook'
+Plaid.autoload :CashFlowUpdatesInsightsV2Webhook, 'plaid/models/cash_flow_updates_insights_v2_webhook'
 Plaid.autoload :CashFlowUpdatesInsightsWebhook, 'plaid/models/cash_flow_updates_insights_webhook'
 Plaid.autoload :CashFlowUpdatesLargeDepositWebhook, 'plaid/models/cash_flow_updates_large_deposit_webhook'
 Plaid.autoload :CashFlowUpdatesLowBalanceWebhook, 'plaid/models/cash_flow_updates_low_balance_webhook'
@@ -358,8 +380,10 @@ Plaid.autoload :CraBankIncomeCompleteWebhook, 'plaid/models/cra_bank_income_comp
 Plaid.autoload :CraBankIncomeEmployer, 'plaid/models/cra_bank_income_employer'
 Plaid.autoload :CraBankIncomeErrorWebhook, 'plaid/models/cra_bank_income_error_webhook'
 Plaid.autoload :CraBankIncomeHistoricalSummary, 'plaid/models/cra_bank_income_historical_summary'
+Plaid.autoload :CraBankIncomeIncomeProvider, 'plaid/models/cra_bank_income_income_provider'
 Plaid.autoload :CraBankIncomeItem, 'plaid/models/cra_bank_income_item'
 Plaid.autoload :CraBankIncomeSource, 'plaid/models/cra_bank_income_source'
+Plaid.autoload :CraBankIncomeStatus, 'plaid/models/cra_bank_income_status'
 Plaid.autoload :CraBankIncomeSummary, 'plaid/models/cra_bank_income_summary'
 Plaid.autoload :CraBankIncomeTransaction, 'plaid/models/cra_bank_income_transaction'
 Plaid.autoload :CraBankIncomeWarning, 'plaid/models/cra_bank_income_warning'
@@ -446,6 +470,8 @@ Plaid.autoload :CraPartnerInsightsItemAccountMetadata, 'plaid/models/cra_partner
 Plaid.autoload :CraPartnerInsightsPrism, 'plaid/models/cra_partner_insights_prism'
 Plaid.autoload :CraPredictionInterval, 'plaid/models/cra_prediction_interval'
 Plaid.autoload :CraUpgradeFailedWebhook, 'plaid/models/cra_upgrade_failed_webhook'
+Plaid.autoload :CraUserCheckReportFailedWebhook, 'plaid/models/cra_user_check_report_failed_webhook'
+Plaid.autoload :CraUserCheckReportReadyWebhook, 'plaid/models/cra_user_check_report_ready_webhook'
 Plaid.autoload :CraVerificationReport, 'plaid/models/cra_verification_report'
 Plaid.autoload :CraVoaReport, 'plaid/models/cra_voa_report'
 Plaid.autoload :CraVoaReportAccount, 'plaid/models/cra_voa_report_account'
@@ -655,7 +681,9 @@ Plaid.autoload :EntityWatchlistScreeningHit, 'plaid/models/entity_watchlist_scre
 Plaid.autoload :EntityWatchlistScreeningReview, 'plaid/models/entity_watchlist_screening_review'
 Plaid.autoload :EntityWatchlistScreeningSearchTerms, 'plaid/models/entity_watchlist_screening_search_terms'
 Plaid.autoload :EntityWatchlistSearchTerms, 'plaid/models/entity_watchlist_search_terms'
+Plaid.autoload :EwaScore, 'plaid/models/ewa_score'
 Plaid.autoload :ExpenditureInsights, 'plaid/models/expenditure_insights'
+Plaid.autoload :ExpenditureInsightsCashFlow, 'plaid/models/expenditure_insights_cash_flow'
 Plaid.autoload :ExpenditureSummary, 'plaid/models/expenditure_summary'
 Plaid.autoload :ExpirationDate, 'plaid/models/expiration_date'
 Plaid.autoload :ExtendedRecipientMetadata, 'plaid/models/extended_recipient_metadata'
@@ -667,10 +695,12 @@ Plaid.autoload :ExternalPaymentScheduleBase, 'plaid/models/external_payment_sche
 Plaid.autoload :ExternalPaymentScheduleGet, 'plaid/models/external_payment_schedule_get'
 Plaid.autoload :ExternalPaymentScheduleRequest, 'plaid/models/external_payment_schedule_request'
 Plaid.autoload :FDXContentTypes, 'plaid/models/fdx_content_types'
+Plaid.autoload :FDXEventStatus, 'plaid/models/fdx_event_status'
 Plaid.autoload :FDXFiAttribute, 'plaid/models/fdxfi_attribute'
 Plaid.autoload :FDXHateoasLink, 'plaid/models/fdx_hateoas_link'
 Plaid.autoload :FDXHateoasLinkAction, 'plaid/models/fdx_hateoas_link_action'
 Plaid.autoload :FDXInitiatorFiAttribute, 'plaid/models/fdx_initiator_fi_attribute'
+Plaid.autoload :FDXLifecycleEvent, 'plaid/models/fdx_lifecycle_event'
 Plaid.autoload :FDXNotification, 'plaid/models/fdx_notification'
 Plaid.autoload :FDXNotificationCategory, 'plaid/models/fdx_notification_category'
 Plaid.autoload :FDXNotificationPayload, 'plaid/models/fdx_notification_payload'
@@ -682,6 +712,7 @@ Plaid.autoload :FDXParty, 'plaid/models/fdx_party'
 Plaid.autoload :FDXPartyRegistry, 'plaid/models/fdx_party_registry'
 Plaid.autoload :FDXPartyType, 'plaid/models/fdx_party_type'
 Plaid.autoload :FDXRecipientMetadata, 'plaid/models/fdx_recipient_metadata'
+Plaid.autoload :FDXUpdateReason, 'plaid/models/fdx_update_reason'
 Plaid.autoload :FallbackAuthMicrodepositAutoVerifiedWebhook, 'plaid/models/fallback_auth_microdeposit_auto_verified_webhook'
 Plaid.autoload :FallbackAuthMicrodepositVerificationExpiredWebhook, 'plaid/models/fallback_auth_microdeposit_verification_expired_webhook'
 Plaid.autoload :FinancialInstitutionInsights, 'plaid/models/financial_institution_insights'
@@ -711,9 +742,8 @@ Plaid.autoload :HostedMMDVerificationWebhook, 'plaid/models/hosted_mmd_verificat
 Plaid.autoload :HumanReview, 'plaid/models/human_review'
 Plaid.autoload :HumanReviewStatus, 'plaid/models/human_review_status'
 Plaid.autoload :IDNumberType, 'plaid/models/id_number_type'
+Plaid.autoload :IDVProtectEvent, 'plaid/models/idv_protect_event'
 Plaid.autoload :ISOCurrencyCode, 'plaid/models/iso_currency_code'
-Plaid.autoload :IdentityCreationResult, 'plaid/models/identity_creation_result'
-Plaid.autoload :IdentityCreationResultType, 'plaid/models/identity_creation_result_type'
 Plaid.autoload :IdentityDefaultUpdateWebhook, 'plaid/models/identity_default_update_webhook'
 Plaid.autoload :IdentityDocumentMetadata, 'plaid/models/identity_document_metadata'
 Plaid.autoload :IdentityDocumentUpload, 'plaid/models/identity_document_upload'
@@ -770,6 +800,10 @@ Plaid.autoload :ImageQualityOutcome, 'plaid/models/image_quality_outcome'
 Plaid.autoload :IncidentUpdate, 'plaid/models/incident_update'
 Plaid.autoload :IncomeBreakdown, 'plaid/models/income_breakdown'
 Plaid.autoload :IncomeBreakdownType, 'plaid/models/income_breakdown_type'
+Plaid.autoload :IncomeInsights, 'plaid/models/income_insights'
+Plaid.autoload :IncomeInsightsIncomeExcludingTransfers, 'plaid/models/income_insights_income_excluding_transfers'
+Plaid.autoload :IncomeInsightsTotalIncome, 'plaid/models/income_insights_total_income'
+Plaid.autoload :IncomeInsightsTransfersIn, 'plaid/models/income_insights_transfers_in'
 Plaid.autoload :IncomeOverride, 'plaid/models/income_override'
 Plaid.autoload :IncomeSourcesCounts, 'plaid/models/income_sources_counts'
 Plaid.autoload :IncomeSummary, 'plaid/models/income_summary'
@@ -1241,6 +1275,7 @@ Plaid.autoload :PendingDisconnectWebhook, 'plaid/models/pending_disconnect_webho
 Plaid.autoload :PendingDisconnectWebhookReason, 'plaid/models/pending_disconnect_webhook_reason'
 Plaid.autoload :PendingExpirationWebhook, 'plaid/models/pending_expiration_webhook'
 Plaid.autoload :PersonalFinanceCategory, 'plaid/models/personal_finance_category'
+Plaid.autoload :PersonalFinanceCategoryVersion, 'plaid/models/personal_finance_category_version'
 Plaid.autoload :PhoneNumber, 'plaid/models/phone_number'
 Plaid.autoload :PhoneNumberMatchScore, 'plaid/models/phone_number_match_score'
 Plaid.autoload :PhoneType, 'plaid/models/phone_type'
@@ -1341,6 +1376,8 @@ Plaid.autoload :ProtectEventSendRequest, 'plaid/models/protect_event_send_reques
 Plaid.autoload :ProtectEventSendResponse, 'plaid/models/protect_event_send_response'
 Plaid.autoload :ProtectIncidentAmount, 'plaid/models/protect_incident_amount'
 Plaid.autoload :ProtectIncidentEvent, 'plaid/models/protect_incident_event'
+Plaid.autoload :ProtectIncidentEventResponse, 'plaid/models/protect_incident_event_response'
+Plaid.autoload :ProtectReport, 'plaid/models/protect_report'
 Plaid.autoload :ProtectReportConfidence, 'plaid/models/protect_report_confidence'
 Plaid.autoload :ProtectReportCreateRequest, 'plaid/models/protect_report_create_request'
 Plaid.autoload :ProtectReportCreateResponse, 'plaid/models/protect_report_create_response'
@@ -1349,6 +1386,7 @@ Plaid.autoload :ProtectReportType, 'plaid/models/protect_report_type'
 Plaid.autoload :ProtectUserEventWebhook, 'plaid/models/protect_user_event_webhook'
 Plaid.autoload :ProtectUserInsightsGetRequest, 'plaid/models/protect_user_insights_get_request'
 Plaid.autoload :ProtectUserInsightsGetResponse, 'plaid/models/protect_user_insights_get_response'
+Plaid.autoload :ProviderBusinessAddress, 'plaid/models/provider_business_address'
 Plaid.autoload :ProxyType, 'plaid/models/proxy_type'
 Plaid.autoload :ReasonCode, 'plaid/models/reason_code'
 Plaid.autoload :RecaptchaRequiredError, 'plaid/models/recaptcha_required_error'
@@ -1370,6 +1408,8 @@ Plaid.autoload :RefreshResult, 'plaid/models/refresh_result'
 Plaid.autoload :RemovedTransaction, 'plaid/models/removed_transaction'
 Plaid.autoload :ReportType, 'plaid/models/report_type'
 Plaid.autoload :ReportingInformation, 'plaid/models/reporting_information'
+Plaid.autoload :RequestBusinessAddress, 'plaid/models/request_business_address'
+Plaid.autoload :ResponseBusinessAddress, 'plaid/models/response_business_address'
 Plaid.autoload :RiskCheckBehavior, 'plaid/models/risk_check_behavior'
 Plaid.autoload :RiskCheckBehaviorBotDetectedLabel, 'plaid/models/risk_check_behavior_bot_detected_label'
 Plaid.autoload :RiskCheckBehaviorFraudRingDetectedLabel, 'plaid/models/risk_check_behavior_fraud_ring_detected_label'
@@ -1382,6 +1422,7 @@ Plaid.autoload :RiskCheckEmailDomainIsDisposable, 'plaid/models/risk_check_email
 Plaid.autoload :RiskCheckEmailDomainIsFreeProvider, 'plaid/models/risk_check_email_domain_is_free_provider'
 Plaid.autoload :RiskCheckEmailIsDeliverableStatus, 'plaid/models/risk_check_email_is_deliverable_status'
 Plaid.autoload :RiskCheckEmailTopLevelDomainIsSuspicious, 'plaid/models/risk_check_email_top_level_domain_is_suspicious'
+Plaid.autoload :RiskCheckFacialDuplicate, 'plaid/models/risk_check_facial_duplicate'
 Plaid.autoload :RiskCheckIdentityAbuseSignals, 'plaid/models/risk_check_identity_abuse_signals'
 Plaid.autoload :RiskCheckLinkedService, 'plaid/models/risk_check_linked_service'
 Plaid.autoload :RiskCheckNetwork, 'plaid/models/risk_check_network'
@@ -1794,6 +1835,7 @@ Plaid.autoload :UserAccountRevokedWebhook, 'plaid/models/user_account_revoked_we
 Plaid.autoload :UserAccountSessionGetRequest, 'plaid/models/user_account_session_get_request'
 Plaid.autoload :UserAccountSessionGetResponse, 'plaid/models/user_account_session_get_response'
 Plaid.autoload :UserAddress, 'plaid/models/user_address'
+Plaid.autoload :UserBasedProducts, 'plaid/models/user_based_products'
 Plaid.autoload :UserCreateRequest, 'plaid/models/user_create_request'
 Plaid.autoload :UserCreateResponse, 'plaid/models/user_create_response'
 Plaid.autoload :UserCustomPassword, 'plaid/models/user_custom_password'
@@ -1807,9 +1849,9 @@ Plaid.autoload :UserItemsAssociateRequest, 'plaid/models/user_items_associate_re
 Plaid.autoload :UserItemsAssociateResponse, 'plaid/models/user_items_associate_response'
 Plaid.autoload :UserItemsGetRequest, 'plaid/models/user_items_get_request'
 Plaid.autoload :UserItemsGetResponse, 'plaid/models/user_items_get_response'
-Plaid.autoload :UserItemsListRequest, 'plaid/models/user_items_list_request'
-Plaid.autoload :UserItemsListResponse, 'plaid/models/user_items_list_response'
 Plaid.autoload :UserPermissionRevokedWebhook, 'plaid/models/user_permission_revoked_webhook'
+Plaid.autoload :UserProductsTerminateRequest, 'plaid/models/user_products_terminate_request'
+Plaid.autoload :UserProductsTerminateResponse, 'plaid/models/user_products_terminate_response'
 Plaid.autoload :UserRemoveRequest, 'plaid/models/user_remove_request'
 Plaid.autoload :UserRemoveResponse, 'plaid/models/user_remove_response'
 Plaid.autoload :UserStatedIncomeSourceCategory, 'plaid/models/user_stated_income_source_category'

data/plaid.gemspec CHANGED Viewed

@@ -5,7 +5,7 @@
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
-The version of the OpenAPI document: 2020-09-14_1.670.0
+The version of the OpenAPI document: 2020-09-14_1.680.0
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.3.0
@@ -31,7 +31,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'faraday-multipart', '>= 1.0.1', '< 2.0'
   s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
-  s.add_development_dependency 'bundler', '~> 2.2.9'
+  s.add_development_dependency 'bundler', '~> 2.4.22'
   s.add_development_dependency 'dotenv'
   s.add_development_dependency 'minitest', '~> 5.14'
   s.add_development_dependency 'minitest-around', '~> 0.5.0'

data/templates/ruby/Gemfile.mustache ADDED Viewed

@@ -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/templates/ruby/README.mustache ADDED Viewed

@@ -0,0 +1,152 @@
+# {{gemName}}
+{{moduleName}} - the Ruby gem for the {{appName}}
+{{#appDescriptionWithNewLines}}
+{{{.}}}
+{{/appDescriptionWithNewLines}}
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+- API version: {{appVersion}}
+- Package version: {{gemVersion}}
+{{^hideGenerationTimestamp}}
+- Build date: {{generatedDate}}
+{{/hideGenerationTimestamp}}
+- Build package: {{generatorClass}}
+{{#infoUrl}}
+For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}})
+{{/infoUrl}}
+## Installation
+### Build a gem
+To build the Ruby code into a gem:
+```shell
+gem build {{{gemName}}}.gemspec
+```
+Then either install the gem locally:
+```shell
+gem install ./{{{gemName}}}-{{{gemVersion}}}.gem
+```
+(for development, run `gem install --dev ./{{{gemName}}}-{{{gemVersion}}}.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 '{{{gemName}}}', '~> {{{gemVersion}}}'
+### Install from Git
+If the Ruby gem is hosted at a git repository: https://{{gitHost}}/{{gitUserId}}{{^gitUserId}}YOUR_GIT_USERNAME{{/gitUserId}}/{{gitRepoId}}{{^gitRepoId}}YOUR_GIT_REPO{{/gitRepoId}}, then add the following in the Gemfile:
+    gem '{{{gemName}}}', :git => 'https://{{gitHost}}/{{gitUserId}}{{^gitUserId}}YOUR_GIT_USERNAME{{/gitUserId}}/{{gitRepoId}}{{^gitRepoId}}YOUR_GIT_REPO{{/gitRepoId}}.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 '{{{gemName}}}'
+{{#apiInfo}}{{#apis}}{{#-first}}{{#operations}}{{#operation}}{{#-first}}{{#hasAuthMethods}}
+# Setup authorization
+{{{moduleName}}}.configure do |config|{{#authMethods}}{{#isBasic}}{{#isBasicBasic}}
+  # Configure HTTP basic authorization: {{{name}}}
+  config.username = 'YOUR_USERNAME'
+  config.password = 'YOUR_PASSWORD'{{/isBasicBasic}}{{#isBasicBearer}}
+  # Configure Bearer authorization{{#bearerFormat}} ({{{.}}}){{/bearerFormat}}: {{{name}}}
+  config.access_token = 'YOUR_BEARER_TOKEN'
+  # Configure a proc to get access tokens in lieu of the static access_token configuration
+  config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } {{/isBasicBearer}}{{/isBasic}}{{#isApiKey}}
+  # Configure API key authorization: {{{name}}}
+  config.api_key['{{{name}}}'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['{{{name}}}'] = 'Bearer'{{/isApiKey}}{{#isOAuth}}
+  # Configure OAuth2 access token for authorization: {{{name}}}
+  config.access_token = 'YOUR ACCESS TOKEN'
+  # Configure a proc to get access tokens in lieu of the static access_token configuration
+  config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } {{/isOAuth}}
+{{/authMethods}}end
+{{/hasAuthMethods}}
+api_instance = {{{moduleName}}}::{{{classname}}}.new
+{{#requiredParams}}
+{{{paramName}}} = {{{vendorExtensions.x-ruby-example}}} # {{{dataType}}} | {{{description}}}
+{{/requiredParams}}
+{{#optionalParams}}
+{{#-first}}
+opts = {
+{{/-first}}
+  {{{paramName}}}: {{{vendorExtensions.x-ruby-example}}}{{^-last}},{{/-last}} # {{{dataType}}} | {{{description}}}
+{{#-last}}
+}
+{{/-last}}
+{{/optionalParams}}
+begin
+{{#summary}}  #{{{.}}}
+{{/summary}}  {{#returnType}}result = {{/returnType}}api_instance.{{{operationId}}}{{#hasParams}}({{#requiredParams}}{{{paramName}}}{{^-last}}, {{/-last}}{{/requiredParams}}{{#optionalParams}}{{#-last}}{{#hasRequiredParams}}, {{/hasRequiredParams}}opts{{/-last}}{{/optionalParams}}){{/hasParams}}{{#returnType}}
+  p result{{/returnType}}
+rescue {{{moduleName}}}::ApiError => e
+  puts "Exception when calling {{classname}}->{{{operationId}}}: #{e}"
+end
+{{/-first}}{{/operation}}{{/operations}}{{/-first}}{{/apis}}{{/apiInfo}}
+```
+## Documentation for API Endpoints
+All URIs are relative to *{{basePath}}*
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{moduleName}}::{{classname}}* | [**{{operationId}}**]({{apiDocPath}}{{classname}}.md#{{operationId}}) | **{{httpMethod}}** {{path}} | {{{summary}}}
+{{/operation}}{{/operations}}{{/apis}}{{/apiInfo}}
+## Documentation for Models
+{{#models}}{{#model}} - [{{moduleName}}::{{classname}}]({{modelDocPath}}{{classname}}.md)
+{{/model}}{{/models}}
+## Documentation for Authorization
+{{^authMethods}} All endpoints do not require authorization.
+{{/authMethods}}{{#authMethods}}{{#last}} Authentication schemes defined for the API:{{/last}}{{/authMethods}}
+{{#authMethods}}### {{name}}
+{{#isApiKey}}
+- **Type**: API key
+- **API key parameter name**: {{keyParamName}}
+- **Location**: {{#isKeyInQuery}}URL query string{{/isKeyInQuery}}{{#isKeyInHeader}}HTTP header{{/isKeyInHeader}}
+{{/isApiKey}}
+{{#isBasic}}
+{{#isBasicBasic}}- **Type**: HTTP basic authentication
+{{/isBasicBasic}}{{#isBasicBearer}}- **Type**: Bearer authentication{{#bearerFormat}} ({{{.}}}){{/bearerFormat}}
+{{/isBasicBearer}}
+{{/isBasic}}
+{{#isOAuth}}
+- **Type**: OAuth
+- **Flow**: {{flow}}
+- **Authorization URL**: {{authorizationUrl}}
+- **Scopes**: {{^scopes}}N/A{{/scopes}}
+{{#scopes}}  - {{scope}}: {{description}}
+{{/scopes}}
+{{/isOAuth}}
+{{/authMethods}}

data/templates/ruby/Rakefile.mustache ADDED Viewed

@@ -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/templates/ruby/api.mustache ADDED Viewed

@@ -0,0 +1,255 @@
+=begin
+{{> api_info}}
+=end
+require 'cgi'
+module {{moduleName}}
+{{#operations}}
+  class {{classname}}
+    attr_accessor :api_client
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+{{#operation}}
+    {{#summary}}
+    # {{{.}}}
+    {{/summary}}
+    {{#notes}}
+    # {{{.}}}
+    {{/notes}}
+{{#vendorExtensions.x-group-parameters}}
+    # @param [Hash] opts the parameters
+{{#allParams}}
+{{#required}}
+    # @option opts [{{{dataType}}}] :{{paramName}} {{description}} (required)
+{{/required}}
+{{/allParams}}
+{{/vendorExtensions.x-group-parameters}}
+{{^vendorExtensions.x-group-parameters}}
+{{#allParams}}
+{{#required}}
+    # @param {{paramName}} [{{{dataType}}}] {{description}}
+{{/required}}
+{{/allParams}}
+    # @param [Hash] opts the optional parameters
+{{/vendorExtensions.x-group-parameters}}
+{{#allParams}}
+{{^required}}
+    # @option opts [{{{dataType}}}] :{{paramName}} {{description}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}}
+{{/required}}
+{{/allParams}}
+    # @return [{{{returnType}}}{{^returnType}}nil{{/returnType}}]
+    def {{operationId}}({{^vendorExtensions.x-group-parameters}}{{#allParams}}{{#required}}{{paramName}}, {{/required}}{{/allParams}}{{/vendorExtensions.x-group-parameters}}opts = {})
+      {{#returnType}}data, _status_code, _headers = {{/returnType}}{{operationId}}_with_http_info({{^vendorExtensions.x-group-parameters}}{{#allParams}}{{#required}}{{paramName}}, {{/required}}{{/allParams}}{{/vendorExtensions.x-group-parameters}}opts)
+      {{#returnType}}data{{/returnType}}{{^returnType}}nil{{/returnType}}
+    end
+    {{#summary}}
+    # {{.}}
+    {{/summary}}
+    {{#notes}}
+    # {{.}}
+    {{/notes}}
+{{#vendorExtensions.x-group-parameters}}
+    # @param [Hash] opts the parameters
+{{#allParams}}
+{{#required}}
+    # @option opts [{{{dataType}}}] :{{paramName}} {{description}} (required)
+{{/required}}
+{{/allParams}}
+{{/vendorExtensions.x-group-parameters}}
+{{^vendorExtensions.x-group-parameters}}
+{{#allParams}}
+{{#required}}
+    # @param {{paramName}} [{{{dataType}}}] {{description}}
+{{/required}}
+{{/allParams}}
+    # @param [Hash] opts the optional parameters
+{{/vendorExtensions.x-group-parameters}}
+{{#allParams}}
+{{^required}}
+    # @option opts [{{{dataType}}}] :{{paramName}} {{description}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}}
+{{/required}}
+{{/allParams}}
+    # @return [Array<({{{returnType}}}{{^returnType}}nil{{/returnType}}, Integer, Hash)>] {{#returnType}}{{{.}}} data{{/returnType}}{{^returnType}}nil{{/returnType}}, response status code and response headers
+    def {{operationId}}_with_http_info({{^vendorExtensions.x-group-parameters}}{{#allParams}}{{#required}}{{paramName}}, {{/required}}{{/allParams}}{{/vendorExtensions.x-group-parameters}}opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: {{classname}}.{{operationId}} ...'
+      end
+      {{#vendorExtensions.x-group-parameters}}
+      # unbox the parameters from the hash
+      {{#allParams}}
+      {{^isNullable}}
+      {{#required}}
+      {{{paramName}}} = opts[:'{{{paramName}}}']
+      {{/required}}
+      {{/isNullable}}
+      {{/allParams}}
+      {{/vendorExtensions.x-group-parameters}}
+      {{#allParams}}
+      {{^isNullable}}
+      {{#required}}
+      # verify the required parameter '{{paramName}}' is set
+      if @api_client.config.client_side_validation && {{{paramName}}}.nil?
+        fail ArgumentError, "Missing the required parameter '{{paramName}}' when calling {{classname}}.{{operationId}}"
+      end
+      {{#isEnum}}
+      {{^isContainer}}
+      # verify enum value
+      allowable_values = [{{#allowableValues}}{{#enumVars}}{{{value}}}{{^-last}}, {{/-last}}{{/enumVars}}{{/allowableValues}}]
+      if @api_client.config.client_side_validation && !allowable_values.include?({{{paramName}}})
+        fail ArgumentError, "invalid value for \"{{{paramName}}}\", must be one of #{allowable_values}"
+      end
+      {{/isContainer}}
+      {{/isEnum}}
+      {{/required}}
+      {{/isNullable}}
+      {{^required}}
+      {{#isEnum}}
+      {{#collectionFormat}}
+      allowable_values = [{{#allowableValues}}{{#enumVars}}{{{value}}}{{^-last}}, {{/-last}}{{/enumVars}}{{/allowableValues}}]
+      if @api_client.config.client_side_validation && opts[:'{{{paramName}}}'] && !opts[:'{{{paramName}}}'].all? { |item| allowable_values.include?(item) }
+        fail ArgumentError, "invalid value for \"{{{paramName}}}\", must include one of #{allowable_values}"
+      end
+      {{/collectionFormat}}
+      {{^collectionFormat}}
+      allowable_values = [{{#allowableValues}}{{#enumVars}}{{{value}}}{{^-last}}, {{/-last}}{{/enumVars}}{{/allowableValues}}]
+      if @api_client.config.client_side_validation && opts[:'{{{paramName}}}'] && !allowable_values.include?(opts[:'{{{paramName}}}'])
+        fail ArgumentError, "invalid value for \"{{{paramName}}}\", must be one of #{allowable_values}"
+      end
+      {{/collectionFormat}}
+      {{/isEnum}}
+      {{/required}}
+      {{#hasValidation}}
+      {{#maxLength}}
+      if @api_client.config.client_side_validation && {{^required}}!opts[:'{{{paramName}}}'].nil? && {{/required}}{{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:'{{{paramName}}}']{{/required}}.to_s.length > {{{maxLength}}}
+        fail ArgumentError, 'invalid value for "{{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:"{{{paramName}}}"]{{/required}}" when calling {{classname}}.{{operationId}}, the character length must be smaller than or equal to {{{maxLength}}}.'
+      end
+      {{/maxLength}}
+      {{#minLength}}
+      if @api_client.config.client_side_validation && {{^required}}!opts[:'{{{paramName}}}'].nil? && {{/required}}{{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:'{{{paramName}}}']{{/required}}.to_s.length < {{{minLength}}}
+        fail ArgumentError, 'invalid value for "{{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:"{{{paramName}}}"]{{/required}}" when calling {{classname}}.{{operationId}}, the character length must be great than or equal to {{{minLength}}}.'
+      end
+      {{/minLength}}
+      {{#maximum}}
+      if @api_client.config.client_side_validation && {{^required}}!opts[:'{{{paramName}}}'].nil? && {{/required}}{{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:'{{{paramName}}}']{{/required}} >{{#exclusiveMaximum}}={{/exclusiveMaximum}} {{{maximum}}}
+        fail ArgumentError, 'invalid value for "{{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:"{{{paramName}}}"]{{/required}}" when calling {{classname}}.{{operationId}}, must be smaller than {{^exclusiveMaximum}}or equal to {{/exclusiveMaximum}}{{{maximum}}}.'
+      end
+      {{/maximum}}
+      {{#minimum}}
+      if @api_client.config.client_side_validation && {{^required}}!opts[:'{{{paramName}}}'].nil? && {{/required}}{{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:'{{{paramName}}}']{{/required}} <{{#exclusiveMinimum}}={{/exclusiveMinimum}} {{{minimum}}}
+        fail ArgumentError, 'invalid value for "{{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:"{{{paramName}}}"]{{/required}}" when calling {{classname}}.{{operationId}}, must be greater than {{^exclusiveMinimum}}or equal to {{/exclusiveMinimum}}{{{minimum}}}.'
+      end
+      {{/minimum}}
+      {{#pattern}}
+      pattern = Regexp.new({{{pattern}}})
+      if @api_client.config.client_side_validation && {{^required}}!opts[:'{{{paramName}}}'].nil? && {{/required}}{{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:'{{{paramName}}}']{{/required}} !~ pattern
+        fail ArgumentError, "invalid value for '{{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:\"{{{paramName}}}\"]{{/required}}' when calling {{classname}}.{{operationId}}, must conform to the pattern #{pattern}."
+      end
+      {{/pattern}}
+      {{#maxItems}}
+      if @api_client.config.client_side_validation && {{^required}}!opts[:'{{{paramName}}}'].nil? && {{/required}}{{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:'{{{paramName}}}']{{/required}}.length > {{{maxItems}}}
+        fail ArgumentError, 'invalid value for "{{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:"{{{paramName}}}"]{{/required}}" when calling {{classname}}.{{operationId}}, number of items must be less than or equal to {{{maxItems}}}.'
+      end
+      {{/maxItems}}
+      {{#minItems}}
+      if @api_client.config.client_side_validation && {{^required}}!opts[:'{{{paramName}}}'].nil? && {{/required}}{{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:'{{{paramName}}}']{{/required}}.length < {{{minItems}}}
+        fail ArgumentError, 'invalid value for "{{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:"{{{paramName}}}"]{{/required}}" when calling {{classname}}.{{operationId}}, number of items must be greater than or equal to {{{minItems}}}.'
+      end
+      {{/minItems}}
+      {{/hasValidation}}
+      {{/allParams}}
+      # resource path
+      local_var_path = '{{{path}}}'{{#pathParams}}.sub('{' + '{{baseName}}' + '}', CGI.escape({{paramName}}.to_s){{^strictSpecBehavior}}.gsub('%2F', '/'){{/strictSpecBehavior}}){{/pathParams}}
+      # query parameters
+      query_params = opts[:query_params] || {}
+      {{#queryParams}}
+      {{#required}}
+      query_params[:'{{{baseName}}}'] = {{#collectionFormat}}@api_client.build_collection_param({{{paramName}}}, :{{{collectionFormat}}}){{/collectionFormat}}{{^collectionFormat}}{{{paramName}}}{{/collectionFormat}}
+      {{/required}}
+      {{/queryParams}}
+      {{#queryParams}}
+      {{^required}}
+      query_params[:'{{{baseName}}}'] = {{#collectionFormat}}@api_client.build_collection_param(opts[:'{{{paramName}}}'], :{{{collectionFormat}}}){{/collectionFormat}}{{^collectionFormat}}opts[:'{{{paramName}}}']{{/collectionFormat}} if !opts[:'{{{paramName}}}'].nil?
+      {{/required}}
+      {{/queryParams}}
+      # header parameters
+      header_params = opts[:header_params] || {}
+      {{#hasProduces}}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept([{{#produces}}'{{{mediaType}}}'{{^-last}}, {{/-last}}{{/produces}}])
+      {{/hasProduces}}
+      {{#hasConsumes}}
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type([{{#consumes}}'{{{mediaType}}}'{{^-last}}, {{/-last}}{{/consumes}}])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+      {{/hasConsumes}}
+      {{#headerParams}}
+      {{#required}}
+      header_params[:'{{{baseName}}}'] = {{#collectionFormat}}@api_client.build_collection_param({{{paramName}}}, :{{{collectionFormat}}}){{/collectionFormat}}{{^collectionFormat}}{{{paramName}}}{{/collectionFormat}}
+      {{/required}}
+      {{/headerParams}}
+      {{#headerParams}}
+      {{^required}}
+      header_params[:'{{{baseName}}}'] = {{#collectionFormat}}@api_client.build_collection_param(opts[:'{{{paramName}}}'], :{{{collectionFormat}}}){{/collectionFormat}}{{^collectionFormat}}opts[:'{{{paramName}}}']{{/collectionFormat}} if !opts[:'{{{paramName}}}'].nil?
+      {{/required}}
+      {{/headerParams}}
+      # form parameters
+      form_params = opts[:form_params] || {}
+      {{#formParams}}
+      {{#required}}
+      form_params['{{baseName}}'] = {{#collectionFormat}}@api_client.build_collection_param({{{paramName}}}, :{{{collectionFormat}}}){{/collectionFormat}}{{^collectionFormat}}{{{paramName}}}{{/collectionFormat}}
+      {{/required}}
+      {{/formParams}}
+      {{#formParams}}
+      {{^required}}
+      form_params['{{baseName}}'] = {{#collectionFormat}}@api_client.build_collection_param(opts[:'{{{paramName}}}'], :{{{collectionFormat}}}){{/collectionFormat}}{{^collectionFormat}}opts[:'{{{paramName}}}']{{/collectionFormat}} if !opts[:'{{paramName}}'].nil?
+      {{/required}}
+      {{/formParams}}
+      # http body (model)
+      post_body = opts[:debug_body]{{#bodyParam}} || @api_client.object_to_http_body({{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:'{{{paramName}}}']{{/required}}){{/bodyParam}}
+      # return_type
+      return_type = opts[:debug_return_type]{{#returnType}} || '{{{.}}}'{{/returnType}}
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [{{#authMethods}}'{{name}}'{{^-last}}, {{/-last}}{{/authMethods}}]
+      new_options = opts.merge(
+        :operation => :"{{classname}}.{{operationId}}",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+      data, status_code, headers = @api_client.call_api(:{{httpMethod}}, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: {{classname}}#{{operationId}}\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+{{^-last}}
+{{/-last}}
+{{/operation}}
+  end
+{{/operations}}
+end