lob 5.4.6 → 6.0.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (496) hide show
  1. checksums.yaml +4 -4
  2. data/CODE_SNIPPETS.md +1871 -0
  3. data/Gemfile +6 -1
  4. data/Gemfile.lock +70 -0
  5. data/LICENSE +21 -0
  6. data/MIGRATION.md +174 -0
  7. data/README.md +70 -97
  8. data/Rakefile +7 -5
  9. data/__tests__/Api/Address.unit.rb +210 -0
  10. data/__tests__/Api/BankAccount.unit.rb +244 -0
  11. data/__tests__/Api/BillingGroup.unit.rb +170 -0
  12. data/__tests__/Api/Card.unit.rb +183 -0
  13. data/__tests__/Api/CardOrder.unit.rb +89 -0
  14. data/__tests__/Api/Check.unit.rb +185 -0
  15. data/__tests__/Api/IntlAutocompletion.unit.rb +43 -0
  16. data/__tests__/Api/IntlVerification.unit.rb +71 -0
  17. data/__tests__/Api/Letter.unit.rb +191 -0
  18. data/__tests__/Api/Postcard.unit.rb +189 -0
  19. data/__tests__/Api/Require.unit.rb +21 -0
  20. data/__tests__/Api/ReverseGeocodeLookup.unit.rb +43 -0
  21. data/__tests__/Api/SelfMailer.unit.rb +190 -0
  22. data/__tests__/Api/Template.unit.rb +165 -0
  23. data/__tests__/Api/TemplateVersion.unit.rb +165 -0
  24. data/__tests__/Api/UsAutocompletion.unit.rb +42 -0
  25. data/__tests__/Api/UsVerification.unit.rb +71 -0
  26. data/__tests__/Api/ZipLookup.unit.rb +42 -0
  27. data/__tests__/Integration/Address.spec.rb +200 -0
  28. data/__tests__/Integration/BankAccount.spec.rb +243 -0
  29. data/__tests__/Integration/BillingGroup.spec.rb +163 -0
  30. data/__tests__/Integration/Card.spec.rb +198 -0
  31. data/__tests__/Integration/CardOrder.spec.rb +122 -0
  32. data/__tests__/Integration/Check.spec.rb +361 -0
  33. data/__tests__/Integration/IntlAutocompletion.spec.rb +54 -0
  34. data/__tests__/Integration/IntlVerification.spec.rb +90 -0
  35. data/__tests__/Integration/Letter.spec.rb +286 -0
  36. data/__tests__/Integration/Postcard.spec.rb +214 -0
  37. data/__tests__/Integration/ReverseGeocodeLookup.spec.rb +30 -0
  38. data/__tests__/Integration/SelfMailer.spec.rb +270 -0
  39. data/__tests__/Integration/Template.spec.rb +221 -0
  40. data/__tests__/Integration/TemplateVersion.spec.rb +275 -0
  41. data/__tests__/Integration/UsAutocompletion.spec.rb +54 -0
  42. data/__tests__/Integration/UsVerification.spec.rb +102 -0
  43. data/__tests__/Integration/ZipLookup.spec.rb +29 -0
  44. data/__tests__/TestFixtures.rb +36 -0
  45. data/docs/Address.md +52 -0
  46. data/docs/AddressDeletion.md +22 -0
  47. data/docs/AddressDomestic.md +40 -0
  48. data/docs/AddressDomesticExpanded.md +40 -0
  49. data/docs/AddressEditable.md +40 -0
  50. data/docs/AddressList.md +28 -0
  51. data/docs/AddressesApi.md +303 -0
  52. data/docs/BankAccount.md +44 -0
  53. data/docs/BankAccountDeletion.md +22 -0
  54. data/docs/BankAccountList.md +28 -0
  55. data/docs/BankAccountVerify.md +18 -0
  56. data/docs/BankAccountWritable.md +28 -0
  57. data/docs/BankAccountsApi.md +376 -0
  58. data/docs/BankTypeEnum.md +15 -0
  59. data/docs/BillingGroup.md +28 -0
  60. data/docs/BillingGroupEditable.md +20 -0
  61. data/docs/BillingGroupList.md +26 -0
  62. data/docs/BillingGroupsApi.md +305 -0
  63. data/docs/Buckslip.md +60 -0
  64. data/docs/BuckslipDeletion.md +20 -0
  65. data/docs/BuckslipEditable.md +24 -0
  66. data/docs/BuckslipOrder.md +42 -0
  67. data/docs/BuckslipOrderEditable.md +18 -0
  68. data/docs/BuckslipOrdersApi.md +157 -0
  69. data/docs/BuckslipOrdersList.md +26 -0
  70. data/docs/BuckslipUpdatable.md +22 -0
  71. data/docs/BuckslipsApi.md +372 -0
  72. data/docs/BuckslipsList.md +28 -0
  73. data/docs/BulkError.md +18 -0
  74. data/docs/BulkErrorProperties.md +20 -0
  75. data/docs/Campaign.md +52 -0
  76. data/docs/CampaignCreative.md +42 -0
  77. data/docs/CampaignDeletion.md +20 -0
  78. data/docs/CampaignUpdatable.md +36 -0
  79. data/docs/CampaignWritable.md +36 -0
  80. data/docs/CampaignsApi.md +376 -0
  81. data/docs/CampaignsList.md +28 -0
  82. data/docs/Card.md +54 -0
  83. data/docs/CardDeletion.md +22 -0
  84. data/docs/CardEditable.md +24 -0
  85. data/docs/CardList.md +28 -0
  86. data/docs/CardOrder.md +42 -0
  87. data/docs/CardOrderEditable.md +18 -0
  88. data/docs/CardOrderList.md +26 -0
  89. data/docs/CardOrdersApi.md +157 -0
  90. data/docs/CardUpdatable.md +22 -0
  91. data/docs/CardsApi.md +372 -0
  92. data/docs/Check.md +68 -0
  93. data/docs/CheckDeletion.md +22 -0
  94. data/docs/CheckEditable.md +48 -0
  95. data/docs/CheckList.md +28 -0
  96. data/docs/ChecksApi.md +315 -0
  97. data/docs/CmpScheduleType.md +15 -0
  98. data/docs/CmpUseType.md +15 -0
  99. data/docs/CountryExtended.md +15 -0
  100. data/docs/CountryExtendedExpanded.md +15 -0
  101. data/docs/CreativePatch.md +22 -0
  102. data/docs/CreativeResponse.md +42 -0
  103. data/docs/CreativeWritable.md +34 -0
  104. data/docs/CreativesApi.md +226 -0
  105. data/docs/CustomEnvelopeReturned.md +22 -0
  106. data/docs/DefaultApi.md +75 -0
  107. data/docs/DeliverabilityAnalysis.md +34 -0
  108. data/docs/DpvFootnote.md +15 -0
  109. data/docs/EngineHtml.md +15 -0
  110. data/docs/EventType.md +24 -0
  111. data/docs/Events.md +28 -0
  112. data/docs/Export.md +32 -0
  113. data/docs/ExportModel.md +18 -0
  114. data/docs/GeocodeAddresses.md +20 -0
  115. data/docs/GeocodeComponents.md +20 -0
  116. data/docs/HTTPValidationError.md +18 -0
  117. data/docs/IdentityValidation.md +34 -0
  118. data/docs/IdentityValidationApi.md +78 -0
  119. data/docs/InlineObject.md +18 -0
  120. data/docs/IntlAutocompletions.md +20 -0
  121. data/docs/IntlAutocompletionsApi.md +82 -0
  122. data/docs/IntlAutocompletionsWritable.md +26 -0
  123. data/docs/IntlComponents.md +26 -0
  124. data/docs/IntlSuggestions.md +30 -0
  125. data/docs/IntlVerification.md +38 -0
  126. data/docs/IntlVerificationOrError.md +40 -0
  127. data/docs/IntlVerificationWritable.md +32 -0
  128. data/docs/IntlVerifications.md +20 -0
  129. data/docs/IntlVerificationsApi.md +153 -0
  130. data/docs/IntlVerificationsPayload.md +18 -0
  131. data/docs/Letter.md +72 -0
  132. data/docs/LetterCustomEnvelope.md +22 -0
  133. data/docs/LetterDeletion.md +22 -0
  134. data/docs/LetterDetailsReturned.md +36 -0
  135. data/docs/LetterDetailsWritable.md +32 -0
  136. data/docs/LetterEditable.md +52 -0
  137. data/docs/LetterList.md +28 -0
  138. data/docs/LettersApi.md +317 -0
  139. data/docs/LobConfidenceScore.md +20 -0
  140. data/docs/LobError.md +22 -0
  141. data/docs/Location.md +20 -0
  142. data/docs/LocationAnalysis.md +22 -0
  143. data/docs/MailType.md +15 -0
  144. data/docs/MultiLineAddress.md +32 -0
  145. data/docs/MultipleComponents.md +30 -0
  146. data/docs/MultipleComponentsIntl.md +30 -0
  147. data/docs/MultipleComponentsList.md +18 -0
  148. data/docs/PlaceholderModel.md +28 -0
  149. data/docs/Postcard.md +60 -0
  150. data/docs/PostcardDeletion.md +22 -0
  151. data/docs/PostcardDetailsReturned.md +26 -0
  152. data/docs/PostcardDetailsWritable.md +20 -0
  153. data/docs/PostcardEditable.md +40 -0
  154. data/docs/PostcardList.md +28 -0
  155. data/docs/PostcardSize.md +15 -0
  156. data/docs/PostcardsApi.md +317 -0
  157. data/docs/QrCode.md +30 -0
  158. data/docs/ReturnEnvelope.md +24 -0
  159. data/docs/ReverseGeocode.md +22 -0
  160. data/docs/ReverseGeocodeLookupsApi.md +82 -0
  161. data/docs/SelfMailer.md +48 -0
  162. data/docs/SelfMailerDeletion.md +22 -0
  163. data/docs/SelfMailerEditable.md +38 -0
  164. data/docs/SelfMailerList.md +28 -0
  165. data/docs/SelfMailerSize.md +15 -0
  166. data/docs/SelfMailersApi.md +317 -0
  167. data/docs/SortBy.md +20 -0
  168. data/docs/SortBy1.md +20 -0
  169. data/docs/SortBy2.md +20 -0
  170. data/docs/SortBy3.md +20 -0
  171. data/docs/SortByDateModified.md +20 -0
  172. data/docs/Suggestions.md +26 -0
  173. data/docs/Template.md +34 -0
  174. data/docs/TemplateDeletion.md +22 -0
  175. data/docs/TemplateList.md +28 -0
  176. data/docs/TemplateUpdate.md +20 -0
  177. data/docs/TemplateVersion.md +36 -0
  178. data/docs/TemplateVersionDeletion.md +22 -0
  179. data/docs/TemplateVersionList.md +28 -0
  180. data/docs/TemplateVersionUpdatable.md +20 -0
  181. data/docs/TemplateVersionWritable.md +22 -0
  182. data/docs/TemplateVersionsApi.md +384 -0
  183. data/docs/TemplateWritable.md +24 -0
  184. data/docs/TemplatesApi.md +376 -0
  185. data/docs/Thumbnail.md +22 -0
  186. data/docs/TrackingEventCertified.md +34 -0
  187. data/docs/TrackingEventDetails.md +24 -0
  188. data/docs/TrackingEventNormal.md +34 -0
  189. data/docs/Upload.md +44 -0
  190. data/docs/UploadCreateExport.md +20 -0
  191. data/docs/UploadFile.md +20 -0
  192. data/docs/UploadState.md +15 -0
  193. data/docs/UploadUpdatable.md +20 -0
  194. data/docs/UploadWritable.md +18 -0
  195. data/docs/UploadsApi.md +584 -0
  196. data/docs/UsAutocompletions.md +22 -0
  197. data/docs/UsAutocompletionsApi.md +78 -0
  198. data/docs/UsAutocompletionsWritable.md +26 -0
  199. data/docs/UsComponents.md +68 -0
  200. data/docs/UsVerification.md +38 -0
  201. data/docs/UsVerificationOrError.md +40 -0
  202. data/docs/UsVerifications.md +20 -0
  203. data/docs/UsVerificationsApi.md +157 -0
  204. data/docs/UsVerificationsWritable.md +32 -0
  205. data/docs/ValidationError.md +22 -0
  206. data/docs/Zip.md +26 -0
  207. data/docs/ZipCodeType.md +15 -0
  208. data/docs/ZipEditable.md +18 -0
  209. data/docs/ZipLookupCity.md +26 -0
  210. data/docs/ZipLookupsApi.md +78 -0
  211. data/git_push.sh +57 -0
  212. data/lib/lob.rb +1 -7
  213. data/lib/openapi_client/api/addresses_api.rb +318 -0
  214. data/lib/openapi_client/api/bank_accounts_api.rb +397 -0
  215. data/lib/openapi_client/api/billing_groups_api.rb +320 -0
  216. data/lib/openapi_client/api/buckslip_orders_api.rb +183 -0
  217. data/lib/openapi_client/api/buckslips_api.rb +382 -0
  218. data/lib/openapi_client/api/campaigns_api.rb +389 -0
  219. data/lib/openapi_client/api/card_orders_api.rb +183 -0
  220. data/lib/openapi_client/api/cards_api.rb +382 -0
  221. data/lib/openapi_client/api/checks_api.rb +337 -0
  222. data/lib/openapi_client/api/creatives_api.rb +244 -0
  223. data/lib/openapi_client/api/default_api.rb +79 -0
  224. data/lib/openapi_client/api/identity_validation_api.rb +90 -0
  225. data/lib/openapi_client/api/intl_autocompletions_api.rb +97 -0
  226. data/lib/openapi_client/api/intl_verifications_api.rb +165 -0
  227. data/lib/openapi_client/api/letters_api.rb +340 -0
  228. data/lib/openapi_client/api/postcards_api.rb +340 -0
  229. data/lib/openapi_client/api/reverse_geocode_lookups_api.rb +101 -0
  230. data/lib/openapi_client/api/self_mailers_api.rb +340 -0
  231. data/lib/openapi_client/api/template_versions_api.rb +440 -0
  232. data/lib/openapi_client/api/templates_api.rb +397 -0
  233. data/lib/openapi_client/api/uploads_api.rb +604 -0
  234. data/lib/openapi_client/api/us_autocompletions_api.rb +90 -0
  235. data/lib/openapi_client/api/us_verifications_api.rb +172 -0
  236. data/lib/openapi_client/api/zip_lookups_api.rb +90 -0
  237. data/lib/openapi_client/api_client.rb +392 -0
  238. data/lib/openapi_client/api_error.rb +57 -0
  239. data/lib/openapi_client/configuration.rb +279 -0
  240. data/lib/openapi_client/models/address.rb +616 -0
  241. data/lib/openapi_client/models/address_deletion.rb +303 -0
  242. data/lib/openapi_client/models/address_domestic.rb +522 -0
  243. data/lib/openapi_client/models/address_domestic_expanded.rb +521 -0
  244. data/lib/openapi_client/models/address_editable.rb +503 -0
  245. data/lib/openapi_client/models/address_list.rb +324 -0
  246. data/lib/openapi_client/models/bank_account.rb +576 -0
  247. data/lib/openapi_client/models/bank_account_deletion.rb +303 -0
  248. data/lib/openapi_client/models/bank_account_list.rb +324 -0
  249. data/lib/openapi_client/models/bank_account_verify.rb +264 -0
  250. data/lib/openapi_client/models/bank_account_writable.rb +387 -0
  251. data/lib/openapi_client/models/bank_type_enum.rb +37 -0
  252. data/lib/openapi_client/models/billing_group.rb +395 -0
  253. data/lib/openapi_client/models/billing_group_editable.rb +278 -0
  254. data/lib/openapi_client/models/billing_group_list.rb +314 -0
  255. data/lib/openapi_client/models/buckslip.rb +814 -0
  256. data/lib/openapi_client/models/buckslip_deletion.rb +257 -0
  257. data/lib/openapi_client/models/buckslip_editable.rb +316 -0
  258. data/lib/openapi_client/models/buckslip_order.rb +438 -0
  259. data/lib/openapi_client/models/buckslip_order_editable.rb +262 -0
  260. data/lib/openapi_client/models/buckslip_orders_list.rb +312 -0
  261. data/lib/openapi_client/models/buckslip_updatable.rb +289 -0
  262. data/lib/openapi_client/models/buckslips_list.rb +324 -0
  263. data/lib/openapi_client/models/bulk_error.rb +229 -0
  264. data/lib/openapi_client/models/bulk_error_properties.rb +274 -0
  265. data/lib/openapi_client/models/campaign.rb +549 -0
  266. data/lib/openapi_client/models/campaign_creative.rb +467 -0
  267. data/lib/openapi_client/models/campaign_deletion.rb +257 -0
  268. data/lib/openapi_client/models/campaign_updatable.rb +341 -0
  269. data/lib/openapi_client/models/campaign_writable.rb +373 -0
  270. data/lib/openapi_client/models/campaigns_list.rb +324 -0
  271. data/lib/openapi_client/models/card.rb +681 -0
  272. data/lib/openapi_client/models/card_deletion.rb +303 -0
  273. data/lib/openapi_client/models/card_editable.rb +318 -0
  274. data/lib/openapi_client/models/card_list.rb +324 -0
  275. data/lib/openapi_client/models/card_order.rb +438 -0
  276. data/lib/openapi_client/models/card_order_editable.rb +261 -0
  277. data/lib/openapi_client/models/card_order_list.rb +273 -0
  278. data/lib/openapi_client/models/card_updatable.rb +289 -0
  279. data/lib/openapi_client/models/check.rb +812 -0
  280. data/lib/openapi_client/models/check_deletion.rb +303 -0
  281. data/lib/openapi_client/models/check_editable.rb +537 -0
  282. data/lib/openapi_client/models/check_list.rb +324 -0
  283. data/lib/openapi_client/models/chk_use_type.rb +38 -0
  284. data/lib/openapi_client/models/cmp_schedule_type.rb +36 -0
  285. data/lib/openapi_client/models/cmp_use_type.rb +38 -0
  286. data/lib/openapi_client/models/country_extended.rb +254 -0
  287. data/lib/openapi_client/models/country_extended_expanded.rb +255 -0
  288. data/lib/openapi_client/models/creative_patch.rb +274 -0
  289. data/lib/openapi_client/models/creative_response.rb +444 -0
  290. data/lib/openapi_client/models/creative_writable.rb +400 -0
  291. data/lib/openapi_client/models/custom_envelope_returned.rb +319 -0
  292. data/lib/openapi_client/models/deliverability_analysis.rb +451 -0
  293. data/lib/openapi_client/models/dpv_footnote.rb +50 -0
  294. data/lib/openapi_client/models/engine_html.rb +37 -0
  295. data/lib/openapi_client/models/event_type.rb +325 -0
  296. data/lib/openapi_client/models/events.rb +365 -0
  297. data/lib/openapi_client/models/export.rb +422 -0
  298. data/lib/openapi_client/models/export_model.rb +262 -0
  299. data/lib/openapi_client/models/geocode_addresses.rb +237 -0
  300. data/lib/openapi_client/models/geocode_components.rb +291 -0
  301. data/lib/openapi_client/models/http_validation_error.rb +230 -0
  302. data/lib/openapi_client/models/identity_validation.rb +460 -0
  303. data/lib/openapi_client/models/inline_object.rb +229 -0
  304. data/lib/openapi_client/models/intl_autocompletions.rb +282 -0
  305. data/lib/openapi_client/models/intl_autocompletions_writable.rb +278 -0
  306. data/lib/openapi_client/models/intl_components.rb +314 -0
  307. data/lib/openapi_client/models/intl_suggestions.rb +372 -0
  308. data/lib/openapi_client/models/intl_verification.rb +463 -0
  309. data/lib/openapi_client/models/intl_verification_or_error.rb +466 -0
  310. data/lib/openapi_client/models/intl_verification_writable.rb +388 -0
  311. data/lib/openapi_client/models/intl_verifications.rb +250 -0
  312. data/lib/openapi_client/models/intl_verifications_payload.rb +263 -0
  313. data/lib/openapi_client/models/letter.rb +737 -0
  314. data/lib/openapi_client/models/letter_custom_envelope.rb +300 -0
  315. data/lib/openapi_client/models/letter_deletion.rb +303 -0
  316. data/lib/openapi_client/models/letter_details_returned.rb +393 -0
  317. data/lib/openapi_client/models/letter_details_writable.rb +390 -0
  318. data/lib/openapi_client/models/letter_editable.rb +532 -0
  319. data/lib/openapi_client/models/letter_list.rb +324 -0
  320. data/lib/openapi_client/models/lob_confidence_score.rb +299 -0
  321. data/lib/openapi_client/models/lob_error.rb +296 -0
  322. data/lib/openapi_client/models/location.rb +289 -0
  323. data/lib/openapi_client/models/location_analysis.rb +305 -0
  324. data/lib/openapi_client/models/ltr_use_type.rb +38 -0
  325. data/lib/openapi_client/models/mail_type.rb +37 -0
  326. data/lib/openapi_client/models/multi_line_address.rb +431 -0
  327. data/lib/openapi_client/models/multiple_components.rb +405 -0
  328. data/lib/openapi_client/models/multiple_components_intl.rb +377 -0
  329. data/lib/openapi_client/models/multiple_components_list.rb +263 -0
  330. data/lib/openapi_client/models/optional_address_column_mapping.rb +259 -0
  331. data/lib/openapi_client/models/placeholder_model.rb +273 -0
  332. data/lib/openapi_client/models/postcard.rb +656 -0
  333. data/lib/openapi_client/models/postcard_deletion.rb +303 -0
  334. data/lib/openapi_client/models/postcard_details_returned.rb +321 -0
  335. data/lib/openapi_client/models/postcard_details_writable.rb +242 -0
  336. data/lib/openapi_client/models/postcard_editable.rb +393 -0
  337. data/lib/openapi_client/models/postcard_list.rb +324 -0
  338. data/lib/openapi_client/models/postcard_size.rb +38 -0
  339. data/lib/openapi_client/models/psc_use_type.rb +38 -0
  340. data/lib/openapi_client/models/qr_code.rb +339 -0
  341. data/lib/openapi_client/models/required_address_column_mapping.rb +285 -0
  342. data/lib/openapi_client/models/return_envelope.rb +258 -0
  343. data/lib/openapi_client/models/reverse_geocode.rb +304 -0
  344. data/lib/openapi_client/models/self_mailer.rb +584 -0
  345. data/lib/openapi_client/models/self_mailer_deletion.rb +303 -0
  346. data/lib/openapi_client/models/self_mailer_editable.rb +384 -0
  347. data/lib/openapi_client/models/self_mailer_list.rb +324 -0
  348. data/lib/openapi_client/models/self_mailer_size.rb +38 -0
  349. data/lib/openapi_client/models/sfm_use_type.rb +38 -0
  350. data/lib/openapi_client/models/sort_by.rb +283 -0
  351. data/lib/openapi_client/models/sort_by1.rb +283 -0
  352. data/lib/openapi_client/models/sort_by2.rb +283 -0
  353. data/lib/openapi_client/models/sort_by3.rb +283 -0
  354. data/lib/openapi_client/models/sort_by_date_modified.rb +283 -0
  355. data/lib/openapi_client/models/suggestions.rb +343 -0
  356. data/lib/openapi_client/models/template.rb +406 -0
  357. data/lib/openapi_client/models/template_deletion.rb +303 -0
  358. data/lib/openapi_client/models/template_list.rb +324 -0
  359. data/lib/openapi_client/models/template_update.rb +272 -0
  360. data/lib/openapi_client/models/template_version.rb +423 -0
  361. data/lib/openapi_client/models/template_version_deletion.rb +303 -0
  362. data/lib/openapi_client/models/template_version_list.rb +324 -0
  363. data/lib/openapi_client/models/template_version_updatable.rb +257 -0
  364. data/lib/openapi_client/models/template_version_writable.rb +291 -0
  365. data/lib/openapi_client/models/template_writable.rb +309 -0
  366. data/lib/openapi_client/models/thumbnail.rb +300 -0
  367. data/lib/openapi_client/models/tracking_event_certified.rb +419 -0
  368. data/lib/openapi_client/models/tracking_event_details.rb +308 -0
  369. data/lib/openapi_client/models/tracking_event_normal.rb +409 -0
  370. data/lib/openapi_client/models/upload.rb +498 -0
  371. data/lib/openapi_client/models/upload_create_export.rb +283 -0
  372. data/lib/openapi_client/models/upload_file.rb +283 -0
  373. data/lib/openapi_client/models/upload_state.rb +42 -0
  374. data/lib/openapi_client/models/upload_updatable.rb +267 -0
  375. data/lib/openapi_client/models/upload_writable.rb +271 -0
  376. data/lib/openapi_client/models/uploads_metadata.rb +237 -0
  377. data/lib/openapi_client/models/us_autocompletions.rb +328 -0
  378. data/lib/openapi_client/models/us_autocompletions_writable.rb +274 -0
  379. data/lib/openapi_client/models/us_components.rb +761 -0
  380. data/lib/openapi_client/models/us_verification.rb +461 -0
  381. data/lib/openapi_client/models/us_verification_or_error.rb +459 -0
  382. data/lib/openapi_client/models/us_verifications.rb +250 -0
  383. data/lib/openapi_client/models/us_verifications_writable.rb +421 -0
  384. data/lib/openapi_client/models/validation_error.rb +263 -0
  385. data/lib/openapi_client/models/zip.rb +363 -0
  386. data/lib/openapi_client/models/zip_code_type.rb +40 -0
  387. data/lib/openapi_client/models/zip_editable.rb +246 -0
  388. data/lib/openapi_client/models/zip_lookup_city.rb +331 -0
  389. data/lib/openapi_client/version.rb +15 -0
  390. data/lib/openapi_client.rb +212 -0
  391. data/openapi_client.gemspec +37 -0
  392. data/spec/api/addresses_api_spec.rb +88 -0
  393. data/spec/api/bank_accounts_api_spec.rb +101 -0
  394. data/spec/api/billing_groups_api_spec.rb +89 -0
  395. data/spec/api/campaigns_api_spec.rb +100 -0
  396. data/spec/api/card_orders_api_spec.rb +62 -0
  397. data/spec/api/cards_api_spec.rb +99 -0
  398. data/spec/api/checks_api_spec.rb +93 -0
  399. data/spec/api/creatives_api_spec.rb +73 -0
  400. data/spec/api/default_api_spec.rb +46 -0
  401. data/spec/api/identity_validation_api_spec.rb +47 -0
  402. data/spec/api/intl_autocompletions_api_spec.rb +48 -0
  403. data/spec/api/intl_verifications_api_spec.rb +60 -0
  404. data/spec/api/letters_api_spec.rb +94 -0
  405. data/spec/api/postcards_api_spec.rb +94 -0
  406. data/spec/api/reverse_geocode_lookups_api_spec.rb +48 -0
  407. data/spec/api/self_mailers_api_spec.rb +94 -0
  408. data/spec/api/template_versions_api_spec.rb +105 -0
  409. data/spec/api/templates_api_spec.rb +101 -0
  410. data/spec/api/uploads_api_spec.rb +135 -0
  411. data/spec/api/us_autocompletions_api_spec.rb +47 -0
  412. data/spec/api/us_verifications_api_spec.rb +61 -0
  413. data/spec/api/zip_lookups_api_spec.rb +47 -0
  414. data/spec/api_client_spec.rb +226 -0
  415. data/spec/configuration_spec.rb +42 -0
  416. data/spec/spec_helper.rb +105 -13
  417. metadata +450 -214
  418. data/.github/workflows/forked_tests_job.yml +0 -36
  419. data/.github/workflows/run_tests_job.yml +0 -32
  420. data/.github/workflows/update_gem.yml +0 -27
  421. data/.gitignore +0 -19
  422. data/CHANGELOG.md +0 -148
  423. data/CONTRIBUTING.md +0 -19
  424. data/LICENSE.txt +0 -22
  425. data/examples/README.md +0 -119
  426. data/examples/cards.rb +0 -51
  427. data/examples/checks.rb +0 -49
  428. data/examples/csv_checks/create_checks.rb +0 -48
  429. data/examples/csv_checks/input.csv +0 -6
  430. data/examples/csv_letters/create_letters.rb +0 -41
  431. data/examples/csv_letters/input.csv +0 -6
  432. data/examples/csv_letters/letter_template.html +0 -33
  433. data/examples/csv_postcards/create_postcards.rb +0 -46
  434. data/examples/csv_postcards/input.csv +0 -7
  435. data/examples/csv_postcards/postcard_back.html +0 -38
  436. data/examples/csv_postcards/postcard_front.html +0 -25
  437. data/examples/csv_verify/input.csv +0 -7
  438. data/examples/csv_verify/verify.rb +0 -37
  439. data/examples/letters.rb +0 -73
  440. data/examples/list_postcards_metadata.rb +0 -94
  441. data/examples/postcards.rb +0 -87
  442. data/examples/postcards_idempotent.rb +0 -92
  443. data/examples/postcards_intl.rb +0 -87
  444. data/examples/postcards_remote.rb +0 -87
  445. data/examples/postcards_send_date.rb +0 -97
  446. data/examples/postcards_template.rb +0 -98
  447. data/examples/self_mailers.rb +0 -38
  448. data/lib/lob/client.rb +0 -96
  449. data/lib/lob/errors/invalid_request_error.rb +0 -4
  450. data/lib/lob/errors/lob_error.rb +0 -20
  451. data/lib/lob/resources/address.rb +0 -14
  452. data/lib/lob/resources/bank_account.rb +0 -30
  453. data/lib/lob/resources/bulk_intl_verifications.rb +0 -27
  454. data/lib/lob/resources/bulk_us_verifications.rb +0 -28
  455. data/lib/lob/resources/card.rb +0 -46
  456. data/lib/lob/resources/check.rb +0 -14
  457. data/lib/lob/resources/group.rb +0 -14
  458. data/lib/lob/resources/groups_member.rb +0 -66
  459. data/lib/lob/resources/intl_verifications.rb +0 -26
  460. data/lib/lob/resources/letter.rb +0 -14
  461. data/lib/lob/resources/postcard.rb +0 -14
  462. data/lib/lob/resources/resource_base.rb +0 -150
  463. data/lib/lob/resources/self_mailer.rb +0 -14
  464. data/lib/lob/resources/us_autocompletions.rb +0 -26
  465. data/lib/lob/resources/us_reverse_geocode_lookups.rb +0 -26
  466. data/lib/lob/resources/us_verifications.rb +0 -27
  467. data/lib/lob/resources/us_zip_lookups.rb +0 -26
  468. data/lib/lob/version.rb +0 -3
  469. data/lob.gemspec +0 -31
  470. data/spec/lob/errors/lob_error_spec.rb +0 -19
  471. data/spec/lob/resources/address_spec.rb +0 -55
  472. data/spec/lob/resources/bank_account_spec.rb +0 -60
  473. data/spec/lob/resources/bulk_intl_verifications_spec.rb +0 -39
  474. data/spec/lob/resources/bulk_us_verifications_spec.rb +0 -51
  475. data/spec/lob/resources/card_spec.rb +0 -145
  476. data/spec/lob/resources/check_spec.rb +0 -119
  477. data/spec/lob/resources/group_spec.rb +0 -50
  478. data/spec/lob/resources/intl_verifications_spec.rb +0 -25
  479. data/spec/lob/resources/letter_spec.rb +0 -114
  480. data/spec/lob/resources/member_spec.rb +0 -65
  481. data/spec/lob/resources/postcard_spec.rb +0 -160
  482. data/spec/lob/resources/resource_base_spec.rb +0 -75
  483. data/spec/lob/resources/self_mailer_spec.rb +0 -177
  484. data/spec/lob/resources/us_autocompletions_spec.rb +0 -24
  485. data/spec/lob/resources/us_reverse_geocode_lookups_spec.rb +0 -22
  486. data/spec/lob/resources/us_verifications_spec.rb +0 -31
  487. data/spec/lob/resources/us_zip_lookups_spec.rb +0 -23
  488. data/spec/lob_spec.rb +0 -48
  489. data/spec/samples/8.5x11.pdf +0 -0
  490. data/spec/samples/card.pdf +1 -743
  491. data/spec/samples/postcardback.pdf +2 -2287
  492. data/spec/samples/postcardfront.pdf +1 -1549
  493. data/spec/samples/sfm-12x9-inside.pdf +0 -0
  494. data/spec/samples/sfm-12x9-outside.pdf +0 -0
  495. data/spec/samples/sfm-6x18-inside.pdf +0 -0
  496. data/spec/samples/sfm-6x18-outside.pdf +0 -0
