lob 5.1.2 → 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 +4 -4
  2. data/CODE_SNIPPETS.md +1871 -0
  3. data/Gemfile +6 -1
  4. data/Gemfile.lock +72 -0
  5. data/LICENSE +21 -0
  6. data/MIGRATION.md +174 -0
  7. data/README.md +70 -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 -139
  418. data/.gitignore +0 -18
  419. data/.travis.yml +0 -13
  420. data/CHANGELOG.md +0 -129
  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 -142
  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 -119
  459. data/spec/lob/resources/group_spec.rb +0 -50
  460. data/spec/lob/resources/intl_verifications_spec.rb +0 -25
  461. data/spec/lob/resources/letter_spec.rb +0 -114
  462. data/spec/lob/resources/member_spec.rb +0 -65
  463. data/spec/lob/resources/postcard_spec.rb +0 -160
  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,165 @@
1
+ # Template.unit.rb
2
+
3
+ include Lob
4
+ $:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
5
+
6
+ RSpec.describe "TemplatesApi" do
7
+
8
+ it "can be instantiated" do
9
+ templateApiMock = double("ApiClient")
10
+ templateApi = TemplatesApi.new(templateApiMock)
11
+
12
+ expect(templateApi).not_to be_nil
13
+ expect(templateApi).to be_a_kind_of(TemplatesApi)
14
+ end
15
+
16
+ describe "Create" do
17
+ it "handles errors returned by the api" do
18
+ templateApiMock = double("ApiClient")
19
+ templateApi = TemplatesApi.new(templateApiMock)
20
+ templateWritable = TemplateWritable.new
21
+
22
+ allow(templateApi).to receive(:create).and_raise("exception thrown in create test")
23
+ begin
24
+ response = templateApi.create(TemplateWritable)
25
+ rescue => err
26
+ expect(err.message).to eq("exception thrown in create test")
27
+ end
28
+ end
29
+
30
+ it "creates a new template" do
31
+ templateApiMock = double("ApiClient")
32
+ templateApi = TemplatesApi.new(templateApiMock)
33
+ templateWritable = TemplateWritable.new
34
+ fakeTemplate = Template.new
35
+
36
+ fakeTemplate.id = "tmpl_fakeId"
37
+ allow(templateApi).to receive(:create) { fakeTemplate }
38
+ response = templateApi.create(TemplateWritable)
39
+
40
+ expect(response).to eq(fakeTemplate)
41
+ expect(response.id).to eq(fakeTemplate.id)
42
+ end
43
+ end
44
+
45
+ describe "Get" do
46
+ it "handles errors returned by the api" do
47
+ templateApiMock = double("ApiClient")
48
+ templateApi = TemplatesApi.new(templateApiMock)
49
+ templateWritable = TemplateWritable.new
50
+
51
+ allow(templateApi).to receive(:get).and_raise("exception thrown in get test")
52
+ begin
53
+ response = templateApi.get("tmpl_fakeId")
54
+ rescue => err
55
+ expect(err.message).to eq("exception thrown in get test")
56
+ end
57
+ end
58
+
59
+ it "retrieves an template" do
60
+ templateApiMock = double("ApiClient")
61
+ templateApi = TemplatesApi.new(templateApiMock)
62
+ templateWritable = TemplateWritable.new
63
+ fakeTemplate = Template.new
64
+
65
+ fakeTemplate.id = "tmpl_fakeId"
66
+ allow(templateApi).to receive(:get) { fakeTemplate }
67
+ response = templateApi.get(fakeTemplate.id)
68
+
69
+ expect(response).to eq(fakeTemplate)
70
+ expect(response.id).to eq(fakeTemplate.id)
71
+ end
72
+ end
73
+
74
+ describe "List" do
75
+ it "handles errors returned by the api" do
76
+ templateApiMock = double("ApiClient")
77
+ templateApi = TemplatesApi.new(templateApiMock)
78
+ templateWritable = TemplateWritable.new
79
+
80
+ allow(templateApi).to receive(:list).and_raise("exception thrown in get test")
81
+ begin
82
+ response = templateApi.list()
83
+ rescue => err
84
+ expect(err.message).to eq("exception thrown in get test")
85
+ end
86
+ end
87
+
88
+ [
89
+ [nil, nil, nil, nil, nil, nil, nil],
90
+ ["limit", 2, nil, nil, nil, nil, nil],
91
+ ["before", nil, "before", nil, nil, nil, nil],
92
+ ["after", nil, nil, "after", nil, nil, nil],
93
+ ["include", nil, nil, nil, Array.new(1, "total_count"), nil, nil],
94
+ ["date_created", nil, nil, nil, nil, { gt: "2020-01-01", lt: "2020-01-31T12" }, nil],
95
+ ["metadata", nil, nil, nil, nil, nil, { fakeMetadata: "fakemetadata" }]
96
+ ].each do |which_param, limit, before, after, include_param, date_created, metadata|
97
+ it "lists templates #{which_param && ("with " + which_param + " param")}" do
98
+ args = {}
99
+ if limit then
100
+ args["limit"] = limit
101
+ end
102
+
103
+ if before then
104
+ args["before"] = before
105
+ end
106
+
107
+ if after then
108
+ args["after"] = after
109
+ end
110
+
111
+ if include_param then
112
+ args["include"] = include_param
113
+ end
114
+
115
+ if date_created then
116
+ args["date_created"] = date_created
117
+ end
118
+
119
+ if metadata then
120
+ args["metadata"] = metadata
121
+ end
122
+
123
+ templateApiMock = double("ApiClient")
124
+ templateApi = TemplatesApi.new(templateApiMock)
125
+ templateWritable = TemplateWritable.new
126
+ fakeTemplates = Array.new(2) { Template.new }
127
+
128
+ fakeTemplates[0].id = "tmpl_fakeId"
129
+ allow(templateApi).to receive(:list) { fakeTemplates }
130
+ response = templateApi.list(args)
131
+
132
+ expect(response.length()).to eq(2)
133
+ expect(response).to eq(fakeTemplates)
134
+ expect(response[0].id).to eq(fakeTemplates[0].id)
135
+ end
136
+ end
137
+ end
138
+
139
+ describe "Delete" do
140
+ it "handles errors returned by the api" do
141
+ templateApiMock = double("ApiClient")
142
+ templateApi = TemplatesApi.new(templateApiMock)
143
+
144
+ allow(templateApi).to receive(:delete).and_raise("exception thrown in delete test")
145
+ begin
146
+ response = templateApi.delete("tmpl_fakeId")
147
+ rescue => err
148
+ expect(err.message).to eq("exception thrown in delete test")
149
+ end
150
+ end
151
+
152
+ it "deletes a template" do
153
+ templateApiMock = double("ApiClient")
154
+ templateApi = TemplatesApi.new(templateApiMock)
155
+ templateDeletion = TemplateDeletion.new
156
+
157
+ templateDeletion.deleted = true
158
+ allow(templateApi).to receive(:delete) { templateDeletion }
159
+ response = templateApi.delete("tmpl_fakeId")
160
+
161
+ expect(response).to eq(templateDeletion)
162
+ expect(response.deleted).to eq(true)
163
+ end
164
+ end
165
+ end
@@ -0,0 +1,165 @@
1
+ # TemplateVersion.unit.rb
2
+
3
+ include Lob
4
+ $:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
5
+
6
+ RSpec.describe "TemplateVersionsApi" do
7
+
8
+ it "can be instantiated" do
9
+ templateVersionApiMock = double("ApiClient")
10
+ templateVersionApi = TemplateVersionsApi.new(templateVersionApiMock)
11
+
12
+ expect(templateVersionApi).not_to be_nil
13
+ expect(templateVersionApi).to be_a_kind_of(TemplateVersionsApi)
14
+ end
15
+
16
+ describe "Create" do
17
+ it "handles errors returned by the api" do
18
+ templateVersionApiMock = double("ApiClient")
19
+ templateVersionApi = TemplateVersionsApi.new(templateVersionApiMock)
20
+ templateVersionWritable = TemplateVersionWritable.new
21
+
22
+ allow(templateVersionApi).to receive(:create).and_raise("exception thrown in create test")
23
+ begin
24
+ response = templateVersionApi.create("tmpl_fakeId", templateVersionWritable)
25
+ rescue => err
26
+ expect(err.message).to eq("exception thrown in create test")
27
+ end
28
+ end
29
+
30
+ it "creates a new template" do
31
+ templateVersionApiMock = double("ApiClient")
32
+ templateVersionApi = TemplateVersionsApi.new(templateVersionApiMock)
33
+ templateVersionWritable = TemplateVersionWritable.new
34
+ fakeTemplateVersion = TemplateVersion.new
35
+
36
+ fakeTemplateVersion.id = "vrsn_fakeId"
37
+ allow(templateVersionApi).to receive(:create) { fakeTemplateVersion }
38
+ response = templateVersionApi.create("tmpl_fakeId", templateVersionWritable)
39
+
40
+ expect(response).to eq(fakeTemplateVersion)
41
+ expect(response.id).to eq(fakeTemplateVersion.id)
42
+ end
43
+ end
44
+
45
+ describe "Get" do
46
+ it "handles errors returned by the api" do
47
+ templateVersionApiMock = double("ApiClient")
48
+ templateVersionApi = TemplateVersionsApi.new(templateVersionApiMock)
49
+ templateVersionWritable = TemplateVersionWritable.new
50
+
51
+ allow(templateVersionApi).to receive(:get).and_raise("exception thrown in get test")
52
+ begin
53
+ response = templateVersionApi.get("tmpl_fakeId", "vrsn_fakeId")
54
+ rescue => err
55
+ expect(err.message).to eq("exception thrown in get test")
56
+ end
57
+ end
58
+
59
+ it "retrieves an template" do
60
+ templateVersionApiMock = double("ApiClient")
61
+ templateVersionApi = TemplateVersionsApi.new(templateVersionApiMock)
62
+ templateVersionWritable = TemplateVersionWritable.new
63
+ fakeTemplateVersion = TemplateVersion.new
64
+
65
+ fakeTemplateVersion.id = "vrsn_fakeId"
66
+ allow(templateVersionApi).to receive(:get) { fakeTemplateVersion }
67
+ response = templateVersionApi.get("tmpl_fakeId", fakeTemplateVersion.id)
68
+
69
+ expect(response).to eq(fakeTemplateVersion)
70
+ expect(response.id).to eq(fakeTemplateVersion.id)
71
+ end
72
+ end
73
+
74
+ describe "List" do
75
+ it "handles errors returned by the api" do
76
+ templateVersionApiMock = double("ApiClient")
77
+ templateVersionApi = TemplateVersionsApi.new(templateVersionApiMock)
78
+ templateVersionWritable = TemplateVersionWritable.new
79
+
80
+ allow(templateVersionApi).to receive(:list).and_raise("exception thrown in get test")
81
+ begin
82
+ response = templateVersionApi.list("tmpl_fakeId")
83
+ rescue => err
84
+ expect(err.message).to eq("exception thrown in get test")
85
+ end
86
+ end
87
+
88
+ [
89
+ [nil, nil, nil, nil, nil, nil, nil],
90
+ ["limit", 2, nil, nil, nil, nil, nil],
91
+ ["before", nil, "before", nil, nil, nil, nil],
92
+ ["after", nil, nil, "after", nil, nil, nil],
93
+ ["include", nil, nil, nil, Array.new(1, "total_count"), nil, nil],
94
+ ["date_created", nil, nil, nil, nil, { gt: "2020-01-01", lt: "2020-01-31T12" }, nil],
95
+ ["metadata", nil, nil, nil, nil, nil, { fakeMetadata: "fakemetadata" }]
96
+ ].each do |which_param, limit, before, after, include_param, date_created, metadata|
97
+ it "lists template versions #{which_param && ("with " + which_param + " param")}" do
98
+ args = {}
99
+ if limit then
100
+ args["limit"] = limit
101
+ end
102
+
103
+ if before then
104
+ args["before"] = before
105
+ end
106
+
107
+ if after then
108
+ args["after"] = after
109
+ end
110
+
111
+ if include_param then
112
+ args["include"] = include_param
113
+ end
114
+
115
+ if date_created then
116
+ args["date_created"] = date_created
117
+ end
118
+
119
+ if metadata then
120
+ args["metadata"] = metadata
121
+ end
122
+
123
+ templateVersionApiMock = double("ApiClient")
124
+ templateVersionApi = TemplateVersionsApi.new(templateVersionApiMock)
125
+ templateVersionWritable = TemplateVersionWritable.new
126
+ fakeTemplateVersionVersions = Array.new(2) { TemplateVersion.new }
127
+
128
+ fakeTemplateVersionVersions[0].id = "vrsn_fakeId"
129
+ allow(templateVersionApi).to receive(:list) { fakeTemplateVersionVersions }
130
+ response = templateVersionApi.list(args)
131
+
132
+ expect(response.length()).to eq(2)
133
+ expect(response).to eq(fakeTemplateVersionVersions)
134
+ expect(response[0].id).to eq(fakeTemplateVersionVersions[0].id)
135
+ end
136
+ end
137
+ end
138
+
139
+ describe "Delete" do
140
+ it "handles errors returned by the api" do
141
+ templateVersionApiMock = double("ApiClient")
142
+ templateVersionApi = TemplateVersionsApi.new(templateVersionApiMock)
143
+
144
+ allow(templateVersionApi).to receive(:delete).and_raise("exception thrown in delete test")
145
+ begin
146
+ response = templateVersionApi.delete("tmpl_fakeId", "vrsn_fakeId")
147
+ rescue => err
148
+ expect(err.message).to eq("exception thrown in delete test")
149
+ end
150
+ end
151
+
152
+ it "deletes a template" do
153
+ templateVersionApiMock = double("ApiClient")
154
+ templateVersionApi = TemplateVersionsApi.new(templateVersionApiMock)
155
+ templateDeletion = TemplateVersionDeletion.new
156
+
157
+ templateDeletion.deleted = true
158
+ allow(templateVersionApi).to receive(:delete) { templateDeletion }
159
+ response = templateVersionApi.delete("tmpl_fakeId", "vrsn_fakeId")
160
+
161
+ expect(response).to eq(templateDeletion)
162
+ expect(response.deleted).to eq(true)
163
+ end
164
+ end
165
+ end
@@ -0,0 +1,42 @@
1
+ # IntlAutcompletion.unit.rb
2
+
3
+ $:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
4
+
5
+ RSpec.describe "UsAutocompletionsApi" do
6
+
7
+ it "can be instantiated" do
8
+ usAutocompletionApiMock = double("ApiClient")
9
+ usAutocompletionApi = Lob::UsAutocompletionsApi.new(usAutocompletionApiMock)
10
+
11
+ expect(usAutocompletionApi).not_to be_nil
12
+ expect(usAutocompletionApi).to be_a_kind_of(Lob::UsAutocompletionsApi)
13
+ end
14
+
15
+ describe "Autocomplete" do
16
+ it "handles errors returned by the api" do
17
+ usAutocompletionApiMock = double("ApiClient")
18
+ usAutocompletionApi = Lob::UsAutocompletionsApi.new(usAutocompletionApiMock)
19
+ usAutocompletionsWritable = Lob::UsAutocompletionsWritable.new
20
+
21
+ allow(usAutocompletionApi).to receive(:autocomplete).and_raise("exception thrown in autocomplete test")
22
+ begin
23
+ response = usAutocompletionApi.autocomplete(usAutocompletionsWritable)
24
+ rescue => err
25
+ expect(err.message).to eq("exception thrown in autocomplete test")
26
+ end
27
+ end
28
+
29
+ it "autocomplete an address" do
30
+ usAutocompletionApiMock = double("ApiClient")
31
+ usAutocompletionApi = Lob::UsAutocompletionsApi.new(usAutocompletionApiMock)
32
+ usAutocompletionsWritable = Lob::UsAutocompletionsWritable.new
33
+ usAutocompletions = Lob::UsAutocompletions.new
34
+ usAutocompletions.suggestions = Array.new(1, Lob::Suggestions.new)
35
+
36
+ allow(usAutocompletionApi).to receive(:autocomplete) { usAutocompletions }
37
+ response = usAutocompletionApi.autocomplete(usAutocompletionsWritable)
38
+
39
+ expect(response.suggestions.length()).to eq(1)
40
+ end
41
+ end
42
+ end
@@ -0,0 +1,71 @@
1
+ # UsVerification.unit.rb
2
+
3
+ include Lob
4
+ $:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
5
+
6
+ RSpec.describe "UsVerificationsApi" do
7
+
8
+ it "can be instantiated" do
9
+ usVerificationApiMock = double("ApiClient")
10
+ usVerificationApi = UsVerificationsApi.new(usVerificationApiMock)
11
+
12
+ expect(usVerificationApi).not_to be_nil
13
+ expect(usVerificationApi).to be_a_kind_of(UsVerificationsApi)
14
+ end
15
+
16
+ describe "Bulk Verification" do
17
+ it "handles errors returned by the api" do
18
+ usVerificationApiMock = double("ApiClient")
19
+ usVerificationApi = UsVerificationsApi.new(usVerificationApiMock)
20
+ usVerificationsWritable = UsVerificationsWritable.new
21
+
22
+ allow(usVerificationApi).to receive(:verifyBulk).and_raise("exception thrown in verification test")
23
+ begin
24
+ response = usVerificationApi.verifyBulk(usVerificationsWritable)
25
+ rescue => err
26
+ expect(err.message).to eq("exception thrown in verification test")
27
+ end
28
+ end
29
+
30
+ it "bulk verify addresses" do
31
+ usVerificationApiMock = double("ApiClient")
32
+ usVerificationApi = UsVerificationsApi.new(usVerificationApiMock)
33
+ usVerificationsWritable = UsVerificationsWritable.new
34
+ usVerifications = UsVerifications.new
35
+ usVerifications.addresses = Array.new(2, { "id": "intl_ver_fakeId", "status": "LF1"})
36
+
37
+ allow(usVerificationApi).to receive(:verifyBulk) { usVerifications }
38
+ response = usVerificationApi.verifyBulk(usVerificationsWritable)
39
+
40
+ expect(response.addresses.length()).to eq(2)
41
+ end
42
+ end
43
+
44
+ describe "Single Verification" do
45
+ it "handles errors returned by the api" do
46
+ usVerificationApiMock = double("ApiClient")
47
+ usVerificationApi = UsVerificationsApi.new(usVerificationApiMock)
48
+ usVerificationWritable = UsVerificationsWritable.new
49
+
50
+ allow(usVerificationApi).to receive(:verifySingle).and_raise("exception thrown in verification test")
51
+ begin
52
+ response = usVerificationApi.verifySingle(usVerificationWritable)
53
+ rescue => err
54
+ expect(err.message).to eq("exception thrown in verification test")
55
+ end
56
+ end
57
+
58
+ it "single verify addresses" do
59
+ usVerificationApiMock = double("ApiClient")
60
+ usVerificationApi = UsVerificationsApi.new(usVerificationApiMock)
61
+ usVerificationWritable = UsVerificationsWritable.new
62
+ usVerification = UsVerification.new
63
+ usVerification.deliverability = "deliverable"
64
+
65
+ allow(usVerificationApi).to receive(:verifySingle) { usVerification }
66
+ response = usVerificationApi.verifySingle(usVerificationWritable)
67
+
68
+ expect(response.deliverability).to eq("deliverable")
69
+ end
70
+ end
71
+ end
@@ -0,0 +1,42 @@
1
+ # ZipLookup.unit.rb
2
+
3
+ include Lob
4
+ $:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
5
+
6
+ RSpec.describe "ZipLookupsApi" do
7
+
8
+ it "can be instantiated" do
9
+ zipLookupApiMock = double("ApiClient")
10
+ zipLookupApi = ZipLookupsApi.new(zipLookupApiMock)
11
+
12
+ expect(zipLookupApi).not_to be_nil
13
+ expect(zipLookupApi).to be_a_kind_of(ZipLookupsApi)
14
+ end
15
+
16
+ describe "Lookup" do
17
+ it "handles errors returned by the api" do
18
+ zipLookupApiMock = double("ApiClient")
19
+ zipLookupApi = ZipLookupsApi.new(zipLookupApiMock)
20
+ zip = Zip.new
21
+
22
+ allow(zipLookupApi).to receive(:lookup).and_raise("exception thrown in lookup test")
23
+ begin
24
+ response = zipLookupApi.lookup(zip)
25
+ rescue => err
26
+ expect(err.message).to eq("exception thrown in lookup test")
27
+ end
28
+ end
29
+
30
+ it "lookup a zip code" do
31
+ zipLookupApiMock = double("ApiClient")
32
+ zipLookupApi = ZipLookupsApi.new(zipLookupApiMock)
33
+ zip = Zip.new
34
+ zip.id = "us_zip_fakeId"
35
+
36
+ allow(zipLookupApi).to receive(:lookup) { zip }
37
+ response = zipLookupApi.lookup("12345")
38
+
39
+ expect(response.id).to eq("us_zip_fakeId")
40
+ end
41
+ end
42
+ end
@@ -0,0 +1,200 @@
1
+ # Address.unit.rb
2
+ require_relative '../TestFixtures'
3
+ include Lob
4
+ $:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
5
+ require 'api/addresses_api'
6
+ require 'models/address'
7
+ require 'models/address_editable'
8
+
9
+ RSpec.describe "AddressesApi" do
10
+ it "can be instantiated" do
11
+ addressApi = AddressesApi.new()
12
+
13
+ expect(addressApi).not_to be_nil
14
+ expect(addressApi).to be_a_kind_of(AddressesApi)
15
+ end
16
+
17
+ describe "Create" do
18
+ before(:all) do
19
+ @api = TestFixtures.api_client_with_test_key()
20
+ end
21
+
22
+ it "creates a new address" do
23
+ addressApi = AddressesApi.new(@api)
24
+ addressEditable = AddressEditable.new({
25
+ name: "Thing T. Thing",
26
+ address_line1: "1313 CEMETERY LN",
27
+ address_city: "WESTFIELD",
28
+ address_state: "NJ",
29
+ address_zip: "07000",
30
+ })
31
+
32
+ response = addressApi.create(addressEditable)
33
+ adrId = response.id
34
+
35
+ expect(response.address_line1).to eq(addressEditable.address_line1)
36
+
37
+ # delete it afterwards
38
+ addressApi.delete(adrId)
39
+ end
40
+
41
+ it "handles errors returned by the api" do
42
+ addressApi = AddressesApi.new(@api)
43
+ addressEditable = AddressEditable.new()
44
+ begin
45
+ response = addressApi.create(addressEditable)
46
+ rescue => err
47
+ expect(err.message.include? "address_line1 is required").to be(true)
48
+ end
49
+ end
50
+
51
+ it "does not allow creation with invalid key" do
52
+ config = Lob::Configuration.default
53
+ config.username = "fake key"
54
+ badapi = Lob::ApiClient.new(config)
55
+
56
+ addressApi = AddressesApi.new(badapi)
57
+ addressEditable = AddressEditable.new({
58
+ name: "Thing T. Thing",
59
+ address_line1: "1313 CEMETERY LN",
60
+ address_city: "WESTFIELD",
61
+ address_state: "NJ",
62
+ address_zip: "07000",
63
+ })
64
+
65
+ begin
66
+ response = addressApi.create(addressEditable)
67
+ rescue => err
68
+ expect(err.message.include? "Your API key is not valid.").to be(true)
69
+ end
70
+ end
71
+ end
72
+
73
+ describe "Get" do
74
+ before(:all) do
75
+ @api = TestFixtures.api_client_with_test_key()
76
+
77
+ @addressApi = AddressesApi.new(@api)
78
+ addressEditable = AddressEditable.new({
79
+ name: "Thing T. Thing",
80
+ address_line1: "1313 CEMETERY LN",
81
+ address_city: "WESTFIELD",
82
+ address_state: "NJ",
83
+ address_zip: "07000",
84
+ })
85
+
86
+ response = @addressApi.create(addressEditable)
87
+ @addressId = response.id
88
+ end
89
+
90
+ it "retrieves an address" do
91
+ response = @addressApi.get(@addressId)
92
+
93
+ expect(response).not_to be_nil()
94
+ expect(response.id).to eq(@addressId)
95
+ end
96
+
97
+ after(:all) do
98
+ api = TestFixtures.api_client_with_test_key()
99
+ addressApi = AddressesApi.new(api)
100
+ addressApi.delete(@addressId)
101
+ end
102
+ end
103
+
104
+ describe "List" do
105
+ before(:all) do
106
+ @api = TestFixtures.api_client_with_test_key()
107
+ @addressApi = AddressesApi.new(@api)
108
+
109
+ addressEditable1 = AddressEditable.new({
110
+ name: "Thing T. Thing",
111
+ address_line1: "1313 CEMETERY LN",
112
+ address_city: "WESTFIELD",
113
+ address_state: "NJ",
114
+ address_zip: "07000",
115
+ })
116
+
117
+ addressEditable2 = AddressEditable.new({
118
+ name: "FESTER",
119
+ address_line1: "001 CEMETERY LN",
120
+ address_line2: "SUITE 666",
121
+ address_city: "WESTFIELD ",
122
+ address_state: "NJ",
123
+ address_zip: "07000",
124
+ })
125
+
126
+ addressEditable3 = AddressEditable.new({
127
+ name: "MORTICIA ADDAMS",
128
+ address_line1: "1212 CEMETERY LANE",
129
+ address_city: "WESTFIELD",
130
+ address_state: "NJ",
131
+ address_zip: "07000",
132
+ })
133
+
134
+ response1 = @addressApi.create(addressEditable1)
135
+ response2 = @addressApi.create(addressEditable2)
136
+ response3 = @addressApi.create(addressEditable3)
137
+
138
+ @address1Id = response1.id
139
+ @address2Id = response2.id
140
+ @address3Id = response3.id
141
+ end
142
+
143
+ it "lists addresses" do
144
+ response = @addressApi.list()
145
+
146
+ expect(response.data.length()).to be > 0
147
+ end
148
+
149
+ it "lists addresses with after param" do
150
+ response = @addressApi.list()
151
+ responseAfter = @addressApi.list(after: response.getNextPageToken())
152
+ expect(responseAfter.data.length()).to be > 0
153
+ end
154
+
155
+ it "lists addresses with before param" do
156
+ response = @addressApi.list()
157
+ responseAfter = @addressApi.list(before: response.getNextPageToken())
158
+ expect(responseAfter.data.length()).to be > 0
159
+ end
160
+
161
+ it "lists addresses with a limit parameter" do
162
+ response = @addressApi.list(limit: 2)
163
+
164
+ expect(response.data.length()).to be(2)
165
+ end
166
+
167
+ after(:all) do
168
+ api = TestFixtures.api_client_with_test_key()
169
+ addressApi = AddressesApi.new(api)
170
+ addressApi.delete(@address1Id)
171
+ addressApi.delete(@address2Id)
172
+ addressApi.delete(@address3Id)
173
+ end
174
+ end
175
+
176
+ describe "Delete" do
177
+ before(:all) do
178
+ @api = TestFixtures.api_client_with_test_key()
179
+
180
+ @addressApi = AddressesApi.new(@api)
181
+ addressEditable = AddressEditable.new({
182
+ name: "Thing T. Thing",
183
+ address_line1: "1313 CEMETERY LN",
184
+ address_city: "WESTFIELD",
185
+ address_state: "NJ",
186
+ address_zip: "07000",
187
+ })
188
+
189
+ response = @addressApi.create(addressEditable)
190
+ @addressId = response.id
191
+ end
192
+
193
+ it "deletes an address" do
194
+ response = @addressApi.delete(@addressId)
195
+
196
+ expect(response.id).to eq(@addressId)
197
+ expect(response.deleted).to eq(true)
198
+ end
199
+ end
200
+ end