lob 5.4.6 → 6.0.0

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