clerk-http-client 1.0.0 → 2.0.0.beta1

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 (343) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +3 -3
  3. data/README.md +155 -191
  4. data/clerk-http-client.gemspec +1 -1
  5. data/docs/ActorTokensApi.md +26 -26
  6. data/docs/AllowListBlockListApi.md +72 -74
  7. data/docs/BetaFeaturesApi.md +42 -41
  8. data/docs/ClientsApi.md +36 -37
  9. data/docs/CreateBulkInvitationsRequestInner.md +28 -0
  10. data/docs/CreateInvitationRequest.md +6 -4
  11. data/docs/{CreateOAuthApplicationRequest.md → CreateOauthApplicationRequest.md} +1 -1
  12. data/docs/CreateOrganizationInvitationBulkRequestInner.md +2 -2
  13. data/docs/CreateOrganizationInvitationRequest.md +5 -3
  14. data/docs/CreateOrganizationRequest.md +3 -3
  15. data/docs/CreateSAMLConnectionRequest.md +2 -0
  16. data/docs/CreateSessionRequest.md +18 -0
  17. data/docs/CreateSessionToken200Response.md +20 -0
  18. data/docs/CreateSessionTokenFromTemplateRequest.md +18 -0
  19. data/docs/CreateSessionTokenRequest.md +18 -0
  20. data/docs/CreateUserRequest.md +3 -3
  21. data/docs/CreateWaitlistEntryRequest.md +20 -0
  22. data/docs/DomainsApi.md +46 -48
  23. data/docs/EmailAddress.md +2 -0
  24. data/docs/EmailAddressVerification.md +3 -3
  25. data/docs/EmailAddressesApi.md +52 -52
  26. data/docs/EmailSMSTemplatesApi.md +60 -66
  27. data/docs/FromOauth.md +26 -0
  28. data/docs/FromOauthError.md +47 -0
  29. data/docs/{GetOAuthAccessToken200ResponseInner.md → GetOauthAccessToken200ResponseInner.md} +4 -2
  30. data/docs/Instance.md +24 -0
  31. data/docs/InstanceSettingsApi.md +114 -45
  32. data/docs/Invitation.md +1 -1
  33. data/docs/InvitationsApi.md +110 -38
  34. data/docs/JWKS.md +18 -0
  35. data/docs/JWKSApi.md +14 -15
  36. data/docs/JWKSKeysInner.md +32 -0
  37. data/docs/JWTTemplatesApi.md +62 -63
  38. data/docs/ListWaitlistEntries200Response.md +20 -0
  39. data/docs/MergeOrganizationMetadataRequest.md +2 -2
  40. data/docs/MiscellaneousApi.md +11 -7
  41. data/docs/{OAuthApplication.md → OauthApplication.md} +4 -0
  42. data/docs/{OAuthApplicationWithSecret.md → OauthApplicationWithSecret.md} +4 -0
  43. data/docs/{OAuthApplicationsApi.md → OauthApplicationsApi.md} +90 -94
  44. data/docs/Organization.md +2 -2
  45. data/docs/OrganizationDomainApi.md +15 -13
  46. data/docs/OrganizationDomainsApi.md +103 -33
  47. data/docs/OrganizationInvitation.md +6 -2
  48. data/docs/OrganizationInvitationWithPublicOrganizationData.md +4 -2
  49. data/docs/OrganizationInvitationsApi.md +76 -81
  50. data/docs/OrganizationMembership.md +2 -2
  51. data/docs/OrganizationMembershipsApi.md +66 -70
  52. data/docs/OrganizationWithLogo.md +2 -2
  53. data/docs/OrganizationsApi.md +87 -93
  54. data/docs/PhoneNumbersApi.md +52 -52
  55. data/docs/ProxyChecksApi.md +16 -15
  56. data/docs/{RedirectURLsApi.md → RedirectUrlsApi.md} +46 -48
  57. data/docs/RevokeInvitation200Response.md +1 -1
  58. data/docs/SAML.md +1 -1
  59. data/docs/SAMLAccount.md +1 -1
  60. data/docs/SAMLConnectionsApi.md +59 -60
  61. data/docs/SchemasSAMLConnection.md +2 -0
  62. data/docs/SessionsApi.md +203 -60
  63. data/docs/SignInTokensApi.md +26 -26
  64. data/docs/SignUp.md +4 -2
  65. data/docs/SignUpsApi.md +16 -15
  66. data/docs/TestingTokensApi.md +11 -12
  67. data/docs/UpdateOrganizationMembershipMetadataRequest.md +2 -2
  68. data/docs/UpdateOrganizationRequest.md +2 -2
  69. data/docs/UpdateSAMLConnectionRequest.md +2 -0
  70. data/docs/UpdateUserRequest.md +3 -3
  71. data/docs/User.md +3 -3
  72. data/docs/UsersApi.md +297 -294
  73. data/docs/WaitlistEntriesApi.md +157 -0
  74. data/docs/WaitlistEntry.md +32 -0
  75. data/docs/WaitlistEntryInvitation.md +36 -0
  76. data/docs/WebhooksApi.md +30 -33
  77. data/lib/clerk-http-client/api/actor_tokens_api.rb +10 -14
  78. data/lib/clerk-http-client/api/allow_list_block_list_api.rb +25 -33
  79. data/lib/clerk-http-client/api/beta_features_api.rb +13 -21
  80. data/lib/clerk-http-client/api/clients_api.rb +13 -17
  81. data/lib/clerk-http-client/api/domains_api.rb +16 -20
  82. data/lib/clerk-http-client/api/email_addresses_api.rb +19 -27
  83. data/lib/clerk-http-client/api/email_sms_templates_api.rb +19 -19
  84. data/lib/clerk-http-client/api/instance_settings_api.rb +78 -31
  85. data/lib/clerk-http-client/api/invitations_api.rb +82 -17
  86. data/lib/clerk-http-client/api/jwks_api.rb +7 -7
  87. data/lib/clerk-http-client/api/jwt_templates_api.rb +22 -30
  88. data/lib/clerk-http-client/api/miscellaneous_api.rb +4 -4
  89. data/lib/clerk-http-client/api/{o_auth_applications_api.rb → oauth_applications_api.rb} +53 -57
  90. data/lib/clerk-http-client/api/organization_domains_api.rb +92 -10
  91. data/lib/clerk-http-client/api/organization_invitations_api.rb +25 -29
  92. data/lib/clerk-http-client/api/organization_memberships_api.rb +22 -26
  93. data/lib/clerk-http-client/api/organizations_api.rb +30 -34
  94. data/lib/clerk-http-client/api/phone_numbers_api.rb +19 -27
  95. data/lib/clerk-http-client/api/proxy_checks_api.rb +7 -11
  96. data/lib/clerk-http-client/api/redirect_urls_api.rb +16 -20
  97. data/lib/clerk-http-client/api/saml_connections_api.rb +22 -23
  98. data/lib/clerk-http-client/api/sessions_api.rb +165 -20
  99. data/lib/clerk-http-client/api/sign_in_tokens_api.rb +10 -14
  100. data/lib/clerk-http-client/api/sign_ups_api.rb +7 -11
  101. data/lib/clerk-http-client/api/testing_tokens_api.rb +6 -6
  102. data/lib/clerk-http-client/api/users_api.rb +149 -92
  103. data/lib/clerk-http-client/api/waitlist_entries_api.rb +178 -0
  104. data/lib/clerk-http-client/api/webhooks_api.rb +10 -10
  105. data/lib/clerk-http-client/api_client.rb +1 -1
  106. data/lib/clerk-http-client/api_error.rb +1 -1
  107. data/lib/clerk-http-client/configuration.rb +1 -1
  108. data/lib/clerk-http-client/models/actor_token.rb +1 -1
  109. data/lib/clerk-http-client/models/add_domain_request.rb +1 -1
  110. data/lib/clerk-http-client/models/admin.rb +1 -1
  111. data/lib/clerk-http-client/models/allowlist_identifier.rb +1 -1
  112. data/lib/clerk-http-client/models/blocklist_identifier.rb +1 -1
  113. data/lib/clerk-http-client/models/blocklist_identifiers.rb +1 -1
  114. data/lib/clerk-http-client/models/change_production_instance_domain_request.rb +1 -1
  115. data/lib/clerk-http-client/models/clerk_error.rb +1 -1
  116. data/lib/clerk-http-client/models/clerk_errors.rb +1 -1
  117. data/lib/clerk-http-client/models/client.rb +1 -1
  118. data/lib/clerk-http-client/models/{c_name_target.rb → cname_target.rb} +1 -1
  119. data/lib/clerk-http-client/models/create_actor_token_request.rb +1 -1
  120. data/lib/clerk-http-client/models/create_allowlist_identifier_request.rb +1 -1
  121. data/lib/clerk-http-client/models/create_blocklist_identifier_request.rb +1 -1
  122. data/lib/clerk-http-client/models/create_bulk_invitations_request_inner.rb +305 -0
  123. data/lib/clerk-http-client/models/create_email_address_request.rb +1 -1
  124. data/lib/clerk-http-client/models/create_invitation_request.rb +57 -10
  125. data/lib/clerk-http-client/models/create_jwt_template_request.rb +1 -1
  126. data/lib/clerk-http-client/models/{create_o_auth_application_request.rb → create_oauth_application_request.rb} +1 -8
  127. data/lib/clerk-http-client/models/create_organization_domain_request.rb +1 -1
  128. data/lib/clerk-http-client/models/create_organization_invitation_bulk_request_inner.rb +11 -7
  129. data/lib/clerk-http-client/models/create_organization_invitation_request.rb +50 -11
  130. data/lib/clerk-http-client/models/create_organization_membership_request.rb +1 -1
  131. data/lib/clerk-http-client/models/create_organization_request.rb +9 -12
  132. data/lib/clerk-http-client/models/create_phone_number_request.rb +1 -1
  133. data/lib/clerk-http-client/models/create_redirect_url_request.rb +1 -1
  134. data/lib/clerk-http-client/models/create_saml_connection_request.rb +13 -2
  135. data/lib/clerk-http-client/models/create_saml_connection_request_attribute_mapping.rb +1 -1
  136. data/lib/clerk-http-client/models/create_session_request.rb +215 -0
  137. data/lib/clerk-http-client/models/create_session_token200_response.rb +257 -0
  138. data/lib/clerk-http-client/models/create_session_token_from_template_request.rb +240 -0
  139. data/lib/clerk-http-client/models/create_session_token_request.rb +240 -0
  140. data/lib/clerk-http-client/models/create_sign_in_token_request.rb +1 -1
  141. data/lib/clerk-http-client/models/create_user_request.rb +13 -7
  142. data/lib/clerk-http-client/models/create_waitlist_entry_request.rb +232 -0
  143. data/lib/clerk-http-client/models/deleted_object.rb +1 -1
  144. data/lib/clerk-http-client/models/disable_mfa200_response.rb +1 -1
  145. data/lib/clerk-http-client/models/domain.rb +1 -1
  146. data/lib/clerk-http-client/models/domains.rb +1 -1
  147. data/lib/clerk-http-client/models/email_address.rb +12 -2
  148. data/lib/clerk-http-client/models/email_address_verification.rb +3 -3
  149. data/lib/clerk-http-client/models/from_o_auth.rb +324 -0
  150. data/{resources/templates/partial_anyof_module.mustache → lib/clerk-http-client/models/from_o_auth_error.rb} +29 -19
  151. data/lib/clerk-http-client/models/from_oauth.rb +324 -0
  152. data/{resources/templates/partial_oneof_module.mustache → lib/clerk-http-client/models/from_oauth_error.rb} +21 -54
  153. data/lib/clerk-http-client/models/{get_o_auth_access_token200_response_inner.rb → get_oauth_access_token200_response_inner.rb} +20 -7
  154. data/lib/clerk-http-client/models/identification_link.rb +3 -3
  155. data/lib/clerk-http-client/models/instance.rb +279 -0
  156. data/lib/clerk-http-client/models/instance_restrictions.rb +1 -1
  157. data/lib/clerk-http-client/models/invitation.rb +5 -3
  158. data/lib/clerk-http-client/models/jwks.rb +216 -0
  159. data/lib/clerk-http-client/models/jwks_keys_inner.rb +277 -0
  160. data/lib/clerk-http-client/models/jwt_template.rb +1 -1
  161. data/lib/clerk-http-client/models/list_waitlist_entries200_response.rb +240 -0
  162. data/lib/clerk-http-client/models/merge_organization_metadata_request.rb +9 -5
  163. data/lib/clerk-http-client/models/o_auth_application.rb +34 -2
  164. data/lib/clerk-http-client/models/o_auth_application_with_secret.rb +34 -2
  165. data/lib/clerk-http-client/models/o_auth_applications.rb +1 -1
  166. data/lib/clerk-http-client/models/oauth.rb +2 -2
  167. data/lib/clerk-http-client/models/oauth_application.rb +481 -0
  168. data/lib/clerk-http-client/models/oauth_application_with_secret.rb +498 -0
  169. data/lib/clerk-http-client/models/oauth_applications.rb +240 -0
  170. data/lib/clerk-http-client/models/organization.rb +10 -5
  171. data/lib/clerk-http-client/models/organization_domain.rb +1 -1
  172. data/lib/clerk-http-client/models/organization_domain_verification.rb +1 -1
  173. data/lib/clerk-http-client/models/organization_domains.rb +1 -1
  174. data/lib/clerk-http-client/models/organization_invitation.rb +31 -6
  175. data/lib/clerk-http-client/models/organization_invitation_with_public_organization_data.rb +20 -6
  176. data/lib/clerk-http-client/models/organization_invitation_with_public_organization_data_public_organization_data.rb +1 -1
  177. data/lib/clerk-http-client/models/organization_invitations.rb +1 -1
  178. data/lib/clerk-http-client/models/organization_invitations_with_public_organization_data.rb +1 -1
  179. data/lib/clerk-http-client/models/organization_membership.rb +9 -5
  180. data/lib/clerk-http-client/models/organization_membership_public_user_data.rb +1 -1
  181. data/lib/clerk-http-client/models/organization_memberships.rb +1 -1
  182. data/lib/clerk-http-client/models/organization_settings.rb +1 -1
  183. data/lib/clerk-http-client/models/organization_with_logo.rb +10 -5
  184. data/lib/clerk-http-client/models/organizations.rb +1 -1
  185. data/lib/clerk-http-client/models/otp.rb +1 -1
  186. data/lib/clerk-http-client/models/passkey.rb +1 -1
  187. data/lib/clerk-http-client/models/phone_number.rb +1 -1
  188. data/lib/clerk-http-client/models/phone_number_verification.rb +1 -1
  189. data/lib/clerk-http-client/models/preview_template_request.rb +1 -1
  190. data/lib/clerk-http-client/models/proxy_check.rb +1 -1
  191. data/lib/clerk-http-client/models/redirect_url.rb +1 -1
  192. data/lib/clerk-http-client/models/revoke_invitation200_response.rb +5 -3
  193. data/lib/clerk-http-client/models/revoke_organization_invitation_request.rb +1 -1
  194. data/lib/clerk-http-client/models/saml.rb +2 -2
  195. data/lib/clerk-http-client/models/saml_account.rb +5 -3
  196. data/lib/clerk-http-client/models/saml_account_saml_connection.rb +1 -1
  197. data/lib/clerk-http-client/models/saml_account_verification.rb +1 -1
  198. data/lib/clerk-http-client/models/saml_connection.rb +1 -1
  199. data/lib/clerk-http-client/models/saml_connections.rb +1 -1
  200. data/lib/clerk-http-client/models/schemas_passkey.rb +1 -1
  201. data/lib/clerk-http-client/models/schemas_passkey_verification.rb +1 -1
  202. data/lib/clerk-http-client/models/schemas_saml_connection.rb +12 -2
  203. data/lib/clerk-http-client/models/schemas_saml_connection_attribute_mapping.rb +1 -1
  204. data/lib/clerk-http-client/models/session.rb +1 -1
  205. data/lib/clerk-http-client/models/session_latest_activity.rb +1 -1
  206. data/lib/clerk-http-client/models/sign_in_token.rb +1 -1
  207. data/lib/clerk-http-client/models/sign_up.rb +21 -6
  208. data/lib/clerk-http-client/models/svix_url.rb +1 -1
  209. data/lib/clerk-http-client/models/template.rb +1 -1
  210. data/lib/clerk-http-client/models/testing_token.rb +1 -1
  211. data/lib/clerk-http-client/models/ticket.rb +1 -1
  212. data/lib/clerk-http-client/models/toggle_template_delivery_request.rb +1 -1
  213. data/lib/clerk-http-client/models/total_count.rb +1 -1
  214. data/lib/clerk-http-client/models/totp.rb +1 -1
  215. data/lib/clerk-http-client/models/update_domain_request.rb +1 -1
  216. data/lib/clerk-http-client/models/update_email_address_request.rb +1 -1
  217. data/lib/clerk-http-client/models/update_instance_auth_config200_response.rb +1 -1
  218. data/lib/clerk-http-client/models/update_instance_auth_config_request.rb +1 -1
  219. data/lib/clerk-http-client/models/update_instance_organization_settings_request.rb +1 -1
  220. data/lib/clerk-http-client/models/update_instance_request.rb +1 -1
  221. data/lib/clerk-http-client/models/update_instance_restrictions_request.rb +1 -1
  222. data/lib/clerk-http-client/models/{update_o_auth_application_request.rb → update_oauth_application_request.rb} +1 -1
  223. data/lib/clerk-http-client/models/update_organization_domain_request.rb +1 -1
  224. data/lib/clerk-http-client/models/update_organization_membership_metadata_request.rb +9 -5
  225. data/lib/clerk-http-client/models/update_organization_membership_request.rb +1 -1
  226. data/lib/clerk-http-client/models/update_organization_request.rb +9 -5
  227. data/lib/clerk-http-client/models/update_phone_number_request.rb +1 -1
  228. data/lib/clerk-http-client/models/update_production_instance_domain_request.rb +1 -1
  229. data/lib/clerk-http-client/models/update_saml_connection_request.rb +13 -2
  230. data/lib/clerk-http-client/models/update_saml_connection_request_attribute_mapping.rb +1 -1
  231. data/lib/clerk-http-client/models/update_sign_up_request.rb +1 -1
  232. data/lib/clerk-http-client/models/update_user_metadata_request.rb +1 -1
  233. data/lib/clerk-http-client/models/update_user_request.rb +13 -7
  234. data/lib/clerk-http-client/models/upsert_template_request.rb +1 -1
  235. data/lib/clerk-http-client/models/user.rb +13 -7
  236. data/lib/clerk-http-client/models/verify_client_request.rb +1 -1
  237. data/lib/clerk-http-client/models/verify_domain_proxy_request.rb +1 -1
  238. data/lib/clerk-http-client/models/verify_password200_response.rb +1 -1
  239. data/lib/clerk-http-client/models/verify_password_request.rb +1 -1
  240. data/lib/clerk-http-client/models/verify_session_request.rb +1 -1
  241. data/lib/clerk-http-client/models/verify_totp200_response.rb +1 -1
  242. data/lib/clerk-http-client/models/verify_totp_request.rb +1 -1
  243. data/lib/clerk-http-client/models/waitlist_entry.rb +369 -0
  244. data/lib/clerk-http-client/models/waitlist_entry_invitation.rb +397 -0
  245. data/lib/clerk-http-client/models/web3_signature.rb +3 -3
  246. data/lib/clerk-http-client/models/web3_wallet.rb +1 -1
  247. data/lib/clerk-http-client/models/web3_wallet_verification.rb +1 -1
  248. data/lib/clerk-http-client/version.rb +1 -1
  249. data/lib/clerk-http-client.rb +54 -59
  250. data/spec/api/actor_tokens_api_spec.rb +1 -1
  251. data/spec/api/allow_list_block_list_api_spec.rb +2 -2
  252. data/spec/api/beta_features_api_spec.rb +2 -2
  253. data/spec/api/clients_api_spec.rb +1 -1
  254. data/spec/api/domains_api_spec.rb +1 -1
  255. data/spec/api/email_addresses_api_spec.rb +2 -2
  256. data/spec/api/instance_settings_api_spec.rb +3 -3
  257. data/spec/api/invitations_api_spec.rb +1 -1
  258. data/spec/api/jwt_templates_api_spec.rb +2 -2
  259. data/spec/api/{o_auth_applications_api_spec.rb → oauth_applications_api_spec.rb} +15 -15
  260. data/spec/api/organizations_api_spec.rb +1 -1
  261. data/spec/api/phone_numbers_api_spec.rb +2 -2
  262. data/spec/api/proxy_checks_api_spec.rb +1 -1
  263. data/spec/api/redirect_urls_api_spec.rb +1 -1
  264. data/spec/api/saml_connections_api_spec.rb +1 -1
  265. data/spec/api/sign_in_tokens_api_spec.rb +1 -1
  266. data/spec/api/sign_ups_api_spec.rb +1 -1
  267. data/spec/api/users_api_spec.rb +3 -3
  268. data/spec/api/waitlist_entries_api_spec.rb +63 -0
  269. data/spec/models/cname_target_spec.rb +48 -0
  270. data/spec/models/create_bulk_invitations_request_inner_spec.rb +66 -0
  271. data/spec/models/create_oauth_application_request_spec.rb +54 -0
  272. data/spec/models/create_session_request_spec.rb +36 -0
  273. data/spec/models/create_session_token200_response_spec.rb +46 -0
  274. data/spec/models/create_session_token_from_template_request_spec.rb +36 -0
  275. data/spec/models/create_session_token_request_spec.rb +36 -0
  276. data/spec/models/create_waitlist_entry_request_spec.rb +42 -0
  277. data/spec/models/from_o_auth_error_spec.rb +32 -0
  278. data/spec/models/from_o_auth_spec.rb +64 -0
  279. data/spec/models/from_oauth_error_spec.rb +32 -0
  280. data/spec/models/from_oauth_spec.rb +64 -0
  281. data/spec/models/get_oauth_access_token200_response_inner_spec.rb +90 -0
  282. data/spec/models/identification_link_spec.rb +1 -1
  283. data/spec/models/instance_spec.rb +58 -0
  284. data/spec/models/jwks_keys_inner_spec.rb +78 -0
  285. data/spec/models/jwks_spec.rb +36 -0
  286. data/spec/models/list_waitlist_entries200_response_spec.rb +42 -0
  287. data/spec/models/oauth_application_spec.rb +124 -0
  288. data/spec/models/oauth_application_with_secret_spec.rb +130 -0
  289. data/spec/models/oauth_applications_spec.rb +42 -0
  290. data/spec/models/oauth_spec.rb +1 -1
  291. data/spec/models/update_oauth_application_request_spec.rb +48 -0
  292. data/spec/models/waitlist_entry_invitation_spec.rb +98 -0
  293. data/spec/models/waitlist_entry_spec.rb +86 -0
  294. data/spec/spec_helper.rb +1 -1
  295. metadata +104 -65
  296. data/bin/fmt +0 -5
  297. data/bin/generate +0 -8
  298. data/bin/setup +0 -7
  299. data/openapitools.json +0 -7
  300. data/pkg/clerk-http-client-1.0.0.gem +0 -0
  301. data/resources/.DS_Store +0 -0
  302. data/resources/oas/bapi-2024-10-01.yml +0 -7238
  303. data/resources/templates/Gemfile.mustache +0 -9
  304. data/resources/templates/README.mustache +0 -163
  305. data/resources/templates/Rakefile.mustache +0 -10
  306. data/resources/templates/api.mustache +0 -257
  307. data/resources/templates/api_client.mustache +0 -246
  308. data/resources/templates/api_client_faraday_partial.mustache +0 -200
  309. data/resources/templates/api_client_httpx_partial.mustache +0 -134
  310. data/resources/templates/api_client_typhoeus_partial.mustache +0 -161
  311. data/resources/templates/api_doc.mustache +0 -132
  312. data/resources/templates/api_error.mustache +0 -50
  313. data/resources/templates/api_info.mustache +0 -12
  314. data/resources/templates/api_test.mustache +0 -47
  315. data/resources/templates/base_object.mustache +0 -114
  316. data/resources/templates/configuration.mustache +0 -491
  317. data/resources/templates/configuration_faraday_partial.mustache +0 -40
  318. data/resources/templates/configuration_httpx_partial.mustache +0 -11
  319. data/resources/templates/configuration_typhoeus_partial.mustache +0 -41
  320. data/resources/templates/gem.mustache +0 -89
  321. data/resources/templates/gemspec.mustache +0 -41
  322. data/resources/templates/git_push.sh.mustache +0 -57
  323. data/resources/templates/gitignore.mustache +0 -39
  324. data/resources/templates/gitlab-ci.mustache +0 -26
  325. data/resources/templates/model.mustache +0 -33
  326. data/resources/templates/model_doc.mustache +0 -12
  327. data/resources/templates/model_test.mustache +0 -82
  328. data/resources/templates/partial_model_enum_class.mustache +0 -23
  329. data/resources/templates/partial_model_generic.mustache +0 -377
  330. data/resources/templates/partial_model_generic_doc.mustache +0 -28
  331. data/resources/templates/partial_oneof_module_doc.mustache +0 -93
  332. data/resources/templates/rspec.mustache +0 -2
  333. data/resources/templates/rubocop.mustache +0 -148
  334. data/resources/templates/spec_helper.mustache +0 -103
  335. data/resources/templates/travis.mustache +0 -11
  336. data/resources/templates/version.mustache +0 -7
  337. data/sdk-generator-config.json +0 -25
  338. /data/docs/{CNameTarget.md → CnameTarget.md} +0 -0
  339. /data/docs/{CreateRedirectURLRequest.md → CreateRedirectUrlRequest.md} +0 -0
  340. /data/docs/{OAuthApplications.md → OauthApplications.md} +0 -0
  341. /data/docs/{RedirectURL.md → RedirectUrl.md} +0 -0
  342. /data/docs/{SvixURL.md → SvixUrl.md} +0 -0
  343. /data/docs/{UpdateOAuthApplicationRequest.md → UpdateOauthApplicationRequest.md} +0 -0
