lob 5.4.6 → 6.0.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (496) hide show
  1. checksums.yaml +4 -4
  2. data/CODE_SNIPPETS.md +1871 -0
  3. data/Gemfile +6 -1
  4. data/Gemfile.lock +72 -0
  5. data/LICENSE +21 -0
  6. data/MIGRATION.md +174 -0
  7. data/README.md +70 -97
  8. data/Rakefile +7 -5
  9. data/__tests__/Api/Address.unit.rb +210 -0
  10. data/__tests__/Api/BankAccount.unit.rb +244 -0
  11. data/__tests__/Api/BillingGroup.unit.rb +170 -0
  12. data/__tests__/Api/Card.unit.rb +183 -0
  13. data/__tests__/Api/CardOrder.unit.rb +89 -0
  14. data/__tests__/Api/Check.unit.rb +185 -0
  15. data/__tests__/Api/IntlAutocompletion.unit.rb +43 -0
  16. data/__tests__/Api/IntlVerification.unit.rb +71 -0
  17. data/__tests__/Api/Letter.unit.rb +191 -0
  18. data/__tests__/Api/Postcard.unit.rb +189 -0
  19. data/__tests__/Api/Require.unit.rb +21 -0
  20. data/__tests__/Api/ReverseGeocodeLookup.unit.rb +43 -0
  21. data/__tests__/Api/SelfMailer.unit.rb +190 -0
  22. data/__tests__/Api/Template.unit.rb +165 -0
  23. data/__tests__/Api/TemplateVersion.unit.rb +165 -0
  24. data/__tests__/Api/UsAutocompletion.unit.rb +42 -0
  25. data/__tests__/Api/UsVerification.unit.rb +71 -0
  26. data/__tests__/Api/ZipLookup.unit.rb +42 -0
  27. data/__tests__/Integration/Address.spec.rb +200 -0
  28. data/__tests__/Integration/BankAccount.spec.rb +243 -0
  29. data/__tests__/Integration/BillingGroup.spec.rb +163 -0
  30. data/__tests__/Integration/Card.spec.rb +198 -0
  31. data/__tests__/Integration/CardOrder.spec.rb +122 -0
  32. data/__tests__/Integration/Check.spec.rb +361 -0
  33. data/__tests__/Integration/IntlAutocompletion.spec.rb +54 -0
  34. data/__tests__/Integration/IntlVerification.spec.rb +90 -0
  35. data/__tests__/Integration/Letter.spec.rb +286 -0
  36. data/__tests__/Integration/Postcard.spec.rb +214 -0
  37. data/__tests__/Integration/ReverseGeocodeLookup.spec.rb +30 -0
  38. data/__tests__/Integration/SelfMailer.spec.rb +270 -0
  39. data/__tests__/Integration/Template.spec.rb +221 -0
  40. data/__tests__/Integration/TemplateVersion.spec.rb +275 -0
  41. data/__tests__/Integration/UsAutocompletion.spec.rb +54 -0
  42. data/__tests__/Integration/UsVerification.spec.rb +102 -0
  43. data/__tests__/Integration/ZipLookup.spec.rb +29 -0
  44. data/__tests__/TestFixtures.rb +36 -0
  45. data/docs/Address.md +52 -0
  46. data/docs/AddressDeletion.md +22 -0
  47. data/docs/AddressDomestic.md +40 -0
  48. data/docs/AddressDomesticExpanded.md +40 -0
  49. data/docs/AddressEditable.md +40 -0
  50. data/docs/AddressList.md +28 -0
  51. data/docs/AddressesApi.md +303 -0
  52. data/docs/BankAccount.md +44 -0
  53. data/docs/BankAccountDeletion.md +22 -0
  54. data/docs/BankAccountList.md +28 -0
  55. data/docs/BankAccountVerify.md +18 -0
  56. data/docs/BankAccountWritable.md +28 -0
  57. data/docs/BankAccountsApi.md +376 -0
  58. data/docs/BankTypeEnum.md +15 -0
  59. data/docs/BillingGroup.md +28 -0
  60. data/docs/BillingGroupEditable.md +20 -0
  61. data/docs/BillingGroupList.md +26 -0
  62. data/docs/BillingGroupsApi.md +305 -0
  63. data/docs/Buckslip.md +60 -0
  64. data/docs/BuckslipDeletion.md +20 -0
  65. data/docs/BuckslipEditable.md +24 -0
  66. data/docs/BuckslipOrder.md +42 -0
  67. data/docs/BuckslipOrderEditable.md +18 -0
  68. data/docs/BuckslipOrdersApi.md +157 -0
  69. data/docs/BuckslipOrdersList.md +26 -0
  70. data/docs/BuckslipUpdatable.md +22 -0
  71. data/docs/BuckslipsApi.md +372 -0
  72. data/docs/BuckslipsList.md +28 -0
  73. data/docs/BulkError.md +18 -0
  74. data/docs/BulkErrorProperties.md +20 -0
  75. data/docs/Campaign.md +52 -0
  76. data/docs/CampaignCreative.md +42 -0
  77. data/docs/CampaignDeletion.md +20 -0
  78. data/docs/CampaignUpdatable.md +36 -0
  79. data/docs/CampaignWritable.md +36 -0
  80. data/docs/CampaignsApi.md +376 -0
  81. data/docs/CampaignsList.md +28 -0
  82. data/docs/Card.md +54 -0
  83. data/docs/CardDeletion.md +22 -0
  84. data/docs/CardEditable.md +24 -0
  85. data/docs/CardList.md +28 -0
  86. data/docs/CardOrder.md +42 -0
  87. data/docs/CardOrderEditable.md +18 -0
  88. data/docs/CardOrderList.md +26 -0
  89. data/docs/CardOrdersApi.md +157 -0
  90. data/docs/CardUpdatable.md +22 -0
  91. data/docs/CardsApi.md +372 -0
  92. data/docs/Check.md +68 -0
  93. data/docs/CheckDeletion.md +22 -0
  94. data/docs/CheckEditable.md +48 -0
  95. data/docs/CheckList.md +28 -0
  96. data/docs/ChecksApi.md +315 -0
  97. data/docs/CmpScheduleType.md +15 -0
  98. data/docs/CmpUseType.md +15 -0
  99. data/docs/CountryExtended.md +15 -0
  100. data/docs/CountryExtendedExpanded.md +15 -0
  101. data/docs/CreativePatch.md +22 -0
  102. data/docs/CreativeResponse.md +42 -0
  103. data/docs/CreativeWritable.md +34 -0
  104. data/docs/CreativesApi.md +226 -0
  105. data/docs/CustomEnvelopeReturned.md +22 -0
  106. data/docs/DefaultApi.md +75 -0
  107. data/docs/DeliverabilityAnalysis.md +46 -0
  108. data/docs/DpvFootnote.md +15 -0
  109. data/docs/EngineHtml.md +15 -0
  110. data/docs/EventType.md +24 -0
  111. data/docs/Events.md +28 -0
  112. data/docs/Export.md +32 -0
  113. data/docs/ExportModel.md +18 -0
  114. data/docs/GeocodeAddresses.md +20 -0
  115. data/docs/GeocodeComponents.md +20 -0
  116. data/docs/HTTPValidationError.md +18 -0
  117. data/docs/IdentityValidation.md +34 -0
  118. data/docs/IdentityValidationApi.md +78 -0
  119. data/docs/InlineObject.md +18 -0
  120. data/docs/IntlAutocompletions.md +20 -0
  121. data/docs/IntlAutocompletionsApi.md +82 -0
  122. data/docs/IntlAutocompletionsWritable.md +26 -0
  123. data/docs/IntlComponents.md +26 -0
  124. data/docs/IntlSuggestions.md +30 -0
  125. data/docs/IntlVerification.md +38 -0
  126. data/docs/IntlVerificationOrError.md +40 -0
  127. data/docs/IntlVerificationWritable.md +32 -0
  128. data/docs/IntlVerifications.md +20 -0
  129. data/docs/IntlVerificationsApi.md +153 -0
  130. data/docs/IntlVerificationsPayload.md +18 -0
  131. data/docs/Letter.md +72 -0
  132. data/docs/LetterCustomEnvelope.md +22 -0
  133. data/docs/LetterDeletion.md +22 -0
  134. data/docs/LetterDetailsReturned.md +36 -0
  135. data/docs/LetterDetailsWritable.md +32 -0
  136. data/docs/LetterEditable.md +52 -0
  137. data/docs/LetterList.md +28 -0
  138. data/docs/LettersApi.md +317 -0
  139. data/docs/LobConfidenceScore.md +20 -0
  140. data/docs/LobError.md +22 -0
  141. data/docs/Location.md +20 -0
  142. data/docs/LocationAnalysis.md +22 -0
  143. data/docs/MailType.md +15 -0
  144. data/docs/MultiLineAddress.md +32 -0
  145. data/docs/MultipleComponents.md +30 -0
  146. data/docs/MultipleComponentsIntl.md +30 -0
  147. data/docs/MultipleComponentsList.md +18 -0
  148. data/docs/PlaceholderModel.md +28 -0
  149. data/docs/Postcard.md +60 -0
  150. data/docs/PostcardDeletion.md +22 -0
  151. data/docs/PostcardDetailsReturned.md +26 -0
  152. data/docs/PostcardDetailsWritable.md +20 -0
  153. data/docs/PostcardEditable.md +40 -0
  154. data/docs/PostcardList.md +28 -0
  155. data/docs/PostcardSize.md +15 -0
  156. data/docs/PostcardsApi.md +317 -0
  157. data/docs/QrCode.md +30 -0
  158. data/docs/ReturnEnvelope.md +24 -0
  159. data/docs/ReverseGeocode.md +22 -0
  160. data/docs/ReverseGeocodeLookupsApi.md +82 -0
  161. data/docs/SelfMailer.md +48 -0
  162. data/docs/SelfMailerDeletion.md +22 -0
  163. data/docs/SelfMailerEditable.md +38 -0
  164. data/docs/SelfMailerList.md +28 -0
  165. data/docs/SelfMailerSize.md +15 -0
  166. data/docs/SelfMailersApi.md +317 -0
  167. data/docs/SortBy.md +20 -0
  168. data/docs/SortBy1.md +20 -0
  169. data/docs/SortBy2.md +20 -0
  170. data/docs/SortBy3.md +20 -0
  171. data/docs/SortByDateModified.md +20 -0
  172. data/docs/Suggestions.md +26 -0
  173. data/docs/Template.md +34 -0
  174. data/docs/TemplateDeletion.md +22 -0
  175. data/docs/TemplateList.md +28 -0
  176. data/docs/TemplateUpdate.md +20 -0
  177. data/docs/TemplateVersion.md +36 -0
  178. data/docs/TemplateVersionDeletion.md +22 -0
  179. data/docs/TemplateVersionList.md +28 -0
  180. data/docs/TemplateVersionUpdatable.md +20 -0
  181. data/docs/TemplateVersionWritable.md +22 -0
  182. data/docs/TemplateVersionsApi.md +384 -0
  183. data/docs/TemplateWritable.md +24 -0
  184. data/docs/TemplatesApi.md +376 -0
  185. data/docs/Thumbnail.md +22 -0
  186. data/docs/TrackingEventCertified.md +34 -0
  187. data/docs/TrackingEventDetails.md +24 -0
  188. data/docs/TrackingEventNormal.md +34 -0
  189. data/docs/Upload.md +44 -0
  190. data/docs/UploadCreateExport.md +20 -0
  191. data/docs/UploadFile.md +20 -0
  192. data/docs/UploadState.md +15 -0
  193. data/docs/UploadUpdatable.md +20 -0
  194. data/docs/UploadWritable.md +18 -0
  195. data/docs/UploadsApi.md +584 -0
  196. data/docs/UsAutocompletions.md +22 -0
  197. data/docs/UsAutocompletionsApi.md +78 -0
  198. data/docs/UsAutocompletionsWritable.md +26 -0
  199. data/docs/UsComponents.md +70 -0
  200. data/docs/UsVerification.md +38 -0
  201. data/docs/UsVerificationOrError.md +40 -0
  202. data/docs/UsVerifications.md +20 -0
  203. data/docs/UsVerificationsApi.md +157 -0
  204. data/docs/UsVerificationsWritable.md +32 -0
  205. data/docs/ValidationError.md +22 -0
  206. data/docs/Zip.md +26 -0
  207. data/docs/ZipCodeType.md +15 -0
  208. data/docs/ZipEditable.md +18 -0
  209. data/docs/ZipLookupCity.md +26 -0
  210. data/docs/ZipLookupsApi.md +78 -0
  211. data/git_push.sh +57 -0
  212. data/lib/lob.rb +1 -7
  213. data/lib/openapi_client/api/addresses_api.rb +318 -0
  214. data/lib/openapi_client/api/bank_accounts_api.rb +397 -0
  215. data/lib/openapi_client/api/billing_groups_api.rb +320 -0
  216. data/lib/openapi_client/api/buckslip_orders_api.rb +183 -0
  217. data/lib/openapi_client/api/buckslips_api.rb +385 -0
  218. data/lib/openapi_client/api/campaigns_api.rb +389 -0
  219. data/lib/openapi_client/api/card_orders_api.rb +183 -0
  220. data/lib/openapi_client/api/cards_api.rb +382 -0
  221. data/lib/openapi_client/api/checks_api.rb +337 -0
  222. data/lib/openapi_client/api/creatives_api.rb +244 -0
  223. data/lib/openapi_client/api/default_api.rb +79 -0
  224. data/lib/openapi_client/api/identity_validation_api.rb +90 -0
  225. data/lib/openapi_client/api/intl_autocompletions_api.rb +97 -0
  226. data/lib/openapi_client/api/intl_verifications_api.rb +165 -0
  227. data/lib/openapi_client/api/letters_api.rb +343 -0
  228. data/lib/openapi_client/api/postcards_api.rb +340 -0
  229. data/lib/openapi_client/api/reverse_geocode_lookups_api.rb +101 -0
  230. data/lib/openapi_client/api/self_mailers_api.rb +340 -0
  231. data/lib/openapi_client/api/template_versions_api.rb +440 -0
  232. data/lib/openapi_client/api/templates_api.rb +397 -0
  233. data/lib/openapi_client/api/uploads_api.rb +604 -0
  234. data/lib/openapi_client/api/us_autocompletions_api.rb +90 -0
  235. data/lib/openapi_client/api/us_verifications_api.rb +172 -0
  236. data/lib/openapi_client/api/zip_lookups_api.rb +90 -0
  237. data/lib/openapi_client/api_client.rb +392 -0
  238. data/lib/openapi_client/api_error.rb +57 -0
  239. data/lib/openapi_client/configuration.rb +279 -0
  240. data/lib/openapi_client/models/address.rb +616 -0
  241. data/lib/openapi_client/models/address_deletion.rb +303 -0
  242. data/lib/openapi_client/models/address_domestic.rb +522 -0
  243. data/lib/openapi_client/models/address_domestic_expanded.rb +521 -0
  244. data/lib/openapi_client/models/address_editable.rb +503 -0
  245. data/lib/openapi_client/models/address_list.rb +324 -0
  246. data/lib/openapi_client/models/bank_account.rb +576 -0
  247. data/lib/openapi_client/models/bank_account_deletion.rb +303 -0
  248. data/lib/openapi_client/models/bank_account_list.rb +324 -0
  249. data/lib/openapi_client/models/bank_account_verify.rb +264 -0
  250. data/lib/openapi_client/models/bank_account_writable.rb +387 -0
  251. data/lib/openapi_client/models/bank_type_enum.rb +37 -0
  252. data/lib/openapi_client/models/billing_group.rb +395 -0
  253. data/lib/openapi_client/models/billing_group_editable.rb +278 -0
  254. data/lib/openapi_client/models/billing_group_list.rb +314 -0
  255. data/lib/openapi_client/models/buckslip.rb +814 -0
  256. data/lib/openapi_client/models/buckslip_deletion.rb +257 -0
  257. data/lib/openapi_client/models/buckslip_editable.rb +316 -0
  258. data/lib/openapi_client/models/buckslip_order.rb +438 -0
  259. data/lib/openapi_client/models/buckslip_order_editable.rb +262 -0
  260. data/lib/openapi_client/models/buckslip_orders_list.rb +312 -0
  261. data/lib/openapi_client/models/buckslip_updatable.rb +289 -0
  262. data/lib/openapi_client/models/buckslips_list.rb +324 -0
  263. data/lib/openapi_client/models/bulk_error.rb +229 -0
  264. data/lib/openapi_client/models/bulk_error_properties.rb +274 -0
  265. data/lib/openapi_client/models/campaign.rb +549 -0
  266. data/lib/openapi_client/models/campaign_creative.rb +467 -0
  267. data/lib/openapi_client/models/campaign_deletion.rb +257 -0
  268. data/lib/openapi_client/models/campaign_updatable.rb +341 -0
  269. data/lib/openapi_client/models/campaign_writable.rb +373 -0
  270. data/lib/openapi_client/models/campaigns_list.rb +324 -0
  271. data/lib/openapi_client/models/card.rb +681 -0
  272. data/lib/openapi_client/models/card_deletion.rb +303 -0
  273. data/lib/openapi_client/models/card_editable.rb +318 -0
  274. data/lib/openapi_client/models/card_list.rb +324 -0
  275. data/lib/openapi_client/models/card_order.rb +438 -0
  276. data/lib/openapi_client/models/card_order_editable.rb +261 -0
  277. data/lib/openapi_client/models/card_order_list.rb +273 -0
  278. data/lib/openapi_client/models/card_updatable.rb +289 -0
  279. data/lib/openapi_client/models/check.rb +812 -0
  280. data/lib/openapi_client/models/check_deletion.rb +303 -0
  281. data/lib/openapi_client/models/check_editable.rb +537 -0
  282. data/lib/openapi_client/models/check_list.rb +324 -0
  283. data/lib/openapi_client/models/chk_use_type.rb +38 -0
  284. data/lib/openapi_client/models/cmp_schedule_type.rb +36 -0
  285. data/lib/openapi_client/models/cmp_use_type.rb +38 -0
  286. data/lib/openapi_client/models/country_extended.rb +254 -0
  287. data/lib/openapi_client/models/country_extended_expanded.rb +255 -0
  288. data/lib/openapi_client/models/creative_patch.rb +274 -0
  289. data/lib/openapi_client/models/creative_response.rb +444 -0
  290. data/lib/openapi_client/models/creative_writable.rb +400 -0
  291. data/lib/openapi_client/models/custom_envelope_returned.rb +319 -0
  292. data/lib/openapi_client/models/deliverability_analysis.rb +601 -0
  293. data/lib/openapi_client/models/dpv_footnote.rb +54 -0
  294. data/lib/openapi_client/models/engine_html.rb +37 -0
  295. data/lib/openapi_client/models/event_type.rb +325 -0
  296. data/lib/openapi_client/models/events.rb +365 -0
  297. data/lib/openapi_client/models/export.rb +422 -0
  298. data/lib/openapi_client/models/export_model.rb +262 -0
  299. data/lib/openapi_client/models/geocode_addresses.rb +237 -0
  300. data/lib/openapi_client/models/geocode_components.rb +291 -0
  301. data/lib/openapi_client/models/http_validation_error.rb +230 -0
  302. data/lib/openapi_client/models/identity_validation.rb +460 -0
  303. data/lib/openapi_client/models/inline_object.rb +229 -0
  304. data/lib/openapi_client/models/intl_autocompletions.rb +282 -0
  305. data/lib/openapi_client/models/intl_autocompletions_writable.rb +278 -0
  306. data/lib/openapi_client/models/intl_components.rb +314 -0
  307. data/lib/openapi_client/models/intl_suggestions.rb +372 -0
  308. data/lib/openapi_client/models/intl_verification.rb +463 -0
  309. data/lib/openapi_client/models/intl_verification_or_error.rb +466 -0
  310. data/lib/openapi_client/models/intl_verification_writable.rb +388 -0
  311. data/lib/openapi_client/models/intl_verifications.rb +250 -0
  312. data/lib/openapi_client/models/intl_verifications_payload.rb +263 -0
  313. data/lib/openapi_client/models/letter.rb +737 -0
  314. data/lib/openapi_client/models/letter_custom_envelope.rb +300 -0
  315. data/lib/openapi_client/models/letter_deletion.rb +303 -0
  316. data/lib/openapi_client/models/letter_details_returned.rb +393 -0
  317. data/lib/openapi_client/models/letter_details_writable.rb +390 -0
  318. data/lib/openapi_client/models/letter_editable.rb +532 -0
  319. data/lib/openapi_client/models/letter_list.rb +324 -0
  320. data/lib/openapi_client/models/lob_confidence_score.rb +299 -0
  321. data/lib/openapi_client/models/lob_error.rb +296 -0
  322. data/lib/openapi_client/models/location.rb +289 -0
  323. data/lib/openapi_client/models/location_analysis.rb +305 -0
  324. data/lib/openapi_client/models/ltr_use_type.rb +38 -0
  325. data/lib/openapi_client/models/mail_type.rb +37 -0
  326. data/lib/openapi_client/models/multi_line_address.rb +431 -0
  327. data/lib/openapi_client/models/multiple_components.rb +405 -0
  328. data/lib/openapi_client/models/multiple_components_intl.rb +377 -0
  329. data/lib/openapi_client/models/multiple_components_list.rb +263 -0
  330. data/lib/openapi_client/models/optional_address_column_mapping.rb +259 -0
  331. data/lib/openapi_client/models/placeholder_model.rb +273 -0
  332. data/lib/openapi_client/models/postcard.rb +656 -0
  333. data/lib/openapi_client/models/postcard_deletion.rb +303 -0
  334. data/lib/openapi_client/models/postcard_details_returned.rb +321 -0
  335. data/lib/openapi_client/models/postcard_details_writable.rb +242 -0
  336. data/lib/openapi_client/models/postcard_editable.rb +393 -0
  337. data/lib/openapi_client/models/postcard_list.rb +324 -0
  338. data/lib/openapi_client/models/postcard_size.rb +38 -0
  339. data/lib/openapi_client/models/psc_use_type.rb +38 -0
  340. data/lib/openapi_client/models/qr_code.rb +339 -0
  341. data/lib/openapi_client/models/required_address_column_mapping.rb +285 -0
  342. data/lib/openapi_client/models/return_envelope.rb +258 -0
  343. data/lib/openapi_client/models/reverse_geocode.rb +304 -0
  344. data/lib/openapi_client/models/self_mailer.rb +584 -0
  345. data/lib/openapi_client/models/self_mailer_deletion.rb +303 -0
  346. data/lib/openapi_client/models/self_mailer_editable.rb +384 -0
  347. data/lib/openapi_client/models/self_mailer_list.rb +324 -0
  348. data/lib/openapi_client/models/self_mailer_size.rb +38 -0
  349. data/lib/openapi_client/models/sfm_use_type.rb +38 -0
  350. data/lib/openapi_client/models/sort_by.rb +283 -0
  351. data/lib/openapi_client/models/sort_by1.rb +283 -0
  352. data/lib/openapi_client/models/sort_by2.rb +283 -0
  353. data/lib/openapi_client/models/sort_by3.rb +283 -0
  354. data/lib/openapi_client/models/sort_by_date_modified.rb +283 -0
  355. data/lib/openapi_client/models/suggestions.rb +343 -0
  356. data/lib/openapi_client/models/template.rb +406 -0
  357. data/lib/openapi_client/models/template_deletion.rb +303 -0
  358. data/lib/openapi_client/models/template_list.rb +324 -0
  359. data/lib/openapi_client/models/template_update.rb +272 -0
  360. data/lib/openapi_client/models/template_version.rb +423 -0
  361. data/lib/openapi_client/models/template_version_deletion.rb +303 -0
  362. data/lib/openapi_client/models/template_version_list.rb +324 -0
  363. data/lib/openapi_client/models/template_version_updatable.rb +257 -0
  364. data/lib/openapi_client/models/template_version_writable.rb +291 -0
  365. data/lib/openapi_client/models/template_writable.rb +309 -0
  366. data/lib/openapi_client/models/thumbnail.rb +300 -0
  367. data/lib/openapi_client/models/tracking_event_certified.rb +419 -0
  368. data/lib/openapi_client/models/tracking_event_details.rb +308 -0
  369. data/lib/openapi_client/models/tracking_event_normal.rb +409 -0
  370. data/lib/openapi_client/models/upload.rb +498 -0
  371. data/lib/openapi_client/models/upload_create_export.rb +283 -0
  372. data/lib/openapi_client/models/upload_file.rb +283 -0
  373. data/lib/openapi_client/models/upload_state.rb +42 -0
  374. data/lib/openapi_client/models/upload_updatable.rb +267 -0
  375. data/lib/openapi_client/models/upload_writable.rb +271 -0
  376. data/lib/openapi_client/models/uploads_metadata.rb +237 -0
  377. data/lib/openapi_client/models/us_autocompletions.rb +328 -0
  378. data/lib/openapi_client/models/us_autocompletions_writable.rb +274 -0
  379. data/lib/openapi_client/models/us_components.rb +788 -0
  380. data/lib/openapi_client/models/us_verification.rb +461 -0
  381. data/lib/openapi_client/models/us_verification_or_error.rb +459 -0
  382. data/lib/openapi_client/models/us_verifications.rb +250 -0
  383. data/lib/openapi_client/models/us_verifications_writable.rb +421 -0
  384. data/lib/openapi_client/models/validation_error.rb +263 -0
  385. data/lib/openapi_client/models/zip.rb +363 -0
  386. data/lib/openapi_client/models/zip_code_type.rb +40 -0
  387. data/lib/openapi_client/models/zip_editable.rb +246 -0
  388. data/lib/openapi_client/models/zip_lookup_city.rb +331 -0
  389. data/lib/openapi_client/version.rb +15 -0
  390. data/lib/openapi_client.rb +212 -0
  391. data/openapi_client.gemspec +37 -0
  392. data/spec/api/addresses_api_spec.rb +88 -0
  393. data/spec/api/bank_accounts_api_spec.rb +101 -0
  394. data/spec/api/billing_groups_api_spec.rb +89 -0
  395. data/spec/api/campaigns_api_spec.rb +100 -0
  396. data/spec/api/card_orders_api_spec.rb +62 -0
  397. data/spec/api/cards_api_spec.rb +99 -0
  398. data/spec/api/checks_api_spec.rb +93 -0
  399. data/spec/api/creatives_api_spec.rb +73 -0
  400. data/spec/api/default_api_spec.rb +46 -0
  401. data/spec/api/identity_validation_api_spec.rb +47 -0
  402. data/spec/api/intl_autocompletions_api_spec.rb +48 -0
  403. data/spec/api/intl_verifications_api_spec.rb +60 -0
  404. data/spec/api/letters_api_spec.rb +94 -0
  405. data/spec/api/postcards_api_spec.rb +94 -0
  406. data/spec/api/reverse_geocode_lookups_api_spec.rb +48 -0
  407. data/spec/api/self_mailers_api_spec.rb +94 -0
  408. data/spec/api/template_versions_api_spec.rb +105 -0
  409. data/spec/api/templates_api_spec.rb +101 -0
  410. data/spec/api/uploads_api_spec.rb +135 -0
  411. data/spec/api/us_autocompletions_api_spec.rb +47 -0
  412. data/spec/api/us_verifications_api_spec.rb +61 -0
  413. data/spec/api/zip_lookups_api_spec.rb +47 -0
  414. data/spec/api_client_spec.rb +226 -0
  415. data/spec/configuration_spec.rb +42 -0
  416. data/spec/spec_helper.rb +105 -13
  417. metadata +450 -214
  418. data/.github/workflows/forked_tests_job.yml +0 -36
  419. data/.github/workflows/run_tests_job.yml +0 -32
  420. data/.github/workflows/update_gem.yml +0 -27
  421. data/.gitignore +0 -19
  422. data/CHANGELOG.md +0 -148
  423. data/CONTRIBUTING.md +0 -19
  424. data/LICENSE.txt +0 -22
  425. data/examples/README.md +0 -119
  426. data/examples/cards.rb +0 -51
  427. data/examples/checks.rb +0 -49
  428. data/examples/csv_checks/create_checks.rb +0 -48
  429. data/examples/csv_checks/input.csv +0 -6
  430. data/examples/csv_letters/create_letters.rb +0 -41
  431. data/examples/csv_letters/input.csv +0 -6
  432. data/examples/csv_letters/letter_template.html +0 -33
  433. data/examples/csv_postcards/create_postcards.rb +0 -46
  434. data/examples/csv_postcards/input.csv +0 -7
  435. data/examples/csv_postcards/postcard_back.html +0 -38
  436. data/examples/csv_postcards/postcard_front.html +0 -25
  437. data/examples/csv_verify/input.csv +0 -7
  438. data/examples/csv_verify/verify.rb +0 -37
  439. data/examples/letters.rb +0 -73
  440. data/examples/list_postcards_metadata.rb +0 -94
  441. data/examples/postcards.rb +0 -87
  442. data/examples/postcards_idempotent.rb +0 -92
  443. data/examples/postcards_intl.rb +0 -87
  444. data/examples/postcards_remote.rb +0 -87
  445. data/examples/postcards_send_date.rb +0 -97
  446. data/examples/postcards_template.rb +0 -98
  447. data/examples/self_mailers.rb +0 -38
  448. data/lib/lob/client.rb +0 -96
  449. data/lib/lob/errors/invalid_request_error.rb +0 -4
  450. data/lib/lob/errors/lob_error.rb +0 -20
  451. data/lib/lob/resources/address.rb +0 -14
  452. data/lib/lob/resources/bank_account.rb +0 -30
  453. data/lib/lob/resources/bulk_intl_verifications.rb +0 -27
  454. data/lib/lob/resources/bulk_us_verifications.rb +0 -28
  455. data/lib/lob/resources/card.rb +0 -46
  456. data/lib/lob/resources/check.rb +0 -14
  457. data/lib/lob/resources/group.rb +0 -14
  458. data/lib/lob/resources/groups_member.rb +0 -66
  459. data/lib/lob/resources/intl_verifications.rb +0 -26
  460. data/lib/lob/resources/letter.rb +0 -14
  461. data/lib/lob/resources/postcard.rb +0 -14
  462. data/lib/lob/resources/resource_base.rb +0 -150
  463. data/lib/lob/resources/self_mailer.rb +0 -14
  464. data/lib/lob/resources/us_autocompletions.rb +0 -26
  465. data/lib/lob/resources/us_reverse_geocode_lookups.rb +0 -26
  466. data/lib/lob/resources/us_verifications.rb +0 -27
  467. data/lib/lob/resources/us_zip_lookups.rb +0 -26
  468. data/lib/lob/version.rb +0 -3
  469. data/lob.gemspec +0 -31
  470. data/spec/lob/errors/lob_error_spec.rb +0 -19
  471. data/spec/lob/resources/address_spec.rb +0 -55
  472. data/spec/lob/resources/bank_account_spec.rb +0 -60
  473. data/spec/lob/resources/bulk_intl_verifications_spec.rb +0 -39
  474. data/spec/lob/resources/bulk_us_verifications_spec.rb +0 -51
  475. data/spec/lob/resources/card_spec.rb +0 -145
  476. data/spec/lob/resources/check_spec.rb +0 -119
  477. data/spec/lob/resources/group_spec.rb +0 -50
  478. data/spec/lob/resources/intl_verifications_spec.rb +0 -25
  479. data/spec/lob/resources/letter_spec.rb +0 -114
  480. data/spec/lob/resources/member_spec.rb +0 -65
  481. data/spec/lob/resources/postcard_spec.rb +0 -160
  482. data/spec/lob/resources/resource_base_spec.rb +0 -75
  483. data/spec/lob/resources/self_mailer_spec.rb +0 -177
  484. data/spec/lob/resources/us_autocompletions_spec.rb +0 -24
  485. data/spec/lob/resources/us_reverse_geocode_lookups_spec.rb +0 -22
  486. data/spec/lob/resources/us_verifications_spec.rb +0 -31
  487. data/spec/lob/resources/us_zip_lookups_spec.rb +0 -23
  488. data/spec/lob_spec.rb +0 -48
  489. data/spec/samples/8.5x11.pdf +0 -0
  490. data/spec/samples/card.pdf +1 -743
  491. data/spec/samples/postcardback.pdf +2 -2287
  492. data/spec/samples/postcardfront.pdf +1 -1549
  493. data/spec/samples/sfm-12x9-inside.pdf +0 -0
  494. data/spec/samples/sfm-12x9-outside.pdf +0 -0
  495. data/spec/samples/sfm-6x18-inside.pdf +0 -0
  496. data/spec/samples/sfm-6x18-outside.pdf +0 -0
