lob 5.1.0 → 6.0.5

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