@@ -1,9 +0,0 @@
1
- source 'https://rubygems.org'
2
-
3
- gemspec
4
-
5
- group :development, :test do
6
- gem 'rake', '~> 13.0.1'
7
- gem 'pry-byebug'
8
- gem 'rubocop', '~> 0.66.0'
9
- end
@@ -1,163 +0,0 @@
1
- # {{gemName}}
2
-
3
- {{moduleName}} - the Ruby gem for the {{appName}}
4
-
5
- {{#appDescriptionWithNewLines}}
6
- {{{.}}}
7
- {{/appDescriptionWithNewLines}}
8
-
9
- This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
10
-
11
- - API version: {{appVersion}}
12
- - Package version: {{gemVersion}}
13
- {{^hideGenerationTimestamp}}
14
- - Build date: {{generatedDate}}
15
- {{/hideGenerationTimestamp}}
16
- - Generator version: {{generatorVersion}}
17
- - Build package: {{generatorClass}}
18
- {{#infoUrl}}
19
- For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}})
20
- {{/infoUrl}}
21
-
22
- ## Installation
23
-
24
- ### Build a gem
25
-
26
- To build the Ruby code into a gem:
27
-
28
- ```shell
29
- gem build {{{gemName}}}.gemspec
30
- ```
31
-
32
- Then either install the gem locally:
33
-
34
- ```shell
35
- gem install ./{{{gemName}}}-{{{gemVersion}}}.gem
36
- ```
37
-
38
- (for development, run `gem install --dev ./{{{gemName}}}-{{{gemVersion}}}.gem` to install the development dependencies)
39
-
40
- or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
41
-
42
- Finally add this to the Gemfile:
43
-
44
- gem '{{{gemName}}}', '~> {{{gemVersion}}}'
45
-
46
- ### Install from Git
47
-
48
- 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:
49
-
50
- gem '{{{gemName}}}', :git => 'https://{{gitHost}}/{{gitUserId}}{{^gitUserId}}YOUR_GIT_USERNAME{{/gitUserId}}/{{gitRepoId}}{{^gitRepoId}}YOUR_GIT_REPO{{/gitRepoId}}.git'
51
-
52
- ### Include the Ruby code directly
53
-
54
- Include the Ruby code directly using `-I` as follows:
55
-
56
- ```shell
57
- ruby -Ilib script.rb
58
- ```
59
-
60
- ## Getting Started
61
-
62
- Please follow the [installation](#installation) procedure and then run the following code:
63
-
64
- ```ruby
65
- # Load the gem
66
- require '{{{gemName}}}'
67
- {{#apiInfo}}{{#apis}}{{#-first}}{{#operations}}{{#operation}}{{#-first}}{{#hasAuthMethods}}
68
- # Setup authorization
69
- {{{moduleName}}}.configure do |config|{{#authMethods}}{{#isBasic}}{{#isBasicBasic}}
70
- # Configure HTTP basic authorization: {{{name}}}
71
- config.username = 'YOUR_USERNAME'
72
- config.password = 'YOUR_PASSWORD'{{/isBasicBasic}}{{#isBasicBearer}}
73
- # Configure Bearer authorization{{#bearerFormat}} ({{{.}}}){{/bearerFormat}}: {{{name}}}
74
- config.access_token = 'YOUR_BEARER_TOKEN'
75
- # Configure a proc to get access tokens in lieu of the static access_token configuration
76
- config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } {{/isBasicBearer}}{{/isBasic}}{{#isApiKey}}
77
- # Configure API key authorization: {{{name}}}
78
- config.api_key['{{{keyParamName}}}'] = 'YOUR API KEY'
79
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
80
- # config.api_key_prefix['{{{keyParamName}}}'] = 'Bearer'{{/isApiKey}}{{#isOAuth}}
81
- # Configure OAuth2 access token for authorization: {{{name}}}
82
- config.access_token = 'YOUR ACCESS TOKEN'
83
- # Configure a proc to get access tokens in lieu of the static access_token configuration
84
- config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } {{/isOAuth}}
85
- {{#isFaraday}}
86
- # Configure faraday connection
87
- config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
88
- {{/isFaraday}}
89
- {{#isHttpx}}
90
- # Configure httpx session
91
- config.configure_session { |session| 'YOUR CONNECTION CONFIG PROC' }
92
- {{/isHttpx}}
93
- {{/authMethods}}end
94
- {{/hasAuthMethods}}
95
-
96
- api_instance = {{{moduleName}}}::{{{classname}}}.new
97
- {{#requiredParams}}
98
- {{{paramName}}} = {{{vendorExtensions.x-ruby-example}}} # {{{dataType}}} | {{{description}}}
99
- {{/requiredParams}}
100
- {{#optionalParams}}
101
- {{#-first}}
102
- opts = {
103
- {{/-first}}
104
- {{{paramName}}}: {{{vendorExtensions.x-ruby-example}}}{{^-last}},{{/-last}} # {{{dataType}}} | {{{description}}}
105
- {{#-last}}
106
- }
107
- {{/-last}}
108
- {{/optionalParams}}
109
-
110
- begin
111
- {{#summary}} #{{{.}}}
112
- {{/summary}} {{#returnType}}result = {{/returnType}}api_instance.{{{operationId}}}{{#hasParams}}({{#requiredParams}}{{{paramName}}}{{^-last}}, {{/-last}}{{/requiredParams}}{{#optionalParams}}{{#-last}}{{#hasRequiredParams}}, {{/hasRequiredParams}}opts{{/-last}}{{/optionalParams}}){{/hasParams}}{{#returnType}}
113
- p result{{/returnType}}
114
- rescue {{{moduleName}}}::ApiError => e
115
- puts "Exception when calling {{classname}}->{{{operationId}}}: #{e}"
116
- end
117
- {{/-first}}{{/operation}}{{/operations}}{{/-first}}{{/apis}}{{/apiInfo}}
118
- ```
119
-
120
- ## Documentation for API Endpoints
121
-
122
- All URIs are relative to *{{basePath}}*
123
-
124
- Class | Method | HTTP request | Description
125
- ------------ | ------------- | ------------- | -------------
126
- {{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{moduleName}}::{{classname}}* | [**{{operationId}}**]({{apiDocPath}}{{classname}}.md#{{operationId}}) | **{{httpMethod}}** {{path}} | {{{summary}}}
127
- {{/operation}}{{/operations}}{{/apis}}{{/apiInfo}}
128
-
129
- ## Documentation for Models
130
-
131
- {{#models}}{{#model}} - [{{moduleName}}::{{classname}}]({{modelDocPath}}{{classname}}.md)
132
- {{/model}}{{/models}}
133
-
134
- ## Documentation for Authorization
135
-
136
- {{^authMethods}}Endpoints do not require authorization.{{/authMethods}}
137
- {{#hasAuthMethods}}Authentication schemes defined for the API:{{/hasAuthMethods}}
138
- {{#authMethods}}
139
- ### {{name}}
140
-
141
- {{#isApiKey}}
142
-
143
- - **Type**: API key
144
- - **API key parameter name**: {{keyParamName}}
145
- - **Location**: {{#isKeyInQuery}}URL query string{{/isKeyInQuery}}{{#isKeyInHeader}}HTTP header{{/isKeyInHeader}}
146
- {{/isApiKey}}
147
- {{#isBasic}}
148
- {{#isBasicBasic}}- **Type**: HTTP basic authentication
149
- {{/isBasicBasic}}{{#isBasicBearer}}- **Type**: Bearer authentication{{#bearerFormat}} ({{{.}}}){{/bearerFormat}}
150
- {{/isBasicBearer}}{{#isHttpSignature}}- **Type**: HTTP signature authentication
151
- {{/isHttpSignature}}
152
- {{/isBasic}}
153
- {{#isOAuth}}
154
-
155
- - **Type**: OAuth
156
- - **Flow**: {{flow}}
157
- - **Authorization URL**: {{authorizationUrl}}
158
- - **Scopes**: {{^scopes}}N/A{{/scopes}}
159
- {{#scopes}} - {{scope}}: {{description}}
160
- {{/scopes}}
161
- {{/isOAuth}}
162
-
163
- {{/authMethods}}
@@ -1,10 +0,0 @@
1
- require "bundler/gem_tasks"
2
-
3
- begin
4
- require 'rspec/core/rake_task'
5
-
6
- RSpec::Core::RakeTask.new(:spec)
7
- task default: :spec
8
- rescue LoadError
9
- # no rspec available
10
- end
@@ -1,257 +0,0 @@
1
- =begin
2
- {{> api_info}}
3
- =end
4
-
5
- require 'cgi'
6
-
7
- module {{moduleName}}
8
- {{#operations}}
9
- class {{classname}}
10
- attr_accessor :api_client
11
-
12
- def initialize(api_client = ApiClient.default)
13
- @api_client = api_client
14
- end
15
- {{#operation}}
16
- {{#summary}}
17
- # {{{.}}}
18
- {{/summary}}
19
- {{#notes}}
20
- # {{{.}}}
21
- {{/notes}}
22
- {{#vendorExtensions.x-group-parameters}}
23
- # @param [Hash] opts the parameters
24
- {{#allParams}}
25
- {{#required}}
26
- # @option opts [{{{dataType}}}] :{{paramName}} {{description}} (required)
27
- {{/required}}
28
- {{/allParams}}
29
- {{/vendorExtensions.x-group-parameters}}
30
- {{^vendorExtensions.x-group-parameters}}
31
- {{#allParams}}
32
- {{#required}}
33
- # @param {{paramName}} [{{{dataType}}}] {{description}}
34
- {{/required}}
35
- {{/allParams}}
36
- # @param [Hash] opts the optional parameters
37
- {{/vendorExtensions.x-group-parameters}}
38
- {{#allParams}}
39
- {{^required}}
40
- # @option opts [{{{dataType}}}] :{{paramName}} {{description}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}}
41
- {{/required}}
42
- {{/allParams}}
43
- # @return [{{{returnType}}}{{^returnType}}nil{{/returnType}}]
44
-
45
- def {{ vendorExtensions.x-sdk-ruby-operationId }}{{ ^vendorExtensions.x-sdk-ruby-operationId }}{{operationId}}{{ /vendorExtensions.x-sdk-ruby-operationId }}({{^vendorExtensions.x-group-parameters}}{{#allParams}}{{#required}}{{paramName}}, {{/required}}{{/allParams}}{{/vendorExtensions.x-group-parameters}}opts = {})
46
- {{#returnType}}data, _status_code, _headers = {{/returnType}}{{ vendorExtensions.x-sdk-ruby-operationId }}{{ ^vendorExtensions.x-sdk-ruby-operationId }}{{operationId}}{{ /vendorExtensions.x-sdk-ruby-operationId }}_with_http_info({{^vendorExtensions.x-group-parameters}}{{#allParams}}{{#required}}{{paramName}}, {{/required}}{{/allParams}}{{/vendorExtensions.x-group-parameters}}opts)
47
- {{#returnType}}data{{/returnType}}{{^returnType}}nil{{/returnType}}
48
- end
49
-
50
- {{#summary}}
51
- # {{.}}
52
- {{/summary}}
53
- {{#notes}}
54
- # {{.}}
55
- {{/notes}}
56
- {{#vendorExtensions.x-group-parameters}}
57
- # @param [Hash] opts the parameters
58
- {{#allParams}}
59
- {{#required}}
60
- # @option opts [{{{dataType}}}] :{{paramName}} {{description}} (required)
61
- {{/required}}
62
- {{/allParams}}
63
- {{/vendorExtensions.x-group-parameters}}
64
- {{^vendorExtensions.x-group-parameters}}
65
- {{#allParams}}
66
- {{#required}}
67
- # @param {{paramName}} [{{{dataType}}}] {{description}}
68
- {{/required}}
69
- {{/allParams}}
70
- # @param [Hash] opts the optional parameters
71
- {{/vendorExtensions.x-group-parameters}}
72
- {{#allParams}}
73
- {{^required}}
74
- # @option opts [{{{dataType}}}] :{{paramName}} {{description}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}}
75
- {{/required}}
76
- {{/allParams}}
77
- # @return [Array<({{{returnType}}}{{^returnType}}nil{{/returnType}}, Integer, Hash)>] {{#returnType}}{{{.}}} data{{/returnType}}{{^returnType}}nil{{/returnType}}, response status code and response headers
78
- # {{ httpMethod }} {{ returnContainer }}
79
- def {{ vendorExtensions.x-sdk-ruby-operationId }}{{ ^vendorExtensions.x-sdk-ruby-operationId }}{{operationId}}{{ /vendorExtensions.x-sdk-ruby-operationId }}_with_http_info({{^vendorExtensions.x-group-parameters}}{{#allParams}}{{#required}}{{paramName}}, {{/required}}{{/allParams}}{{/vendorExtensions.x-group-parameters}}opts = {})
80
- if @api_client.config.debugging
81
- @api_client.config.logger.debug 'Calling API: {{classname}}.{{operationId}} ...'
82
- end
83
- {{#vendorExtensions.x-group-parameters}}
84
- # unbox the parameters from the hash
85
- {{#allParams}}
86
- {{^isNullable}}
87
- {{#required}}
88
- {{{paramName}}} = opts[:'{{{paramName}}}']
89
- {{/required}}
90
- {{/isNullable}}
91
- {{/allParams}}
92
- {{/vendorExtensions.x-group-parameters}}
93
- {{#allParams}}
94
- {{^isNullable}}
95
- {{#required}}
96
- # verify the required parameter '{{paramName}}' is set
97
- if @api_client.config.client_side_validation && {{{paramName}}}.nil?
98
- fail ArgumentError, "Missing the required parameter '{{paramName}}' when calling {{classname}}.{{operationId}}"
99
- end
100
- {{#isEnum}}
101
- {{^isContainer}}
102
- # verify enum value
103
- allowable_values = [{{#allowableValues}}{{#enumVars}}{{{value}}}{{^-last}}, {{/-last}}{{/enumVars}}{{/allowableValues}}]
104
- if @api_client.config.client_side_validation && !allowable_values.include?({{{paramName}}})
105
- fail ArgumentError, "invalid value for \"{{{paramName}}}\", must be one of #{allowable_values}"
106
- end
107
- {{/isContainer}}
108
- {{/isEnum}}
109
- {{/required}}
110
- {{/isNullable}}
111
- {{^required}}
112
- {{#isEnum}}
113
- {{#collectionFormat}}
114
- allowable_values = [{{#allowableValues}}{{#enumVars}}{{{value}}}{{^-last}}, {{/-last}}{{/enumVars}}{{/allowableValues}}]
115
- if @api_client.config.client_side_validation && opts[:'{{{paramName}}}'] && !opts[:'{{{paramName}}}'].all? { |item| allowable_values.include?(item) }
116
- fail ArgumentError, "invalid value for \"{{{paramName}}}\", must include one of #{allowable_values}"
117
- end
118
- {{/collectionFormat}}
119
- {{^collectionFormat}}
120
- allowable_values = [{{#allowableValues}}{{#enumVars}}{{{value}}}{{^-last}}, {{/-last}}{{/enumVars}}{{/allowableValues}}]
121
- if @api_client.config.client_side_validation && opts[:'{{{paramName}}}'] && !allowable_values.include?(opts[:'{{{paramName}}}'])
122
- fail ArgumentError, "invalid value for \"{{{paramName}}}\", must be one of #{allowable_values}"
123
- end
124
- {{/collectionFormat}}
125
- {{/isEnum}}
126
- {{/required}}
127
- {{#hasValidation}}
128
- {{#maxLength}}
129
- if @api_client.config.client_side_validation && {{^required}}!opts[:'{{{paramName}}}'].nil? && {{/required}}{{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:'{{{paramName}}}']{{/required}}.to_s.length > {{{maxLength}}}
130
- 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}}}.'
131
- end
132
-
133
- {{/maxLength}}
134
- {{#minLength}}
135
- if @api_client.config.client_side_validation && {{^required}}!opts[:'{{{paramName}}}'].nil? && {{/required}}{{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:'{{{paramName}}}']{{/required}}.to_s.length < {{{minLength}}}
136
- 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}}}.'
137
- end
138
-
139
- {{/minLength}}
140
- {{#maximum}}
141
- if @api_client.config.client_side_validation && {{^required}}!opts[:'{{{paramName}}}'].nil? && {{/required}}{{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:'{{{paramName}}}']{{/required}} >{{#exclusiveMaximum}}={{/exclusiveMaximum}} {{{maximum}}}
142
- 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}}}.'
143
- end
144
-
145
- {{/maximum}}
146
- {{#minimum}}
147
- if @api_client.config.client_side_validation && {{^required}}!opts[:'{{{paramName}}}'].nil? && {{/required}}{{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:'{{{paramName}}}']{{/required}} <{{#exclusiveMinimum}}={{/exclusiveMinimum}} {{{minimum}}}
148
- 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}}}.'
149
- end
150
-
151
- {{/minimum}}
152
- {{#pattern}}
153
- pattern = Regexp.new({{{pattern}}})
154
- if @api_client.config.client_side_validation && {{^required}}!opts[:'{{{paramName}}}'].nil? && {{/required}}{{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:'{{{paramName}}}']{{/required}} !~ pattern
155
- fail ArgumentError, "invalid value for '{{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:\"{{{paramName}}}\"]{{/required}}' when calling {{classname}}.{{operationId}}, must conform to the pattern #{pattern}."
156
- end
157
-
158
- {{/pattern}}
159
- {{#maxItems}}
160
- if @api_client.config.client_side_validation && {{^required}}!opts[:'{{{paramName}}}'].nil? && {{/required}}{{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:'{{{paramName}}}']{{/required}}.length > {{{maxItems}}}
161
- 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}}}.'
162
- end
163
-
164
- {{/maxItems}}
165
- {{#minItems}}
166
- if @api_client.config.client_side_validation && {{^required}}!opts[:'{{{paramName}}}'].nil? && {{/required}}{{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:'{{{paramName}}}']{{/required}}.length < {{{minItems}}}
167
- 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}}}.'
168
- end
169
-
170
- {{/minItems}}
171
- {{/hasValidation}}
172
- {{/allParams}}
173
- # resource path
174
- local_var_path = '{{{path}}}'{{#pathParams}}.sub('{' + '{{baseName}}' + '}', CGI.escape({{paramName}}.to_s){{^strictSpecBehavior}}.gsub('%2F', '/'){{/strictSpecBehavior}}){{/pathParams}}
175
-
176
- # query parameters
177
- query_params = opts[:query_params] || {}
178
- {{#queryParams}}
179
- {{#required}}
180
- query_params[:'{{{baseName}}}'] = {{#collectionFormat}}@api_client.build_collection_param({{{paramName}}}, :{{{collectionFormat}}}){{/collectionFormat}}{{^collectionFormat}}{{{paramName}}}{{/collectionFormat}}
181
- {{/required}}
182
- {{/queryParams}}
183
- {{#queryParams}}
184
- {{^required}}
185
- query_params[:'{{{baseName}}}'] = {{#collectionFormat}}@api_client.build_collection_param(opts[:'{{{paramName}}}'], :{{{collectionFormat}}}){{/collectionFormat}}{{^collectionFormat}}opts[:'{{{paramName}}}']{{/collectionFormat}} if !opts[:'{{{paramName}}}'].nil?
186
- {{/required}}
187
- {{/queryParams}}
188
-
189
- # header parameters
190
- header_params = opts[:header_params] || {}
191
- {{#hasProduces}}
192
- # HTTP header 'Accept' (if needed)
193
- header_params['Accept'] = @api_client.select_header_accept([{{#produces}}'{{{mediaType}}}'{{^-last}}, {{/-last}}{{/produces}}]) unless header_params['Accept']
194
- {{/hasProduces}}
195
- {{#hasConsumes}}
196
- # HTTP header 'Content-Type'
197
- content_type = @api_client.select_header_content_type([{{#consumes}}'{{{mediaType}}}'{{^-last}}, {{/-last}}{{/consumes}}])
198
- if !content_type.nil?
199
- header_params['Content-Type'] = content_type
200
- end
201
- {{/hasConsumes}}
202
- {{#headerParams}}
203
- {{#required}}
204
- header_params[{{#lambdaFixHeaderKey}}:'{{{baseName}}}'{{/lambdaFixHeaderKey}}] = {{#collectionFormat}}@api_client.build_collection_param({{{paramName}}}, :{{{collectionFormat}}}){{/collectionFormat}}{{^collectionFormat}}{{{paramName}}}{{/collectionFormat}}
205
- {{/required}}
206
- {{/headerParams}}
207
- {{#headerParams}}
208
- {{^required}}
209
- header_params[{{#lambdaFixHeaderKey}}:'{{{baseName}}}'{{/lambdaFixHeaderKey}}] = {{#collectionFormat}}@api_client.build_collection_param(opts[:'{{{paramName}}}'], :{{{collectionFormat}}}){{/collectionFormat}}{{^collectionFormat}}opts[:'{{{paramName}}}']{{/collectionFormat}} if !opts[:'{{{paramName}}}'].nil?
210
- {{/required}}
211
- {{/headerParams}}
212
-
213
- # form parameters
214
- form_params = opts[:form_params] || {}
215
- {{#formParams}}
216
- {{#required}}
217
- form_params['{{baseName}}'] = {{#collectionFormat}}@api_client.build_collection_param({{{paramName}}}, :{{{collectionFormat}}}){{/collectionFormat}}{{^collectionFormat}}{{{paramName}}}{{/collectionFormat}}
218
- {{/required}}
219
- {{/formParams}}
220
- {{#formParams}}
221
- {{^required}}
222
- form_params['{{baseName}}'] = {{#collectionFormat}}@api_client.build_collection_param(opts[:'{{{paramName}}}'], :{{{collectionFormat}}}){{/collectionFormat}}{{^collectionFormat}}opts[:'{{{paramName}}}']{{/collectionFormat}} if !opts[:'{{paramName}}'].nil?
223
- {{/required}}
224
- {{/formParams}}
225
-
226
- # http body (model)
227
- post_body = opts[:debug_body]{{#bodyParam}} || @api_client.object_to_http_body({{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:'{{{paramName}}}']{{/required}}){{/bodyParam}}
228
-
229
- # return_type
230
- return_type = opts[:debug_return_type]{{#returnType}} || '{{{.}}}'{{/returnType}}
231
-
232
- # auth_names
233
- auth_names = opts[:debug_auth_names] || [{{#authMethods}}'{{name}}'{{^-last}}, {{/-last}}{{/authMethods}}]
234
-
235
- new_options = opts.merge(
236
- :operation => :"{{classname}}.{{operationId}}",
237
- :header_params => header_params,
238
- :query_params => query_params,
239
- :form_params => form_params,
240
- :body => post_body,
241
- :auth_names => auth_names,
242
- :return_type => return_type
243
- )
244
-
245
- data, status_code, headers = @api_client.call_api(:{{httpMethod}}, local_var_path, new_options)
246
- if @api_client.config.debugging
247
- @api_client.config.logger.debug "API called: {{classname}}#{{operationId}}\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
248
- end
249
- return data, status_code, headers
250
- end
251
- {{^-last}}
252
-
253
- {{/-last}}
254
- {{/operation}}
255
- end
256
- {{/operations}}
257
- end
@@ -1,246 +0,0 @@
1
- =begin
2
- {{> api_info}}
3
- =end
4
-
5
- require 'date'
6
- require 'json'
7
- require 'logger'
8
- require 'tempfile'
9
- require 'time'
10
- {{#isTyphoeus}}
11
- require 'typhoeus'
12
- {{/isTyphoeus}}
13
- {{#isFaraday}}
14
- require 'faraday'
15
- require 'faraday/multipart' if Gem::Version.new(Faraday::VERSION) >= Gem::Version.new('2.0')
16
- require 'marcel'
17
- {{/isFaraday}}
18
- {{#isHttpx}}
19
- require 'httpx'
20
- require 'net/http/status'
21
- {{/isHttpx}}
22
-
23
-
24
- module {{moduleName}}
25
- class ApiClient
26
- # The Configuration object holding settings to be used in the API client.
27
- attr_accessor :config
28
-
29
- # Defines the headers to be used in HTTP requests of all API calls by default.
30
- #
31
- # @return [Hash]
32
- attr_accessor :default_headers
33
-
34
- # Initializes the ApiClient
35
- # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
36
- def initialize(config = Configuration.default)
37
- @config = config
38
- @user_agent = "{{{httpUserAgent}}}{{^httpUserAgent}}OpenAPI-Generator/#{VERSION}/ruby{{/httpUserAgent}}"
39
- @default_headers = {
40
- 'Content-Type' => 'application/json',
41
- 'User-Agent' => @user_agent
42
- }
43
- end
44
-
45
- def self.default
46
- @@default ||= ApiClient.new
47
- end
48
-
49
- {{#isTyphoeus}}
50
- {{> api_client_typhoeus_partial}}
51
- {{/isTyphoeus}}
52
- {{#isFaraday}}
53
- {{> api_client_faraday_partial}}
54
- {{/isFaraday}}
55
- {{#isHttpx}}
56
- {{> api_client_httpx_partial}}
57
- {{/isHttpx}}
58
- # Check if the given MIME is a JSON MIME.
59
- # JSON MIME examples:
60
- # application/json
61
- # application/json; charset=UTF8
62
- # APPLICATION/JSON
63
- # */*
64
- # @param [String] mime MIME
65
- # @return [Boolean] True if the MIME is application/json
66
- def json_mime?(mime)
67
- (mime == '*/*') || !(mime =~ /^Application\/.*json(?!p)(;.*)?/i).nil?
68
- end
69
-
70
- # Deserialize the response to the given return type.
71
- #
72
- # @param [Response] response HTTP response
73
- # @param [String] return_type some examples: "User", "Array<User>", "Hash<String, Integer>"
74
- def deserialize(response, return_type)
75
- body = response.body
76
- return nil if body.nil? || body.empty?
77
-
78
- # return response body directly for String return type
79
- return body.to_s if return_type == 'String'
80
-
81
- # ensuring a default content type
82
- content_type = response.headers['Content-Type'] || 'application/json'
83
-
84
- fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
85
-
86
- begin
87
- data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
88
- rescue JSON::ParserError => e
89
- if %w(String Date Time).include?(return_type)
90
- data = body
91
- else
92
- raise e
93
- end
94
- end
95
-
96
- convert_to_type data, return_type
97
- end
98
-
99
- # Convert data to the given return type.
100
- # @param [Object] data Data to be converted
101
- # @param [String] return_type Return type
102
- # @return [Mixed] Data in a particular type
103
- def convert_to_type(data, return_type)
104
- return nil if data.nil?
105
- case return_type
106
- when 'String'
107
- data.to_s
108
- when 'Integer'
109
- data.to_i
110
- when 'Float'
111
- data.to_f
112
- when 'Boolean'
113
- data == true
114
- when 'Time'
115
- # parse date time (expecting ISO 8601 format)
116
- Time.parse data
117
- when 'Date'
118
- # parse date time (expecting ISO 8601 format)
119
- Date.parse data
120
- when 'Object'
121
- # generic object (usually a Hash), return directly
122
- data
123
- when /\AArray<(.+)>\z/
124
- # e.g. Array<Pet>
125
- sub_type = $1
126
- data.map { |item| convert_to_type(item, sub_type) }
127
- when /\AHash\<String, (.+)\>\z/
128
- # e.g. Hash<String, Integer>
129
- sub_type = $1
130
- {}.tap do |hash|
131
- data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
132
- end
133
- else
134
- # models (e.g. Pet) or oneOf
135
- klass = {{moduleName}}.const_get(return_type)
136
- klass.respond_to?(:openapi_one_of) ? klass.build(data) : klass.build_from_hash(data)
137
- end
138
- end
139
-
140
- # Sanitize filename by removing path.
141
- # e.g. ../../sun.gif becomes sun.gif
142
- #
143
- # @param [String] filename the filename to be sanitized
144
- # @return [String] the sanitized filename
145
- def sanitize_filename(filename)
146
- filename.split(/[\/\\]/).last
147
- end
148
-
149
- def build_request_url(path, opts = {})
150
- # Add leading and trailing slashes to path
151
- path = "/#{path}".gsub(/\/+/, '/')
152
- @config.base_url(opts[:operation]) + path
153
- end
154
-
155
- # Update header and query params based on authentication settings.
156
- #
157
- # @param [Hash] header_params Header parameters
158
- # @param [Hash] query_params Query parameters
159
- # @param [String] auth_names Authentication scheme name
160
- def update_params_for_auth!(header_params, query_params, auth_names)
161
- Array(auth_names).each do |auth_name|
162
- auth_setting = @config.auth_settings[auth_name]
163
- next unless auth_setting
164
- case auth_setting[:in]
165
- when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
166
- when 'query' then query_params[auth_setting[:key]] = auth_setting[:value]
167
- else fail ArgumentError, 'Authentication token must be in `query` or `header`'
168
- end
169
- end
170
- end
171
-
172
- # Sets user agent in HTTP header
173
- #
174
- # @param [String] user_agent User agent (e.g. openapi-generator/ruby/1.0.0)
175
- def user_agent=(user_agent)
176
- @user_agent = user_agent
177
- @default_headers['User-Agent'] = @user_agent
178
- end
179
-
180
- # Return Accept header based on an array of accepts provided.
181
- # @param [Array] accepts array for Accept
182
- # @return [String] the Accept header (e.g. application/json)
183
- def select_header_accept(accepts)
184
- return nil if accepts.nil? || accepts.empty?
185
- # use JSON when present, otherwise use all of the provided
186
- json_accept = accepts.find { |s| json_mime?(s) }
187
- json_accept || accepts.join(',')
188
- end
189
-
190
- # Return Content-Type header based on an array of content types provided.
191
- # @param [Array] content_types array for Content-Type
192
- # @return [String] the Content-Type header (e.g. application/json)
193
- def select_header_content_type(content_types)
194
- # return nil by default
195
- return if content_types.nil? || content_types.empty?
196
- # use JSON when present, otherwise use the first one
197
- json_content_type = content_types.find { |s| json_mime?(s) }
198
- json_content_type || content_types.first
199
- end
200
-
201
- # Convert object (array, hash, object, etc) to JSON string.
202
- # @param [Object] model object to be converted into JSON string
203
- # @return [String] JSON string representation of the object
204
- def object_to_http_body(model)
205
- return model if model.nil? || model.is_a?(String)
206
- local_body = nil
207
- if model.is_a?(Array)
208
- local_body = model.map { |m| object_to_hash(m) }
209
- else
210
- local_body = object_to_hash(model)
211
- end
212
- local_body.to_json
213
- end
214
-
215
- # Convert object(non-array) to hash.
216
- # @param [Object] obj object to be converted into JSON string
217
- # @return [String] JSON string representation of the object
218
- def object_to_hash(obj)
219
- if obj.respond_to?(:to_hash)
220
- obj.to_hash
221
- else
222
- obj
223
- end
224
- end
225
-
226
- # Build parameter value according to the given collection format.
227
- # @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
228
- def build_collection_param(param, collection_format)
229
- case collection_format
230
- when :csv
231
- param.join(',')
232
- when :ssv
233
- param.join(' ')
234
- when :tsv
235
- param.join("\t")
236
- when :pipes
237
- param.join('|')
238
- when :multi
239
- # return the array directly as typhoeus will handle it as expected
240
- param
241
- else
242
- fail "unknown collection format: #{collection_format.inspect}"
243
- end
244
- end
245
- end
246
- end