@@ -0,0 +1,122 @@
1
+ # CardOrder.spec.rb
2
+ require_relative '../TestFixtures'
3
+ include Lob
4
+ $:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
5
+ require 'uri'
6
+
7
+ RSpec.describe "CardOrdersApi" do
8
+ it "can be instantiated" do
9
+ cardOrderApi = CardOrdersApi.new()
10
+
11
+ expect(cardOrderApi).not_to be_nil
12
+ expect(cardOrderApi).to be_a_kind_of(CardOrdersApi)
13
+ end
14
+
15
+ describe "Create" do
16
+ before(:all) do
17
+ api = TestFixtures.api_client_with_test_key()
18
+ @cardOrderApi = CardOrdersApi.new(api)
19
+ @cardApi = CardsApi.new(api)
20
+
21
+ cardEditable = CardEditable.new({
22
+ front: TestFixtures.FILE_LOCATION,
23
+ back: TestFixtures.FILE_LOCATION,
24
+ size: "2.125x3.375"
25
+ })
26
+
27
+ @cardId = @cardApi.create(cardEditable).id
28
+ puts @cardId
29
+
30
+ @cardOrderEditable = CardOrderEditable.new({
31
+ quantity: 10000
32
+ })
33
+ end
34
+
35
+ it "creates a new card order" do
36
+ createdCardOrder = @cardOrderApi.create(@cardId, @cardOrderEditable)
37
+ expect(createdCardOrder.id).not_to be_nil
38
+ end
39
+
40
+ it "handles errors returned by the api" do
41
+ cardOrderEditable = CardOrderEditable.new()
42
+ begin
43
+ response = @cardOrderApi.create(@cardId, cardOrderEditable)
44
+ rescue => err
45
+ expect(err.message.include? "quantity is required").to be(true)
46
+ end
47
+ end
48
+
49
+ it "does not allow creation with invalid key" do
50
+ config = Lob::Configuration.default
51
+ config.username = "fake key"
52
+ badapi = Lob::ApiClient.new(config)
53
+
54
+ cardOrderApi = CardOrdersApi.new(badapi)
55
+
56
+ begin
57
+ response = cardOrderApi.create(@cardId, @cardOrderEditable)
58
+ rescue => err
59
+ expect(err.message.include? "Your API key is not valid.").to be(true)
60
+ end
61
+ end
62
+
63
+ after(:all) do
64
+ api = TestFixtures.api_client_with_test_key()
65
+ cardApi = CardsApi.new(api)
66
+ cardApi.delete(@cardId)
67
+ end
68
+ end
69
+
70
+ describe "List" do
71
+ before(:all) do
72
+ api = TestFixtures.api_client_with_test_key()
73
+ @cardOrderApi = CardOrdersApi.new(api)
74
+ @cardApi = CardsApi.new(api)
75
+
76
+ cardEditable = CardEditable.new({
77
+ front: TestFixtures.FILE_LOCATION,
78
+ back: TestFixtures.FILE_LOCATION,
79
+ size: "2.125x3.375"
80
+ })
81
+
82
+ @cardId = @cardApi.create(cardEditable).id
83
+
84
+ @cardOrderEditable = CardOrderEditable.new({
85
+ quantity: 10002
86
+ })
87
+ @cardOrderApi.create(@cardId, @cardOrderEditable)
88
+ @cardOrderApi.create(@cardId, @cardOrderEditable)
89
+ @cardOrderApi.create(@cardId, @cardOrderEditable)
90
+ end
91
+
92
+ [
93
+ [nil, nil, nil],
94
+ ["limit", 2, nil],
95
+ ["offset", nil, 1],
96
+ ].each do |which_param, limit, offset|
97
+ it "lists card orders #{which_param && ("with " + which_param + " param")}" do
98
+ args = {}
99
+
100
+ if limit then
101
+ args[:"limit"] = limit
102
+ end
103
+
104
+ if offset then
105
+ args[:"offset"] = offset
106
+ end
107
+
108
+ response = @cardOrderApi.get(@cardId, args)
109
+
110
+ expect(response.data.length()).to be > 0
111
+
112
+ if limit then
113
+ expect(response.data.length()).to be == limit
114
+ end
115
+ end
116
+ end
117
+
118
+ after(:all) do
119
+ @cardApi.delete(@cardId)
120
+ end
121
+ end
122
+ end
@@ -0,0 +1,361 @@
1
+ # Check.spec.rb
2
+ require_relative '../TestFixtures'
3
+ include Lob
4
+ $:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
5
+ require 'uri'
6
+
7
+ RSpec.describe "ChecksApi" do
8
+ it "can be instantiated" do
9
+ checkApi = ChecksApi.new()
10
+
11
+ expect(checkApi).not_to be_nil
12
+ expect(checkApi).to be_a_kind_of(ChecksApi)
13
+ end
14
+
15
+ describe "Create" do
16
+ before(:all) do
17
+ api = TestFixtures.api_client_with_test_key()
18
+ @checkApi = ChecksApi.new(api)
19
+ bankAccountApi = BankAccountsApi.new(api)
20
+
21
+ addr1 = AddressDomestic.new({
22
+ name: "Thing T. Thing",
23
+ address_line1: "1313 CEMETERY LN",
24
+ address_city: "WESTFIELD",
25
+ address_state: "NJ",
26
+ address_zip: "07000",
27
+ })
28
+
29
+ addr2 = AddressDomestic.new({
30
+ name: "FESTER",
31
+ address_line1: "001 CEMETERY LN",
32
+ address_line2: "SUITE 666",
33
+ address_city: "WESTFIELD",
34
+ address_state: "NJ",
35
+ address_zip: "07000"
36
+ })
37
+
38
+ bankWritable = BankAccountWritable.new({
39
+ routing_number: "322271627",
40
+ account_number: "123456789",
41
+ signatory: "Sigourney Lobster",
42
+ account_type: BankTypeEnum::INDIVIDUAL
43
+ })
44
+
45
+ bankVerify = BankAccountVerify.new({
46
+ amounts: [11, 35]
47
+ })
48
+
49
+ bankAcc = bankAccountApi.create(bankWritable)
50
+ bankAcc = bankAccountApi.verify(bankAcc.id, bankVerify)
51
+ @bankAccId = bankAcc.id
52
+
53
+ @checkEditable = CheckEditable.new({
54
+ to: addr1,
55
+ message: "Ruby Integration Test Check",
56
+ bank_account: @bankAccId,
57
+ from: addr2,
58
+ amount: 100.0
59
+ })
60
+ end
61
+
62
+ it "creates a new check" do
63
+ createdCheck = @checkApi.create(@checkEditable)
64
+ expect(createdCheck.id).to be
65
+
66
+ # delete it in the end
67
+ @checkApi.cancel(createdCheck.id)
68
+ end
69
+
70
+ it "handles errors returned by the api" do
71
+ checkEditable = CheckEditable.new()
72
+ begin
73
+ response = @checkApi.create(checkEditable)
74
+ rescue => err
75
+ expect(err.message.include? "to is required").to be(true)
76
+ end
77
+ end
78
+
79
+ it "does not allow creation with invalid key" do
80
+ config = Lob::Configuration.default
81
+ config.username = "fake key"
82
+ badapi = Lob::ApiClient.new(config)
83
+
84
+ checkApi = ChecksApi.new(badapi)
85
+
86
+ begin
87
+ response = checkApi.create(@checkEditable)
88
+ rescue => err
89
+ expect(err.message.include? "Your API key is not valid.").to be(true)
90
+ end
91
+ end
92
+
93
+ after(:all) do
94
+ api = TestFixtures.api_client_with_test_key()
95
+ bankAccountApi = BankAccountsApi.new(api)
96
+ bankAccountApi.delete(@bankAccId)
97
+ end
98
+ end
99
+
100
+ describe "Get" do
101
+ before(:all) do
102
+ api = TestFixtures.api_client_with_test_key()
103
+ @checkApi = ChecksApi.new(api)
104
+
105
+ bankAccountApi = BankAccountsApi.new(api)
106
+
107
+ addr1 = AddressDomestic.new({
108
+ name: "Thing T. Thing",
109
+ address_line1: "1313 CEMETERY LN",
110
+ address_city: "WESTFIELD",
111
+ address_state: "NJ",
112
+ address_zip: "07000",
113
+ })
114
+
115
+ addr2 = AddressDomestic.new({
116
+ name: "FESTER",
117
+ address_line1: "001 CEMETERY LN",
118
+ address_line2: "SUITE 666",
119
+ address_city: "WESTFIELD",
120
+ address_state: "NJ",
121
+ address_zip: "07000"
122
+ })
123
+
124
+ bankWritable = BankAccountWritable.new({
125
+ routing_number: "322271627",
126
+ account_number: "123456789",
127
+ signatory: "Sigourney Lobster",
128
+ account_type: BankTypeEnum::INDIVIDUAL
129
+ })
130
+
131
+ bankVerify = BankAccountVerify.new({
132
+ amounts: [11, 35]
133
+ })
134
+
135
+ bankAcc = bankAccountApi.create(bankWritable)
136
+ bankAcc = bankAccountApi.verify(bankAcc.id, bankVerify)
137
+ bankAccId = bankAcc.id
138
+
139
+ checkEditable = CheckEditable.new({
140
+ to: addr1,
141
+ message: "Ruby Integration Test Check",
142
+ bank_account: bankAccId,
143
+ from: addr2,
144
+ amount: 100.0
145
+ })
146
+
147
+ response = @checkApi.create(checkEditable)
148
+ @checkId = response.id
149
+
150
+ bankAccountApi.delete(bankAccId)
151
+ end
152
+
153
+ it "retrieves a check" do
154
+ response = @checkApi.get(@checkId)
155
+
156
+ expect(response).not_to be_nil()
157
+ expect(response.id).to eq(@checkId)
158
+ end
159
+
160
+ after(:all) do
161
+ @checkApi.cancel(@checkId)
162
+ end
163
+ end
164
+
165
+ describe "List" do
166
+ before(:all) do
167
+ api = TestFixtures.api_client_with_test_key()
168
+ @checkApi = ChecksApi.new(api)
169
+
170
+ bankAccountApi = BankAccountsApi.new(api)
171
+
172
+ addr1 = AddressDomestic.new({
173
+ name: "Thing T. Thing",
174
+ address_line1: "1313 CEMETERY LN",
175
+ address_city: "WESTFIELD",
176
+ address_state: "NJ",
177
+ address_zip: "07000",
178
+ })
179
+
180
+ addr2 = AddressDomestic.new({
181
+ name: "FESTER",
182
+ address_line1: "001 CEMETERY LN",
183
+ address_line2: "SUITE 666",
184
+ address_city: "WESTFIELD",
185
+ address_state: "NJ",
186
+ address_zip: "07000"
187
+ })
188
+
189
+ bankWritable = BankAccountWritable.new({
190
+ routing_number: "322271627",
191
+ account_number: "123456789",
192
+ signatory: "Sigourney Lobster",
193
+ account_type: BankTypeEnum::INDIVIDUAL
194
+ })
195
+
196
+ bankVerify = BankAccountVerify.new({
197
+ amounts: [11, 35]
198
+ })
199
+
200
+ bankAcc = bankAccountApi.create(bankWritable)
201
+ bankAcc = bankAccountApi.verify(bankAcc.id, bankVerify)
202
+ bankAccId = bankAcc.id
203
+
204
+ checkEditable = CheckEditable.new({
205
+ to: addr1,
206
+ message: "Ruby Integration Test Check",
207
+ bank_account: bankAccId,
208
+ from: addr2,
209
+ amount: 100.0
210
+ })
211
+
212
+ response1 = @checkApi.create(checkEditable)
213
+ response2 = @checkApi.create(checkEditable)
214
+ response3 = @checkApi.create(checkEditable)
215
+
216
+ @check1Id = response1.id
217
+ @check2Id = response2.id
218
+ @check3Id = response3.id
219
+
220
+ bankAccountApi.delete(bankAccId)
221
+ end
222
+
223
+ it "lists checks with limit, before, and after params" do
224
+ response = @checkApi.list({ :"limit" => 2 })
225
+
226
+ expect(response.data.length()).to be == 2
227
+ first_chk_id = response.data[0].id
228
+
229
+ uri = URI.parse(response.next_url)
230
+ params = CGI.parse(uri.query)
231
+
232
+ response = @checkApi.list({ :"limit" => 2, :"after" => params["after"][0] })
233
+
234
+ expect(response.data[0].id).not_to eq(first_chk_id)
235
+
236
+ uri = URI.parse(response.next_url)
237
+ params = CGI.parse(uri.query)
238
+
239
+ response = @checkApi.list({ :"limit" => 2, :"before" => params["before"][0] })
240
+ expect(response.data[0].id).not_to be_nil
241
+ end
242
+
243
+ [
244
+ [nil, nil, nil, nil, nil, nil, nil, nil, nil],
245
+ ["include", Array.new(1, "total_count"), nil, nil, nil, nil, nil, nil],
246
+ ["date_created", nil, { "gt" => "2020-01-01" }, nil, nil, nil, nil, nil, nil],
247
+ ["metadata", nil, nil, '{ "name": "Harry" }', nil, nil, nil, nil, nil],
248
+ ["scheduled", nil, nil, nil, true, nil, nil, nil, nil],
249
+ ["send_date", nil, nil, nil, nil, { "gt" => "2020-01-01" }, nil, nil, nil],
250
+ ["mail_type", nil, nil, nil, nil, nil, MailType::FIRST_CLASS, nil, nil],
251
+ ["sort_by", nil, nil, nil, nil, nil, nil, { "date_created": "asc" }],
252
+ ].each do |which_param, include_param, date_created, metadata, scheduled, send_date, mail_type, sort_by|
253
+ it "lists checks #{which_param && ("with " + which_param + " param")}" do
254
+ args = {}
255
+
256
+ if include_param then
257
+ args[:"include"] = include_param
258
+ end
259
+
260
+ if date_created then
261
+ args[:"date_created"] = date_created
262
+ end
263
+
264
+ if metadata then
265
+ args[:"metadata"] = metadata
266
+ end
267
+
268
+ if scheduled then
269
+ args[:"scheduled"] = scheduled
270
+ end
271
+
272
+ if send_date then
273
+ args[:"send_date"] = send_date
274
+ end
275
+
276
+ if mail_type then
277
+ args[:"mail_type"] = mail_type
278
+ end
279
+
280
+ if sort_by then
281
+ args[:"sort_by"] = sort_by
282
+ end
283
+
284
+ response = @checkApi.list(args)
285
+
286
+ expect(response.data.length()).to be >= 0
287
+
288
+ if include_param
289
+ expect(response.total_count).to be
290
+ end
291
+ end
292
+ end
293
+
294
+ after(:all) do
295
+ @checkApi.cancel(@check1Id)
296
+ @checkApi.cancel(@check2Id)
297
+ @checkApi.cancel(@check3Id)
298
+ end
299
+ end
300
+
301
+ describe "Delete" do
302
+ before(:all) do
303
+ api = TestFixtures.api_client_with_test_key()
304
+ @checkApi = ChecksApi.new(api)
305
+
306
+ bankAccountApi = BankAccountsApi.new(api)
307
+
308
+ addr1 = AddressDomestic.new({
309
+ name: "Thing T. Thing",
310
+ address_line1: "1313 CEMETERY LN",
311
+ address_city: "WESTFIELD",
312
+ address_state: "NJ",
313
+ address_zip: "07000",
314
+ })
315
+
316
+ addr2 = AddressDomestic.new({
317
+ name: "FESTER",
318
+ address_line1: "001 CEMETERY LN",
319
+ address_line2: "SUITE 666",
320
+ address_city: "WESTFIELD",
321
+ address_state: "NJ",
322
+ address_zip: "07000"
323
+ })
324
+
325
+ bankWritable = BankAccountWritable.new({
326
+ routing_number: "322271627",
327
+ account_number: "123456789",
328
+ signatory: "Sigourney Lobster",
329
+ account_type: BankTypeEnum::INDIVIDUAL
330
+ })
331
+
332
+ bankVerify = BankAccountVerify.new({
333
+ amounts: [11, 35]
334
+ })
335
+
336
+ bankAcc = bankAccountApi.create(bankWritable)
337
+ bankAcc = bankAccountApi.verify(bankAcc.id, bankVerify)
338
+ bankAccId = bankAcc.id
339
+
340
+ checkEditable = CheckEditable.new({
341
+ to: addr1,
342
+ message: "Ruby Integration Test Check",
343
+ bank_account: bankAccId,
344
+ from: addr2,
345
+ amount: 100.0
346
+ })
347
+
348
+ response = @checkApi.create(checkEditable)
349
+ @checkId = response.id
350
+
351
+ bankAccountApi.delete(bankAccId)
352
+ end
353
+
354
+ it "deletes a check" do
355
+ response = @checkApi.cancel(@checkId)
356
+
357
+ expect(response.id).to eq(@checkId)
358
+ expect(response.deleted).to eq(true)
359
+ end
360
+ end
361
+ end
@@ -0,0 +1,54 @@
1
+ # IntlAutocompletion.spec.rb
2
+ require_relative '../TestFixtures'
3
+ include Lob
4
+ $:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
5
+
6
+ RSpec.describe "IntlAutocompletionsApi" do
7
+ it "can be instantiated" do
8
+ intlAutocompletionApi = IntlAutocompletionsApi.new()
9
+
10
+ expect(intlAutocompletionApi).not_to be_nil
11
+ expect(intlAutocompletionApi).to be_a_kind_of(IntlAutocompletionsApi)
12
+ end
13
+
14
+ describe "Autocomplete" do
15
+ before(:all) do
16
+ api = TestFixtures.api_client_with_test_key()
17
+ @intlAutocompletionApi = IntlAutocompletionsApi.new(api)
18
+
19
+ @validAddress = IntlAutocompletionsWritable.new({
20
+ address_prefix: "370 W",
21
+ city: "SUMMERSIDE",
22
+ country: CountryExtended::CA
23
+ })
24
+ end
25
+
26
+ it "Autocompletes intl address (with test key)" do
27
+ autocompletedAddr = @intlAutocompletionApi.autocomplete(@validAddress)
28
+ expect(autocompletedAddr.suggestions[0].primary_line).to eq("TEST KEYS DO NOT AUTOCOMPLETE INTL ADDRESSES")
29
+ end
30
+
31
+ it "handles errors returned by the api" do
32
+ validAddress = IntlAutocompletionsWritable.new()
33
+ begin
34
+ response = @intlAutocompletionApi.autocomplete(validAddress)
35
+ rescue => err
36
+ expect(err.message.include? "address_prefix is required").to be(true)
37
+ end
38
+ end
39
+
40
+ it "does not allow creation with invalid key" do
41
+ config = Lob::Configuration.default
42
+ config.username = "fake key"
43
+ badapi = Lob::ApiClient.new(config)
44
+
45
+ intlAutocompletionApi = IntlAutocompletionsApi.new(badapi)
46
+
47
+ begin
48
+ response = intlAutocompletionApi.autocomplete(@validAddress)
49
+ rescue => err
50
+ expect(err.message.include? "Your API key is not valid.").to be(true)
51
+ end
52
+ end
53
+ end
54
+ end
@@ -0,0 +1,90 @@
1
+ # IntlVerification.spec.rb
2
+ require_relative '../TestFixtures'
3
+ include Lob
4
+ $:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
5
+
6
+ RSpec.describe "IntlVerificationsApi" do
7
+ it "can be instantiated" do
8
+ intlVerificationApi = IntlVerificationsApi.new()
9
+
10
+ expect(intlVerificationApi).not_to be_nil
11
+ expect(intlVerificationApi).to be_a_kind_of(IntlVerificationsApi)
12
+ end
13
+
14
+ describe "verifySingle" do
15
+ before(:all) do
16
+ api = TestFixtures.api_client_with_live_key()
17
+ @intlVerificationApi = IntlVerificationsApi.new(api)
18
+
19
+ @validAddress = IntlVerificationWritable.new({
20
+ primary_line: "35 TOWER HILL",
21
+ city: "LONDON",
22
+ postal_code: "EC3N 4DR",
23
+ country: CountryExtended::GB
24
+ })
25
+
26
+ @invalidAddress = IntlVerificationWritable.new({
27
+ primary_line: "1 CEMETERY ST",
28
+ city: "POTATOFIELD",
29
+ postal_code: "EC3N 40R",
30
+ country: CountryExtended::GB
31
+ })
32
+
33
+ mc1 = MultipleComponentsIntl.new({
34
+ primary_line: "35 TOWER HILL",
35
+ city: "LONDON",
36
+ postal_code: "EC3N 4DR",
37
+ country: CountryExtended::GB
38
+ })
39
+ mc2 = MultipleComponentsIntl.new({
40
+ primary_line: "10 DOWNING ST",
41
+ city: "LONDON",
42
+ postal_code: "SW1A 2AB",
43
+ country: CountryExtended::GB
44
+ })
45
+ @addressList = IntlVerificationsPayload.new({
46
+ addresses: [mc1, mc2]
47
+ })
48
+ end
49
+
50
+ it "Verifies valid addresses in bulk" do
51
+ verifiedList = @intlVerificationApi.verifyBulk(@addressList)
52
+ expect(verifiedList.addresses.length()).to be(2)
53
+ expect(verifiedList.addresses[0].deliverability).to eq("deliverable")
54
+ expect(verifiedList.addresses[1].deliverability).to eq("deliverable_missing_info")
55
+ end
56
+
57
+ it "Verifies single deliverable address" do
58
+ verifiedAddr = @intlVerificationApi.verifySingle(@validAddress)
59
+ expect(verifiedAddr.deliverability).to eq("deliverable")
60
+ end
61
+
62
+ it "Verifies single undeliverable address" do
63
+ verifiedAddr = @intlVerificationApi.verifySingle(@invalidAddress)
64
+ expect(verifiedAddr.deliverability).to eq("undeliverable")
65
+ end
66
+
67
+ it "handles errors returned by the api" do
68
+ validAddress = IntlVerificationWritable.new()
69
+ begin
70
+ response = @intlVerificationApi.verifySingle(validAddress)
71
+ rescue => err
72
+ expect(err.message.include? "primary_line is required").to be(true)
73
+ end
74
+ end
75
+
76
+ it "does not allow creation with invalid key" do
77
+ config = Lob::Configuration.default
78
+ config.username = "fake key"
79
+ badapi = Lob::ApiClient.new(config)
80
+
81
+ intlVerificationApi = IntlVerificationsApi.new(badapi)
82
+
83
+ begin
84
+ response = intlVerificationApi.verifySingle(@validAddress)
85
+ rescue => err
86
+ expect(err.message.include? "Your API key is not valid.").to be(true)
87
+ end
88
+ end
89
+ end
90
+ end