lob 5.1.0 → 6.0.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (471) hide show
  1. checksums.yaml +5 -5
  2. data/CODE_SNIPPETS.md +1871 -0
  3. data/Gemfile +6 -1
  4. data/Gemfile.lock +72 -0
  5. data/LICENSE +21 -0
  6. data/MIGRATION.md +174 -0
  7. data/README.md +70 -154
  8. data/Rakefile +7 -5
  9. data/__tests__/Api/Address.unit.rb +210 -0
  10. data/__tests__/Api/BankAccount.unit.rb +244 -0
  11. data/__tests__/Api/BillingGroup.unit.rb +170 -0
  12. data/__tests__/Api/Card.unit.rb +183 -0
  13. data/__tests__/Api/CardOrder.unit.rb +89 -0
  14. data/__tests__/Api/Check.unit.rb +185 -0
  15. data/__tests__/Api/IntlAutocompletion.unit.rb +43 -0
  16. data/__tests__/Api/IntlVerification.unit.rb +71 -0
  17. data/__tests__/Api/Letter.unit.rb +191 -0
  18. data/__tests__/Api/Postcard.unit.rb +189 -0
  19. data/__tests__/Api/Require.unit.rb +21 -0
  20. data/__tests__/Api/ReverseGeocodeLookup.unit.rb +43 -0
  21. data/__tests__/Api/SelfMailer.unit.rb +190 -0
  22. data/__tests__/Api/Template.unit.rb +165 -0
  23. data/__tests__/Api/TemplateVersion.unit.rb +165 -0
  24. data/__tests__/Api/UsAutocompletion.unit.rb +42 -0
  25. data/__tests__/Api/UsVerification.unit.rb +71 -0
  26. data/__tests__/Api/ZipLookup.unit.rb +42 -0
  27. data/__tests__/Integration/Address.spec.rb +200 -0
  28. data/__tests__/Integration/BankAccount.spec.rb +243 -0
  29. data/__tests__/Integration/BillingGroup.spec.rb +163 -0
  30. data/__tests__/Integration/Card.spec.rb +198 -0
  31. data/__tests__/Integration/CardOrder.spec.rb +122 -0
  32. data/__tests__/Integration/Check.spec.rb +361 -0
  33. data/__tests__/Integration/IntlAutocompletion.spec.rb +54 -0
  34. data/__tests__/Integration/IntlVerification.spec.rb +90 -0
  35. data/__tests__/Integration/Letter.spec.rb +286 -0
  36. data/__tests__/Integration/Postcard.spec.rb +214 -0
  37. data/__tests__/Integration/ReverseGeocodeLookup.spec.rb +30 -0
  38. data/__tests__/Integration/SelfMailer.spec.rb +270 -0
  39. data/__tests__/Integration/Template.spec.rb +221 -0
  40. data/__tests__/Integration/TemplateVersion.spec.rb +275 -0
  41. data/__tests__/Integration/UsAutocompletion.spec.rb +54 -0
  42. data/__tests__/Integration/UsVerification.spec.rb +102 -0
  43. data/__tests__/Integration/ZipLookup.spec.rb +29 -0
  44. data/__tests__/TestFixtures.rb +36 -0
  45. data/docs/Address.md +52 -0
  46. data/docs/AddressDeletion.md +22 -0
  47. data/docs/AddressDomestic.md +40 -0
  48. data/docs/AddressDomesticExpanded.md +40 -0
  49. data/docs/AddressEditable.md +40 -0
  50. data/docs/AddressList.md +28 -0
  51. data/docs/AddressesApi.md +303 -0
  52. data/docs/BankAccount.md +44 -0
  53. data/docs/BankAccountDeletion.md +22 -0
  54. data/docs/BankAccountList.md +28 -0
  55. data/docs/BankAccountVerify.md +18 -0
  56. data/docs/BankAccountWritable.md +28 -0
  57. data/docs/BankAccountsApi.md +376 -0
  58. data/docs/BankTypeEnum.md +15 -0
  59. data/docs/BillingGroup.md +28 -0
  60. data/docs/BillingGroupEditable.md +20 -0
  61. data/docs/BillingGroupList.md +26 -0
  62. data/docs/BillingGroupsApi.md +305 -0
  63. data/docs/Buckslip.md +60 -0
  64. data/docs/BuckslipDeletion.md +20 -0
  65. data/docs/BuckslipEditable.md +24 -0
  66. data/docs/BuckslipOrder.md +42 -0
  67. data/docs/BuckslipOrderEditable.md +18 -0
  68. data/docs/BuckslipOrdersApi.md +157 -0
  69. data/docs/BuckslipOrdersList.md +26 -0
  70. data/docs/BuckslipUpdatable.md +22 -0
  71. data/docs/BuckslipsApi.md +372 -0
  72. data/docs/BuckslipsList.md +28 -0
  73. data/docs/BulkError.md +18 -0
  74. data/docs/BulkErrorProperties.md +20 -0
  75. data/docs/Campaign.md +52 -0
  76. data/docs/CampaignCreative.md +42 -0
  77. data/docs/CampaignDeletion.md +20 -0
  78. data/docs/CampaignUpdatable.md +36 -0
  79. data/docs/CampaignWritable.md +36 -0
  80. data/docs/CampaignsApi.md +376 -0
  81. data/docs/CampaignsList.md +28 -0
  82. data/docs/Card.md +54 -0
  83. data/docs/CardDeletion.md +22 -0
  84. data/docs/CardEditable.md +24 -0
  85. data/docs/CardList.md +28 -0
  86. data/docs/CardOrder.md +42 -0
  87. data/docs/CardOrderEditable.md +18 -0
  88. data/docs/CardOrderList.md +26 -0
  89. data/docs/CardOrdersApi.md +157 -0
  90. data/docs/CardUpdatable.md +22 -0
  91. data/docs/CardsApi.md +372 -0
  92. data/docs/Check.md +68 -0
  93. data/docs/CheckDeletion.md +22 -0
  94. data/docs/CheckEditable.md +48 -0
  95. data/docs/CheckList.md +28 -0
  96. data/docs/ChecksApi.md +315 -0
  97. data/docs/CmpScheduleType.md +15 -0
  98. data/docs/CmpUseType.md +15 -0
  99. data/docs/CountryExtended.md +15 -0
  100. data/docs/CountryExtendedExpanded.md +15 -0
  101. data/docs/CreativePatch.md +22 -0
  102. data/docs/CreativeResponse.md +42 -0
  103. data/docs/CreativeWritable.md +34 -0
  104. data/docs/CreativesApi.md +226 -0
  105. data/docs/CustomEnvelopeReturned.md +22 -0
  106. data/docs/DefaultApi.md +75 -0
  107. data/docs/DeliverabilityAnalysis.md +46 -0
  108. data/docs/DpvFootnote.md +15 -0
  109. data/docs/EngineHtml.md +15 -0
  110. data/docs/EventType.md +24 -0
  111. data/docs/Events.md +28 -0
  112. data/docs/Export.md +32 -0
  113. data/docs/ExportModel.md +18 -0
  114. data/docs/GeocodeAddresses.md +20 -0
  115. data/docs/GeocodeComponents.md +20 -0
  116. data/docs/HTTPValidationError.md +18 -0
  117. data/docs/IdentityValidation.md +34 -0
  118. data/docs/IdentityValidationApi.md +78 -0
  119. data/docs/InlineObject.md +18 -0
  120. data/docs/IntlAutocompletions.md +20 -0
  121. data/docs/IntlAutocompletionsApi.md +82 -0
  122. data/docs/IntlAutocompletionsWritable.md +26 -0
  123. data/docs/IntlComponents.md +26 -0
  124. data/docs/IntlSuggestions.md +30 -0
  125. data/docs/IntlVerification.md +38 -0
  126. data/docs/IntlVerificationOrError.md +40 -0
  127. data/docs/IntlVerificationWritable.md +32 -0
  128. data/docs/IntlVerifications.md +20 -0
  129. data/docs/IntlVerificationsApi.md +153 -0
  130. data/docs/IntlVerificationsPayload.md +18 -0
  131. data/docs/Letter.md +72 -0
  132. data/docs/LetterCustomEnvelope.md +22 -0
  133. data/docs/LetterDeletion.md +22 -0
  134. data/docs/LetterDetailsReturned.md +36 -0
  135. data/docs/LetterDetailsWritable.md +32 -0
  136. data/docs/LetterEditable.md +52 -0
  137. data/docs/LetterList.md +28 -0
  138. data/docs/LettersApi.md +317 -0
  139. data/docs/LobConfidenceScore.md +20 -0
  140. data/docs/LobError.md +22 -0
  141. data/docs/Location.md +20 -0
  142. data/docs/LocationAnalysis.md +22 -0
  143. data/docs/MailType.md +15 -0
  144. data/docs/MultiLineAddress.md +32 -0
  145. data/docs/MultipleComponents.md +30 -0
  146. data/docs/MultipleComponentsIntl.md +30 -0
  147. data/docs/MultipleComponentsList.md +18 -0
  148. data/docs/PlaceholderModel.md +28 -0
  149. data/docs/Postcard.md +60 -0
  150. data/docs/PostcardDeletion.md +22 -0
  151. data/docs/PostcardDetailsReturned.md +26 -0
  152. data/docs/PostcardDetailsWritable.md +20 -0
  153. data/docs/PostcardEditable.md +40 -0
  154. data/docs/PostcardList.md +28 -0
  155. data/docs/PostcardSize.md +15 -0
  156. data/docs/PostcardsApi.md +317 -0
  157. data/docs/QrCode.md +30 -0
  158. data/docs/ReturnEnvelope.md +24 -0
  159. data/docs/ReverseGeocode.md +22 -0
  160. data/docs/ReverseGeocodeLookupsApi.md +82 -0
  161. data/docs/SelfMailer.md +48 -0
  162. data/docs/SelfMailerDeletion.md +22 -0
  163. data/docs/SelfMailerEditable.md +38 -0
  164. data/docs/SelfMailerList.md +28 -0
  165. data/docs/SelfMailerSize.md +15 -0
  166. data/docs/SelfMailersApi.md +317 -0
  167. data/docs/SortBy.md +20 -0
  168. data/docs/SortBy1.md +20 -0
  169. data/docs/SortBy2.md +20 -0
  170. data/docs/SortBy3.md +20 -0
  171. data/docs/SortByDateModified.md +20 -0
  172. data/docs/Suggestions.md +26 -0
  173. data/docs/Template.md +34 -0
  174. data/docs/TemplateDeletion.md +22 -0
  175. data/docs/TemplateList.md +28 -0
  176. data/docs/TemplateUpdate.md +20 -0
  177. data/docs/TemplateVersion.md +36 -0
  178. data/docs/TemplateVersionDeletion.md +22 -0
  179. data/docs/TemplateVersionList.md +28 -0
  180. data/docs/TemplateVersionUpdatable.md +20 -0
  181. data/docs/TemplateVersionWritable.md +22 -0
  182. data/docs/TemplateVersionsApi.md +384 -0
  183. data/docs/TemplateWritable.md +24 -0
  184. data/docs/TemplatesApi.md +376 -0
  185. data/docs/Thumbnail.md +22 -0
  186. data/docs/TrackingEventCertified.md +34 -0
  187. data/docs/TrackingEventDetails.md +24 -0
  188. data/docs/TrackingEventNormal.md +34 -0
  189. data/docs/Upload.md +44 -0
  190. data/docs/UploadCreateExport.md +20 -0
  191. data/docs/UploadFile.md +20 -0
  192. data/docs/UploadState.md +15 -0
  193. data/docs/UploadUpdatable.md +20 -0
  194. data/docs/UploadWritable.md +18 -0
  195. data/docs/UploadsApi.md +584 -0
  196. data/docs/UsAutocompletions.md +22 -0
  197. data/docs/UsAutocompletionsApi.md +78 -0
  198. data/docs/UsAutocompletionsWritable.md +26 -0
  199. data/docs/UsComponents.md +70 -0
  200. data/docs/UsVerification.md +38 -0
  201. data/docs/UsVerificationOrError.md +40 -0
  202. data/docs/UsVerifications.md +20 -0
  203. data/docs/UsVerificationsApi.md +157 -0
  204. data/docs/UsVerificationsWritable.md +32 -0
  205. data/docs/ValidationError.md +22 -0
  206. data/docs/Zip.md +26 -0
  207. data/docs/ZipCodeType.md +15 -0
  208. data/docs/ZipEditable.md +18 -0
  209. data/docs/ZipLookupCity.md +26 -0
  210. data/docs/ZipLookupsApi.md +78 -0
  211. data/git_push.sh +57 -0
  212. data/lib/lob.rb +1 -7
  213. data/lib/openapi_client/api/addresses_api.rb +318 -0
  214. data/lib/openapi_client/api/bank_accounts_api.rb +397 -0
  215. data/lib/openapi_client/api/billing_groups_api.rb +320 -0
  216. data/lib/openapi_client/api/buckslip_orders_api.rb +183 -0
  217. data/lib/openapi_client/api/buckslips_api.rb +385 -0
  218. data/lib/openapi_client/api/campaigns_api.rb +389 -0
  219. data/lib/openapi_client/api/card_orders_api.rb +183 -0
  220. data/lib/openapi_client/api/cards_api.rb +382 -0
  221. data/lib/openapi_client/api/checks_api.rb +337 -0
  222. data/lib/openapi_client/api/creatives_api.rb +244 -0
  223. data/lib/openapi_client/api/default_api.rb +79 -0
  224. data/lib/openapi_client/api/identity_validation_api.rb +90 -0
  225. data/lib/openapi_client/api/intl_autocompletions_api.rb +97 -0
  226. data/lib/openapi_client/api/intl_verifications_api.rb +165 -0
  227. data/lib/openapi_client/api/letters_api.rb +343 -0
  228. data/lib/openapi_client/api/postcards_api.rb +340 -0
  229. data/lib/openapi_client/api/reverse_geocode_lookups_api.rb +101 -0
  230. data/lib/openapi_client/api/self_mailers_api.rb +340 -0
  231. data/lib/openapi_client/api/template_versions_api.rb +440 -0
  232. data/lib/openapi_client/api/templates_api.rb +397 -0
  233. data/lib/openapi_client/api/uploads_api.rb +604 -0
  234. data/lib/openapi_client/api/us_autocompletions_api.rb +90 -0
  235. data/lib/openapi_client/api/us_verifications_api.rb +172 -0
  236. data/lib/openapi_client/api/zip_lookups_api.rb +90 -0
  237. data/lib/openapi_client/api_client.rb +392 -0
  238. data/lib/openapi_client/api_error.rb +57 -0
  239. data/lib/openapi_client/configuration.rb +279 -0
  240. data/lib/openapi_client/models/address.rb +616 -0
  241. data/lib/openapi_client/models/address_deletion.rb +303 -0
  242. data/lib/openapi_client/models/address_domestic.rb +522 -0
  243. data/lib/openapi_client/models/address_domestic_expanded.rb +521 -0
  244. data/lib/openapi_client/models/address_editable.rb +503 -0
  245. data/lib/openapi_client/models/address_list.rb +324 -0
  246. data/lib/openapi_client/models/bank_account.rb +576 -0
  247. data/lib/openapi_client/models/bank_account_deletion.rb +303 -0
  248. data/lib/openapi_client/models/bank_account_list.rb +324 -0
  249. data/lib/openapi_client/models/bank_account_verify.rb +264 -0
  250. data/lib/openapi_client/models/bank_account_writable.rb +387 -0
  251. data/lib/openapi_client/models/bank_type_enum.rb +37 -0
  252. data/lib/openapi_client/models/billing_group.rb +395 -0
  253. data/lib/openapi_client/models/billing_group_editable.rb +278 -0
  254. data/lib/openapi_client/models/billing_group_list.rb +314 -0
  255. data/lib/openapi_client/models/buckslip.rb +814 -0
  256. data/lib/openapi_client/models/buckslip_deletion.rb +257 -0
  257. data/lib/openapi_client/models/buckslip_editable.rb +316 -0
  258. data/lib/openapi_client/models/buckslip_order.rb +438 -0
  259. data/lib/openapi_client/models/buckslip_order_editable.rb +262 -0
  260. data/lib/openapi_client/models/buckslip_orders_list.rb +312 -0
  261. data/lib/openapi_client/models/buckslip_updatable.rb +289 -0
  262. data/lib/openapi_client/models/buckslips_list.rb +324 -0
  263. data/lib/openapi_client/models/bulk_error.rb +229 -0
  264. data/lib/openapi_client/models/bulk_error_properties.rb +274 -0
  265. data/lib/openapi_client/models/campaign.rb +549 -0
  266. data/lib/openapi_client/models/campaign_creative.rb +467 -0
  267. data/lib/openapi_client/models/campaign_deletion.rb +257 -0
  268. data/lib/openapi_client/models/campaign_updatable.rb +341 -0
  269. data/lib/openapi_client/models/campaign_writable.rb +373 -0
  270. data/lib/openapi_client/models/campaigns_list.rb +324 -0
  271. data/lib/openapi_client/models/card.rb +681 -0
  272. data/lib/openapi_client/models/card_deletion.rb +303 -0
  273. data/lib/openapi_client/models/card_editable.rb +318 -0
  274. data/lib/openapi_client/models/card_list.rb +324 -0
  275. data/lib/openapi_client/models/card_order.rb +438 -0
  276. data/lib/openapi_client/models/card_order_editable.rb +261 -0
  277. data/lib/openapi_client/models/card_order_list.rb +273 -0
  278. data/lib/openapi_client/models/card_updatable.rb +289 -0
  279. data/lib/openapi_client/models/check.rb +812 -0
  280. data/lib/openapi_client/models/check_deletion.rb +303 -0
  281. data/lib/openapi_client/models/check_editable.rb +537 -0
  282. data/lib/openapi_client/models/check_list.rb +324 -0
  283. data/lib/openapi_client/models/chk_use_type.rb +38 -0
  284. data/lib/openapi_client/models/cmp_schedule_type.rb +36 -0
  285. data/lib/openapi_client/models/cmp_use_type.rb +38 -0
  286. data/lib/openapi_client/models/country_extended.rb +254 -0
  287. data/lib/openapi_client/models/country_extended_expanded.rb +255 -0
  288. data/lib/openapi_client/models/creative_patch.rb +274 -0
  289. data/lib/openapi_client/models/creative_response.rb +444 -0
  290. data/lib/openapi_client/models/creative_writable.rb +400 -0
  291. data/lib/openapi_client/models/custom_envelope_returned.rb +319 -0
  292. data/lib/openapi_client/models/deliverability_analysis.rb +601 -0
  293. data/lib/openapi_client/models/dpv_footnote.rb +54 -0
  294. data/lib/openapi_client/models/engine_html.rb +37 -0
  295. data/lib/openapi_client/models/event_type.rb +325 -0
  296. data/lib/openapi_client/models/events.rb +365 -0
  297. data/lib/openapi_client/models/export.rb +422 -0
  298. data/lib/openapi_client/models/export_model.rb +262 -0
  299. data/lib/openapi_client/models/geocode_addresses.rb +237 -0
  300. data/lib/openapi_client/models/geocode_components.rb +291 -0
  301. data/lib/openapi_client/models/http_validation_error.rb +230 -0
  302. data/lib/openapi_client/models/identity_validation.rb +460 -0
  303. data/lib/openapi_client/models/inline_object.rb +229 -0
  304. data/lib/openapi_client/models/intl_autocompletions.rb +282 -0
  305. data/lib/openapi_client/models/intl_autocompletions_writable.rb +278 -0
  306. data/lib/openapi_client/models/intl_components.rb +314 -0
  307. data/lib/openapi_client/models/intl_suggestions.rb +372 -0
  308. data/lib/openapi_client/models/intl_verification.rb +463 -0
  309. data/lib/openapi_client/models/intl_verification_or_error.rb +466 -0
  310. data/lib/openapi_client/models/intl_verification_writable.rb +388 -0
  311. data/lib/openapi_client/models/intl_verifications.rb +250 -0
  312. data/lib/openapi_client/models/intl_verifications_payload.rb +263 -0
  313. data/lib/openapi_client/models/letter.rb +737 -0
  314. data/lib/openapi_client/models/letter_custom_envelope.rb +300 -0
  315. data/lib/openapi_client/models/letter_deletion.rb +303 -0
  316. data/lib/openapi_client/models/letter_details_returned.rb +393 -0
  317. data/lib/openapi_client/models/letter_details_writable.rb +390 -0
  318. data/lib/openapi_client/models/letter_editable.rb +532 -0
  319. data/lib/openapi_client/models/letter_list.rb +324 -0
  320. data/lib/openapi_client/models/lob_confidence_score.rb +299 -0
  321. data/lib/openapi_client/models/lob_error.rb +296 -0
  322. data/lib/openapi_client/models/location.rb +289 -0
  323. data/lib/openapi_client/models/location_analysis.rb +305 -0
  324. data/lib/openapi_client/models/ltr_use_type.rb +38 -0
  325. data/lib/openapi_client/models/mail_type.rb +37 -0
  326. data/lib/openapi_client/models/multi_line_address.rb +431 -0
  327. data/lib/openapi_client/models/multiple_components.rb +405 -0
  328. data/lib/openapi_client/models/multiple_components_intl.rb +377 -0
  329. data/lib/openapi_client/models/multiple_components_list.rb +263 -0
  330. data/lib/openapi_client/models/optional_address_column_mapping.rb +259 -0
  331. data/lib/openapi_client/models/placeholder_model.rb +273 -0
  332. data/lib/openapi_client/models/postcard.rb +656 -0
  333. data/lib/openapi_client/models/postcard_deletion.rb +303 -0
  334. data/lib/openapi_client/models/postcard_details_returned.rb +321 -0
  335. data/lib/openapi_client/models/postcard_details_writable.rb +242 -0
  336. data/lib/openapi_client/models/postcard_editable.rb +393 -0
  337. data/lib/openapi_client/models/postcard_list.rb +324 -0
  338. data/lib/openapi_client/models/postcard_size.rb +38 -0
  339. data/lib/openapi_client/models/psc_use_type.rb +38 -0
  340. data/lib/openapi_client/models/qr_code.rb +339 -0
  341. data/lib/openapi_client/models/required_address_column_mapping.rb +285 -0
  342. data/lib/openapi_client/models/return_envelope.rb +258 -0
  343. data/lib/openapi_client/models/reverse_geocode.rb +304 -0
  344. data/lib/openapi_client/models/self_mailer.rb +584 -0
  345. data/lib/openapi_client/models/self_mailer_deletion.rb +303 -0
  346. data/lib/openapi_client/models/self_mailer_editable.rb +384 -0
  347. data/lib/openapi_client/models/self_mailer_list.rb +324 -0
  348. data/lib/openapi_client/models/self_mailer_size.rb +38 -0
  349. data/lib/openapi_client/models/sfm_use_type.rb +38 -0
  350. data/lib/openapi_client/models/sort_by.rb +283 -0
  351. data/lib/openapi_client/models/sort_by1.rb +283 -0
  352. data/lib/openapi_client/models/sort_by2.rb +283 -0
  353. data/lib/openapi_client/models/sort_by3.rb +283 -0
  354. data/lib/openapi_client/models/sort_by_date_modified.rb +283 -0
  355. data/lib/openapi_client/models/suggestions.rb +343 -0
  356. data/lib/openapi_client/models/template.rb +406 -0
  357. data/lib/openapi_client/models/template_deletion.rb +303 -0
  358. data/lib/openapi_client/models/template_list.rb +324 -0
  359. data/lib/openapi_client/models/template_update.rb +272 -0
  360. data/lib/openapi_client/models/template_version.rb +423 -0
  361. data/lib/openapi_client/models/template_version_deletion.rb +303 -0
  362. data/lib/openapi_client/models/template_version_list.rb +324 -0
  363. data/lib/openapi_client/models/template_version_updatable.rb +257 -0
  364. data/lib/openapi_client/models/template_version_writable.rb +291 -0
  365. data/lib/openapi_client/models/template_writable.rb +309 -0
  366. data/lib/openapi_client/models/thumbnail.rb +300 -0
  367. data/lib/openapi_client/models/tracking_event_certified.rb +419 -0
  368. data/lib/openapi_client/models/tracking_event_details.rb +308 -0
  369. data/lib/openapi_client/models/tracking_event_normal.rb +409 -0
  370. data/lib/openapi_client/models/upload.rb +498 -0
  371. data/lib/openapi_client/models/upload_create_export.rb +283 -0
  372. data/lib/openapi_client/models/upload_file.rb +283 -0
  373. data/lib/openapi_client/models/upload_state.rb +42 -0
  374. data/lib/openapi_client/models/upload_updatable.rb +267 -0
  375. data/lib/openapi_client/models/upload_writable.rb +271 -0
  376. data/lib/openapi_client/models/uploads_metadata.rb +237 -0
  377. data/lib/openapi_client/models/us_autocompletions.rb +328 -0
  378. data/lib/openapi_client/models/us_autocompletions_writable.rb +274 -0
  379. data/lib/openapi_client/models/us_components.rb +788 -0
  380. data/lib/openapi_client/models/us_verification.rb +461 -0
  381. data/lib/openapi_client/models/us_verification_or_error.rb +459 -0
  382. data/lib/openapi_client/models/us_verifications.rb +250 -0
  383. data/lib/openapi_client/models/us_verifications_writable.rb +421 -0
  384. data/lib/openapi_client/models/validation_error.rb +263 -0
  385. data/lib/openapi_client/models/zip.rb +363 -0
  386. data/lib/openapi_client/models/zip_code_type.rb +40 -0
  387. data/lib/openapi_client/models/zip_editable.rb +246 -0
  388. data/lib/openapi_client/models/zip_lookup_city.rb +331 -0
  389. data/lib/openapi_client/version.rb +15 -0
  390. data/lib/openapi_client.rb +212 -0
  391. data/openapi_client.gemspec +37 -0
  392. data/spec/api/addresses_api_spec.rb +88 -0
  393. data/spec/api/bank_accounts_api_spec.rb +101 -0
  394. data/spec/api/billing_groups_api_spec.rb +89 -0
  395. data/spec/api/campaigns_api_spec.rb +100 -0
  396. data/spec/api/card_orders_api_spec.rb +62 -0
  397. data/spec/api/cards_api_spec.rb +99 -0
  398. data/spec/api/checks_api_spec.rb +93 -0
  399. data/spec/api/creatives_api_spec.rb +73 -0
  400. data/spec/api/default_api_spec.rb +46 -0
  401. data/spec/api/identity_validation_api_spec.rb +47 -0
  402. data/spec/api/intl_autocompletions_api_spec.rb +48 -0
  403. data/spec/api/intl_verifications_api_spec.rb +60 -0
  404. data/spec/api/letters_api_spec.rb +94 -0
  405. data/spec/api/postcards_api_spec.rb +94 -0
  406. data/spec/api/reverse_geocode_lookups_api_spec.rb +48 -0
  407. data/spec/api/self_mailers_api_spec.rb +94 -0
  408. data/spec/api/template_versions_api_spec.rb +105 -0
  409. data/spec/api/templates_api_spec.rb +101 -0
  410. data/spec/api/uploads_api_spec.rb +135 -0
  411. data/spec/api/us_autocompletions_api_spec.rb +47 -0
  412. data/spec/api/us_verifications_api_spec.rb +61 -0
  413. data/spec/api/zip_lookups_api_spec.rb +47 -0
  414. data/spec/api_client_spec.rb +226 -0
  415. data/spec/configuration_spec.rb +42 -0
  416. data/spec/spec_helper.rb +107 -13
  417. metadata +452 -140
  418. data/.gitignore +0 -18
  419. data/.travis.yml +0 -16
  420. data/CHANGELOG.md +0 -114
  421. data/CONTRIBUTING.md +0 -19
  422. data/LICENSE.txt +0 -22
  423. data/examples/README.md +0 -33
  424. data/examples/checks.rb +0 -48
  425. data/examples/csv_checks/create_checks.rb +0 -47
  426. data/examples/csv_checks/input.csv +0 -6
  427. data/examples/csv_letters/create_letters.rb +0 -40
  428. data/examples/csv_letters/input.csv +0 -6
  429. data/examples/csv_letters/letter_template.html +0 -33
  430. data/examples/csv_postcards/create_postcards.rb +0 -45
  431. data/examples/csv_postcards/input.csv +0 -7
  432. data/examples/csv_postcards/postcard_back.html +0 -38
  433. data/examples/csv_postcards/postcard_front.html +0 -25
  434. data/examples/csv_verify/input.csv +0 -7
  435. data/examples/csv_verify/verify.rb +0 -36
  436. data/examples/letters.rb +0 -72
  437. data/examples/postcards.rb +0 -86
  438. data/lib/lob/client.rb +0 -71
  439. data/lib/lob/errors/invalid_request_error.rb +0 -4
  440. data/lib/lob/errors/lob_error.rb +0 -20
  441. data/lib/lob/resources/address.rb +0 -14
  442. data/lib/lob/resources/bank_account.rb +0 -30
  443. data/lib/lob/resources/check.rb +0 -14
  444. data/lib/lob/resources/group.rb +0 -14
  445. data/lib/lob/resources/groups_member.rb +0 -66
  446. data/lib/lob/resources/intl_verifications.rb +0 -26
  447. data/lib/lob/resources/letter.rb +0 -14
  448. data/lib/lob/resources/postcard.rb +0 -14
  449. data/lib/lob/resources/resource_base.rb +0 -139
  450. data/lib/lob/resources/us_autocompletions.rb +0 -26
  451. data/lib/lob/resources/us_verifications.rb +0 -27
  452. data/lib/lob/resources/us_zip_lookups.rb +0 -26
  453. data/lib/lob/version.rb +0 -3
  454. data/lob.gemspec +0 -28
  455. data/spec/lob/errors/lob_error_spec.rb +0 -19
  456. data/spec/lob/resources/address_spec.rb +0 -55
  457. data/spec/lob/resources/bank_account_spec.rb +0 -60
  458. data/spec/lob/resources/check_spec.rb +0 -98
  459. data/spec/lob/resources/group_spec.rb +0 -50
  460. data/spec/lob/resources/intl_verifications_spec.rb +0 -28
  461. data/spec/lob/resources/letter_spec.rb +0 -94
  462. data/spec/lob/resources/member_spec.rb +0 -65
  463. data/spec/lob/resources/postcard_spec.rb +0 -135
  464. data/spec/lob/resources/resource_base_spec.rb +0 -75
  465. data/spec/lob/resources/us_autocompletions_spec.rb +0 -24
  466. data/spec/lob/resources/us_verifications_spec.rb +0 -31
  467. data/spec/lob/resources/us_zip_lookups_spec.rb +0 -23
  468. data/spec/lob_spec.rb +0 -48
  469. data/spec/samples/8.5x11.pdf +0 -0
  470. data/spec/samples/postcardback.pdf +2 -2287
  471. data/spec/samples/postcardfront.pdf +1 -1549