@@ -0,0 +1,521 @@
1
+ =begin
2
+ #Lob
3
+
4
+ #The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors. <p> Looking for our [previous documentation](https://lob.github.io/legacy-docs/)?
5
+
6
+ The version of the OpenAPI document: 1.3.0
7
+ Contact: lob-openapi@lob.com
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.2.1
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module Lob
17
+ class AddressDomesticExpanded
18
+ # The building number, street name, street suffix, and any street directionals. For US addresses, the max length is 64 characters.
19
+ attr_accessor :address_line1
20
+
21
+ # The suite or apartment number of the recipient address, if applicable. For US addresses, the max length is 64 characters.
22
+ attr_accessor :address_line2
23
+
24
+ attr_accessor :address_city
25
+
26
+ attr_accessor :address_state
27
+
28
+ # Optional postal code. For US addresses, must be either 5 or 9 digits.
29
+ attr_accessor :address_zip
30
+
31
+ # An internal description that identifies this resource. Must be no longer than 255 characters.
32
+ attr_accessor :description
33
+
34
+ # Either `name` or `company` is required, you may also add both. Must be no longer than 40 characters. If both `name` and `company` are provided, they will be printed on two separate lines above the rest of the address.
35
+ attr_accessor :name
36
+
37
+ # Either `name` or `company` is required, you may also add both.
38
+ attr_accessor :company
39
+
40
+ # Must be no longer than 40 characters.
41
+ attr_accessor :phone
42
+
43
+ # Must be no longer than 100 characters.
44
+ attr_accessor :email
45
+
46
+ # The country associated with this address.
47
+ attr_accessor :address_country
48
+
49
+ # Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information.
50
+ attr_accessor :metadata
51
+
52
+ # Attribute mapping from ruby-style variable name to JSON key.
53
+ def self.attribute_map
54
+ {
55
+ :'address_line1' => :'address_line1',
56
+ :'address_line2' => :'address_line2',
57
+ :'address_city' => :'address_city',
58
+ :'address_state' => :'address_state',
59
+ :'address_zip' => :'address_zip',
60
+ :'description' => :'description',
61
+ :'name' => :'name',
62
+ :'company' => :'company',
63
+ :'phone' => :'phone',
64
+ :'email' => :'email',
65
+ :'address_country' => :'address_country',
66
+ :'metadata' => :'metadata'
67
+ }
68
+ end
69
+
70
+ # Returns all the JSON keys this model knows about
71
+ def self.acceptable_attributes
72
+ attribute_map.values
73
+ end
74
+
75
+ # Attribute type mapping.
76
+ def self.openapi_types
77
+ {
78
+ :'address_line1' => :'String',
79
+ :'address_line2' => :'String',
80
+ :'address_city' => :'String',
81
+ :'address_state' => :'String',
82
+ :'address_zip' => :'String',
83
+ :'description' => :'String',
84
+ :'name' => :'String',
85
+ :'company' => :'String',
86
+ :'phone' => :'String',
87
+ :'email' => :'String',
88
+ :'address_country' => :'String',
89
+ :'metadata' => :'Hash<String, String>'
90
+ }
91
+ end
92
+
93
+ # List of attributes with nullable: true
94
+ def self.openapi_nullable
95
+ Set.new([
96
+ :'address_line2',
97
+ :'address_city',
98
+ :'address_state',
99
+ :'address_zip',
100
+ :'description',
101
+ :'name',
102
+ :'company',
103
+ :'phone',
104
+ :'email',
105
+ ])
106
+ end
107
+
108
+ # Initializes the object
109
+ # @param [Hash] attributes Model attributes in the form of hash
110
+ def initialize(attributes = {})
111
+ if (!attributes.is_a?(Hash))
112
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Lob::AddressDomesticExpanded` initialize method"
113
+ end
114
+
115
+ # check to see if the attribute exists and convert string to symbol for hash key
116
+ attributes = attributes.each_with_object({}) { |(k, v), h|
117
+ if (!self.class.attribute_map.key?(k.to_sym))
118
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Lob::AddressDomesticExpanded`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
119
+ end
120
+ h[k.to_sym] = v
121
+ }
122
+
123
+ if attributes.key?(:'address_line1')
124
+ self.address_line1 = attributes[:'address_line1']
125
+ end
126
+
127
+ if attributes.key?(:'address_line2')
128
+ self.address_line2 = attributes[:'address_line2']
129
+ end
130
+
131
+ if attributes.key?(:'address_city')
132
+ self.address_city = attributes[:'address_city']
133
+ end
134
+
135
+ if attributes.key?(:'address_state')
136
+ self.address_state = attributes[:'address_state']
137
+ end
138
+
139
+ if attributes.key?(:'address_zip')
140
+ self.address_zip = attributes[:'address_zip']
141
+ end
142
+
143
+ if attributes.key?(:'description')
144
+ self.description = attributes[:'description']
145
+ end
146
+
147
+ if attributes.key?(:'name')
148
+ self.name = attributes[:'name']
149
+ end
150
+
151
+ if attributes.key?(:'company')
152
+ self.company = attributes[:'company']
153
+ end
154
+
155
+ if attributes.key?(:'phone')
156
+ self.phone = attributes[:'phone']
157
+ end
158
+
159
+ if attributes.key?(:'email')
160
+ self.email = attributes[:'email']
161
+ end
162
+
163
+ if attributes.key?(:'address_country')
164
+ self.address_country = attributes[:'address_country']
165
+ end
166
+
167
+ if attributes.key?(:'metadata')
168
+ if (value = attributes[:'metadata']).is_a?(Hash)
169
+ self.metadata = value
170
+ end
171
+ end
172
+ end
173
+
174
+ # Show invalid properties with the reasons. Usually used together with valid?
175
+ # @return Array for valid properties with the reasons
176
+ def list_invalid_properties
177
+ invalid_properties = Array.new
178
+ if !@address_line1.nil? && @address_line1.to_s.length > 200
179
+ invalid_properties.push('invalid value for "address_line1", the character length must be smaller than or equal to 200.')
180
+ end
181
+
182
+ if !@address_line2.nil? && @address_line2.to_s.length > 200
183
+ invalid_properties.push('invalid value for "address_line2", the character length must be smaller than or equal to 200.')
184
+ end
185
+
186
+ if !@address_city.nil? && @address_city.to_s.length > 200
187
+ invalid_properties.push('invalid value for "address_city", the character length must be smaller than or equal to 200.')
188
+ end
189
+
190
+ if !@address_state.nil? && @address_state.to_s.length > 200
191
+ invalid_properties.push('invalid value for "address_state", the character length must be smaller than or equal to 200.')
192
+ end
193
+
194
+ if !@address_zip.nil? && @address_zip.to_s.length > 40
195
+ invalid_properties.push('invalid value for "address_zip", the character length must be smaller than or equal to 40.')
196
+ end
197
+
198
+ if !@description.nil? && @description.to_s.length > 255
199
+ invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 255.')
200
+ end
201
+
202
+ if !@name.nil? && @name.to_s.length > 40
203
+ invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 40.')
204
+ end
205
+
206
+ if !@company.nil? && @company.to_s.length > 40
207
+ invalid_properties.push('invalid value for "company", the character length must be smaller than or equal to 40.')
208
+ end
209
+
210
+ if !@phone.nil? && @phone.to_s.length > 40
211
+ invalid_properties.push('invalid value for "phone", the character length must be smaller than or equal to 40.')
212
+ end
213
+
214
+ if !@email.nil? && @email.to_s.length > 100
215
+ invalid_properties.push('invalid value for "email", the character length must be smaller than or equal to 100.')
216
+ end
217
+
218
+ pattern = Regexp.new(/UNITED STATES/)
219
+ if !@address_country.nil? && @address_country !~ pattern
220
+ invalid_properties.push("invalid value for \"address_country\", must conform to the pattern #{pattern}.")
221
+ end
222
+
223
+ invalid_properties
224
+ end
225
+
226
+ # Check to see if the all the properties in the model are valid
227
+ # @return true if the model is valid
228
+ def valid?
229
+ return false if !@address_line1.nil? && @address_line1.to_s.length > 200
230
+ return false if !@address_line2.nil? && @address_line2.to_s.length > 200
231
+ return false if !@address_city.nil? && @address_city.to_s.length > 200
232
+ return false if !@address_state.nil? && @address_state.to_s.length > 200
233
+ return false if !@address_zip.nil? && @address_zip.to_s.length > 40
234
+ return false if !@description.nil? && @description.to_s.length > 255
235
+ return false if !@name.nil? && @name.to_s.length > 40
236
+ return false if !@company.nil? && @company.to_s.length > 40
237
+ return false if !@phone.nil? && @phone.to_s.length > 40
238
+ return false if !@email.nil? && @email.to_s.length > 100
239
+ return false if !@address_country.nil? && @address_country !~ Regexp.new(/UNITED STATES/)
240
+ true
241
+ end
242
+
243
+ # Custom attribute writer method with validation
244
+ # @param [Object] address_line1 Value to be assigned
245
+ def address_line1=(address_line1)
246
+ if !address_line1.nil? && address_line1.to_s.length > 200
247
+ fail ArgumentError, 'invalid value for "address_line1", the character length must be smaller than or equal to 200.'
248
+ end
249
+
250
+ @address_line1 = address_line1
251
+ end
252
+
253
+ # Custom attribute writer method with validation
254
+ # @param [Object] address_line2 Value to be assigned
255
+ def address_line2=(address_line2)
256
+ if !address_line2.nil? && address_line2.to_s.length > 200
257
+ fail ArgumentError, 'invalid value for "address_line2", the character length must be smaller than or equal to 200.'
258
+ end
259
+
260
+ @address_line2 = address_line2
261
+ end
262
+
263
+ # Custom attribute writer method with validation
264
+ # @param [Object] address_city Value to be assigned
265
+ def address_city=(address_city)
266
+ if !address_city.nil? && address_city.to_s.length > 200
267
+ fail ArgumentError, 'invalid value for "address_city", the character length must be smaller than or equal to 200.'
268
+ end
269
+
270
+ @address_city = address_city
271
+ end
272
+
273
+ # Custom attribute writer method with validation
274
+ # @param [Object] address_state Value to be assigned
275
+ def address_state=(address_state)
276
+ if !address_state.nil? && address_state.to_s.length > 200
277
+ fail ArgumentError, 'invalid value for "address_state", the character length must be smaller than or equal to 200.'
278
+ end
279
+
280
+ @address_state = address_state
281
+ end
282
+
283
+ # Custom attribute writer method with validation
284
+ # @param [Object] address_zip Value to be assigned
285
+ def address_zip=(address_zip)
286
+ if !address_zip.nil? && address_zip.to_s.length > 40
287
+ fail ArgumentError, 'invalid value for "address_zip", the character length must be smaller than or equal to 40.'
288
+ end
289
+
290
+ @address_zip = address_zip
291
+ end
292
+
293
+ # Custom attribute writer method with validation
294
+ # @param [Object] description Value to be assigned
295
+ def description=(description)
296
+ if !description.nil? && description.to_s.length > 255
297
+ fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 255.'
298
+ end
299
+
300
+ @description = description
301
+ end
302
+
303
+ # Custom attribute writer method with validation
304
+ # @param [Object] name Value to be assigned
305
+ def name=(name)
306
+ if !name.nil? && name.to_s.length > 40
307
+ fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 40.'
308
+ end
309
+
310
+ @name = name
311
+ end
312
+
313
+ # Custom attribute writer method with validation
314
+ # @param [Object] company Value to be assigned
315
+ def company=(company)
316
+ if !company.nil? && company.to_s.length > 40
317
+ fail ArgumentError, 'invalid value for "company", the character length must be smaller than or equal to 40.'
318
+ end
319
+
320
+ @company = company
321
+ end
322
+
323
+ # Custom attribute writer method with validation
324
+ # @param [Object] phone Value to be assigned
325
+ def phone=(phone)
326
+ if !phone.nil? && phone.to_s.length > 40
327
+ fail ArgumentError, 'invalid value for "phone", the character length must be smaller than or equal to 40.'
328
+ end
329
+
330
+ @phone = phone
331
+ end
332
+
333
+ # Custom attribute writer method with validation
334
+ # @param [Object] email Value to be assigned
335
+ def email=(email)
336
+ if !email.nil? && email.to_s.length > 100
337
+ fail ArgumentError, 'invalid value for "email", the character length must be smaller than or equal to 100.'
338
+ end
339
+
340
+ @email = email
341
+ end
342
+
343
+ # Custom attribute writer method with validation
344
+ # @param [Object] address_country Value to be assigned
345
+ def address_country=(address_country)
346
+ pattern = Regexp.new(/UNITED STATES/)
347
+ if !address_country.nil? && address_country !~ pattern
348
+ fail ArgumentError, "invalid value for \"address_country\", must conform to the pattern #{pattern}."
349
+ end
350
+
351
+ @address_country = address_country
352
+ end
353
+
354
+ # Custom attribute writer method with validation
355
+ # @param [Object] metadata Value to be assigned
356
+ def metadata=(metadata)
357
+ @metadata = metadata
358
+ end
359
+
360
+ # Checks equality by comparing each attribute.
361
+ # @param [Object] Object to be compared
362
+ def ==(o)
363
+ return true if self.equal?(o)
364
+ self.class == o.class &&
365
+ address_line1 == o.address_line1 &&
366
+ address_line2 == o.address_line2 &&
367
+ address_city == o.address_city &&
368
+ address_state == o.address_state &&
369
+ address_zip == o.address_zip &&
370
+ description == o.description &&
371
+ name == o.name &&
372
+ company == o.company &&
373
+ phone == o.phone &&
374
+ email == o.email &&
375
+ address_country == o.address_country &&
376
+ metadata == o.metadata
377
+ end
378
+
379
+ # @see the `==` method
380
+ # @param [Object] Object to be compared
381
+ def eql?(o)
382
+ self == o
383
+ end
384
+
385
+ # Calculates hash code according to all attributes.
386
+ # @return [Integer] Hash code
387
+ def hash
388
+ [address_line1, address_line2, address_city, address_state, address_zip, description, name, company, phone, email, address_country, metadata].hash
389
+ end
390
+
391
+
392
+ # Builds the object from hash
393
+ # @param [Hash] attributes Model attributes in the form of hash
394
+ # @return [Object] Returns the model itself
395
+ def self.build_from_hash(attributes)
396
+ new.build_from_hash(attributes)
397
+ end
398
+
399
+ # Builds the object from hash
400
+ # @param [Hash] attributes Model attributes in the form of hash
401
+ # @return [Object] Returns the model itself
402
+ def build_from_hash(attributes)
403
+ return nil unless attributes.is_a?(Hash)
404
+ attributes = attributes.transform_keys(&:to_sym)
405
+ self.class.openapi_types.each_pair do |key, type|
406
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
407
+ self.send("#{key}=", nil) # // guardrails-disable-line
408
+ elsif type =~ /\AArray<(.*)>/i
409
+ # check to ensure the input is an array given that the attribute
410
+ # is documented as an array but the input is not
411
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
412
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) # // guardrails-disable-line
413
+ end
414
+ elsif !attributes[self.class.attribute_map[key]].nil? && type.kind_of?(Array)
415
+ for base_type in type do
416
+ res = _deserialize(base_type, attributes[self.class.attribute_map[key]])
417
+ if !res.nil?
418
+ self.send("#{key}=", res) # // guardrails-disable-line
419
+ break
420
+ end
421
+ end
422
+ elsif !attributes[self.class.attribute_map[key]].nil?
423
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) # // guardrails-disable-line
424
+ end
425
+ end
426
+
427
+ self
428
+ end
429
+
430
+ # Deserializes the data based on type
431
+ # @param string type Data type
432
+ # @param string value Value to be deserialized
433
+ # @return [Object] Deserialized data
434
+ def _deserialize(type, value)
435
+ case type.to_sym
436
+ when :Time
437
+ Time.parse(value)
438
+ when :Date
439
+ Date.parse(value)
440
+ when :String
441
+ value.to_s
442
+ when :Integer
443
+ value.to_i
444
+ when :Float
445
+ value.to_f
446
+ when :Boolean
447
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
448
+ true
449
+ else
450
+ false
451
+ end
452
+ when :Object
453
+ # generic object (usually a Hash), return directly
454
+ value
455
+ when /\AArray<(?<inner_type>.+)>\z/
456
+ inner_type = Regexp.last_match[:inner_type]
457
+ value.map { |v| _deserialize(inner_type, v) }
458
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
459
+ k_type = Regexp.last_match[:k_type]
460
+ v_type = Regexp.last_match[:v_type]
461
+ {}.tap do |hash|
462
+ value.each do |k, v|
463
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
464
+ end
465
+ end
466
+ else # model
467
+ # models (e.g. Pet) or oneOf
468
+ klass = Lob.const_get(type)
469
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
470
+ end
471
+ end
472
+
473
+ # Returns the string representation of the object
474
+ # @return [String] String presentation of the object
475
+ def to_s
476
+ to_hash.to_s
477
+ end
478
+
479
+ # to_body is an alias to to_hash (backward compatibility)
480
+ # @return [Hash] Returns the object in the form of hash
481
+ def to_body
482
+ to_hash
483
+ end
484
+
485
+ # Returns the object in the form of hash
486
+ # @return [Hash] Returns the object in the form of hash
487
+ def to_hash
488
+ hash = {}
489
+ self.class.attribute_map.each_pair do |attr, param|
490
+ value = self.send(attr) # // guardrails-disable-line
491
+ if value.nil?
492
+ is_nullable = self.class.openapi_nullable.include?(attr)
493
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
494
+ end
495
+
496
+ hash[param] = _to_hash(value)
497
+ end
498
+ hash
499
+ end
500
+
501
+ # Outputs non-array value in the form of hash
502
+ # For object, use to_hash. Otherwise, just return the value
503
+ # @param [Object] value Any valid value
504
+ # @return [Hash] Returns the value in the form of hash
505
+ def _to_hash(value)
506
+ if value.is_a?(Array)
507
+ value.compact.map { |v| _to_hash(v) }
508
+ elsif value.is_a?(Hash)
509
+ {}.tap do |hash|
510
+ value.each { |k, v| hash[k] = _to_hash(v) }
511
+ end
512
+ elsif value.respond_to? :to_hash
513
+ value.to_hash
514
+ else
515
+ value
516
+ end
517
+ end
518
+
519
+ end
520
+
521
+ end