lob 5.4.6 → 6.0.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (496) hide show
  1. checksums.yaml +4 -4
  2. data/CODE_SNIPPETS.md +1871 -0
  3. data/Gemfile +6 -1
  4. data/Gemfile.lock +72 -0
  5. data/LICENSE +21 -0
  6. data/MIGRATION.md +174 -0
  7. data/README.md +70 -97
  8. data/Rakefile +7 -5
  9. data/__tests__/Api/Address.unit.rb +210 -0
  10. data/__tests__/Api/BankAccount.unit.rb +244 -0
  11. data/__tests__/Api/BillingGroup.unit.rb +170 -0
  12. data/__tests__/Api/Card.unit.rb +183 -0
  13. data/__tests__/Api/CardOrder.unit.rb +89 -0
  14. data/__tests__/Api/Check.unit.rb +185 -0
  15. data/__tests__/Api/IntlAutocompletion.unit.rb +43 -0
  16. data/__tests__/Api/IntlVerification.unit.rb +71 -0
  17. data/__tests__/Api/Letter.unit.rb +191 -0
  18. data/__tests__/Api/Postcard.unit.rb +189 -0
  19. data/__tests__/Api/Require.unit.rb +21 -0
  20. data/__tests__/Api/ReverseGeocodeLookup.unit.rb +43 -0
  21. data/__tests__/Api/SelfMailer.unit.rb +190 -0
  22. data/__tests__/Api/Template.unit.rb +165 -0
  23. data/__tests__/Api/TemplateVersion.unit.rb +165 -0
  24. data/__tests__/Api/UsAutocompletion.unit.rb +42 -0
  25. data/__tests__/Api/UsVerification.unit.rb +71 -0
  26. data/__tests__/Api/ZipLookup.unit.rb +42 -0
  27. data/__tests__/Integration/Address.spec.rb +200 -0
  28. data/__tests__/Integration/BankAccount.spec.rb +243 -0
  29. data/__tests__/Integration/BillingGroup.spec.rb +163 -0
  30. data/__tests__/Integration/Card.spec.rb +198 -0
  31. data/__tests__/Integration/CardOrder.spec.rb +122 -0
  32. data/__tests__/Integration/Check.spec.rb +361 -0
  33. data/__tests__/Integration/IntlAutocompletion.spec.rb +54 -0
  34. data/__tests__/Integration/IntlVerification.spec.rb +90 -0
  35. data/__tests__/Integration/Letter.spec.rb +286 -0
  36. data/__tests__/Integration/Postcard.spec.rb +214 -0
  37. data/__tests__/Integration/ReverseGeocodeLookup.spec.rb +30 -0
  38. data/__tests__/Integration/SelfMailer.spec.rb +270 -0
  39. data/__tests__/Integration/Template.spec.rb +221 -0
  40. data/__tests__/Integration/TemplateVersion.spec.rb +275 -0
  41. data/__tests__/Integration/UsAutocompletion.spec.rb +54 -0
  42. data/__tests__/Integration/UsVerification.spec.rb +102 -0
  43. data/__tests__/Integration/ZipLookup.spec.rb +29 -0
  44. data/__tests__/TestFixtures.rb +36 -0
  45. data/docs/Address.md +52 -0
  46. data/docs/AddressDeletion.md +22 -0
  47. data/docs/AddressDomestic.md +40 -0
  48. data/docs/AddressDomesticExpanded.md +40 -0
  49. data/docs/AddressEditable.md +40 -0
  50. data/docs/AddressList.md +28 -0
  51. data/docs/AddressesApi.md +303 -0
  52. data/docs/BankAccount.md +44 -0
  53. data/docs/BankAccountDeletion.md +22 -0
  54. data/docs/BankAccountList.md +28 -0
  55. data/docs/BankAccountVerify.md +18 -0
  56. data/docs/BankAccountWritable.md +28 -0
  57. data/docs/BankAccountsApi.md +376 -0
  58. data/docs/BankTypeEnum.md +15 -0
  59. data/docs/BillingGroup.md +28 -0
  60. data/docs/BillingGroupEditable.md +20 -0
  61. data/docs/BillingGroupList.md +26 -0
  62. data/docs/BillingGroupsApi.md +305 -0
  63. data/docs/Buckslip.md +60 -0
  64. data/docs/BuckslipDeletion.md +20 -0
  65. data/docs/BuckslipEditable.md +24 -0
  66. data/docs/BuckslipOrder.md +42 -0
  67. data/docs/BuckslipOrderEditable.md +18 -0
  68. data/docs/BuckslipOrdersApi.md +157 -0
  69. data/docs/BuckslipOrdersList.md +26 -0
  70. data/docs/BuckslipUpdatable.md +22 -0
  71. data/docs/BuckslipsApi.md +372 -0
  72. data/docs/BuckslipsList.md +28 -0
  73. data/docs/BulkError.md +18 -0
  74. data/docs/BulkErrorProperties.md +20 -0
  75. data/docs/Campaign.md +52 -0
  76. data/docs/CampaignCreative.md +42 -0
  77. data/docs/CampaignDeletion.md +20 -0
  78. data/docs/CampaignUpdatable.md +36 -0
  79. data/docs/CampaignWritable.md +36 -0
  80. data/docs/CampaignsApi.md +376 -0
  81. data/docs/CampaignsList.md +28 -0
  82. data/docs/Card.md +54 -0
  83. data/docs/CardDeletion.md +22 -0
  84. data/docs/CardEditable.md +24 -0
  85. data/docs/CardList.md +28 -0
  86. data/docs/CardOrder.md +42 -0
  87. data/docs/CardOrderEditable.md +18 -0
  88. data/docs/CardOrderList.md +26 -0
  89. data/docs/CardOrdersApi.md +157 -0
  90. data/docs/CardUpdatable.md +22 -0
  91. data/docs/CardsApi.md +372 -0
  92. data/docs/Check.md +68 -0
  93. data/docs/CheckDeletion.md +22 -0
  94. data/docs/CheckEditable.md +48 -0
  95. data/docs/CheckList.md +28 -0
  96. data/docs/ChecksApi.md +315 -0
  97. data/docs/CmpScheduleType.md +15 -0
  98. data/docs/CmpUseType.md +15 -0
  99. data/docs/CountryExtended.md +15 -0
  100. data/docs/CountryExtendedExpanded.md +15 -0
  101. data/docs/CreativePatch.md +22 -0
  102. data/docs/CreativeResponse.md +42 -0
  103. data/docs/CreativeWritable.md +34 -0
  104. data/docs/CreativesApi.md +226 -0
  105. data/docs/CustomEnvelopeReturned.md +22 -0
  106. data/docs/DefaultApi.md +75 -0
  107. data/docs/DeliverabilityAnalysis.md +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 +105 -13
  417. metadata +450 -214
  418. data/.github/workflows/forked_tests_job.yml +0 -36
  419. data/.github/workflows/run_tests_job.yml +0 -32
  420. data/.github/workflows/update_gem.yml +0 -27
  421. data/.gitignore +0 -19
  422. data/CHANGELOG.md +0 -148
  423. data/CONTRIBUTING.md +0 -19
  424. data/LICENSE.txt +0 -22
  425. data/examples/README.md +0 -119
  426. data/examples/cards.rb +0 -51
  427. data/examples/checks.rb +0 -49
  428. data/examples/csv_checks/create_checks.rb +0 -48
  429. data/examples/csv_checks/input.csv +0 -6
  430. data/examples/csv_letters/create_letters.rb +0 -41
  431. data/examples/csv_letters/input.csv +0 -6
  432. data/examples/csv_letters/letter_template.html +0 -33
  433. data/examples/csv_postcards/create_postcards.rb +0 -46
  434. data/examples/csv_postcards/input.csv +0 -7
  435. data/examples/csv_postcards/postcard_back.html +0 -38
  436. data/examples/csv_postcards/postcard_front.html +0 -25
  437. data/examples/csv_verify/input.csv +0 -7
  438. data/examples/csv_verify/verify.rb +0 -37
  439. data/examples/letters.rb +0 -73
  440. data/examples/list_postcards_metadata.rb +0 -94
  441. data/examples/postcards.rb +0 -87
  442. data/examples/postcards_idempotent.rb +0 -92
  443. data/examples/postcards_intl.rb +0 -87
  444. data/examples/postcards_remote.rb +0 -87
  445. data/examples/postcards_send_date.rb +0 -97
  446. data/examples/postcards_template.rb +0 -98
  447. data/examples/self_mailers.rb +0 -38
  448. data/lib/lob/client.rb +0 -96
  449. data/lib/lob/errors/invalid_request_error.rb +0 -4
  450. data/lib/lob/errors/lob_error.rb +0 -20
  451. data/lib/lob/resources/address.rb +0 -14
  452. data/lib/lob/resources/bank_account.rb +0 -30
  453. data/lib/lob/resources/bulk_intl_verifications.rb +0 -27
  454. data/lib/lob/resources/bulk_us_verifications.rb +0 -28
  455. data/lib/lob/resources/card.rb +0 -46
  456. data/lib/lob/resources/check.rb +0 -14
  457. data/lib/lob/resources/group.rb +0 -14
  458. data/lib/lob/resources/groups_member.rb +0 -66
  459. data/lib/lob/resources/intl_verifications.rb +0 -26
  460. data/lib/lob/resources/letter.rb +0 -14
  461. data/lib/lob/resources/postcard.rb +0 -14
  462. data/lib/lob/resources/resource_base.rb +0 -150
  463. data/lib/lob/resources/self_mailer.rb +0 -14
  464. data/lib/lob/resources/us_autocompletions.rb +0 -26
  465. data/lib/lob/resources/us_reverse_geocode_lookups.rb +0 -26
  466. data/lib/lob/resources/us_verifications.rb +0 -27
  467. data/lib/lob/resources/us_zip_lookups.rb +0 -26
  468. data/lib/lob/version.rb +0 -3
  469. data/lob.gemspec +0 -31
  470. data/spec/lob/errors/lob_error_spec.rb +0 -19
  471. data/spec/lob/resources/address_spec.rb +0 -55
  472. data/spec/lob/resources/bank_account_spec.rb +0 -60
  473. data/spec/lob/resources/bulk_intl_verifications_spec.rb +0 -39
  474. data/spec/lob/resources/bulk_us_verifications_spec.rb +0 -51
  475. data/spec/lob/resources/card_spec.rb +0 -145
  476. data/spec/lob/resources/check_spec.rb +0 -119
  477. data/spec/lob/resources/group_spec.rb +0 -50
  478. data/spec/lob/resources/intl_verifications_spec.rb +0 -25
  479. data/spec/lob/resources/letter_spec.rb +0 -114
  480. data/spec/lob/resources/member_spec.rb +0 -65
  481. data/spec/lob/resources/postcard_spec.rb +0 -160
  482. data/spec/lob/resources/resource_base_spec.rb +0 -75
  483. data/spec/lob/resources/self_mailer_spec.rb +0 -177
  484. data/spec/lob/resources/us_autocompletions_spec.rb +0 -24
  485. data/spec/lob/resources/us_reverse_geocode_lookups_spec.rb +0 -22
  486. data/spec/lob/resources/us_verifications_spec.rb +0 -31
  487. data/spec/lob/resources/us_zip_lookups_spec.rb +0 -23
  488. data/spec/lob_spec.rb +0 -48
  489. data/spec/samples/8.5x11.pdf +0 -0
  490. data/spec/samples/card.pdf +1 -743
  491. data/spec/samples/postcardback.pdf +2 -2287
  492. data/spec/samples/postcardfront.pdf +1 -1549
  493. data/spec/samples/sfm-12x9-inside.pdf +0 -0
  494. data/spec/samples/sfm-12x9-outside.pdf +0 -0
  495. data/spec/samples/sfm-6x18-inside.pdf +0 -0
  496. data/spec/samples/sfm-6x18-outside.pdf +0 -0