data/Gemfile CHANGED
@@ -1,4 +1,9 @@
1
1
  source 'https://rubygems.org'
2
2
 
3
- # Specify your gem's dependencies in lob.gemspec
4
3
  gemspec
4
+
5
+ group :development, :test do
6
+ gem 'rake', '~> 13.0.1'
7
+ gem 'pry-byebug'
8
+ gem 'rubocop', '~> 0.66.0'
9
+ end
data/Gemfile.lock ADDED
@@ -0,0 +1,72 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ lob (6.0.5)
5
+ typhoeus (~> 1.0, >= 1.0.1)
6
+
7
+ GEM
8
+ remote: https://rubygems.org/
9
+ specs:
10
+ ast (2.4.2)
11
+ byebug (11.1.3)
12
+ coderay (1.1.3)
13
+ diff-lcs (1.5.0)
14
+ ethon (0.16.0)
15
+ ffi (>= 1.15.0)
16
+ ffi (1.16.3)
17
+ jaro_winkler (1.5.6)
18
+ method_source (1.0.0)
19
+ parallel (1.23.0)
20
+ parser (3.2.2.4)
21
+ ast (~> 2.4.1)
22
+ racc
23
+ pry (0.14.2)
24
+ coderay (~> 1.1)
25
+ method_source (~> 1.0)
26
+ pry-byebug (3.10.1)
27
+ byebug (~> 11.0)
28
+ pry (>= 0.13, < 0.15)
29
+ psych (5.1.1.1)
30
+ stringio
31
+ racc (1.7.3)
32
+ rainbow (3.1.1)
33
+ rake (13.0.6)
34
+ rspec (3.12.0)
35
+ rspec-core (~> 3.12.0)
36
+ rspec-expectations (~> 3.12.0)
37
+ rspec-mocks (~> 3.12.0)
38
+ rspec-core (3.12.2)
39
+ rspec-support (~> 3.12.0)
40
+ rspec-expectations (3.12.3)
41
+ diff-lcs (>= 1.2.0, < 2.0)
42
+ rspec-support (~> 3.12.0)
43
+ rspec-mocks (3.12.6)
44
+ diff-lcs (>= 1.2.0, < 2.0)
45
+ rspec-support (~> 3.12.0)
46
+ rspec-support (3.12.1)
47
+ rubocop (0.66.0)
48
+ jaro_winkler (~> 1.5.1)
49
+ parallel (~> 1.10)
50
+ parser (>= 2.5, != 2.5.1.1)
51
+ psych (>= 3.1.0)
52
+ rainbow (>= 2.2.2, < 4.0)
53
+ ruby-progressbar (~> 1.7)
54
+ unicode-display_width (>= 1.4.0, < 1.6)
55
+ ruby-progressbar (1.13.0)
56
+ stringio (3.0.9)
57
+ typhoeus (1.4.0)
58
+ ethon (>= 0.9.0)
59
+ unicode-display_width (1.5.0)
60
+
61
+ PLATFORMS
62
+ x86_64-linux
63
+
64
+ DEPENDENCIES
65
+ lob!
66
+ pry-byebug
67
+ rake (~> 13.0.1)
68
+ rspec (~> 3.6, >= 3.6.0)
69
+ rubocop (~> 0.66.0)
70
+
71
+ BUNDLED WITH
72
+ 2.4.22
data/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2022 Lob
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
data/MIGRATION.md ADDED
@@ -0,0 +1,174 @@
1
+ # Migrate from version < v6.0.0
2
+
3
+ This guide illustrates differences between Lob’s the legacy versions of this SDK and the new current version.
4
+
5
+ In this guide we compare how `v5.*.*` and >= `v6.0.0` implement the following method pattern.
6
+
7
+ - CREATE
8
+ - LIST
9
+ - GET
10
+ - DELETE
11
+ - VERIFY (BANK ACCOUNTS)
12
+ - UPDATE
13
+
14
+ ## INSTALL
15
+
16
+ Similar to the legacy version, the new lob-ruby SDK is available through `gem`:
17
+
18
+ ```
19
+ $ gem install lob
20
+ ```
21
+
22
+ ## IMPORT AND INITIALIZE
23
+
24
+
25
+ ```ruby
26
+ require 'lob'
27
+ config = Lob::Configuration.default
28
+ config.username = ENV['LOB_API_TEST_KEY']
29
+ ```
30
+ You then instantiate the specific resource API that you need access to as follows:
31
+
32
+ ```ruby
33
+ api = Lob::ApiClient.new(config)
34
+ addressApi = AddressesApi.new(@api)
35
+
36
+ ```
37
+
38
+ ## METHODS
39
+
40
+ The new SDK version abstracts the request/response interaction out of the calling code such that you create the resource and pass it to the corresponding API in a begin/rescue such that any non-success is an `ApiException` that must be handled.
41
+
42
+ ### COMPARE CREATE METHODS
43
+
44
+ Here is a sample of the legacy lob-ruby CREATE function:
45
+
46
+ ```ruby
47
+ @lob.addresses.create(
48
+ description: 'Harry - Office',
49
+ name: 'Harry Zhang',
50
+ company: 'Lob',
51
+ email: 'harry@lob.com',
52
+ phone: '5555555555',
53
+ address_line1: '210 King St',
54
+ address_line2: '# 6100',
55
+ address_city: 'San Francisco',
56
+ address_state: 'CA',
57
+ address_country: 'US',
58
+ address_zip: '94107'
59
+ )
60
+ ```
61
+
62
+ Here is a sample of the updated CREATE method
63
+
64
+ ```ruby
65
+ addressEditable = AddressEditable.new({
66
+ name: 'Thing T. Thing',
67
+ address_line1: '1313 CEMETERY LN',
68
+ address_city: 'WESTFIELD',
69
+ address_state: 'NJ',
70
+ address_zip: '07000',
71
+ })
72
+
73
+ begin
74
+ response = @addressApi.create(addressEditable)
75
+ rescue => e
76
+ puts 'An error of has occcured, message is #{e.message}'
77
+ end
78
+ ```
79
+
80
+ ### COMPARE LIST METHODS
81
+
82
+ Here is a sample of the legacy lob-ruby LIST method:
83
+
84
+ ```ruby
85
+ @lob.addresses.list(limit: 2)
86
+ ```
87
+
88
+ Here is a sample of the updated LIST method:
89
+
90
+ ```ruby
91
+ begin
92
+ response = @addressApi.list()
93
+ rescue => e
94
+ puts 'An error of has occcured, message is #{e.message}'
95
+ end
96
+ ```
97
+
98
+ ### COMPARE GET BY ID METHOD
99
+
100
+ Here is a sample of the legacy lob-ruby GET method:
101
+
102
+ ```ruby
103
+ @lob.addresses.find('adr_xxx')
104
+
105
+ ```
106
+
107
+ Here is a sample of the updated GET method:
108
+
109
+ ```ruby
110
+ begin
111
+ response = @addressApi.get('adr_xxx')
112
+ rescue => e
113
+ puts 'An error of has occcured, message is #{e.message}'
114
+ end
115
+ ```
116
+
117
+ ### COMPARE DELETE METHOD
118
+
119
+ Here is a sample of the legacy lob-ruby DELETE method:
120
+
121
+ ```ruby
122
+ @lob.addresses.destroy('adr_xxx')
123
+ ```
124
+
125
+ Here is a sample of the updated DELETE method:
126
+
127
+ ```ruby
128
+ begin
129
+ response = @addressApi.delete('adr_xxx')
130
+ rescue => e
131
+ puts 'An error of has occcured, message is #{e.message}'
132
+ end
133
+ ```
134
+
135
+ ### COMPARE BANK ACCOUNT VERIFY
136
+
137
+ Here is a sample of the legacy lob-ruby BANK ACCOUNT VERIFY method:
138
+
139
+ ```ruby
140
+ @lob.bank_accounts.verify('bank_xxx', amounts: [25, 63])
141
+ ```
142
+
143
+ Here is a sample of the updated BANK ACCOUNT VERIFY method:
144
+
145
+ ```ruby
146
+ bankVerify = BankAccountVerify.new({ 'amounts': [11, 35] })
147
+ begin
148
+ response = @bankAccountApi.verify('bank_xxx', bankVerify)
149
+ rescue => e
150
+ puts 'An error of has occcured, message is #{e.message}'
151
+ end
152
+ ```
153
+
154
+ ### COMPARE UPDATE METHOD
155
+
156
+ Here is a sample of the legacy lob-ruby UPDATE method:
157
+
158
+ ```ruby
159
+ This feature was not supported by the legacy library.
160
+ ```
161
+
162
+ Here is a sample of the updated UPDATE method:
163
+
164
+ ```ruby
165
+ updatableTemplate = TemplateUpdate.new({
166
+ description: 'Updated template for Ruby Integration Test'
167
+ })
168
+
169
+ begin
170
+ updatedTemplate = @templateApi.update('tmpl_xxxx', updatableTemplate)
171
+ rescue => e
172
+ puts 'An error of has occcured, message is #{e.message}'
173
+ end
174
+ ```
data/README.md CHANGED
@@ -1,196 +1,112 @@
1
- # lob-ruby
1
+ # lob-ruby-sdk
2
+ 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.
2
3
 
