lob 5.4.5 → 6.0.0.pre.rc

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