lob 5.1.0 → 6.0.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (471) hide show
  1. checksums.yaml +5 -5
  2. data/CODE_SNIPPETS.md +1871 -0
  3. data/Gemfile +6 -1
  4. data/Gemfile.lock +72 -0
  5. data/LICENSE +21 -0
  6. data/MIGRATION.md +174 -0
  7. data/README.md +70 -154
  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 +46 -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 +70 -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 +385 -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 +343 -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 +601 -0
  293. data/lib/openapi_client/models/dpv_footnote.rb +54 -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 +788 -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 +107 -13
  417. metadata +452 -140
  418. data/.gitignore +0 -18
  419. data/.travis.yml +0 -16
  420. data/CHANGELOG.md +0 -114
  421. data/CONTRIBUTING.md +0 -19
  422. data/LICENSE.txt +0 -22
  423. data/examples/README.md +0 -33
  424. data/examples/checks.rb +0 -48
  425. data/examples/csv_checks/create_checks.rb +0 -47
  426. data/examples/csv_checks/input.csv +0 -6
  427. data/examples/csv_letters/create_letters.rb +0 -40
  428. data/examples/csv_letters/input.csv +0 -6
  429. data/examples/csv_letters/letter_template.html +0 -33
  430. data/examples/csv_postcards/create_postcards.rb +0 -45
  431. data/examples/csv_postcards/input.csv +0 -7
  432. data/examples/csv_postcards/postcard_back.html +0 -38
  433. data/examples/csv_postcards/postcard_front.html +0 -25
  434. data/examples/csv_verify/input.csv +0 -7
  435. data/examples/csv_verify/verify.rb +0 -36
  436. data/examples/letters.rb +0 -72
  437. data/examples/postcards.rb +0 -86
  438. data/lib/lob/client.rb +0 -71
  439. data/lib/lob/errors/invalid_request_error.rb +0 -4
  440. data/lib/lob/errors/lob_error.rb +0 -20
  441. data/lib/lob/resources/address.rb +0 -14
  442. data/lib/lob/resources/bank_account.rb +0 -30
  443. data/lib/lob/resources/check.rb +0 -14
  444. data/lib/lob/resources/group.rb +0 -14
  445. data/lib/lob/resources/groups_member.rb +0 -66
  446. data/lib/lob/resources/intl_verifications.rb +0 -26
  447. data/lib/lob/resources/letter.rb +0 -14
  448. data/lib/lob/resources/postcard.rb +0 -14
  449. data/lib/lob/resources/resource_base.rb +0 -139
  450. data/lib/lob/resources/us_autocompletions.rb +0 -26
  451. data/lib/lob/resources/us_verifications.rb +0 -27
  452. data/lib/lob/resources/us_zip_lookups.rb +0 -26
  453. data/lib/lob/version.rb +0 -3
  454. data/lob.gemspec +0 -28
  455. data/spec/lob/errors/lob_error_spec.rb +0 -19
  456. data/spec/lob/resources/address_spec.rb +0 -55
  457. data/spec/lob/resources/bank_account_spec.rb +0 -60
  458. data/spec/lob/resources/check_spec.rb +0 -98
  459. data/spec/lob/resources/group_spec.rb +0 -50
  460. data/spec/lob/resources/intl_verifications_spec.rb +0 -28
  461. data/spec/lob/resources/letter_spec.rb +0 -94
  462. data/spec/lob/resources/member_spec.rb +0 -65
  463. data/spec/lob/resources/postcard_spec.rb +0 -135
  464. data/spec/lob/resources/resource_base_spec.rb +0 -75
  465. data/spec/lob/resources/us_autocompletions_spec.rb +0 -24
  466. data/spec/lob/resources/us_verifications_spec.rb +0 -31
  467. data/spec/lob/resources/us_zip_lookups_spec.rb +0 -23
  468. data/spec/lob_spec.rb +0 -48
  469. data/spec/samples/8.5x11.pdf +0 -0
  470. data/spec/samples/postcardback.pdf +2 -2287
  471. data/spec/samples/postcardfront.pdf +1 -1549
