lob 5.4.6 → 6.0.0

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