@@ -0,0 +1,601 @@
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 the deliverability of an address.
18
+ class DeliverabilityAnalysis
19
+ # Result of Delivery Point Validation (DPV), which determines whether or not the address is deliverable by the USPS. Possible values are: * `Y` –– The address is deliverable by the USPS. * `S` –– The address is deliverable by removing the provided secondary unit designator. This information may be incorrect or unnecessary. * `D` –– The address is deliverable to the building's default address but is missing a secondary unit designator and/or number. There is a chance the mail will not reach the intended recipient. * `N` –– The address is not deliverable according to the USPS, but parts of the address are valid (such as the street and ZIP code). * `''` –– This address is not deliverable. No matching street could be found within the city or ZIP code.
20
+ attr_accessor :dpv_confirmation
21
+
22
+ # indicates whether or not the address is [CMRA-authorized](https://en.wikipedia.org/wiki/Commercial_mail_receiving_agency). Possible values are: * `Y` –– Address is CMRA-authorized. * `N` –– Address is not CMRA-authorized. * `''` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string).
23
+ attr_accessor :dpv_cmra
24
+
25
+ # indicates that an address was once deliverable, but has become vacant and is no longer receiving deliveries. Possible values are: * `Y` –– Address is vacant. * `N` –– Address is not vacant. * `''` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string).
26
+ attr_accessor :dpv_vacant
27
+
28
+ # Corresponds to the USPS field `dpv_no_stat`. Indicates that an address has been vacated in the recent past, and is no longer receiving deliveries. If it's been unoccupied for 90+ days, or temporarily vacant, this will be flagged. Possible values are: * `Y` –– Address is active. * `N` –– Address is not active. * `''` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string).
29
+ attr_accessor :dpv_active
30
+
31
+ # Indicates the reason why an address is vacant or no longer receiving deliveries. Possible values are: * `01` –– Address does not receive mail from the USPS directly, but is serviced by a drop address. * `02` –– Address not yet deliverable. * `03` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string). * `04` –– Address is a College, Military Zone, or other type. * `05` –– Address no longer receives deliveries. * `06` –– Address is missing required secondary information. * `''` –– A DPV match is not made or the address is active.
32
+ attr_accessor :dpv_inactive_reason
33
+
34
+ # Indicates a street address for which mail is delivered to a PO Box. Possible values are: * `Y` –– Address is a PO Box throwback delivery point. * `N` –– Address is not a PO Box throwback delivery point. * `''` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string).
35
+ attr_accessor :dpv_throwback
36
+
37
+ # Indicates whether deliveries are not performed on one or more days of the week at an address. Possible values are: * `Y` –– Mail delivery does not occur on some days of the week. * `N` –– Mail delivery occurs every day of the week. * `''` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string).
38
+ attr_accessor :dpv_non_delivery_day_flag
39
+
40
+ # Indicates days of the week (starting on Sunday) deliveries are not performed at an address. For example: * `YNNNNNN` –– Mail delivery does not occur on Sunday's. * `NYNNNYN` –– Mail delivery does not occur on Monday's or Friday's. * `''` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string) or address receives mail every day of the week (`deliverability_analysis[dpv_non_delivery_day_flag]` is `N` or an empty string).
41
+ attr_accessor :dpv_non_delivery_day_values
42
+
43
+ # Indicates packages to this address will not be left due to security concerns. Possible values are: * `Y` –– Address does not have a secure mailbox. * `N` –– Address has a secure mailbox. * `''` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string).
44
+ attr_accessor :dpv_no_secure_location
45
+
46
+ # Indicates the door of the address is not accessible for mail delivery. Possible values are: * `Y` –– Door is not accessible. * `N` –– Door is accessible. * `''` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string).
47
+ attr_accessor :dpv_door_not_accessible
48
+
49
+ # An array of 2-character strings that gives more insight into how `deliverability_analysis[dpv_confirmation]` was determined. Will always include at least 1 string, and can include up to 3. For details, see [US Verification Details](#tag/US-Verification-Types).
50
+ attr_accessor :dpv_footnotes
51
+
52
+ # indicates whether or not an address has been flagged in the [Early Warning System](https://docs.informatica.com/data-engineering/data-engineering-quality/10-4-0/address-validator-port-reference/postal-carrier-certification-data-ports/early-warning-system-return-code.html), meaning the address is under development and not yet ready to receive mail. However, it should become available in a few months.
53
+ attr_accessor :ews_match
54
+
55
+ # indicates whether this address has been converted by [LACS<sup>Link</sup>](https://postalpro.usps.com/address-quality/lacslink). LACS<sup>Link</sup> corrects outdated addresses into their modern counterparts. Possible values are: * `Y` –– New address produced with a matching record in LACS<sup>Link</sup>. * `N` –– New address could not be produced with a matching record in LACS<sup>Link</sup>. * `''` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string).
56
+ attr_accessor :lacs_indicator
57
+
58
+ # A code indicating how `deliverability_analysis[lacs_indicator]` was determined. Possible values are: * `A` — A new address was produced because a match was found in LACS<sup>Link</sup>. * `92` — A LACS<sup>Link</sup> record was matched after dropping secondary information. * `14` — A match was found in LACS<sup>Link</sup>, but could not be converted to a deliverable address. * `00` — A match was not found in LACS<sup>Link</sup>, and no new address was produced. * `''` — LACS<sup>Link</sup> was not attempted.
59
+ attr_accessor :lacs_return_code
60
+
61
+ # A return code that indicates whether the address was matched and corrected by [Suite<sup>Link</sup>](https://postalpro.usps.com/address-quality-solutions/suitelink). Suite<sup>Link</sup> attempts to provide secondary information to business addresses. Possible values are: * `A` –– A Suite<sup>Link</sup> match was found and secondary information was added. * `00` –– A Suite<sup>Link</sup> match could not be found and no secondary information was added. * `''` –– Suite<sup>Link</sup> lookup was not attempted.
62
+ attr_accessor :suite_return_code
63
+
64
+ class EnumAttributeValidator
65
+ attr_reader :datatype
66
+ attr_reader :allowable_values
67
+
68
+ def initialize(datatype, allowable_values)
69
+ @allowable_values = allowable_values.map do |value|
70
+ case datatype.to_s
71
+ when /Integer/i
72
+ value.to_i
73
+ when /Float/i
74
+ value.to_f
75
+ else
76
+ value
77
+ end
78
+ end
79
+ end
80
+
81
+ def valid?(value)
82
+ !value || allowable_values.include?(value)
83
+ end
84
+ end
85
+
86
+ # Attribute mapping from ruby-style variable name to JSON key.
87
+ def self.attribute_map
88
+ {
89
+ :'dpv_confirmation' => :'dpv_confirmation',
90
+ :'dpv_cmra' => :'dpv_cmra',
91
+ :'dpv_vacant' => :'dpv_vacant',
92
+ :'dpv_active' => :'dpv_active',
93
+ :'dpv_inactive_reason' => :'dpv_inactive_reason',
94
+ :'dpv_throwback' => :'dpv_throwback',
95
+ :'dpv_non_delivery_day_flag' => :'dpv_non_delivery_day_flag',
96
+ :'dpv_non_delivery_day_values' => :'dpv_non_delivery_day_values',
97
+ :'dpv_no_secure_location' => :'dpv_no_secure_location',
98
+ :'dpv_door_not_accessible' => :'dpv_door_not_accessible',
99
+ :'dpv_footnotes' => :'dpv_footnotes',
100
+ :'ews_match' => :'ews_match',
101
+ :'lacs_indicator' => :'lacs_indicator',
102
+ :'lacs_return_code' => :'lacs_return_code',
103
+ :'suite_return_code' => :'suite_return_code'
104
+ }
105
+ end
106
+
107
+ # Returns all the JSON keys this model knows about
108
+ def self.acceptable_attributes
109
+ attribute_map.values
110
+ end
111
+
112
+ # Attribute type mapping.
113
+ def self.openapi_types
114
+ {
115
+ :'dpv_confirmation' => :'String',
116
+ :'dpv_cmra' => :'String',
117
+ :'dpv_vacant' => :'String',
118
+ :'dpv_active' => :'String',
119
+ :'dpv_inactive_reason' => :'String',
120
+ :'dpv_throwback' => :'String',
121
+ :'dpv_non_delivery_day_flag' => :'String',
122
+ :'dpv_non_delivery_day_values' => :'String',
123
+ :'dpv_no_secure_location' => :'String',
124
+ :'dpv_door_not_accessible' => :'String',
125
+ :'dpv_footnotes' => :'Array<DpvFootnote>',
126
+ :'ews_match' => :'Boolean',
127
+ :'lacs_indicator' => :'String',
128
+ :'lacs_return_code' => :'String',
129
+ :'suite_return_code' => :'String'
130
+ }
131
+ end
132
+
133
+ # List of attributes with nullable: true
134
+ def self.openapi_nullable
135
+ Set.new([
136
+ ])
137
+ end
138
+
139
+ # Initializes the object
140
+ # @param [Hash] attributes Model attributes in the form of hash
141
+ def initialize(attributes = {})
142
+ if (!attributes.is_a?(Hash))
143
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Lob::DeliverabilityAnalysis` initialize method"
144
+ end
145
+
146
+ # check to see if the attribute exists and convert string to symbol for hash key
147
+ attributes = attributes.each_with_object({}) { |(k, v), h|
148
+ if (!self.class.attribute_map.key?(k.to_sym))
149
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Lob::DeliverabilityAnalysis`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
150
+ end
151
+ h[k.to_sym] = v
152
+ }
153
+
154
+ if attributes.key?(:'dpv_confirmation')
155
+ self.dpv_confirmation = attributes[:'dpv_confirmation']
156
+ end
157
+
158
+ if attributes.key?(:'dpv_cmra')
159
+ self.dpv_cmra = attributes[:'dpv_cmra']
160
+ end
161
+
162
+ if attributes.key?(:'dpv_vacant')
163
+ self.dpv_vacant = attributes[:'dpv_vacant']
164
+ end
165
+
166
+ if attributes.key?(:'dpv_active')
167
+ self.dpv_active = attributes[:'dpv_active']
168
+ end
169
+
170
+ if attributes.key?(:'dpv_inactive_reason')
171
+ self.dpv_inactive_reason = attributes[:'dpv_inactive_reason']
172
+ end
173
+
174
+ if attributes.key?(:'dpv_throwback')
175
+ self.dpv_throwback = attributes[:'dpv_throwback']
176
+ end
177
+
178
+ if attributes.key?(:'dpv_non_delivery_day_flag')
179
+ self.dpv_non_delivery_day_flag = attributes[:'dpv_non_delivery_day_flag']
180
+ end
181
+
182
+ if attributes.key?(:'dpv_non_delivery_day_values')
183
+ self.dpv_non_delivery_day_values = attributes[:'dpv_non_delivery_day_values']
184
+ end
185
+
186
+ if attributes.key?(:'dpv_no_secure_location')
187
+ self.dpv_no_secure_location = attributes[:'dpv_no_secure_location']
188
+ end
189
+
190
+ if attributes.key?(:'dpv_door_not_accessible')
191
+ self.dpv_door_not_accessible = attributes[:'dpv_door_not_accessible']
192
+ end
193
+
194
+ if attributes.key?(:'dpv_footnotes')
195
+ if (value = attributes[:'dpv_footnotes']).is_a?(Array)
196
+ self.dpv_footnotes = value
197
+ end
198
+ end
199
+
200
+ if attributes.key?(:'ews_match')
201
+ self.ews_match = attributes[:'ews_match']
202
+ end
203
+
204
+ if attributes.key?(:'lacs_indicator')
205
+ self.lacs_indicator = attributes[:'lacs_indicator']
206
+ end
207
+
208
+ if attributes.key?(:'lacs_return_code')
209
+ self.lacs_return_code = attributes[:'lacs_return_code']
210
+ end
211
+
212
+ if attributes.key?(:'suite_return_code')
213
+ self.suite_return_code = attributes[:'suite_return_code']
214
+ end
215
+ end
216
+
217
+ # Show invalid properties with the reasons. Usually used together with valid?
218
+ # @return Array for valid properties with the reasons
219
+ def list_invalid_properties
220
+ invalid_properties = Array.new
221
+ if @dpv_confirmation.nil?
222
+ invalid_properties.push('invalid value for "dpv_confirmation", dpv_confirmation cannot be nil.')
223
+ end
224
+
225
+ if @dpv_cmra.nil?
226
+ invalid_properties.push('invalid value for "dpv_cmra", dpv_cmra cannot be nil.')
227
+ end
228
+
229
+ if @dpv_vacant.nil?
230
+ invalid_properties.push('invalid value for "dpv_vacant", dpv_vacant cannot be nil.')
231
+ end
232
+
233
+ if @dpv_active.nil?
234
+ invalid_properties.push('invalid value for "dpv_active", dpv_active cannot be nil.')
235
+ end
236
+
237
+ if @dpv_inactive_reason.nil?
238
+ invalid_properties.push('invalid value for "dpv_inactive_reason", dpv_inactive_reason cannot be nil.')
239
+ end
240
+
241
+ if @dpv_throwback.nil?
242
+ invalid_properties.push('invalid value for "dpv_throwback", dpv_throwback cannot be nil.')
243
+ end
244
+
245
+ if @dpv_non_delivery_day_flag.nil?
246
+ invalid_properties.push('invalid value for "dpv_non_delivery_day_flag", dpv_non_delivery_day_flag cannot be nil.')
247
+ end
248
+
249
+ if @dpv_non_delivery_day_values.nil?
250
+ invalid_properties.push('invalid value for "dpv_non_delivery_day_values", dpv_non_delivery_day_values cannot be nil.')
251
+ end
252
+
253
+ if @dpv_no_secure_location.nil?
254
+ invalid_properties.push('invalid value for "dpv_no_secure_location", dpv_no_secure_location cannot be nil.')
255
+ end
256
+
257
+ if @dpv_door_not_accessible.nil?
258
+ invalid_properties.push('invalid value for "dpv_door_not_accessible", dpv_door_not_accessible cannot be nil.')
259
+ end
260
+
261
+ if @dpv_footnotes.nil?
262
+ invalid_properties.push('invalid value for "dpv_footnotes", dpv_footnotes cannot be nil.')
263
+ end
264
+
265
+ if @ews_match.nil?
266
+ invalid_properties.push('invalid value for "ews_match", ews_match cannot be nil.')
267
+ end
268
+
269
+ if @lacs_indicator.nil?
270
+ invalid_properties.push('invalid value for "lacs_indicator", lacs_indicator cannot be nil.')
271
+ end
272
+
273
+ if @lacs_return_code.nil?
274
+ invalid_properties.push('invalid value for "lacs_return_code", lacs_return_code cannot be nil.')
275
+ end
276
+
277
+ if @suite_return_code.nil?
278
+ invalid_properties.push('invalid value for "suite_return_code", suite_return_code cannot be nil.')
279
+ end
280
+
281
+ invalid_properties
282
+ end
283
+
284
+ # Check to see if the all the properties in the model are valid
285
+ # @return true if the model is valid
286
+ def valid?
287
+ return false if @dpv_confirmation.nil?
288
+ dpv_confirmation_validator = EnumAttributeValidator.new('String', ["Y", "S", "D", "N", ""])
289
+ return false unless dpv_confirmation_validator.valid?(@dpv_confirmation)
290
+ return false if @dpv_cmra.nil?
291
+ dpv_cmra_validator = EnumAttributeValidator.new('String', ["Y", "N", ""])
292
+ return false unless dpv_cmra_validator.valid?(@dpv_cmra)
293
+ return false if @dpv_vacant.nil?
294
+ dpv_vacant_validator = EnumAttributeValidator.new('String', ["Y", "N", ""])
295
+ return false unless dpv_vacant_validator.valid?(@dpv_vacant)
296
+ return false if @dpv_active.nil?
297
+ dpv_active_validator = EnumAttributeValidator.new('String', ["Y", "N", ""])
298
+ return false unless dpv_active_validator.valid?(@dpv_active)
299
+ return false if @dpv_inactive_reason.nil?
300
+ dpv_inactive_reason_validator = EnumAttributeValidator.new('String', ["01", "02", "03", "04", "05", "06", ""])
301
+ return false unless dpv_inactive_reason_validator.valid?(@dpv_inactive_reason)
302
+ return false if @dpv_throwback.nil?
303
+ dpv_throwback_validator = EnumAttributeValidator.new('String', ["Y", "N", ""])
304
+ return false unless dpv_throwback_validator.valid?(@dpv_throwback)
305
+ return false if @dpv_non_delivery_day_flag.nil?
306
+ dpv_non_delivery_day_flag_validator = EnumAttributeValidator.new('String', ["Y", "N", ""])
307
+ return false unless dpv_non_delivery_day_flag_validator.valid?(@dpv_non_delivery_day_flag)
308
+ return false if @dpv_non_delivery_day_values.nil?
309
+ return false if @dpv_no_secure_location.nil?
310
+ dpv_no_secure_location_validator = EnumAttributeValidator.new('String', ["Y", "N", ""])
311
+ return false unless dpv_no_secure_location_validator.valid?(@dpv_no_secure_location)
312
+ return false if @dpv_door_not_accessible.nil?
313
+ dpv_door_not_accessible_validator = EnumAttributeValidator.new('String', ["Y", "N", ""])
314
+ return false unless dpv_door_not_accessible_validator.valid?(@dpv_door_not_accessible)
315
+ return false if @dpv_footnotes.nil?
316
+ return false if @ews_match.nil?
317
+ return false if @lacs_indicator.nil?
318
+ lacs_indicator_validator = EnumAttributeValidator.new('String', ["Y", "N", ""])
319
+ return false unless lacs_indicator_validator.valid?(@lacs_indicator)
320
+ return false if @lacs_return_code.nil?
321
+ return false if @suite_return_code.nil?
322
+ suite_return_code_validator = EnumAttributeValidator.new('String', ["A", "00", ""])
323
+ return false unless suite_return_code_validator.valid?(@suite_return_code)
324
+ true
325
+ end
326
+
327
+ # Custom attribute writer method checking allowed values (enum).
328
+ # @param [Object] dpv_confirmation Object to be assigned
329
+ def dpv_confirmation=(dpv_confirmation)
330
+ validator = EnumAttributeValidator.new('String', ["Y", "S", "D", "N", ""])
331
+ unless validator.valid?(dpv_confirmation)
332
+ fail ArgumentError, "invalid value for \"dpv_confirmation\", must be one of #{validator.allowable_values}."
333
+ end
334
+ @dpv_confirmation = dpv_confirmation
335
+ end
336
+
337
+ # Custom attribute writer method checking allowed values (enum).
338
+ # @param [Object] dpv_cmra Object to be assigned
339
+ def dpv_cmra=(dpv_cmra)
340
+ validator = EnumAttributeValidator.new('String', ["Y", "N", ""])
341
+ unless validator.valid?(dpv_cmra)
342
+ fail ArgumentError, "invalid value for \"dpv_cmra\", must be one of #{validator.allowable_values}."
343
+ end
344
+ @dpv_cmra = dpv_cmra
345
+ end
346
+
347
+ # Custom attribute writer method checking allowed values (enum).
348
+ # @param [Object] dpv_vacant Object to be assigned
349
+ def dpv_vacant=(dpv_vacant)
350
+ validator = EnumAttributeValidator.new('String', ["Y", "N", ""])
351
+ unless validator.valid?(dpv_vacant)
352
+ fail ArgumentError, "invalid value for \"dpv_vacant\", must be one of #{validator.allowable_values}."
353
+ end
354
+ @dpv_vacant = dpv_vacant
355
+ end
356
+
357
+ # Custom attribute writer method checking allowed values (enum).
358
+ # @param [Object] dpv_active Object to be assigned
359
+ def dpv_active=(dpv_active)
360
+ validator = EnumAttributeValidator.new('String', ["Y", "N", ""])
361
+ unless validator.valid?(dpv_active)
362
+ fail ArgumentError, "invalid value for \"dpv_active\", must be one of #{validator.allowable_values}."
363
+ end
364
+ @dpv_active = dpv_active
365
+ end
366
+
367
+ # Custom attribute writer method checking allowed values (enum).
368
+ # @param [Object] dpv_inactive_reason Object to be assigned
369
+ def dpv_inactive_reason=(dpv_inactive_reason)
370
+ validator = EnumAttributeValidator.new('String', ["01", "02", "03", "04", "05", "06", ""])
371
+ unless validator.valid?(dpv_inactive_reason)
372
+ fail ArgumentError, "invalid value for \"dpv_inactive_reason\", must be one of #{validator.allowable_values}."
373
+ end
374
+ @dpv_inactive_reason = dpv_inactive_reason
375
+ end
376
+
377
+ # Custom attribute writer method checking allowed values (enum).
378
+ # @param [Object] dpv_throwback Object to be assigned
379
+ def dpv_throwback=(dpv_throwback)
380
+ validator = EnumAttributeValidator.new('String', ["Y", "N", ""])
381
+ unless validator.valid?(dpv_throwback)
382
+ fail ArgumentError, "invalid value for \"dpv_throwback\", must be one of #{validator.allowable_values}."
383
+ end
384
+ @dpv_throwback = dpv_throwback
385
+ end
386
+
387
+ # Custom attribute writer method checking allowed values (enum).
388
+ # @param [Object] dpv_non_delivery_day_flag Object to be assigned
389
+ def dpv_non_delivery_day_flag=(dpv_non_delivery_day_flag)
390
+ validator = EnumAttributeValidator.new('String', ["Y", "N", ""])
391
+ unless validator.valid?(dpv_non_delivery_day_flag)
392
+ fail ArgumentError, "invalid value for \"dpv_non_delivery_day_flag\", must be one of #{validator.allowable_values}."
393
+ end
394
+ @dpv_non_delivery_day_flag = dpv_non_delivery_day_flag
395
+ end
396
+
397
+ # Custom attribute writer method checking allowed values (enum).
398
+ # @param [Object] dpv_no_secure_location Object to be assigned
399
+ def dpv_no_secure_location=(dpv_no_secure_location)
400
+ validator = EnumAttributeValidator.new('String', ["Y", "N", ""])
401
+ unless validator.valid?(dpv_no_secure_location)
402
+ fail ArgumentError, "invalid value for \"dpv_no_secure_location\", must be one of #{validator.allowable_values}."
403
+ end
404
+ @dpv_no_secure_location = dpv_no_secure_location
405
+ end
406
+
407
+ # Custom attribute writer method checking allowed values (enum).
408
+ # @param [Object] dpv_door_not_accessible Object to be assigned
409
+ def dpv_door_not_accessible=(dpv_door_not_accessible)
410
+ validator = EnumAttributeValidator.new('String', ["Y", "N", ""])
411
+ unless validator.valid?(dpv_door_not_accessible)
412
+ fail ArgumentError, "invalid value for \"dpv_door_not_accessible\", must be one of #{validator.allowable_values}."
413
+ end
414
+ @dpv_door_not_accessible = dpv_door_not_accessible
415
+ end
416
+
417
+ # Custom attribute writer method checking allowed values (enum).
418
+ # @param [Object] lacs_indicator Object to be assigned
419
+ def lacs_indicator=(lacs_indicator)
420
+ validator = EnumAttributeValidator.new('String', ["Y", "N", ""])
421
+ unless validator.valid?(lacs_indicator)
422
+ fail ArgumentError, "invalid value for \"lacs_indicator\", must be one of #{validator.allowable_values}."
423
+ end
424
+ @lacs_indicator = lacs_indicator
425
+ end
426
+
427
+ # Custom attribute writer method checking allowed values (enum).
428
+ # @param [Object] suite_return_code Object to be assigned
429
+ def suite_return_code=(suite_return_code)
430
+ validator = EnumAttributeValidator.new('String', ["A", "00", ""])
431
+ unless validator.valid?(suite_return_code)
432
+ fail ArgumentError, "invalid value for \"suite_return_code\", must be one of #{validator.allowable_values}."
433
+ end
434
+ @suite_return_code = suite_return_code
435
+ end
436
+
437
+ # Checks equality by comparing each attribute.
438
+ # @param [Object] Object to be compared
439
+ def ==(o)
440
+ return true if self.equal?(o)
441
+ self.class == o.class &&
442
+ dpv_confirmation == o.dpv_confirmation &&
443
+ dpv_cmra == o.dpv_cmra &&
444
+ dpv_vacant == o.dpv_vacant &&
445
+ dpv_active == o.dpv_active &&
446
+ dpv_inactive_reason == o.dpv_inactive_reason &&
447
+ dpv_throwback == o.dpv_throwback &&
448
+ dpv_non_delivery_day_flag == o.dpv_non_delivery_day_flag &&
449
+ dpv_non_delivery_day_values == o.dpv_non_delivery_day_values &&
450
+ dpv_no_secure_location == o.dpv_no_secure_location &&
451
+ dpv_door_not_accessible == o.dpv_door_not_accessible &&
452
+ dpv_footnotes == o.dpv_footnotes &&
453
+ ews_match == o.ews_match &&
454
+ lacs_indicator == o.lacs_indicator &&
455
+ lacs_return_code == o.lacs_return_code &&
456
+ suite_return_code == o.suite_return_code
457
+ end
458
+
459
+ # @see the `==` method
460
+ # @param [Object] Object to be compared
461
+ def eql?(o)
462
+ self == o
463
+ end
464
+
465
+ # Calculates hash code according to all attributes.
466
+ # @return [Integer] Hash code
467
+ def hash
468
+ [dpv_confirmation, dpv_cmra, dpv_vacant, dpv_active, dpv_inactive_reason, dpv_throwback, dpv_non_delivery_day_flag, dpv_non_delivery_day_values, dpv_no_secure_location, dpv_door_not_accessible, dpv_footnotes, ews_match, lacs_indicator, lacs_return_code, suite_return_code].hash
469
+ end
470
+
471
+
472
+ # Builds the object from hash
473
+ # @param [Hash] attributes Model attributes in the form of hash
474
+ # @return [Object] Returns the model itself
475
+ def self.build_from_hash(attributes)
476
+ new.build_from_hash(attributes)
477
+ end
478
+
479
+ # Builds the object from hash
480
+ # @param [Hash] attributes Model attributes in the form of hash
481
+ # @return [Object] Returns the model itself
482
+ def build_from_hash(attributes)
483
+ return nil unless attributes.is_a?(Hash)
484
+ attributes = attributes.transform_keys(&:to_sym)
485
+ self.class.openapi_types.each_pair do |key, type|
486
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
487
+ self.send("#{key}=", nil) # // guardrails-disable-line
488
+ elsif type =~ /\AArray<(.*)>/i
489
+ # check to ensure the input is an array given that the attribute
490
+ # is documented as an array but the input is not
491
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
492
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) # // guardrails-disable-line
493
+ end
494
+ elsif !attributes[self.class.attribute_map[key]].nil? && type.kind_of?(Array)
495
+ for base_type in type do
496
+ res = _deserialize(base_type, attributes[self.class.attribute_map[key]])
497
+ if !res.nil?
498
+ self.send("#{key}=", res) # // guardrails-disable-line
499
+ break
500
+ end
501
+ end
502
+ elsif !attributes[self.class.attribute_map[key]].nil?
503
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) # // guardrails-disable-line
504
+ end
505
+ end
506
+
507
+ self
508
+ end
509
+
510
+ # Deserializes the data based on type
511
+ # @param string type Data type
512
+ # @param string value Value to be deserialized
513
+ # @return [Object] Deserialized data
514
+ def _deserialize(type, value)
515
+ case type.to_sym
516
+ when :Time
517
+ Time.parse(value)
518
+ when :Date
519
+ Date.parse(value)
520
+ when :String
521
+ value.to_s
522
+ when :Integer
523
+ value.to_i
524
+ when :Float
525
+ value.to_f
526
+ when :Boolean
527
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
528
+ true
529
+ else
530
+ false
531
+ end
532
+ when :Object
533
+ # generic object (usually a Hash), return directly
534
+ value
535
+ when /\AArray<(?<inner_type>.+)>\z/
536
+ inner_type = Regexp.last_match[:inner_type]
537
+ value.map { |v| _deserialize(inner_type, v) }
538
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
539
+ k_type = Regexp.last_match[:k_type]
540
+ v_type = Regexp.last_match[:v_type]
541
+ {}.tap do |hash|
542
+ value.each do |k, v|
543
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
544
+ end
545
+ end
546
+ else # model
547
+ # models (e.g. Pet) or oneOf
548
+ klass = Lob.const_get(type)
549
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
550
+ end
551
+ end
552
+
553
+ # Returns the string representation of the object
554
+ # @return [String] String presentation of the object
555
+ def to_s
556
+ to_hash.to_s
557
+ end
558
+
559
+ # to_body is an alias to to_hash (backward compatibility)
560
+ # @return [Hash] Returns the object in the form of hash
561
+ def to_body
562
+ to_hash
563
+ end
564
+
565
+ # Returns the object in the form of hash
566
+ # @return [Hash] Returns the object in the form of hash
567
+ def to_hash
568
+ hash = {}
569
+ self.class.attribute_map.each_pair do |attr, param|
570
+ value = self.send(attr) # // guardrails-disable-line
571
+ if value.nil?
572
+ is_nullable = self.class.openapi_nullable.include?(attr)
573
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
574
+ end
575
+
576
+ hash[param] = _to_hash(value)
577
+ end
578
+ hash
579
+ end
580
+
581
+ # Outputs non-array value in the form of hash
582
+ # For object, use to_hash. Otherwise, just return the value
583
+ # @param [Object] value Any valid value
584
+ # @return [Hash] Returns the value in the form of hash
585
+ def _to_hash(value)
586
+ if value.is_a?(Array)
587
+ value.compact.map { |v| _to_hash(v) }
588
+ elsif value.is_a?(Hash)
589
+ {}.tap do |hash|
590
+ value.each { |k, v| hash[k] = _to_hash(v) }
591
+ end
592
+ elsif value.respond_to? :to_hash
593
+ value.to_hash
594
+ else
595
+ value
596
+ end
597
+ end
598
+
599
+ end
600
+
601
+ end
@@ -0,0 +1,54 @@
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 DpvFootnote
18
+ AA = "AA".freeze
19
+ A1 = "A1".freeze
20
+ BB = "BB".freeze
21
+ CC = "CC".freeze
22
+ C1 = "C1".freeze
23
+ F1 = "F1".freeze
24
+ G1 = "G1".freeze
25
+ IA = "IA".freeze
26
+ M1 = "M1".freeze
27
+ M3 = "M3".freeze
28
+ N1 = "N1".freeze
29
+ PB = "PB".freeze
30
+ P1 = "P1".freeze
31
+ P3 = "P3".freeze
32
+ R1 = "R1".freeze
33
+ R7 = "R7".freeze
34
+ RR = "RR".freeze
35
+ TA = "TA".freeze
36
+ U1 = "U1".freeze
37
+
38
+ # Builds the enum from string
39
+ # @param [String] The enum value in the form of the string
40
+ # @return [String] The enum value
41
+ def self.build_from_hash(value)
42
+ new.build_from_hash(value)
43
+ end
44
+
45
+ # Builds the enum from string
46
+ # @param [String] The enum value in the form of the string
47
+ # @return [String] The enum value
48
+ def build_from_hash(value)
49
+ constantValues = DpvFootnote.constants.select { |c| DpvFootnote::const_get(c) == value }
50
+ raise "Invalid ENUM value #{value} for class #DpvFootnote" if constantValues.empty?
51
+ value
52
+ end
53
+ end
54
+ end