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,812 @@
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 Check
18
+ # Unique identifier prefixed with `chk_`.
19
+ attr_accessor :id
20
+
21
+ attr_accessor :to
22
+
23
+ attr_accessor :from
24
+
25
+ # An internal description that identifies this resource. Must be no longer than 255 characters.
26
+ attr_accessor :description
27
+
28
+ # Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information.
29
+ attr_accessor :metadata
30
+
31
+ # You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, `` ` ``, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string.
32
+ attr_accessor :merge_variables
33
+
34
+ # A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC.
35
+ attr_accessor :send_date
36
+
37
+ # Checks must be sent `usps_first_class`
38
+ attr_accessor :mail_type
39
+
40
+ # Text to include on the memo line of the check.
41
+ attr_accessor :memo
42
+
43
+ # An integer that designates the check number. If `check_number` is not provided, checks created from a new `bank_account` will start at `10000` and increment with each check created with the `bank_account`. A provided `check_number` overrides the defaults. Subsequent checks created with the same `bank_account` will increment from the provided check number.
44
+ attr_accessor :check_number
45
+
46
+ # Max of 400 characters to be included at the bottom of the check page.
47
+ attr_accessor :message
48
+
49
+ # The payment amount to be sent in US dollars.
50
+ attr_accessor :amount
51
+
52
+ attr_accessor :bank_account
53
+
54
+ # Unique identifier prefixed with `tmpl_`. ID of a saved [HTML template](#section/HTML-Templates).
55
+ attr_accessor :check_bottom_template_id
56
+
57
+ # Unique identifier prefixed with `tmpl_`. ID of a saved [HTML template](#section/HTML-Templates).
58
+ attr_accessor :attachment_template_id
59
+
60
+ # Unique identifier prefixed with `vrsn_`.
61
+ attr_accessor :check_bottom_template_version_id
62
+
63
+ # Unique identifier prefixed with `vrsn_`.
64
+ attr_accessor :attachment_template_version_id
65
+
66
+ # A [signed link](#section/Asset-URLs) served over HTTPS. The link returned will expire in 30 days to prevent mis-sharing. Each time a GET request is initiated, a new signed URL will be generated.
67
+ attr_accessor :url
68
+
69
+ attr_accessor :carrier
70
+
71
+ attr_accessor :thumbnails
72
+
73
+ # A date in YYYY-MM-DD format of the mailpiece's expected delivery date based on its `send_date`.
74
+ attr_accessor :expected_delivery_date
75
+
76
+ # An array of tracking_event objects ordered by ascending `time`. Will not be populated for checks created in test mode.
77
+ attr_accessor :tracking_events
78
+
79
+ attr_accessor :object
80
+
81
+ # A timestamp in ISO 8601 format of the date the resource was created.
82
+ attr_accessor :date_created
83
+
84
+ # A timestamp in ISO 8601 format of the date the resource was last modified.
85
+ attr_accessor :date_modified
86
+
87
+ # Only returned if the resource has been successfully deleted.
88
+ attr_accessor :deleted
89
+
90
+ attr_accessor :use_type
91
+
92
+ class EnumAttributeValidator
93
+ attr_reader :datatype
94
+ attr_reader :allowable_values
95
+
96
+ def initialize(datatype, allowable_values)
97
+ @allowable_values = allowable_values.map do |value|
98
+ case datatype.to_s
99
+ when /Integer/i
100
+ value.to_i
101
+ when /Float/i
102
+ value.to_f
103
+ else
104
+ value
105
+ end
106
+ end
107
+ end
108
+
109
+ def valid?(value)
110
+ !value || allowable_values.include?(value)
111
+ end
112
+ end
113
+
114
+ # Attribute mapping from ruby-style variable name to JSON key.
115
+ def self.attribute_map
116
+ {
117
+ :'id' => :'id',
118
+ :'to' => :'to',
119
+ :'from' => :'from',
120
+ :'description' => :'description',
121
+ :'metadata' => :'metadata',
122
+ :'merge_variables' => :'merge_variables',
123
+ :'send_date' => :'send_date',
124
+ :'mail_type' => :'mail_type',
125
+ :'memo' => :'memo',
126
+ :'check_number' => :'check_number',
127
+ :'message' => :'message',
128
+ :'amount' => :'amount',
129
+ :'bank_account' => :'bank_account',
130
+ :'check_bottom_template_id' => :'check_bottom_template_id',
131
+ :'attachment_template_id' => :'attachment_template_id',
132
+ :'check_bottom_template_version_id' => :'check_bottom_template_version_id',
133
+ :'attachment_template_version_id' => :'attachment_template_version_id',
134
+ :'url' => :'url',
135
+ :'carrier' => :'carrier',
136
+ :'thumbnails' => :'thumbnails',
137
+ :'expected_delivery_date' => :'expected_delivery_date',
138
+ :'tracking_events' => :'tracking_events',
139
+ :'object' => :'object',
140
+ :'date_created' => :'date_created',
141
+ :'date_modified' => :'date_modified',
142
+ :'deleted' => :'deleted',
143
+ :'use_type' => :'use_type'
144
+ }
145
+ end
146
+
147
+ # Returns all the JSON keys this model knows about
148
+ def self.acceptable_attributes
149
+ attribute_map.values
150
+ end
151
+
152
+ # Attribute type mapping.
153
+ def self.openapi_types
154
+ {
155
+ :'id' => :'String',
156
+ :'to' => :'Address',
157
+ :'from' => :'Address',
158
+ :'description' => :'String',
159
+ :'metadata' => :'Hash<String, String>',
160
+ :'merge_variables' => :'Object',
161
+ :'send_date' => :'Time',
162
+ :'mail_type' => :'String',
163
+ :'memo' => :'String',
164
+ :'check_number' => :'Integer',
165
+ :'message' => :'String',
166
+ :'amount' => :'Float',
167
+ :'bank_account' => :'BankAccount',
168
+ :'check_bottom_template_id' => :'String',
169
+ :'attachment_template_id' => :'String',
170
+ :'check_bottom_template_version_id' => :'String',
171
+ :'attachment_template_version_id' => :'String',
172
+ :'url' => :'String',
173
+ :'carrier' => :'String',
174
+ :'thumbnails' => :'Array<Thumbnail>',
175
+ :'expected_delivery_date' => :'Date',
176
+ :'tracking_events' => :'Array<TrackingEventNormal>',
177
+ :'object' => :'String',
178
+ :'date_created' => :'Time',
179
+ :'date_modified' => :'Time',
180
+ :'deleted' => :'Boolean',
181
+ :'use_type' => :'ChkUseType'
182
+ }
183
+ end
184
+
185
+ # List of attributes with nullable: true
186
+ def self.openapi_nullable
187
+ Set.new([
188
+ :'description',
189
+ :'merge_variables',
190
+ :'memo',
191
+ :'tracking_events',
192
+ :'use_type'
193
+ ])
194
+ end
195
+
196
+ # Initializes the object
197
+ # @param [Hash] attributes Model attributes in the form of hash
198
+ def initialize(attributes = {})
199
+ if (!attributes.is_a?(Hash))
200
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Lob::Check` initialize method"
201
+ end
202
+
203
+ # check to see if the attribute exists and convert string to symbol for hash key
204
+ attributes = attributes.each_with_object({}) { |(k, v), h|
205
+ if (!self.class.attribute_map.key?(k.to_sym))
206
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Lob::Check`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
207
+ end
208
+ h[k.to_sym] = v
209
+ }
210
+
211
+ if attributes.key?(:'id')
212
+ self.id = attributes[:'id']
213
+ end
214
+
215
+ if attributes.key?(:'to')
216
+ self.to = attributes[:'to']
217
+ end
218
+
219
+ if attributes.key?(:'from')
220
+ self.from = attributes[:'from']
221
+ end
222
+
223
+ if attributes.key?(:'description')
224
+ self.description = attributes[:'description']
225
+ end
226
+
227
+ if attributes.key?(:'metadata')
228
+ if (value = attributes[:'metadata']).is_a?(Hash)
229
+ self.metadata = value
230
+ end
231
+ end
232
+
233
+ if attributes.key?(:'merge_variables')
234
+ self.merge_variables = attributes[:'merge_variables']
235
+ end
236
+
237
+ if attributes.key?(:'send_date')
238
+ self.send_date = attributes[:'send_date']
239
+ end
240
+
241
+ if attributes.key?(:'mail_type')
242
+ self.mail_type = attributes[:'mail_type']
243
+ else
244
+ self.mail_type = 'usps_first_class'
245
+ end
246
+
247
+ if attributes.key?(:'memo')
248
+ self.memo = attributes[:'memo']
249
+ end
250
+
251
+ if attributes.key?(:'check_number')
252
+ self.check_number = attributes[:'check_number']
253
+ end
254
+
255
+ if attributes.key?(:'message')
256
+ self.message = attributes[:'message']
257
+ end
258
+
259
+ if attributes.key?(:'amount')
260
+ self.amount = attributes[:'amount']
261
+ end
262
+
263
+ if attributes.key?(:'bank_account')
264
+ self.bank_account = attributes[:'bank_account']
265
+ end
266
+
267
+ if attributes.key?(:'check_bottom_template_id')
268
+ self.check_bottom_template_id = attributes[:'check_bottom_template_id']
269
+ end
270
+
271
+ if attributes.key?(:'attachment_template_id')
272
+ self.attachment_template_id = attributes[:'attachment_template_id']
273
+ end
274
+
275
+ if attributes.key?(:'check_bottom_template_version_id')
276
+ self.check_bottom_template_version_id = attributes[:'check_bottom_template_version_id']
277
+ end
278
+
279
+ if attributes.key?(:'attachment_template_version_id')
280
+ self.attachment_template_version_id = attributes[:'attachment_template_version_id']
281
+ end
282
+
283
+ if attributes.key?(:'url')
284
+ self.url = attributes[:'url']
285
+ end
286
+
287
+ if attributes.key?(:'carrier')
288
+ self.carrier = attributes[:'carrier']
289
+ else
290
+ self.carrier = 'USPS'
291
+ end
292
+
293
+ if attributes.key?(:'thumbnails')
294
+ if (value = attributes[:'thumbnails']).is_a?(Array)
295
+ self.thumbnails = value
296
+ end
297
+ end
298
+
299
+ if attributes.key?(:'expected_delivery_date')
300
+ self.expected_delivery_date = attributes[:'expected_delivery_date']
301
+ end
302
+
303
+ if attributes.key?(:'tracking_events')
304
+ if (value = attributes[:'tracking_events']).is_a?(Array)
305
+ self.tracking_events = value
306
+ end
307
+ end
308
+
309
+ if attributes.key?(:'object')
310
+ self.object = attributes[:'object']
311
+ else
312
+ self.object = 'check'
313
+ end
314
+
315
+ if attributes.key?(:'date_created')
316
+ self.date_created = attributes[:'date_created']
317
+ end
318
+
319
+ if attributes.key?(:'date_modified')
320
+ self.date_modified = attributes[:'date_modified']
321
+ end
322
+
323
+ if attributes.key?(:'deleted')
324
+ self.deleted = attributes[:'deleted']
325
+ end
326
+
327
+ if attributes.key?(:'use_type')
328
+ self.use_type = attributes[:'use_type']
329
+ end
330
+ end
331
+
332
+ # Show invalid properties with the reasons. Usually used together with valid?
333
+ # @return Array for valid properties with the reasons
334
+ def list_invalid_properties
335
+ invalid_properties = Array.new
336
+ if @id.nil?
337
+ invalid_properties.push('invalid value for "id", id cannot be nil.')
338
+ end
339
+
340
+ pattern = Regexp.new(/^chk_[a-zA-Z0-9]+$/)
341
+ if @id !~ pattern
342
+ invalid_properties.push("invalid value for \"id\", must conform to the pattern #{pattern}.")
343
+ end
344
+
345
+ if @to.nil?
346
+ invalid_properties.push('invalid value for "to", to cannot be nil.')
347
+ end
348
+
349
+ if !@description.nil? && @description.to_s.length > 255
350
+ invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 255.')
351
+ end
352
+
353
+ if !@memo.nil? && @memo.to_s.length > 40
354
+ invalid_properties.push('invalid value for "memo", the character length must be smaller than or equal to 40.')
355
+ end
356
+
357
+ if !@check_number.nil? && @check_number > 500000000
358
+ invalid_properties.push('invalid value for "check_number", must be smaller than or equal to 500000000.')
359
+ end
360
+
361
+ if !@check_number.nil? && @check_number < 1
362
+ invalid_properties.push('invalid value for "check_number", must be greater than or equal to 1.')
363
+ end
364
+
365
+ if !@message.nil? && @message.to_s.length > 400
366
+ invalid_properties.push('invalid value for "message", the character length must be smaller than or equal to 400.')
367
+ end
368
+
369
+ if @amount.nil?
370
+ invalid_properties.push('invalid value for "amount", amount cannot be nil.')
371
+ end
372
+
373
+ if @amount > 999999.99
374
+ invalid_properties.push('invalid value for "amount", must be smaller than or equal to 999999.99.')
375
+ end
376
+
377
+ if @bank_account.nil?
378
+ invalid_properties.push('invalid value for "bank_account", bank_account cannot be nil.')
379
+ end
380
+
381
+ pattern = Regexp.new(/^tmpl_[a-zA-Z0-9]+$/)
382
+ if !@check_bottom_template_id.nil? && @check_bottom_template_id !~ pattern
383
+ invalid_properties.push("invalid value for \"check_bottom_template_id\", must conform to the pattern #{pattern}.")
384
+ end
385
+
386
+ pattern = Regexp.new(/^tmpl_[a-zA-Z0-9]+$/)
387
+ if !@attachment_template_id.nil? && @attachment_template_id !~ pattern
388
+ invalid_properties.push("invalid value for \"attachment_template_id\", must conform to the pattern #{pattern}.")
389
+ end
390
+
391
+ pattern = Regexp.new(/^vrsn_[a-zA-Z0-9]+$/)
392
+ if !@check_bottom_template_version_id.nil? && @check_bottom_template_version_id !~ pattern
393
+ invalid_properties.push("invalid value for \"check_bottom_template_version_id\", must conform to the pattern #{pattern}.")
394
+ end
395
+
396
+ pattern = Regexp.new(/^vrsn_[a-zA-Z0-9]+$/)
397
+ if !@attachment_template_version_id.nil? && @attachment_template_version_id !~ pattern
398
+ invalid_properties.push("invalid value for \"attachment_template_version_id\", must conform to the pattern #{pattern}.")
399
+ end
400
+
401
+ if @url.nil?
402
+ invalid_properties.push('invalid value for "url", url cannot be nil.')
403
+ end
404
+
405
+ pattern = Regexp.new(/^https:\/\/(lob-assets|lob-assets-staging)\.com\/(letters|postcards|bank-accounts|checks|self-mailers|cards)\/[a-z]{3,4}_[a-z0-9]{15,16}(\.pdf|_thumb_[a-z]+_[0-9]+\.png)\?(version=[a-z0-9-]*&)?expires=[0-9]{10}&signature=[a-zA-Z0-9_-]+$/)
406
+ if @url !~ pattern
407
+ invalid_properties.push("invalid value for \"url\", must conform to the pattern #{pattern}.")
408
+ end
409
+
410
+ if @carrier.nil?
411
+ invalid_properties.push('invalid value for "carrier", carrier cannot be nil.')
412
+ end
413
+
414
+ if @object.nil?
415
+ invalid_properties.push('invalid value for "object", object cannot be nil.')
416
+ end
417
+
418
+ if @date_created.nil?
419
+ invalid_properties.push('invalid value for "date_created", date_created cannot be nil.')
420
+ end
421
+
422
+ if @date_modified.nil?
423
+ invalid_properties.push('invalid value for "date_modified", date_modified cannot be nil.')
424
+ end
425
+
426
+ invalid_properties
427
+ end
428
+
429
+ # Check to see if the all the properties in the model are valid
430
+ # @return true if the model is valid
431
+ def valid?
432
+ return false if @id.nil?
433
+ return false if @id !~ Regexp.new(/^chk_[a-zA-Z0-9]+$/)
434
+ return false if @to.nil?
435
+ return false if !@description.nil? && @description.to_s.length > 255
436
+ mail_type_validator = EnumAttributeValidator.new('String', ["usps_first_class"])
437
+ return false unless mail_type_validator.valid?(@mail_type)
438
+ return false if !@memo.nil? && @memo.to_s.length > 40
439
+ return false if !@check_number.nil? && @check_number > 500000000
440
+ return false if !@check_number.nil? && @check_number < 1
441
+ return false if !@message.nil? && @message.to_s.length > 400
442
+ return false if @amount.nil?
443
+ return false if @amount > 999999.99
444
+ return false if @bank_account.nil?
445
+ return false if !@check_bottom_template_id.nil? && @check_bottom_template_id !~ Regexp.new(/^tmpl_[a-zA-Z0-9]+$/)
446
+ return false if !@attachment_template_id.nil? && @attachment_template_id !~ Regexp.new(/^tmpl_[a-zA-Z0-9]+$/)
447
+ return false if !@check_bottom_template_version_id.nil? && @check_bottom_template_version_id !~ Regexp.new(/^vrsn_[a-zA-Z0-9]+$/)
448
+ return false if !@attachment_template_version_id.nil? && @attachment_template_version_id !~ Regexp.new(/^vrsn_[a-zA-Z0-9]+$/)
449
+ return false if @url.nil?
450
+ return false if @url !~ Regexp.new(/^https:\/\/(lob-assets|lob-assets-staging)\.com\/(letters|postcards|bank-accounts|checks|self-mailers|cards)\/[a-z]{3,4}_[a-z0-9]{15,16}(\.pdf|_thumb_[a-z]+_[0-9]+\.png)\?(version=[a-z0-9-]*&)?expires=[0-9]{10}&signature=[a-zA-Z0-9_-]+$/)
451
+ return false if @carrier.nil?
452
+ carrier_validator = EnumAttributeValidator.new('String', ["USPS"])
453
+ return false unless carrier_validator.valid?(@carrier)
454
+ return false if @object.nil?
455
+ object_validator = EnumAttributeValidator.new('String', ["check"])
456
+ return false unless object_validator.valid?(@object)
457
+ return false if @date_created.nil?
458
+ return false if @date_modified.nil?
459
+ true
460
+ end
461
+
462
+ # Custom attribute writer method with validation
463
+ # @param [Object] id Value to be assigned
464
+ def id=(id)
465
+ if id.nil?
466
+ fail ArgumentError, 'id cannot be nil'
467
+ end
468
+
469
+ pattern = Regexp.new(/^chk_[a-zA-Z0-9]+$/)
470
+ if id !~ pattern
471
+ fail ArgumentError, "invalid value for \"id\", must conform to the pattern #{pattern}."
472
+ end
473
+
474
+ @id = id
475
+ end
476
+
477
+ # Custom attribute writer method with validation
478
+ # @param [Object] description Value to be assigned
479
+ def description=(description)
480
+ if !description.nil? && description.to_s.length > 255
481
+ fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 255.'
482
+ end
483
+
484
+ @description = description
485
+ end
486
+
487
+ # Custom attribute writer method with validation
488
+ # @param [Object] metadata Value to be assigned
489
+ def metadata=(metadata)
490
+ @metadata = metadata
491
+ end
492
+
493
+ # Custom attribute writer method with validation
494
+ # @param [Object] merge_variables Value to be assigned
495
+ def merge_variables=(merge_variables)
496
+ @merge_variables = merge_variables
497
+ end
498
+
499
+ # Custom attribute writer method checking allowed values (enum).
500
+ # @param [Object] mail_type Object to be assigned
501
+ def mail_type=(mail_type)
502
+ validator = EnumAttributeValidator.new('String', ["usps_first_class"])
503
+ unless validator.valid?(mail_type)
504
+ fail ArgumentError, "invalid value for \"mail_type\", must be one of #{validator.allowable_values}."
505
+ end
506
+ @mail_type = mail_type
507
+ end
508
+
509
+ # Custom attribute writer method with validation
510
+ # @param [Object] memo Value to be assigned
511
+ def memo=(memo)
512
+ if !memo.nil? && memo.to_s.length > 40
513
+ fail ArgumentError, 'invalid value for "memo", the character length must be smaller than or equal to 40.'
514
+ end
515
+
516
+ @memo = memo
517
+ end
518
+
519
+ # Custom attribute writer method with validation
520
+ # @param [Object] check_number Value to be assigned
521
+ def check_number=(check_number)
522
+ if !check_number.nil? && check_number > 500000000
523
+ fail ArgumentError, 'invalid value for "check_number", must be smaller than or equal to 500000000.'
524
+ end
525
+
526
+ if !check_number.nil? && check_number < 1
527
+ fail ArgumentError, 'invalid value for "check_number", must be greater than or equal to 1.'
528
+ end
529
+
530
+ @check_number = check_number
531
+ end
532
+
533
+ # Custom attribute writer method with validation
534
+ # @param [Object] message Value to be assigned
535
+ def message=(message)
536
+ if !message.nil? && message.to_s.length > 400
537
+ fail ArgumentError, 'invalid value for "message", the character length must be smaller than or equal to 400.'
538
+ end
539
+
540
+ @message = message
541
+ end
542
+
543
+ # Custom attribute writer method with validation
544
+ # @param [Object] amount Value to be assigned
545
+ def amount=(amount)
546
+ if amount.nil?
547
+ fail ArgumentError, 'amount cannot be nil'
548
+ end
549
+
550
+ if amount > 999999.99
551
+ fail ArgumentError, 'invalid value for "amount", must be smaller than or equal to 999999.99.'
552
+ end
553
+
554
+ @amount = amount
555
+ end
556
+
557
+ # Custom attribute writer method with validation
558
+ # @param [Object] check_bottom_template_id Value to be assigned
559
+ def check_bottom_template_id=(check_bottom_template_id)
560
+ pattern = Regexp.new(/^tmpl_[a-zA-Z0-9]+$/)
561
+ if !check_bottom_template_id.nil? && check_bottom_template_id !~ pattern
562
+ fail ArgumentError, "invalid value for \"check_bottom_template_id\", must conform to the pattern #{pattern}."
563
+ end
564
+
565
+ @check_bottom_template_id = check_bottom_template_id
566
+ end
567
+
568
+ # Custom attribute writer method with validation
569
+ # @param [Object] attachment_template_id Value to be assigned
570
+ def attachment_template_id=(attachment_template_id)
571
+ pattern = Regexp.new(/^tmpl_[a-zA-Z0-9]+$/)
572
+ if !attachment_template_id.nil? && attachment_template_id !~ pattern
573
+ fail ArgumentError, "invalid value for \"attachment_template_id\", must conform to the pattern #{pattern}."
574
+ end
575
+
576
+ @attachment_template_id = attachment_template_id
577
+ end
578
+
579
+ # Custom attribute writer method with validation
580
+ # @param [Object] check_bottom_template_version_id Value to be assigned
581
+ def check_bottom_template_version_id=(check_bottom_template_version_id)
582
+ pattern = Regexp.new(/^vrsn_[a-zA-Z0-9]+$/)
583
+ if !check_bottom_template_version_id.nil? && check_bottom_template_version_id !~ pattern
584
+ fail ArgumentError, "invalid value for \"check_bottom_template_version_id\", must conform to the pattern #{pattern}."
585
+ end
586
+
587
+ @check_bottom_template_version_id = check_bottom_template_version_id
588
+ end
589
+
590
+ # Custom attribute writer method with validation
591
+ # @param [Object] attachment_template_version_id Value to be assigned
592
+ def attachment_template_version_id=(attachment_template_version_id)
593
+ pattern = Regexp.new(/^vrsn_[a-zA-Z0-9]+$/)
594
+ if !attachment_template_version_id.nil? && attachment_template_version_id !~ pattern
595
+ fail ArgumentError, "invalid value for \"attachment_template_version_id\", must conform to the pattern #{pattern}."
596
+ end
597
+
598
+ @attachment_template_version_id = attachment_template_version_id
599
+ end
600
+
601
+ # Custom attribute writer method with validation
602
+ # @param [Object] url Value to be assigned
603
+ def url=(url)
604
+ if url.nil?
605
+ fail ArgumentError, 'url cannot be nil'
606
+ end
607
+
608
+ pattern = Regexp.new(/^https:\/\/(lob-assets|lob-assets-staging)\.com\/(letters|postcards|bank-accounts|checks|self-mailers|cards)\/[a-z]{3,4}_[a-z0-9]{15,16}(\.pdf|_thumb_[a-z]+_[0-9]+\.png)\?(version=[a-z0-9-]*&)?expires=[0-9]{10}&signature=[a-zA-Z0-9_-]+$/)
609
+ if url !~ pattern
610
+ fail ArgumentError, "invalid value for \"url\", must conform to the pattern #{pattern}."
611
+ end
612
+
613
+ @url = url
614
+ end
615
+
616
+ # Custom attribute writer method checking allowed values (enum).
617
+ # @param [Object] carrier Object to be assigned
618
+ def carrier=(carrier)
619
+ validator = EnumAttributeValidator.new('String', ["USPS"])
620
+ unless validator.valid?(carrier)
621
+ fail ArgumentError, "invalid value for \"carrier\", must be one of #{validator.allowable_values}."
622
+ end
623
+ @carrier = carrier
624
+ end
625
+
626
+ # Custom attribute writer method checking allowed values (enum).
627
+ # @param [Object] object Object to be assigned
628
+ def object=(object)
629
+ validator = EnumAttributeValidator.new('String', ["check"])
630
+ unless validator.valid?(object)
631
+ fail ArgumentError, "invalid value for \"object\", must be one of #{validator.allowable_values}."
632
+ end
633
+ @object = object
634
+ end
635
+
636
+ # Checks equality by comparing each attribute.
637
+ # @param [Object] Object to be compared
638
+ def ==(o)
639
+ return true if self.equal?(o)
640
+ self.class == o.class &&
641
+ id == o.id &&
642
+ to == o.to &&
643
+ from == o.from &&
644
+ description == o.description &&
645
+ metadata == o.metadata &&
646
+ merge_variables == o.merge_variables &&
647
+ send_date == o.send_date &&
648
+ mail_type == o.mail_type &&
649
+ memo == o.memo &&
650
+ check_number == o.check_number &&
651
+ message == o.message &&
652
+ amount == o.amount &&
653
+ bank_account == o.bank_account &&
654
+ check_bottom_template_id == o.check_bottom_template_id &&
655
+ attachment_template_id == o.attachment_template_id &&
656
+ check_bottom_template_version_id == o.check_bottom_template_version_id &&
657
+ attachment_template_version_id == o.attachment_template_version_id &&
658
+ url == o.url &&
659
+ carrier == o.carrier &&
660
+ thumbnails == o.thumbnails &&
661
+ expected_delivery_date == o.expected_delivery_date &&
662
+ tracking_events == o.tracking_events &&
663
+ object == o.object &&
664
+ date_created == o.date_created &&
665
+ date_modified == o.date_modified &&
666
+ deleted == o.deleted &&
667
+ use_type == o.use_type
668
+ end
669
+
670
+ # @see the `==` method
671
+ # @param [Object] Object to be compared
672
+ def eql?(o)
673
+ self == o
674
+ end
675
+
676
+ # Calculates hash code according to all attributes.
677
+ # @return [Integer] Hash code
678
+ def hash
679
+ [id, to, from, description, metadata, merge_variables, send_date, mail_type, memo, check_number, message, amount, bank_account, check_bottom_template_id, attachment_template_id, check_bottom_template_version_id, attachment_template_version_id, url, carrier, thumbnails, expected_delivery_date, tracking_events, object, date_created, date_modified, deleted, use_type].hash
680
+ end
681
+
682
+
683
+ # Builds the object from hash
684
+ # @param [Hash] attributes Model attributes in the form of hash
685
+ # @return [Object] Returns the model itself
686
+ def self.build_from_hash(attributes)
687
+ new.build_from_hash(attributes)
688
+ end
689
+
690
+ # Builds the object from hash
691
+ # @param [Hash] attributes Model attributes in the form of hash
692
+ # @return [Object] Returns the model itself
693
+ def build_from_hash(attributes)
694
+ return nil unless attributes.is_a?(Hash)
695
+ attributes = attributes.transform_keys(&:to_sym)
696
+ self.class.openapi_types.each_pair do |key, type|
697
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
698
+ self.send("#{key}=", nil) # // guardrails-disable-line
699
+ elsif type =~ /\AArray<(.*)>/i
700
+ # check to ensure the input is an array given that the attribute
701
+ # is documented as an array but the input is not
702
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
703
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) # // guardrails-disable-line
704
+ end
705
+ elsif !attributes[self.class.attribute_map[key]].nil? && type.kind_of?(Array)
706
+ for base_type in type do
707
+ res = _deserialize(base_type, attributes[self.class.attribute_map[key]])
708
+ if !res.nil?
709
+ self.send("#{key}=", res) # // guardrails-disable-line
710
+ break
711
+ end
712
+ end
713
+ elsif !attributes[self.class.attribute_map[key]].nil?
714
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) # // guardrails-disable-line
715
+ end
716
+ end
717
+
718
+ self
719
+ end
720
+
721
+ # Deserializes the data based on type
722
+ # @param string type Data type
723
+ # @param string value Value to be deserialized
724
+ # @return [Object] Deserialized data
725
+ def _deserialize(type, value)
726
+ case type.to_sym
727
+ when :Time
728
+ Time.parse(value)
729
+ when :Date
730
+ Date.parse(value)
731
+ when :String
732
+ value.to_s
733
+ when :Integer
734
+ value.to_i
735
+ when :Float
736
+ value.to_f
737
+ when :Boolean
738
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
739
+ true
740
+ else
741
+ false
742
+ end
743
+ when :Object
744
+ # generic object (usually a Hash), return directly
745
+ value
746
+ when /\AArray<(?<inner_type>.+)>\z/
747
+ inner_type = Regexp.last_match[:inner_type]
748
+ value.map { |v| _deserialize(inner_type, v) }
749
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
750
+ k_type = Regexp.last_match[:k_type]
751
+ v_type = Regexp.last_match[:v_type]
752
+ {}.tap do |hash|
753
+ value.each do |k, v|
754
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
755
+ end
756
+ end
757
+ else # model
758
+ # models (e.g. Pet) or oneOf
759
+ klass = Lob.const_get(type)
760
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
761
+ end
762
+ end
763
+
764
+ # Returns the string representation of the object
765
+ # @return [String] String presentation of the object
766
+ def to_s
767
+ to_hash.to_s
768
+ end
769
+
770
+ # to_body is an alias to to_hash (backward compatibility)
771
+ # @return [Hash] Returns the object in the form of hash
772
+ def to_body
773
+ to_hash
774
+ end
775
+
776
+ # Returns the object in the form of hash
777
+ # @return [Hash] Returns the object in the form of hash
778
+ def to_hash
779
+ hash = {}
780
+ self.class.attribute_map.each_pair do |attr, param|
781
+ value = self.send(attr) # // guardrails-disable-line
782
+ if value.nil?
783
+ is_nullable = self.class.openapi_nullable.include?(attr)
784
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
785
+ end
786
+
787
+ hash[param] = _to_hash(value)
788
+ end
789
+ hash
790
+ end
791
+
792
+ # Outputs non-array value in the form of hash
793
+ # For object, use to_hash. Otherwise, just return the value
794
+ # @param [Object] value Any valid value
795
+ # @return [Hash] Returns the value in the form of hash
796
+ def _to_hash(value)
797
+ if value.is_a?(Array)
798
+ value.compact.map { |v| _to_hash(v) }
799
+ elsif value.is_a?(Hash)
800
+ {}.tap do |hash|
801
+ value.each { |k, v| hash[k] = _to_hash(v) }
802
+ end
803
+ elsif value.respond_to? :to_hash
804
+ value.to_hash
805
+ else
806
+ value
807
+ end
808
+ end
809
+
810
+ end
811
+
812
+ end