3
- [![Build Status](https://travis-ci.org/lob/lob-ruby.svg?branch=master)](https://travis-ci.org/lob/lob-ruby)
4
- [![Gem Version](https://badge.fury.io/rb/lob.svg)](https://badge.fury.io/rb/lob)
5
- [![Coverage Status](https://coveralls.io/repos/lob/lob-ruby/badge.svg?branch=master)](https://coveralls.io/r/lob/lob-ruby?branch=master)
6
- [![Downloads](https://ruby-gem-downloads-badge.herokuapp.com/lob?color=green&type=total)](https://rubygems.org/gems/lob)
4
+ This Ruby package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
7
5
 
8
- Ruby wrapper for the [Lob.com](https://lob.com) API. See the full Lob.com [API Documentation](https://lob.com/docs/ruby). For best results, be sure that you're using [the latest version](https://lob.com/docs/ruby#version) of the Lob API and the latest version of the ruby wrapper. This gem gives you an ActiveRecord-style syntax to use the Lob.com API.
6
+ - API version: 1.3.0
7
+ - Package version: 1.0.0
8
+ - Build package: org.openapitools.codegen.languages.RubyClientCodegen
9
+ For more information, please visit [https://support.lob.com/](https://support.lob.com/)
9
10
 
10
- Supports Ruby 2.0.0 and greater.
11
+ ## Requirements
11
12
 
12
- ## Table of Contents
13
-
14
- - [Getting Started](#getting-started)
15
- - [Registration](#registration)
16
- - [Installation](#installation)
17
- - [Usage](#usage)
18
- - [Examples](#examples)
19
- - [API Documentation](#api-documentation)
20
- - [Contributing](#contributing)
21
- - [Testing](#testing)
13
+ Ruby
22
14
 
23
15
  ## Getting Started
24
16
 
25
- Here's a general overview of the Lob services available, click through to read more.
26
-
27
- - [Postcards API](https://lob.com/services/postcards)
28
- - [Letters API](https://lob.com/services/letters)
29
- - [Checks API](https://lob.com/services/checks)
30
- - [Address Verification API](https://lob.com/services/verifications)
31
-
32
- Please read through the official [API Documentation](#api-documentation) to get a complete sense of what to expect from each endpoint.
33
-
34
17
  ### Registration
35
18
 
36
19
  First, you will need to first create an account at [Lob.com](https://dashboard.lob.com/#/register) and obtain your Test and Live API Keys.
37
20
 
38
21
  Once you have created an account, you can access your API Keys from the [Settings Panel](https://dashboard.lob.com/#/settings).
39
22
 
40
- ### Installation
41
-
42
- Add this line to your application's `Gemfile`:
43
-
44
- gem 'lob'
45
-
46
- And then execute:
47
-
48
- $ bundle
23
+ ### Installation & Usage
49
24
 
50
- Or manually install it yourself:
51
-
52
- $ gem install lob
53
-
54
- ### Usage
55
-
56
- The library uses an ActiveRecord-style interface. You'll feel right at home.
57
-
58
- For optional parameters and other details, refer to the docs [here](https://lob.com/docs/ruby).
59
-
60
- #### Initialization and Configuration
25
+ Install with the appropriate [package manager](https://www.ruby-lang.org/en/documentation/installation/#winget).
61
26
 
27
+ Then add Lob's Ruby SDK to your Gemfile
62
28
  ```ruby
63
- # To initialize a Lob object
64
- lob = Lob::Client.new(api_key: "your-api-key")
65
-
66
- # To initialize a Lob object with an older API version
67
- lob = Lob::Client.new(api_key: "your-api-key", api_version: "2014-12-18")
29
+ gem install 'lob'
68
30
  ```
69
31
 
70
- #### Caution: Pass zero-prefixed zip codes as strings
32
+ ## First API Call
71
33
 
72
- When using zip codes with zero-prefixes, always quote them. For example when specifying `02125`, pass it as a string `"02125"`, instead of an integer.
73
-
74
- The Ruby interpreter interprets a number with a leading zero as an octal (i.e., base-8) number and converts it to a base-10 number. Thus `01000` is converted to the base-10 value `512` (since `8*8*8=512`). So not quoting might result in an entirely different zip-code than intended.
34
+ ```ruby
35
+ require 'lob'
36
+
37
+ config = Lob::Configuration.default
38
+ config.username = ENV['LOB_API_TEST_KEY']
39
+
40
+ apiInstance = Lob::AddressesApi.new
41
+ addressEditable = Lob::AddressEditable.new({
42
+ description: "Harry - Office",
43
+ name: "Harry Zhang",
44
+ company: "Lob",
45
+ email: "harry@lob.com",
46
+ phone: "5555555555",
47
+ address_line1: "210 King St",
48
+ address_line2: "# 6100",
49
+ address_city: "San Francisco",
50
+ address_state: "CA",
51
+ address_zip: "94107",
52
+ address_country: "US",
53
+ });
75
54
 
76
- #### Accessing Response Headers
55
+ begin
56
+ #create
57
+ result = apiInstance.create(addressEditable)
58
+ p result
59
+ rescue Lob::ApiError => e
60
+ puts "Exception when calling AddressesApi->create: #{e}"
61
+ end
62
+ ```
77
63
 
78
- You can access response headers via a hidden `headers` method on the response hash.
64
+ ## API Documentation
79
65
 
80
- ```ruby
81
- addresses = lob.addresses.list
66
+ The full and comprehensive documentation of Lob's APIs is available [here](https://docs.lob.com/).
82
67
 
83
- addresses._response.headers[:content_type]
84
- # => "application/json; charset=utf-8"
68
+ ## Testing
85
69
 
86
- addresses._response.headers[:rate_limit_window]
87
- # => "60"
70
+ First, install [RSpec](https://rspec.info/) to run the tests. This can be done by running either of the following lines on your command line depending on whether you use Bundler:
71
+ ```shell
72
+ $ bundle add rspec # with Bundler
88
73
 
89
- addresses._response.headers[:rate_limit_remaining]
90
- # => "1234"
74
+ $ gem install rspec # without Bundler
91
75
  ```
92
76
 
93
- You can also access headers from `Lob::InvalidRequestError`s.
77
+ ### Unit Tests
94
78
 
95
- ```ruby
96
- begin
97
- lob.objects.create(name: "Test", file: "https://s3-us-west-2.amazonaws.com/public.lob.com/assets/incorrect_size.pdf", bad_param: "bad_value")
98
- rescue Lob::InvalidRequestError => e
99
- e._response.headers[:content_type]
100
- # => "application/json; charset=utf-8"
101
- end
79
+ ```bash
80
+ $ rspec -P __tests__/Api/* --color --format doc
102
81
  ```
103
82
 
104
- ## Examples
105
-
106
- We've provided various examples for you to try out [here](https://github.com/lob/lob-ruby/tree/master/examples).
83
+ ### Integration Tests
107
84
 
108
- There are simple scripts to demonstrate how to create all the core Lob objects (checks, letters, postcards. etc.) as well as more complex examples that utilize other libraries and external files.
85
+ Integration tests run against a live deployment of the Lob API and require multiple valid API keys with access to specific features. As such, it is not expected that these tests will pass for every user in every environment.
109
86
 
110
- ## API Documentation
87
+ To run integration tests:
111
88
 
112
- - [Introduction](https://lob.com/docs/ruby#introduction)
113
- - [Versioning](https://lob.com/docs/ruby#version)
114
- - [Errors](https://lob.com/docs/ruby#errors)
115
- - [Rate Limiting](https://lob.com/docs/ruby#rate-limits)
116
- - [Webhooks](https://lob.com/docs/ruby#webhooks)
117
- - [Cancellation Windows](https://lob.com/docs/ruby#cancellation)
118
- - [Scheduled Mailings](https://lob.com/docs/ruby#scheduled)
119
- - [Metadata](https://lob.com/docs/ruby#metadata)
120
- - [HTML Templates](https://lob.com/docs/ruby#templates)
121
- - [Asset URLs](https://lob.com/docs/ruby#urls)
122
- - **Addresses**
123
- - [Address Book](https://lob.com/docs/ruby#addresses)
124
- - [The Address Object](https://lob.com/docs/ruby#addresses_object)
125
- - [Create an Address](https://lob.com/docs/ruby#addresses_create)
126
- - [Retrieve an Address](https://lob.com/docs/ruby#addresses_retrieve)
127
- - [Delete an Address](https://lob.com/docs/ruby#addresses_delete)
128
- - [List all Addresses](https://lob.com/docs/ruby#addresses_list)
129
- - **US Verification API**
130
- - [US Verification API](https://lob.com/docs/ruby#us_verifications)
131
- - [The US Verification Object](https://lob.com/docs/ruby#us_verifications_object)
132
- - [Verify a US Address](https://lob.com/docs/ruby#us_verifications_create)
133
- - [The US Zip Lookup Object](https://lob.com/docs/ruby#us_zip_lookups_object)
134
- - [Lookup a US Zip Code](https://lob.com/docs/ruby#us_zip_lookups_create)
135
- - [US Autocompletion API](https://lob.com/docs/ruby#us_autocompletions)
136
- - [The US Autocompletion Object](https://lob.com/docs/ruby#us_autocompletions_object)
137
- - [Autocomplete a US Address](https://lob.com/docs/ruby#us_autocompletions_create)
138
- - [The US Autocompletion Test Environment](https://lob.com/docs/ruby#us-autocompletions-test-environment)
139
- - **Int'l Verification API**
140
- - [International Verifications](https://lob.com/docs/ruby#intl_verifications)
141
- - [Verify an International Address](https://lob.com/docs/ruby#intl_verifications_create)
142
- - **Postcards API**
143
- - [Postcards](https://lob.com/docs/ruby#postcards)
144
- - [The Postcard Object](https://lob.com/docs/ruby#postcards_object)
145
- - [Create a Postcard](https://lob.com/docs/ruby#postcards_create)
146
- - [Retrieve a Postcard](https://lob.com/docs/ruby#postcards_retrieve)
147
- - [Cancel a Postcard](https://lob.com/docs/ruby#postcards_delete)
148
- - [List all Postcards](https://lob.com/docs/ruby#postcards_list)
149
- - **Letters API**
150
- - [Letters](https://lob.com/docs/ruby#letters)
151
- - [The Letter Object](https://lob.com/docs/ruby#letters_object)
152
- - [Create a Letter](https://lob.com/docs/ruby#letters_create)
153
- - [Retrieve a Letter](https://lob.com/docs/ruby#letters_retrieve)
154
- - [Cancel a Letter](https://lob.com/docs/ruby#letters_delete)
155
- - [List all Letters](https://lob.com/docs/ruby#letters_list)
156
- - **Checks API**
157
- - [Checks](https://lob.com/docs/ruby#checks)
158
- - [The Check Object](https://lob.com/docs/ruby#checks_object)
159
- - [Create a Check](https://lob.com/docs/ruby#checks_create)
160
- - [Retrieve a Check](https://lob.com/docs/ruby#checks_retrieve)
161
- - [Cancel a Check](https://lob.com/docs/ruby#checks_delete)
162
- - [List all Checks](https://lob.com/docs/ruby#checks_list)
163
- - [Bank Accounts](https://lob.com/docs/ruby#bank-accounts)
164
- - [The Bank Account Object](https://lob.com/docs/ruby#bankaccounts_object)
165
- - [Create a Bank Account](https://lob.com/docs/ruby#bankaccounts_create)
166
- - [Retrieve a Bank Account](https://lob.com/docs/ruby#bankaccounts_retrieve)
167
- - [Delete a Bank Account](https://lob.com/docs/ruby#bankaccounts_delete)
168
- - [Verify a Bank Account](https://lob.com/docs/ruby#bankaccounts_verify)
169
- - [List all Bank Accounts](https://lob.com/docs/ruby#bankaccounts_list)
170
- - **Appendix**
171
- - [API Changelog](https://lob.com/docs/ruby#changelog)
172
- - [The Tracking Event Object](https://lob.com/docs/ruby#tracking_event_object)
173
- - [Events](https://lob.com/docs/ruby#events)
174
- - [HTML Examples](https://lob.com/docs/ruby#html-examples)
175
- - [Image Prepping](https://lob.com/docs/ruby#prepping)
176
- - [US Verification Details](https://lob.com/docs/ruby#us_verification_details)
177
-
178
- ## Contributing
179
-
180
- To contribute, please see the [CONTRIBUTING.md](CONTRIBUTING.md) file.
89
+ ```bash
90
+ $ LOB_API_TEST_KEY=<<YOUR TEST KEY>> LOB_API_LIVE_KEY=<<YOUR LIVE KEY>> rspec -P __tests__/Integration/* --color --format doc
91
+ ```
181
92
 
182
- ## Testing
93
+ #### A cleaner alternative if you are going to run integration tests frequently
183
94
 
184
- Tests are written using MiniTest, a testing library that comes with Ruby stdlib.
95
+ Run this the first time:
185
96
 
186
- Here's how you can run the tests:
97
+ ```bash
98
+ $ echo "LOB_API_TEST_KEY=<<YOUR TEST KEY>> LOB_API_LIVE_KEY=<<YOUR LIVE KEY>>" > LOCAL.env
99
+ ```
187
100
 
188
- bundle exec rake test
101
+ Then, to run the integration tests:
189
102
 
190
- You can also configure, TravisCI for your fork of the repository and it'll run the tests for you, when you push.
103
+ ```bash
104
+ $ env $(cat LOCAL.env) rspec -P __tests__/Integration/* --color --format doc
105
+ ```
191
106
 
192
107
  =======================
193
108
 
194
- Copyright &copy; 2016 Lob.com
109
+ Copyright © 2022 Lob.com
110
+
111
+ Released under the MIT License, which can be found in the repository in [LICENSE.txt](https://github.com/lob/lob-go/blob/main/LICENSE.txt).
195
112
 
196
- Released under the MIT License, which can be found in the repository in `LICENSE.txt`.
data/Rakefile CHANGED
@@ -1,8 +1,10 @@
1
1
  require "bundler/gem_tasks"
2
- require "rake/testtask"
3
2
 
4
- Rake::TestTask.new do |t|
5
- t.libs.push "lib", "spec"
6
- t.test_files = FileList['spec/**/*_spec.rb']
7
- t.verbose = true
3
+ begin
4
+ require 'rspec/core/rake_task'
5
+
6
+ RSpec::Core::RakeTask.new(:spec)
7
+ task default: :spec
8
+ rescue LoadError
9
+ # no rspec available
8
10
  end