@@ -0,0 +1,788 @@
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
+ # A nested object containing a breakdown of each component of an address.
18
+ class UsComponents
19
+ # The numeric or alphanumeric part of an address preceding the street name. Often the house, building, or PO Box number.
20
+ attr_accessor :primary_number
21
+
22
+ # Geographic direction preceding a street name (`N`, `S`, `E`, `W`, `NE`, `SW`, `SE`, `NW`).
23
+ attr_accessor :street_predirection
24
+
25
+ # The name of the street.
26
+ attr_accessor :street_name
27
+
28
+ # The standard USPS abbreviation for the street suffix (`ST`, `AVE`, `BLVD`, etc).
29
+ attr_accessor :street_suffix
30
+
31
+ # Geographic direction following a street name (`N`, `S`, `E`, `W`, `NE`, `SW`, `SE`, `NW`).
32
+ attr_accessor :street_postdirection
33
+
34
+ # The standard USPS abbreviation describing the `components[secondary_number]` (`STE`, `APT`, `BLDG`, etc).
35
+ attr_accessor :secondary_designator
36
+
37
+ # Number of the apartment/unit/etc.
38
+ attr_accessor :secondary_number
39
+
40
+ # Designator of a [CMRA-authorized](https://en.wikipedia.org/wiki/Commercial_mail_receiving_agency) private mailbox.
41
+ attr_accessor :pmb_designator
42
+
43
+ # Number of a [CMRA-authorized](https://en.wikipedia.org/wiki/Commercial_mail_receiving_agency) private mailbox.
44
+ attr_accessor :pmb_number
45
+
46
+ # An extra (often unnecessary) secondary designator provided with the input address.
47
+ attr_accessor :extra_secondary_designator
48
+
49
+ # An extra (often unnecessary) secondary number provided with the input address.
50
+ attr_accessor :extra_secondary_number
51
+
52
+ attr_accessor :city
53
+
54
+ # The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) two letter code for the state.
55
+ attr_accessor :state
56
+
57
+ # The 5-digit ZIP code
58
+ attr_accessor :zip_code
59
+
60
+ attr_accessor :zip_code_plus_4
61
+
62
+ attr_accessor :zip_code_type
63
+
64
+ # A 12-digit identifier that uniquely identifies a delivery point (location where mail can be sent and received). It consists of the 5-digit ZIP code (`zip_code`), 4-digit ZIP+4 add-on (`zip_code_plus_4`), 2-digit delivery point, and 1-digit delivery point check digit.
65
+ attr_accessor :delivery_point_barcode
66
+
67
+ # Uses USPS's [Residential Delivery Indicator (RDI)](https://www.usps.com/nationalpremieraccounts/rdi.htm) to identify whether an address is classified as residential or business. Possible values are: * `residential` –– The address is residential or a PO Box. * `commercial` –– The address is commercial. * `''` –– Not enough information provided to be determined.
68
+ attr_accessor :address_type
69
+
70
+ # A description of the type of address. Populated if a DPV match is made (`deliverability_analysis[dpv_confirmation]` is `Y`, `S`, or `D`). For more detailed information about each record type, see [US Verification Details](#tag/US-Verification-Types).
71
+ attr_accessor :record_type
72
+
73
+ # Designates whether or not the address is the default address for a building containing multiple delivery points.
74
+ attr_accessor :default_building_address
75
+
76
+ # County name of the address city.
77
+ attr_accessor :county
78
+
79
+ # A 5-digit [FIPS county code](https://en.wikipedia.org/wiki/FIPS_county_code) which uniquely identifies `components[county]`. It consists of a 2-digit state code and a 3-digit county code.
80
+ attr_accessor :county_fips
81
+
82
+ # A 4-character code assigned to a mail delivery route within a ZIP code.
83
+ attr_accessor :carrier_route
84
+
85
+ # The type of `components[carrier_route]`. For more detailed information about each carrier route type, see [US Verification Details](#tag/US-Verification-Types).
86
+ attr_accessor :carrier_route_type
87
+
88
+ # Indicates the mailing facility for an address only supports PO Box deliveries and other forms of mail delivery are not available.
89
+ attr_accessor :po_box_only_flag
90
+
91
+ # A positive or negative decimal indicating the geographic latitude of the address, specifying the north-to-south position of a location. This should be used with `longitude` to pinpoint locations on a map. Will not be returned for undeliverable addresses or military addresses (state is `AA`, `AE`, or `AP`).
92
+ attr_accessor :latitude
93
+
94
+ # A positive or negative decimal indicating the geographic longitude of the address, specifying the north-to-south position of a location. This should be used with `latitude` to pinpoint locations on a map. Will not be returned for undeliverable addresses or military addresses (state is `AA`, `AE`, or `AP`).
95
+ attr_accessor :longitude
96
+
97
+ class EnumAttributeValidator
98
+ attr_reader :datatype
99
+ attr_reader :allowable_values
100
+
101
+ def initialize(datatype, allowable_values)
102
+ @allowable_values = allowable_values.map do |value|
103
+ case datatype.to_s
104
+ when /Integer/i
105
+ value.to_i
106
+ when /Float/i
107
+ value.to_f
108
+ else
109
+ value
110
+ end
111
+ end
112
+ end
113
+
114
+ def valid?(value)
115
+ !value || allowable_values.include?(value)
116
+ end
117
+ end
118
+
119
+ # Attribute mapping from ruby-style variable name to JSON key.
120
+ def self.attribute_map
121
+ {
122
+ :'primary_number' => :'primary_number',
123
+ :'street_predirection' => :'street_predirection',
124
+ :'street_name' => :'street_name',
125
+ :'street_suffix' => :'street_suffix',
126
+ :'street_postdirection' => :'street_postdirection',
127
+ :'secondary_designator' => :'secondary_designator',
128
+ :'secondary_number' => :'secondary_number',
129
+ :'pmb_designator' => :'pmb_designator',
130
+ :'pmb_number' => :'pmb_number',
131
+ :'extra_secondary_designator' => :'extra_secondary_designator',
132
+ :'extra_secondary_number' => :'extra_secondary_number',
133
+ :'city' => :'city',
134
+ :'state' => :'state',
135
+ :'zip_code' => :'zip_code',
136
+ :'zip_code_plus_4' => :'zip_code_plus_4',
137
+ :'zip_code_type' => :'zip_code_type',
138
+ :'delivery_point_barcode' => :'delivery_point_barcode',
139
+ :'address_type' => :'address_type',
140
+ :'record_type' => :'record_type',
141
+ :'default_building_address' => :'default_building_address',
142
+ :'county' => :'county',
143
+ :'county_fips' => :'county_fips',
144
+ :'carrier_route' => :'carrier_route',
145
+ :'carrier_route_type' => :'carrier_route_type',
146
+ :'po_box_only_flag' => :'po_box_only_flag',
147
+ :'latitude' => :'latitude',
148
+ :'longitude' => :'longitude'
149
+ }
150
+ end
151
+
152
+ # Returns all the JSON keys this model knows about
153
+ def self.acceptable_attributes
154
+ attribute_map.values
155
+ end
156
+
157
+ # Attribute type mapping.
158
+ def self.openapi_types
159
+ {
160
+ :'primary_number' => :'String',
161
+ :'street_predirection' => :'String',
162
+ :'street_name' => :'String',
163
+ :'street_suffix' => :'String',
164
+ :'street_postdirection' => :'String',
165
+ :'secondary_designator' => :'String',
166
+ :'secondary_number' => :'String',
167
+ :'pmb_designator' => :'String',
168
+ :'pmb_number' => :'String',
169
+ :'extra_secondary_designator' => :'String',
170
+ :'extra_secondary_number' => :'String',
171
+ :'city' => :'String',
172
+ :'state' => :'String',
173
+ :'zip_code' => :'String',
174
+ :'zip_code_plus_4' => :'String',
175
+ :'zip_code_type' => :'ZipCodeType',
176
+ :'delivery_point_barcode' => :'String',
177
+ :'address_type' => :'String',
178
+ :'record_type' => :'String',
179
+ :'default_building_address' => :'Boolean',
180
+ :'county' => :'String',
181
+ :'county_fips' => :'String',
182
+ :'carrier_route' => :'String',
183
+ :'carrier_route_type' => :'String',
184
+ :'po_box_only_flag' => :'String',
185
+ :'latitude' => :'Float',
186
+ :'longitude' => :'Float'
187
+ }
188
+ end
189
+
190
+ # List of attributes with nullable: true
191
+ def self.openapi_nullable
192
+ Set.new([
193
+ :'latitude',
194
+ :'longitude'
195
+ ])
196
+ end
197
+
198
+ # Initializes the object
199
+ # @param [Hash] attributes Model attributes in the form of hash
200
+ def initialize(attributes = {})
201
+ if (!attributes.is_a?(Hash))
202
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Lob::UsComponents` initialize method"
203
+ end
204
+
205
+ # check to see if the attribute exists and convert string to symbol for hash key
206
+ attributes = attributes.each_with_object({}) { |(k, v), h|
207
+ if (!self.class.attribute_map.key?(k.to_sym))
208
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Lob::UsComponents`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
209
+ end
210
+ h[k.to_sym] = v
211
+ }
212
+
213
+ if attributes.key?(:'primary_number')
214
+ self.primary_number = attributes[:'primary_number']
215
+ end
216
+
217
+ if attributes.key?(:'street_predirection')
218
+ self.street_predirection = attributes[:'street_predirection']
219
+ end
220
+
221
+ if attributes.key?(:'street_name')
222
+ self.street_name = attributes[:'street_name']
223
+ end
224
+
225
+ if attributes.key?(:'street_suffix')
226
+ self.street_suffix = attributes[:'street_suffix']
227
+ end
228
+
229
+ if attributes.key?(:'street_postdirection')
230
+ self.street_postdirection = attributes[:'street_postdirection']
231
+ end
232
+
233
+ if attributes.key?(:'secondary_designator')
234
+ self.secondary_designator = attributes[:'secondary_designator']
235
+ end
236
+
237
+ if attributes.key?(:'secondary_number')
238
+ self.secondary_number = attributes[:'secondary_number']
239
+ end
240
+
241
+ if attributes.key?(:'pmb_designator')
242
+ self.pmb_designator = attributes[:'pmb_designator']
243
+ end
244
+
245
+ if attributes.key?(:'pmb_number')
246
+ self.pmb_number = attributes[:'pmb_number']
247
+ end
248
+
249
+ if attributes.key?(:'extra_secondary_designator')
250
+ self.extra_secondary_designator = attributes[:'extra_secondary_designator']
251
+ end
252
+
253
+ if attributes.key?(:'extra_secondary_number')
254
+ self.extra_secondary_number = attributes[:'extra_secondary_number']
255
+ end
256
+
257
+ if attributes.key?(:'city')
258
+ self.city = attributes[:'city']
259
+ end
260
+
261
+ if attributes.key?(:'state')
262
+ self.state = attributes[:'state']
263
+ end
264
+
265
+ if attributes.key?(:'zip_code')
266
+ self.zip_code = attributes[:'zip_code']
267
+ end
268
+
269
+ if attributes.key?(:'zip_code_plus_4')
270
+ self.zip_code_plus_4 = attributes[:'zip_code_plus_4']
271
+ end
272
+
273
+ if attributes.key?(:'zip_code_type')
274
+ self.zip_code_type = attributes[:'zip_code_type']
275
+ end
276
+
277
+ if attributes.key?(:'delivery_point_barcode')
278
+ self.delivery_point_barcode = attributes[:'delivery_point_barcode']
279
+ end
280
+
281
+ if attributes.key?(:'address_type')
282
+ self.address_type = attributes[:'address_type']
283
+ end
284
+
285
+ if attributes.key?(:'record_type')
286
+ self.record_type = attributes[:'record_type']
287
+ end
288
+
289
+ if attributes.key?(:'default_building_address')
290
+ self.default_building_address = attributes[:'default_building_address']
291
+ end
292
+
293
+ if attributes.key?(:'county')
294
+ self.county = attributes[:'county']
295
+ end
296
+
297
+ if attributes.key?(:'county_fips')
298
+ self.county_fips = attributes[:'county_fips']
299
+ end
300
+
301
+ if attributes.key?(:'carrier_route')
302
+ self.carrier_route = attributes[:'carrier_route']
303
+ end
304
+
305
+ if attributes.key?(:'carrier_route_type')
306
+ self.carrier_route_type = attributes[:'carrier_route_type']
307
+ end
308
+
309
+ if attributes.key?(:'po_box_only_flag')
310
+ self.po_box_only_flag = attributes[:'po_box_only_flag']
311
+ end
312
+
313
+ if attributes.key?(:'latitude')
314
+ self.latitude = attributes[:'latitude']
315
+ end
316
+
317
+ if attributes.key?(:'longitude')
318
+ self.longitude = attributes[:'longitude']
319
+ end
320
+ end
321
+
322
+ # Show invalid properties with the reasons. Usually used together with valid?
323
+ # @return Array for valid properties with the reasons
324
+ def list_invalid_properties
325
+ invalid_properties = Array.new
326
+ if @primary_number.nil?
327
+ invalid_properties.push('invalid value for "primary_number", primary_number cannot be nil.')
328
+ end
329
+
330
+ if @street_predirection.nil?
331
+ invalid_properties.push('invalid value for "street_predirection", street_predirection cannot be nil.')
332
+ end
333
+
334
+ if @street_name.nil?
335
+ invalid_properties.push('invalid value for "street_name", street_name cannot be nil.')
336
+ end
337
+
338
+ if @street_suffix.nil?
339
+ invalid_properties.push('invalid value for "street_suffix", street_suffix cannot be nil.')
340
+ end
341
+
342
+ if @street_postdirection.nil?
343
+ invalid_properties.push('invalid value for "street_postdirection", street_postdirection cannot be nil.')
344
+ end
345
+
346
+ if @secondary_designator.nil?
347
+ invalid_properties.push('invalid value for "secondary_designator", secondary_designator cannot be nil.')
348
+ end
349
+
350
+ if @secondary_number.nil?
351
+ invalid_properties.push('invalid value for "secondary_number", secondary_number cannot be nil.')
352
+ end
353
+
354
+ if @pmb_designator.nil?
355
+ invalid_properties.push('invalid value for "pmb_designator", pmb_designator cannot be nil.')
356
+ end
357
+
358
+ if @pmb_number.nil?
359
+ invalid_properties.push('invalid value for "pmb_number", pmb_number cannot be nil.')
360
+ end
361
+
362
+ if @extra_secondary_designator.nil?
363
+ invalid_properties.push('invalid value for "extra_secondary_designator", extra_secondary_designator cannot be nil.')
364
+ end
365
+
366
+ if @extra_secondary_number.nil?
367
+ invalid_properties.push('invalid value for "extra_secondary_number", extra_secondary_number cannot be nil.')
368
+ end
369
+
370
+ if @city.nil?
371
+ invalid_properties.push('invalid value for "city", city cannot be nil.')
372
+ end
373
+
374
+ if @city.to_s.length > 200
375
+ invalid_properties.push('invalid value for "city", the character length must be smaller than or equal to 200.')
376
+ end
377
+
378
+ if @state.nil?
379
+ invalid_properties.push('invalid value for "state", state cannot be nil.')
380
+ end
381
+
382
+ if @state.to_s.length > 2
383
+ invalid_properties.push('invalid value for "state", the character length must be smaller than or equal to 2.')
384
+ end
385
+
386
+ if @zip_code.nil?
387
+ invalid_properties.push('invalid value for "zip_code", zip_code cannot be nil.')
388
+ end
389
+
390
+ pattern = Regexp.new(/(^$)|(^\d{5}$)/)
391
+ if @zip_code !~ pattern
392
+ invalid_properties.push("invalid value for \"zip_code\", must conform to the pattern #{pattern}.")
393
+ end
394
+
395
+ if @zip_code_plus_4.nil?
396
+ invalid_properties.push('invalid value for "zip_code_plus_4", zip_code_plus_4 cannot be nil.')
397
+ end
398
+
399
+ pattern = Regexp.new(/^(\d{4})?$/)
400
+ if @zip_code_plus_4 !~ pattern
401
+ invalid_properties.push("invalid value for \"zip_code_plus_4\", must conform to the pattern #{pattern}.")
402
+ end
403
+
404
+ if @zip_code_type.nil?
405
+ invalid_properties.push('invalid value for "zip_code_type", zip_code_type cannot be nil.')
406
+ end
407
+
408
+ if @delivery_point_barcode.nil?
409
+ invalid_properties.push('invalid value for "delivery_point_barcode", delivery_point_barcode cannot be nil.')
410
+ end
411
+
412
+ if @address_type.nil?
413
+ invalid_properties.push('invalid value for "address_type", address_type cannot be nil.')
414
+ end
415
+
416
+ if @record_type.nil?
417
+ invalid_properties.push('invalid value for "record_type", record_type cannot be nil.')
418
+ end
419
+
420
+ if @default_building_address.nil?
421
+ invalid_properties.push('invalid value for "default_building_address", default_building_address cannot be nil.')
422
+ end
423
+
424
+ if @county.nil?
425
+ invalid_properties.push('invalid value for "county", county cannot be nil.')
426
+ end
427
+
428
+ if @county_fips.nil?
429
+ invalid_properties.push('invalid value for "county_fips", county_fips cannot be nil.')
430
+ end
431
+
432
+ if @carrier_route.nil?
433
+ invalid_properties.push('invalid value for "carrier_route", carrier_route cannot be nil.')
434
+ end
435
+
436
+ if @carrier_route_type.nil?
437
+ invalid_properties.push('invalid value for "carrier_route_type", carrier_route_type cannot be nil.')
438
+ end
439
+
440
+ if @po_box_only_flag.nil?
441
+ invalid_properties.push('invalid value for "po_box_only_flag", po_box_only_flag cannot be nil.')
442
+ end
443
+
444
+ invalid_properties
445
+ end
446
+
447
+ # Check to see if the all the properties in the model are valid
448
+ # @return true if the model is valid
449
+ def valid?
450
+ return false if @primary_number.nil?
451
+ return false if @street_predirection.nil?
452
+ street_predirection_validator = EnumAttributeValidator.new('String', ["N", "S", "E", "W", "NE", "SW", "SE", "NW", ""])
453
+ return false unless street_predirection_validator.valid?(@street_predirection)
454
+ return false if @street_name.nil?
455
+ return false if @street_suffix.nil?
456
+ return false if @street_postdirection.nil?
457
+ street_postdirection_validator = EnumAttributeValidator.new('String', ["N", "S", "E", "W", "NE", "SW", "SE", "NW", ""])
458
+ return false unless street_postdirection_validator.valid?(@street_postdirection)
459
+ return false if @secondary_designator.nil?
460
+ return false if @secondary_number.nil?
461
+ return false if @pmb_designator.nil?
462
+ return false if @pmb_number.nil?
463
+ return false if @extra_secondary_designator.nil?
464
+ return false if @extra_secondary_number.nil?
465
+ return false if @city.nil?
466
+ return false if @city.to_s.length > 200
467
+ return false if @state.nil?
468
+ return false if @state.to_s.length > 2
469
+ return false if @zip_code.nil?
470
+ return false if @zip_code !~ Regexp.new(/(^$)|(^\d{5}$)/)
471
+ return false if @zip_code_plus_4.nil?
472
+ return false if @zip_code_plus_4 !~ Regexp.new(/^(\d{4})?$/)
473
+ return false if @zip_code_type.nil?
474
+ return false if @delivery_point_barcode.nil?
475
+ return false if @address_type.nil?
476
+ address_type_validator = EnumAttributeValidator.new('String', ["residential", "commercial", ""])
477
+ return false unless address_type_validator.valid?(@address_type)
478
+ return false if @record_type.nil?
479
+ record_type_validator = EnumAttributeValidator.new('String', ["street", "highrise", "firm", "po_box", "rural_route", "general_delivery", ""])
480
+ return false unless record_type_validator.valid?(@record_type)
481
+ return false if @default_building_address.nil?
482
+ return false if @county.nil?
483
+ return false if @county_fips.nil?
484
+ return false if @carrier_route.nil?
485
+ return false if @carrier_route_type.nil?
486
+ carrier_route_type_validator = EnumAttributeValidator.new('String', ["city_delivery", "rural_route", "highway_contract", "po_box", "general_delivery", ""])
487
+ return false unless carrier_route_type_validator.valid?(@carrier_route_type)
488
+ return false if @po_box_only_flag.nil?
489
+ po_box_only_flag_validator = EnumAttributeValidator.new('String', ["Y", "N", ""])
490
+ return false unless po_box_only_flag_validator.valid?(@po_box_only_flag)
491
+ true
492
+ end
493
+
494
+ # Custom attribute writer method checking allowed values (enum).
495
+ # @param [Object] street_predirection Object to be assigned
496
+ def street_predirection=(street_predirection)
497
+ validator = EnumAttributeValidator.new('String', ["N", "S", "E", "W", "NE", "SW", "SE", "NW", ""])
498
+ unless validator.valid?(street_predirection)
499
+ fail ArgumentError, "invalid value for \"street_predirection\", must be one of #{validator.allowable_values}."
500
+ end
501
+ @street_predirection = street_predirection
502
+ end
503
+
504
+ # Custom attribute writer method checking allowed values (enum).
505
+ # @param [Object] street_postdirection Object to be assigned
506
+ def street_postdirection=(street_postdirection)
507
+ validator = EnumAttributeValidator.new('String', ["N", "S", "E", "W", "NE", "SW", "SE", "NW", ""])
508
+ unless validator.valid?(street_postdirection)
509
+ fail ArgumentError, "invalid value for \"street_postdirection\", must be one of #{validator.allowable_values}."
510
+ end
511
+ @street_postdirection = street_postdirection
512
+ end
513
+
514
+ # Custom attribute writer method with validation
515
+ # @param [Object] city Value to be assigned
516
+ def city=(city)
517
+ if city.nil?
518
+ fail ArgumentError, 'city cannot be nil'
519
+ end
520
+
521
+ if city.to_s.length > 200
522
+ fail ArgumentError, 'invalid value for "city", the character length must be smaller than or equal to 200.'
523
+ end
524
+
525
+ @city = city
526
+ end
527
+
528
+ # Custom attribute writer method with validation
529
+ # @param [Object] state Value to be assigned
530
+ def state=(state)
531
+ if state.nil?
532
+ fail ArgumentError, 'state cannot be nil'
533
+ end
534
+
535
+ if state.to_s.length > 2
536
+ fail ArgumentError, 'invalid value for "state", the character length must be smaller than or equal to 2.'
537
+ end
538
+
539
+ @state = state
540
+ end
541
+
542
+ # Custom attribute writer method with validation
543
+ # @param [Object] zip_code Value to be assigned
544
+ def zip_code=(zip_code)
545
+ if zip_code.nil?
546
+ fail ArgumentError, 'zip_code cannot be nil'
547
+ end
548
+
549
+ pattern = Regexp.new(/(^$)|(^\d{5}$)/)
550
+ if zip_code !~ pattern
551
+ fail ArgumentError, "invalid value for \"zip_code\", must conform to the pattern #{pattern}."
552
+ end
553
+
554
+ @zip_code = zip_code
555
+ end
556
+
557
+ # Custom attribute writer method with validation
558
+ # @param [Object] zip_code_plus_4 Value to be assigned
559
+ def zip_code_plus_4=(zip_code_plus_4)
560
+ if zip_code_plus_4.nil?
561
+ fail ArgumentError, 'zip_code_plus_4 cannot be nil'
562
+ end
563
+
564
+ pattern = Regexp.new(/^(\d{4})?$/)
565
+ if zip_code_plus_4 !~ pattern
566
+ fail ArgumentError, "invalid value for \"zip_code_plus_4\", must conform to the pattern #{pattern}."
567
+ end
568
+
569
+ @zip_code_plus_4 = zip_code_plus_4
570
+ end
571
+
572
+ # Custom attribute writer method checking allowed values (enum).
573
+ # @param [Object] address_type Object to be assigned
574
+ def address_type=(address_type)
575
+ validator = EnumAttributeValidator.new('String', ["residential", "commercial", ""])
576
+ unless validator.valid?(address_type)
577
+ fail ArgumentError, "invalid value for \"address_type\", must be one of #{validator.allowable_values}."
578
+ end
579
+ @address_type = address_type
580
+ end
581
+
582
+ # Custom attribute writer method checking allowed values (enum).
583
+ # @param [Object] record_type Object to be assigned
584
+ def record_type=(record_type)
585
+ validator = EnumAttributeValidator.new('String', ["street", "highrise", "firm", "po_box", "rural_route", "general_delivery", ""])
586
+ unless validator.valid?(record_type)
587
+ fail ArgumentError, "invalid value for \"record_type\", must be one of #{validator.allowable_values}."
588
+ end
589
+ @record_type = record_type
590
+ end
591
+
592
+ # Custom attribute writer method checking allowed values (enum).
593
+ # @param [Object] carrier_route_type Object to be assigned
594
+ def carrier_route_type=(carrier_route_type)
595
+ validator = EnumAttributeValidator.new('String', ["city_delivery", "rural_route", "highway_contract", "po_box", "general_delivery", ""])
596
+ unless validator.valid?(carrier_route_type)
597
+ fail ArgumentError, "invalid value for \"carrier_route_type\", must be one of #{validator.allowable_values}."
598
+ end
599
+ @carrier_route_type = carrier_route_type
600
+ end
601
+
602
+ # Custom attribute writer method checking allowed values (enum).
603
+ # @param [Object] po_box_only_flag Object to be assigned
604
+ def po_box_only_flag=(po_box_only_flag)
605
+ validator = EnumAttributeValidator.new('String', ["Y", "N", ""])
606
+ unless validator.valid?(po_box_only_flag)
607
+ fail ArgumentError, "invalid value for \"po_box_only_flag\", must be one of #{validator.allowable_values}."
608
+ end
609
+ @po_box_only_flag = po_box_only_flag
610
+ end
611
+
612
+ # Checks equality by comparing each attribute.
613
+ # @param [Object] Object to be compared
614
+ def ==(o)
615
+ return true if self.equal?(o)
616
+ self.class == o.class &&
617
+ primary_number == o.primary_number &&
618
+ street_predirection == o.street_predirection &&
619
+ street_name == o.street_name &&
620
+ street_suffix == o.street_suffix &&
621
+ street_postdirection == o.street_postdirection &&
622
+ secondary_designator == o.secondary_designator &&
623
+ secondary_number == o.secondary_number &&
624
+ pmb_designator == o.pmb_designator &&
625
+ pmb_number == o.pmb_number &&
626
+ extra_secondary_designator == o.extra_secondary_designator &&
627
+ extra_secondary_number == o.extra_secondary_number &&
628
+ city == o.city &&
629
+ state == o.state &&
630
+ zip_code == o.zip_code &&
631
+ zip_code_plus_4 == o.zip_code_plus_4 &&
632
+ zip_code_type == o.zip_code_type &&
633
+ delivery_point_barcode == o.delivery_point_barcode &&
634
+ address_type == o.address_type &&
635
+ record_type == o.record_type &&
636
+ default_building_address == o.default_building_address &&
637
+ county == o.county &&
638
+ county_fips == o.county_fips &&
639
+ carrier_route == o.carrier_route &&
640
+ carrier_route_type == o.carrier_route_type &&
641
+ po_box_only_flag == o.po_box_only_flag &&
642
+ latitude == o.latitude &&
643
+ longitude == o.longitude
644
+ end
645
+
646
+ # @see the `==` method
647
+ # @param [Object] Object to be compared
648
+ def eql?(o)
649
+ self == o
650
+ end
651
+
652
+ # Calculates hash code according to all attributes.
653
+ # @return [Integer] Hash code
654
+ def hash
655
+ [primary_number, street_predirection, street_name, street_suffix, street_postdirection, secondary_designator, secondary_number, pmb_designator, pmb_number, extra_secondary_designator, extra_secondary_number, city, state, zip_code, zip_code_plus_4, zip_code_type, delivery_point_barcode, address_type, record_type, default_building_address, county, county_fips, carrier_route, carrier_route_type, po_box_only_flag, latitude, longitude].hash
656
+ end
657
+
658
+
659
+ # Builds the object from hash
660
+ # @param [Hash] attributes Model attributes in the form of hash
661
+ # @return [Object] Returns the model itself
662
+ def self.build_from_hash(attributes)
663
+ new.build_from_hash(attributes)
664
+ end
665
+
666
+ # Builds the object from hash
667
+ # @param [Hash] attributes Model attributes in the form of hash
668
+ # @return [Object] Returns the model itself
669
+ def build_from_hash(attributes)
670
+ return nil unless attributes.is_a?(Hash)
671
+ attributes = attributes.transform_keys(&:to_sym)
672
+ self.class.openapi_types.each_pair do |key, type|
673
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
674
+ self.send("#{key}=", nil) # // guardrails-disable-line
675
+ elsif type =~ /\AArray<(.*)>/i
676
+ # check to ensure the input is an array given that the attribute
677
+ # is documented as an array but the input is not
678
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
679
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) # // guardrails-disable-line
680
+ end
681
+ elsif !attributes[self.class.attribute_map[key]].nil? && type.kind_of?(Array)
682
+ for base_type in type do
683
+ res = _deserialize(base_type, attributes[self.class.attribute_map[key]])
684
+ if !res.nil?
685
+ self.send("#{key}=", res) # // guardrails-disable-line
686
+ break
687
+ end
688
+ end
689
+ elsif !attributes[self.class.attribute_map[key]].nil?
690
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) # // guardrails-disable-line
691
+ end
692
+ end
693
+
694
+ self
695
+ end
696
+
697
+ # Deserializes the data based on type
698
+ # @param string type Data type
699
+ # @param string value Value to be deserialized
700
+ # @return [Object] Deserialized data
701
+ def _deserialize(type, value)
702
+ case type.to_sym
703
+ when :Time
704
+ Time.parse(value)
705
+ when :Date
706
+ Date.parse(value)
707
+ when :String
708
+ value.to_s
709
+ when :Integer
710
+ value.to_i
711
+ when :Float
712
+ value.to_f
713
+ when :Boolean
714
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
715
+ true
716
+ else
717
+ false
718
+ end
719
+ when :Object
720
+ # generic object (usually a Hash), return directly
721
+ value
722
+ when /\AArray<(?<inner_type>.+)>\z/
723
+ inner_type = Regexp.last_match[:inner_type]
724
+ value.map { |v| _deserialize(inner_type, v) }
725
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
726
+ k_type = Regexp.last_match[:k_type]
727
+ v_type = Regexp.last_match[:v_type]
728
+ {}.tap do |hash|
729
+ value.each do |k, v|
730
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
731
+ end
732
+ end
733
+ else # model
734
+ # models (e.g. Pet) or oneOf
735
+ klass = Lob.const_get(type)
736
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
737
+ end
738
+ end
739
+
740
+ # Returns the string representation of the object
741
+ # @return [String] String presentation of the object
742
+ def to_s
743
+ to_hash.to_s
744
+ end
745
+
746
+ # to_body is an alias to to_hash (backward compatibility)
747
+ # @return [Hash] Returns the object in the form of hash
748
+ def to_body
749
+ to_hash
750
+ end
751
+
752
+ # Returns the object in the form of hash
753
+ # @return [Hash] Returns the object in the form of hash
754
+ def to_hash
755
+ hash = {}
756
+ self.class.attribute_map.each_pair do |attr, param|
757
+ value = self.send(attr) # // guardrails-disable-line
758
+ if value.nil?
759
+ is_nullable = self.class.openapi_nullable.include?(attr)
760
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
761
+ end
762
+
763
+ hash[param] = _to_hash(value)
764
+ end
765
+ hash
766
+ end
767
+
768
+ # Outputs non-array value in the form of hash
769
+ # For object, use to_hash. Otherwise, just return the value
770
+ # @param [Object] value Any valid value
771
+ # @return [Hash] Returns the value in the form of hash
772
+ def _to_hash(value)
773
+ if value.is_a?(Array)
774
+ value.compact.map { |v| _to_hash(v) }
775
+ elsif value.is_a?(Hash)
776
+ {}.tap do |hash|
777
+ value.each { |k, v| hash[k] = _to_hash(v) }
778
+ end
779
+ elsif value.respond_to? :to_hash
780
+ value.to_hash
781
+ else
782
+ value
783
+ end
784
+ end
785
+
786
+ end
787
+
788
+ end