lob 5.1.2 → 6.0.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (471) hide show
  1. checksums.yaml +4 -4
  2. data/CODE_SNIPPETS.md +1871 -0
  3. data/Gemfile +6 -1
  4. data/Gemfile.lock +72 -0
  5. data/LICENSE +21 -0
  6. data/MIGRATION.md +174 -0
  7. data/README.md +70 -154
  8. data/Rakefile +7 -5
  9. data/__tests__/Api/Address.unit.rb +210 -0
  10. data/__tests__/Api/BankAccount.unit.rb +244 -0
  11. data/__tests__/Api/BillingGroup.unit.rb +170 -0
  12. data/__tests__/Api/Card.unit.rb +183 -0
  13. data/__tests__/Api/CardOrder.unit.rb +89 -0
  14. data/__tests__/Api/Check.unit.rb +185 -0
  15. data/__tests__/Api/IntlAutocompletion.unit.rb +43 -0
  16. data/__tests__/Api/IntlVerification.unit.rb +71 -0
  17. data/__tests__/Api/Letter.unit.rb +191 -0
  18. data/__tests__/Api/Postcard.unit.rb +189 -0
  19. data/__tests__/Api/Require.unit.rb +21 -0
  20. data/__tests__/Api/ReverseGeocodeLookup.unit.rb +43 -0
  21. data/__tests__/Api/SelfMailer.unit.rb +190 -0
  22. data/__tests__/Api/Template.unit.rb +165 -0
  23. data/__tests__/Api/TemplateVersion.unit.rb +165 -0
  24. data/__tests__/Api/UsAutocompletion.unit.rb +42 -0
  25. data/__tests__/Api/UsVerification.unit.rb +71 -0
  26. data/__tests__/Api/ZipLookup.unit.rb +42 -0
  27. data/__tests__/Integration/Address.spec.rb +200 -0
  28. data/__tests__/Integration/BankAccount.spec.rb +243 -0
  29. data/__tests__/Integration/BillingGroup.spec.rb +163 -0
  30. data/__tests__/Integration/Card.spec.rb +198 -0
  31. data/__tests__/Integration/CardOrder.spec.rb +122 -0
  32. data/__tests__/Integration/Check.spec.rb +361 -0
  33. data/__tests__/Integration/IntlAutocompletion.spec.rb +54 -0
  34. data/__tests__/Integration/IntlVerification.spec.rb +90 -0
  35. data/__tests__/Integration/Letter.spec.rb +286 -0
  36. data/__tests__/Integration/Postcard.spec.rb +214 -0
  37. data/__tests__/Integration/ReverseGeocodeLookup.spec.rb +30 -0
  38. data/__tests__/Integration/SelfMailer.spec.rb +270 -0
  39. data/__tests__/Integration/Template.spec.rb +221 -0
  40. data/__tests__/Integration/TemplateVersion.spec.rb +275 -0
  41. data/__tests__/Integration/UsAutocompletion.spec.rb +54 -0
  42. data/__tests__/Integration/UsVerification.spec.rb +102 -0
  43. data/__tests__/Integration/ZipLookup.spec.rb +29 -0
  44. data/__tests__/TestFixtures.rb +36 -0
  45. data/docs/Address.md +52 -0
  46. data/docs/AddressDeletion.md +22 -0
  47. data/docs/AddressDomestic.md +40 -0
  48. data/docs/AddressDomesticExpanded.md +40 -0
  49. data/docs/AddressEditable.md +40 -0
  50. data/docs/AddressList.md +28 -0
  51. data/docs/AddressesApi.md +303 -0
  52. data/docs/BankAccount.md +44 -0
  53. data/docs/BankAccountDeletion.md +22 -0
  54. data/docs/BankAccountList.md +28 -0
  55. data/docs/BankAccountVerify.md +18 -0
  56. data/docs/BankAccountWritable.md +28 -0
  57. data/docs/BankAccountsApi.md +376 -0
  58. data/docs/BankTypeEnum.md +15 -0
  59. data/docs/BillingGroup.md +28 -0
  60. data/docs/BillingGroupEditable.md +20 -0
  61. data/docs/BillingGroupList.md +26 -0
  62. data/docs/BillingGroupsApi.md +305 -0
  63. data/docs/Buckslip.md +60 -0
  64. data/docs/BuckslipDeletion.md +20 -0
  65. data/docs/BuckslipEditable.md +24 -0
  66. data/docs/BuckslipOrder.md +42 -0
  67. data/docs/BuckslipOrderEditable.md +18 -0
  68. data/docs/BuckslipOrdersApi.md +157 -0
  69. data/docs/BuckslipOrdersList.md +26 -0
  70. data/docs/BuckslipUpdatable.md +22 -0
  71. data/docs/BuckslipsApi.md +372 -0
  72. data/docs/BuckslipsList.md +28 -0
  73. data/docs/BulkError.md +18 -0
  74. data/docs/BulkErrorProperties.md +20 -0
  75. data/docs/Campaign.md +52 -0
  76. data/docs/CampaignCreative.md +42 -0
  77. data/docs/CampaignDeletion.md +20 -0
  78. data/docs/CampaignUpdatable.md +36 -0
  79. data/docs/CampaignWritable.md +36 -0
  80. data/docs/CampaignsApi.md +376 -0
  81. data/docs/CampaignsList.md +28 -0
  82. data/docs/Card.md +54 -0
  83. data/docs/CardDeletion.md +22 -0
  84. data/docs/CardEditable.md +24 -0
  85. data/docs/CardList.md +28 -0
  86. data/docs/CardOrder.md +42 -0
  87. data/docs/CardOrderEditable.md +18 -0
  88. data/docs/CardOrderList.md +26 -0
  89. data/docs/CardOrdersApi.md +157 -0
  90. data/docs/CardUpdatable.md +22 -0
  91. data/docs/CardsApi.md +372 -0
  92. data/docs/Check.md +68 -0
  93. data/docs/CheckDeletion.md +22 -0
  94. data/docs/CheckEditable.md +48 -0
  95. data/docs/CheckList.md +28 -0
  96. data/docs/ChecksApi.md +315 -0
  97. data/docs/CmpScheduleType.md +15 -0
  98. data/docs/CmpUseType.md +15 -0
  99. data/docs/CountryExtended.md +15 -0
  100. data/docs/CountryExtendedExpanded.md +15 -0
  101. data/docs/CreativePatch.md +22 -0
  102. data/docs/CreativeResponse.md +42 -0
  103. data/docs/CreativeWritable.md +34 -0
  104. data/docs/CreativesApi.md +226 -0
  105. data/docs/CustomEnvelopeReturned.md +22 -0
  106. data/docs/DefaultApi.md +75 -0
  107. data/docs/DeliverabilityAnalysis.md +46 -0
  108. data/docs/DpvFootnote.md +15 -0
  109. data/docs/EngineHtml.md +15 -0
  110. data/docs/EventType.md +24 -0
  111. data/docs/Events.md +28 -0
  112. data/docs/Export.md +32 -0
  113. data/docs/ExportModel.md +18 -0
  114. data/docs/GeocodeAddresses.md +20 -0
  115. data/docs/GeocodeComponents.md +20 -0
  116. data/docs/HTTPValidationError.md +18 -0
  117. data/docs/IdentityValidation.md +34 -0
  118. data/docs/IdentityValidationApi.md +78 -0
  119. data/docs/InlineObject.md +18 -0
  120. data/docs/IntlAutocompletions.md +20 -0
  121. data/docs/IntlAutocompletionsApi.md +82 -0
  122. data/docs/IntlAutocompletionsWritable.md +26 -0
  123. data/docs/IntlComponents.md +26 -0
  124. data/docs/IntlSuggestions.md +30 -0
  125. data/docs/IntlVerification.md +38 -0
  126. data/docs/IntlVerificationOrError.md +40 -0
  127. data/docs/IntlVerificationWritable.md +32 -0
  128. data/docs/IntlVerifications.md +20 -0
  129. data/docs/IntlVerificationsApi.md +153 -0
  130. data/docs/IntlVerificationsPayload.md +18 -0
  131. data/docs/Letter.md +72 -0
  132. data/docs/LetterCustomEnvelope.md +22 -0
  133. data/docs/LetterDeletion.md +22 -0
  134. data/docs/LetterDetailsReturned.md +36 -0
  135. data/docs/LetterDetailsWritable.md +32 -0
  136. data/docs/LetterEditable.md +52 -0
  137. data/docs/LetterList.md +28 -0
  138. data/docs/LettersApi.md +317 -0
  139. data/docs/LobConfidenceScore.md +20 -0
  140. data/docs/LobError.md +22 -0
  141. data/docs/Location.md +20 -0
  142. data/docs/LocationAnalysis.md +22 -0
  143. data/docs/MailType.md +15 -0
  144. data/docs/MultiLineAddress.md +32 -0
  145. data/docs/MultipleComponents.md +30 -0
  146. data/docs/MultipleComponentsIntl.md +30 -0
  147. data/docs/MultipleComponentsList.md +18 -0
  148. data/docs/PlaceholderModel.md +28 -0
  149. data/docs/Postcard.md +60 -0
  150. data/docs/PostcardDeletion.md +22 -0
  151. data/docs/PostcardDetailsReturned.md +26 -0
  152. data/docs/PostcardDetailsWritable.md +20 -0
  153. data/docs/PostcardEditable.md +40 -0
  154. data/docs/PostcardList.md +28 -0
  155. data/docs/PostcardSize.md +15 -0
  156. data/docs/PostcardsApi.md +317 -0
  157. data/docs/QrCode.md +30 -0
  158. data/docs/ReturnEnvelope.md +24 -0
  159. data/docs/ReverseGeocode.md +22 -0
  160. data/docs/ReverseGeocodeLookupsApi.md +82 -0
  161. data/docs/SelfMailer.md +48 -0
  162. data/docs/SelfMailerDeletion.md +22 -0
  163. data/docs/SelfMailerEditable.md +38 -0
  164. data/docs/SelfMailerList.md +28 -0
  165. data/docs/SelfMailerSize.md +15 -0
  166. data/docs/SelfMailersApi.md +317 -0
  167. data/docs/SortBy.md +20 -0
  168. data/docs/SortBy1.md +20 -0
  169. data/docs/SortBy2.md +20 -0
  170. data/docs/SortBy3.md +20 -0
  171. data/docs/SortByDateModified.md +20 -0
  172. data/docs/Suggestions.md +26 -0
  173. data/docs/Template.md +34 -0
  174. data/docs/TemplateDeletion.md +22 -0
  175. data/docs/TemplateList.md +28 -0
  176. data/docs/TemplateUpdate.md +20 -0
  177. data/docs/TemplateVersion.md +36 -0
  178. data/docs/TemplateVersionDeletion.md +22 -0
  179. data/docs/TemplateVersionList.md +28 -0
  180. data/docs/TemplateVersionUpdatable.md +20 -0
  181. data/docs/TemplateVersionWritable.md +22 -0
  182. data/docs/TemplateVersionsApi.md +384 -0
  183. data/docs/TemplateWritable.md +24 -0
  184. data/docs/TemplatesApi.md +376 -0
  185. data/docs/Thumbnail.md +22 -0
  186. data/docs/TrackingEventCertified.md +34 -0
  187. data/docs/TrackingEventDetails.md +24 -0
  188. data/docs/TrackingEventNormal.md +34 -0
  189. data/docs/Upload.md +44 -0
  190. data/docs/UploadCreateExport.md +20 -0
  191. data/docs/UploadFile.md +20 -0
  192. data/docs/UploadState.md +15 -0
  193. data/docs/UploadUpdatable.md +20 -0
  194. data/docs/UploadWritable.md +18 -0
  195. data/docs/UploadsApi.md +584 -0
  196. data/docs/UsAutocompletions.md +22 -0
  197. data/docs/UsAutocompletionsApi.md +78 -0
  198. data/docs/UsAutocompletionsWritable.md +26 -0
  199. data/docs/UsComponents.md +70 -0
  200. data/docs/UsVerification.md +38 -0
  201. data/docs/UsVerificationOrError.md +40 -0
  202. data/docs/UsVerifications.md +20 -0
  203. data/docs/UsVerificationsApi.md +157 -0
  204. data/docs/UsVerificationsWritable.md +32 -0
  205. data/docs/ValidationError.md +22 -0
  206. data/docs/Zip.md +26 -0
  207. data/docs/ZipCodeType.md +15 -0
  208. data/docs/ZipEditable.md +18 -0
  209. data/docs/ZipLookupCity.md +26 -0
  210. data/docs/ZipLookupsApi.md +78 -0
  211. data/git_push.sh +57 -0
  212. data/lib/lob.rb +1 -7
  213. data/lib/openapi_client/api/addresses_api.rb +318 -0
  214. data/lib/openapi_client/api/bank_accounts_api.rb +397 -0
  215. data/lib/openapi_client/api/billing_groups_api.rb +320 -0
  216. data/lib/openapi_client/api/buckslip_orders_api.rb +183 -0
  217. data/lib/openapi_client/api/buckslips_api.rb +385 -0
  218. data/lib/openapi_client/api/campaigns_api.rb +389 -0
  219. data/lib/openapi_client/api/card_orders_api.rb +183 -0
  220. data/lib/openapi_client/api/cards_api.rb +382 -0
  221. data/lib/openapi_client/api/checks_api.rb +337 -0
  222. data/lib/openapi_client/api/creatives_api.rb +244 -0
  223. data/lib/openapi_client/api/default_api.rb +79 -0
  224. data/lib/openapi_client/api/identity_validation_api.rb +90 -0
  225. data/lib/openapi_client/api/intl_autocompletions_api.rb +97 -0
  226. data/lib/openapi_client/api/intl_verifications_api.rb +165 -0
  227. data/lib/openapi_client/api/letters_api.rb +343 -0
  228. data/lib/openapi_client/api/postcards_api.rb +340 -0
  229. data/lib/openapi_client/api/reverse_geocode_lookups_api.rb +101 -0
  230. data/lib/openapi_client/api/self_mailers_api.rb +340 -0
  231. data/lib/openapi_client/api/template_versions_api.rb +440 -0
  232. data/lib/openapi_client/api/templates_api.rb +397 -0
  233. data/lib/openapi_client/api/uploads_api.rb +604 -0
  234. data/lib/openapi_client/api/us_autocompletions_api.rb +90 -0
  235. data/lib/openapi_client/api/us_verifications_api.rb +172 -0
  236. data/lib/openapi_client/api/zip_lookups_api.rb +90 -0
  237. data/lib/openapi_client/api_client.rb +392 -0
  238. data/lib/openapi_client/api_error.rb +57 -0
  239. data/lib/openapi_client/configuration.rb +279 -0
  240. data/lib/openapi_client/models/address.rb +616 -0
  241. data/lib/openapi_client/models/address_deletion.rb +303 -0
  242. data/lib/openapi_client/models/address_domestic.rb +522 -0
  243. data/lib/openapi_client/models/address_domestic_expanded.rb +521 -0
  244. data/lib/openapi_client/models/address_editable.rb +503 -0
  245. data/lib/openapi_client/models/address_list.rb +324 -0
  246. data/lib/openapi_client/models/bank_account.rb +576 -0
  247. data/lib/openapi_client/models/bank_account_deletion.rb +303 -0
  248. data/lib/openapi_client/models/bank_account_list.rb +324 -0
  249. data/lib/openapi_client/models/bank_account_verify.rb +264 -0
  250. data/lib/openapi_client/models/bank_account_writable.rb +387 -0
  251. data/lib/openapi_client/models/bank_type_enum.rb +37 -0
  252. data/lib/openapi_client/models/billing_group.rb +395 -0
  253. data/lib/openapi_client/models/billing_group_editable.rb +278 -0
  254. data/lib/openapi_client/models/billing_group_list.rb +314 -0
  255. data/lib/openapi_client/models/buckslip.rb +814 -0
  256. data/lib/openapi_client/models/buckslip_deletion.rb +257 -0
  257. data/lib/openapi_client/models/buckslip_editable.rb +316 -0
  258. data/lib/openapi_client/models/buckslip_order.rb +438 -0
  259. data/lib/openapi_client/models/buckslip_order_editable.rb +262 -0
  260. data/lib/openapi_client/models/buckslip_orders_list.rb +312 -0
  261. data/lib/openapi_client/models/buckslip_updatable.rb +289 -0
  262. data/lib/openapi_client/models/buckslips_list.rb +324 -0
  263. data/lib/openapi_client/models/bulk_error.rb +229 -0
  264. data/lib/openapi_client/models/bulk_error_properties.rb +274 -0
  265. data/lib/openapi_client/models/campaign.rb +549 -0
  266. data/lib/openapi_client/models/campaign_creative.rb +467 -0
  267. data/lib/openapi_client/models/campaign_deletion.rb +257 -0
  268. data/lib/openapi_client/models/campaign_updatable.rb +341 -0
  269. data/lib/openapi_client/models/campaign_writable.rb +373 -0
  270. data/lib/openapi_client/models/campaigns_list.rb +324 -0
  271. data/lib/openapi_client/models/card.rb +681 -0
  272. data/lib/openapi_client/models/card_deletion.rb +303 -0
  273. data/lib/openapi_client/models/card_editable.rb +318 -0
  274. data/lib/openapi_client/models/card_list.rb +324 -0
  275. data/lib/openapi_client/models/card_order.rb +438 -0
  276. data/lib/openapi_client/models/card_order_editable.rb +261 -0
  277. data/lib/openapi_client/models/card_order_list.rb +273 -0
  278. data/lib/openapi_client/models/card_updatable.rb +289 -0
  279. data/lib/openapi_client/models/check.rb +812 -0
  280. data/lib/openapi_client/models/check_deletion.rb +303 -0
  281. data/lib/openapi_client/models/check_editable.rb +537 -0
  282. data/lib/openapi_client/models/check_list.rb +324 -0
  283. data/lib/openapi_client/models/chk_use_type.rb +38 -0
  284. data/lib/openapi_client/models/cmp_schedule_type.rb +36 -0
  285. data/lib/openapi_client/models/cmp_use_type.rb +38 -0
  286. data/lib/openapi_client/models/country_extended.rb +254 -0
  287. data/lib/openapi_client/models/country_extended_expanded.rb +255 -0
  288. data/lib/openapi_client/models/creative_patch.rb +274 -0
  289. data/lib/openapi_client/models/creative_response.rb +444 -0
  290. data/lib/openapi_client/models/creative_writable.rb +400 -0
  291. data/lib/openapi_client/models/custom_envelope_returned.rb +319 -0
  292. data/lib/openapi_client/models/deliverability_analysis.rb +601 -0
  293. data/lib/openapi_client/models/dpv_footnote.rb +54 -0
  294. data/lib/openapi_client/models/engine_html.rb +37 -0
  295. data/lib/openapi_client/models/event_type.rb +325 -0
  296. data/lib/openapi_client/models/events.rb +365 -0
  297. data/lib/openapi_client/models/export.rb +422 -0
  298. data/lib/openapi_client/models/export_model.rb +262 -0
  299. data/lib/openapi_client/models/geocode_addresses.rb +237 -0
  300. data/lib/openapi_client/models/geocode_components.rb +291 -0
  301. data/lib/openapi_client/models/http_validation_error.rb +230 -0
  302. data/lib/openapi_client/models/identity_validation.rb +460 -0
  303. data/lib/openapi_client/models/inline_object.rb +229 -0
  304. data/lib/openapi_client/models/intl_autocompletions.rb +282 -0
  305. data/lib/openapi_client/models/intl_autocompletions_writable.rb +278 -0
  306. data/lib/openapi_client/models/intl_components.rb +314 -0
  307. data/lib/openapi_client/models/intl_suggestions.rb +372 -0
  308. data/lib/openapi_client/models/intl_verification.rb +463 -0
  309. data/lib/openapi_client/models/intl_verification_or_error.rb +466 -0
  310. data/lib/openapi_client/models/intl_verification_writable.rb +388 -0
  311. data/lib/openapi_client/models/intl_verifications.rb +250 -0
  312. data/lib/openapi_client/models/intl_verifications_payload.rb +263 -0
  313. data/lib/openapi_client/models/letter.rb +737 -0
  314. data/lib/openapi_client/models/letter_custom_envelope.rb +300 -0
  315. data/lib/openapi_client/models/letter_deletion.rb +303 -0
  316. data/lib/openapi_client/models/letter_details_returned.rb +393 -0
  317. data/lib/openapi_client/models/letter_details_writable.rb +390 -0
  318. data/lib/openapi_client/models/letter_editable.rb +532 -0
  319. data/lib/openapi_client/models/letter_list.rb +324 -0
  320. data/lib/openapi_client/models/lob_confidence_score.rb +299 -0
  321. data/lib/openapi_client/models/lob_error.rb +296 -0
  322. data/lib/openapi_client/models/location.rb +289 -0
  323. data/lib/openapi_client/models/location_analysis.rb +305 -0
  324. data/lib/openapi_client/models/ltr_use_type.rb +38 -0
  325. data/lib/openapi_client/models/mail_type.rb +37 -0
  326. data/lib/openapi_client/models/multi_line_address.rb +431 -0
  327. data/lib/openapi_client/models/multiple_components.rb +405 -0
  328. data/lib/openapi_client/models/multiple_components_intl.rb +377 -0
  329. data/lib/openapi_client/models/multiple_components_list.rb +263 -0
  330. data/lib/openapi_client/models/optional_address_column_mapping.rb +259 -0
  331. data/lib/openapi_client/models/placeholder_model.rb +273 -0
  332. data/lib/openapi_client/models/postcard.rb +656 -0
  333. data/lib/openapi_client/models/postcard_deletion.rb +303 -0
  334. data/lib/openapi_client/models/postcard_details_returned.rb +321 -0
  335. data/lib/openapi_client/models/postcard_details_writable.rb +242 -0
  336. data/lib/openapi_client/models/postcard_editable.rb +393 -0
  337. data/lib/openapi_client/models/postcard_list.rb +324 -0
  338. data/lib/openapi_client/models/postcard_size.rb +38 -0
  339. data/lib/openapi_client/models/psc_use_type.rb +38 -0
  340. data/lib/openapi_client/models/qr_code.rb +339 -0
  341. data/lib/openapi_client/models/required_address_column_mapping.rb +285 -0
  342. data/lib/openapi_client/models/return_envelope.rb +258 -0
  343. data/lib/openapi_client/models/reverse_geocode.rb +304 -0
  344. data/lib/openapi_client/models/self_mailer.rb +584 -0
  345. data/lib/openapi_client/models/self_mailer_deletion.rb +303 -0
  346. data/lib/openapi_client/models/self_mailer_editable.rb +384 -0
  347. data/lib/openapi_client/models/self_mailer_list.rb +324 -0
  348. data/lib/openapi_client/models/self_mailer_size.rb +38 -0
  349. data/lib/openapi_client/models/sfm_use_type.rb +38 -0
  350. data/lib/openapi_client/models/sort_by.rb +283 -0
  351. data/lib/openapi_client/models/sort_by1.rb +283 -0
  352. data/lib/openapi_client/models/sort_by2.rb +283 -0
  353. data/lib/openapi_client/models/sort_by3.rb +283 -0
  354. data/lib/openapi_client/models/sort_by_date_modified.rb +283 -0
  355. data/lib/openapi_client/models/suggestions.rb +343 -0
  356. data/lib/openapi_client/models/template.rb +406 -0
  357. data/lib/openapi_client/models/template_deletion.rb +303 -0
  358. data/lib/openapi_client/models/template_list.rb +324 -0
  359. data/lib/openapi_client/models/template_update.rb +272 -0
  360. data/lib/openapi_client/models/template_version.rb +423 -0
  361. data/lib/openapi_client/models/template_version_deletion.rb +303 -0
  362. data/lib/openapi_client/models/template_version_list.rb +324 -0
  363. data/lib/openapi_client/models/template_version_updatable.rb +257 -0
  364. data/lib/openapi_client/models/template_version_writable.rb +291 -0
  365. data/lib/openapi_client/models/template_writable.rb +309 -0
  366. data/lib/openapi_client/models/thumbnail.rb +300 -0
  367. data/lib/openapi_client/models/tracking_event_certified.rb +419 -0
  368. data/lib/openapi_client/models/tracking_event_details.rb +308 -0
  369. data/lib/openapi_client/models/tracking_event_normal.rb +409 -0
  370. data/lib/openapi_client/models/upload.rb +498 -0
  371. data/lib/openapi_client/models/upload_create_export.rb +283 -0
  372. data/lib/openapi_client/models/upload_file.rb +283 -0
  373. data/lib/openapi_client/models/upload_state.rb +42 -0
  374. data/lib/openapi_client/models/upload_updatable.rb +267 -0
  375. data/lib/openapi_client/models/upload_writable.rb +271 -0
  376. data/lib/openapi_client/models/uploads_metadata.rb +237 -0
  377. data/lib/openapi_client/models/us_autocompletions.rb +328 -0
  378. data/lib/openapi_client/models/us_autocompletions_writable.rb +274 -0
  379. data/lib/openapi_client/models/us_components.rb +788 -0
  380. data/lib/openapi_client/models/us_verification.rb +461 -0
  381. data/lib/openapi_client/models/us_verification_or_error.rb +459 -0
  382. data/lib/openapi_client/models/us_verifications.rb +250 -0
  383. data/lib/openapi_client/models/us_verifications_writable.rb +421 -0
  384. data/lib/openapi_client/models/validation_error.rb +263 -0
  385. data/lib/openapi_client/models/zip.rb +363 -0
  386. data/lib/openapi_client/models/zip_code_type.rb +40 -0
  387. data/lib/openapi_client/models/zip_editable.rb +246 -0
  388. data/lib/openapi_client/models/zip_lookup_city.rb +331 -0
  389. data/lib/openapi_client/version.rb +15 -0
  390. data/lib/openapi_client.rb +212 -0
  391. data/openapi_client.gemspec +37 -0
  392. data/spec/api/addresses_api_spec.rb +88 -0
  393. data/spec/api/bank_accounts_api_spec.rb +101 -0
  394. data/spec/api/billing_groups_api_spec.rb +89 -0
  395. data/spec/api/campaigns_api_spec.rb +100 -0
  396. data/spec/api/card_orders_api_spec.rb +62 -0
  397. data/spec/api/cards_api_spec.rb +99 -0
  398. data/spec/api/checks_api_spec.rb +93 -0
  399. data/spec/api/creatives_api_spec.rb +73 -0
  400. data/spec/api/default_api_spec.rb +46 -0
  401. data/spec/api/identity_validation_api_spec.rb +47 -0
  402. data/spec/api/intl_autocompletions_api_spec.rb +48 -0
  403. data/spec/api/intl_verifications_api_spec.rb +60 -0
  404. data/spec/api/letters_api_spec.rb +94 -0
  405. data/spec/api/postcards_api_spec.rb +94 -0
  406. data/spec/api/reverse_geocode_lookups_api_spec.rb +48 -0
  407. data/spec/api/self_mailers_api_spec.rb +94 -0
  408. data/spec/api/template_versions_api_spec.rb +105 -0
  409. data/spec/api/templates_api_spec.rb +101 -0
  410. data/spec/api/uploads_api_spec.rb +135 -0
  411. data/spec/api/us_autocompletions_api_spec.rb +47 -0
  412. data/spec/api/us_verifications_api_spec.rb +61 -0
  413. data/spec/api/zip_lookups_api_spec.rb +47 -0
  414. data/spec/api_client_spec.rb +226 -0
  415. data/spec/configuration_spec.rb +42 -0
  416. data/spec/spec_helper.rb +107 -13
  417. metadata +452 -139
  418. data/.gitignore +0 -18
  419. data/.travis.yml +0 -13
  420. data/CHANGELOG.md +0 -129
  421. data/CONTRIBUTING.md +0 -19
  422. data/LICENSE.txt +0 -22
  423. data/examples/README.md +0 -33
  424. data/examples/checks.rb +0 -48
  425. data/examples/csv_checks/create_checks.rb +0 -47
  426. data/examples/csv_checks/input.csv +0 -6
  427. data/examples/csv_letters/create_letters.rb +0 -40
  428. data/examples/csv_letters/input.csv +0 -6
  429. data/examples/csv_letters/letter_template.html +0 -33
  430. data/examples/csv_postcards/create_postcards.rb +0 -45
  431. data/examples/csv_postcards/input.csv +0 -7
  432. data/examples/csv_postcards/postcard_back.html +0 -38
  433. data/examples/csv_postcards/postcard_front.html +0 -25
  434. data/examples/csv_verify/input.csv +0 -7
  435. data/examples/csv_verify/verify.rb +0 -36
  436. data/examples/letters.rb +0 -72
  437. data/examples/postcards.rb +0 -86
  438. data/lib/lob/client.rb +0 -71
  439. data/lib/lob/errors/invalid_request_error.rb +0 -4
  440. data/lib/lob/errors/lob_error.rb +0 -20
  441. data/lib/lob/resources/address.rb +0 -14
  442. data/lib/lob/resources/bank_account.rb +0 -30
  443. data/lib/lob/resources/check.rb +0 -14
  444. data/lib/lob/resources/group.rb +0 -14
  445. data/lib/lob/resources/groups_member.rb +0 -66
  446. data/lib/lob/resources/intl_verifications.rb +0 -26
  447. data/lib/lob/resources/letter.rb +0 -14
  448. data/lib/lob/resources/postcard.rb +0 -14
  449. data/lib/lob/resources/resource_base.rb +0 -142
  450. data/lib/lob/resources/us_autocompletions.rb +0 -26
  451. data/lib/lob/resources/us_verifications.rb +0 -27
  452. data/lib/lob/resources/us_zip_lookups.rb +0 -26
  453. data/lib/lob/version.rb +0 -3
  454. data/lob.gemspec +0 -28
  455. data/spec/lob/errors/lob_error_spec.rb +0 -19
  456. data/spec/lob/resources/address_spec.rb +0 -55
  457. data/spec/lob/resources/bank_account_spec.rb +0 -60
  458. data/spec/lob/resources/check_spec.rb +0 -119
  459. data/spec/lob/resources/group_spec.rb +0 -50
  460. data/spec/lob/resources/intl_verifications_spec.rb +0 -25
  461. data/spec/lob/resources/letter_spec.rb +0 -114
  462. data/spec/lob/resources/member_spec.rb +0 -65
  463. data/spec/lob/resources/postcard_spec.rb +0 -160
  464. data/spec/lob/resources/resource_base_spec.rb +0 -75
  465. data/spec/lob/resources/us_autocompletions_spec.rb +0 -24
  466. data/spec/lob/resources/us_verifications_spec.rb +0 -31
  467. data/spec/lob/resources/us_zip_lookups_spec.rb +0 -23
  468. data/spec/lob_spec.rb +0 -48
  469. data/spec/samples/8.5x11.pdf +0 -0
  470. data/spec/samples/postcardback.pdf +2 -2287
  471. data/spec/samples/postcardfront.pdf +1 -1549
@@ -0,0 +1,584 @@
1
+ # Lob::UploadsApi
2
+
3
+ All URIs are relative to *https://api.lob.com/v1*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**export_retrieve**](UploadsApi.md#export_retrieve) | **GET** /uploads/{upl_id}/exports/{ex_id} | get_export |
8
+ | [**upload_create**](UploadsApi.md#upload_create) | **POST** /uploads | create_upload |
9
+ | [**upload_delete**](UploadsApi.md#upload_delete) | **DELETE** /uploads/{upl_id} | delete_upload |
10
+ | [**upload_export_create**](UploadsApi.md#upload_export_create) | **POST** /uploads/{upl_id}/exports | create_export |
11
+ | [**upload_file_create**](UploadsApi.md#upload_file_create) | **POST** /uploads/{upl_id}/file | upload_file |
12
+ | [**upload_retrieve**](UploadsApi.md#upload_retrieve) | **GET** /uploads/{upl_id} | get_upload |
13
+ | [**upload_update**](UploadsApi.md#upload_update) | **PATCH** /uploads/{upl_id} | update_upload |
14
+ | [**uploads_list**](UploadsApi.md#uploads_list) | **GET** /uploads | list_upload |
15
+
16
+
17
+ ## export_retrieve
18
+
19
+ > <Export> export_retrieve(upl_id, ex_id)
20
+
21
+ get_export
22
+
23
+ Retrieves the details of an existing export. You need only supply the unique export identifier that was returned upon export creation. If you try retrieving an export immediately after creating one (i.e., before we're done processing the export), you will get back an export object with `state = in_progress`.
24
+
25
+ ### Examples
26
+
27
+ ```ruby
28
+ require 'time'
29
+ require 'openapi_client'
30
+ # setup authorization
31
+ Lob.configure do |config|
32
+ # Configure HTTP basic authorization: basicAuth
33
+ config.username = 'YOUR USERNAME'
34
+ config.password = 'YOUR PASSWORD'
35
+ end
36
+
37
+ api_instance = Lob::UploadsApi.new
38
+ upl_id = 'upl_id_example' # String | ID of the upload
39
+ ex_id = 'ex_id_example' # String | ID of the export
40
+
41
+ begin
42
+ # get_export
43
+ result = api_instance.get_export(upl_id, ex_id)
44
+ p result
45
+ rescue Lob::ApiError => e
46
+ puts "Error when calling UploadsApi->get_export: #{e}"
47
+ end
48
+ ```
49
+
50
+ #### Using the export_retrieve_with_http_info variant
51
+
52
+ This returns an Array which contains the response data, status code and headers.
53
+
54
+ > <Array(<Export>, Integer, Hash)> export_retrieve_with_http_info(upl_id, ex_id)
55
+
56
+ ```ruby
57
+ begin
58
+ # get_export
59
+ data, status_code, headers = api_instance.export_retrieve_with_http_info(upl_id, ex_id)
60
+ p status_code # => 2xx
61
+ p headers # => { ... }
62
+ p data # => <Export>
63
+ rescue Lob::ApiError => e
64
+ puts "Error when calling UploadsApi->export_retrieve_with_http_info: #{e}"
65
+ end
66
+ ```
67
+
68
+ ### Parameters
69
+
70
+ | Name | Type | Description | Notes |
71
+ | ---- | ---- | ----------- | ----- |
72
+ | **upl_id** | **String** | ID of the upload | |
73
+ | **ex_id** | **String** | ID of the export | |
74
+
75
+ ### Return type
76
+
77
+ [**Export**](Export.md)
78
+
79
+ ### Authorization
80
+
81
+ [basicAuth](../README.md#basicAuth)
82
+
83
+ ### HTTP request headers
84
+
85
+ - **Content-Type**: Not defined
86
+ - **Accept**: application/json
87
+
88
+
89
+ ## upload_create
90
+
91
+ > <Upload> upload_create(upload_writable)
92
+
93
+ create_upload
94
+
95
+ Creates a new upload with the provided properties.
96
+
97
+ ### Examples
98
+
99
+ ```ruby
100
+ require 'time'
101
+ require 'openapi_client'
102
+ # setup authorization
103
+ Lob.configure do |config|
104
+ # Configure HTTP basic authorization: basicAuth
105
+ config.username = 'YOUR USERNAME'
106
+ config.password = 'YOUR PASSWORD'
107
+ end
108
+
109
+ api_instance = Lob::UploadsApi.new
110
+ upload_writable = Lob::UploadWritable.new({campaign_id: 'campaign_id_example'}) # UploadWritable |
111
+
112
+ begin
113
+ # create_upload
114
+ result = api_instance.create_upload(upload_writable)
115
+ p result
116
+ rescue Lob::ApiError => e
117
+ puts "Error when calling UploadsApi->create_upload: #{e}"
118
+ end
119
+ ```
120
+
121
+ #### Using the upload_create_with_http_info variant
122
+
123
+ This returns an Array which contains the response data, status code and headers.
124
+
125
+ > <Array(<Upload>, Integer, Hash)> upload_create_with_http_info(upload_writable)
126
+
127
+ ```ruby
128
+ begin
129
+ # create_upload
130
+ data, status_code, headers = api_instance.upload_create_with_http_info(upload_writable)
131
+ p status_code # => 2xx
132
+ p headers # => { ... }
133
+ p data # => <Upload>
134
+ rescue Lob::ApiError => e
135
+ puts "Error when calling UploadsApi->upload_create_with_http_info: #{e}"
136
+ end
137
+ ```
138
+
139
+ ### Parameters
140
+
141
+ | Name | Type | Description | Notes |
142
+ | ---- | ---- | ----------- | ----- |
143
+ | **upload_writable** | [**UploadWritable**](UploadWritable.md) | | |
144
+
145
+ ### Return type
146
+
147
+ [**Upload**](Upload.md)
148
+
149
+ ### Authorization
150
+
151
+ [basicAuth](../README.md#basicAuth)
152
+
153
+ ### HTTP request headers
154
+
155
+ - **Content-Type**: application/json
156
+ - **Accept**: application/json
157
+
158
+
159
+ ## upload_delete
160
+
161
+ > upload_delete(upl_id)
162
+
163
+ delete_upload
164
+
165
+ Delete an existing upload. You need only supply the unique identifier that was returned upon upload creation.
166
+
167
+ ### Examples
168
+
169
+ ```ruby
170
+ require 'time'
171
+ require 'openapi_client'
172
+ # setup authorization
173
+ Lob.configure do |config|
174
+ # Configure HTTP basic authorization: basicAuth
175
+ config.username = 'YOUR USERNAME'
176
+ config.password = 'YOUR PASSWORD'
177
+ end
178
+
179
+ api_instance = Lob::UploadsApi.new
180
+ upl_id = 'upl_id_example' # String | id of the upload
181
+
182
+ begin
183
+ # delete_upload
184
+ api_instance.delete_upload(upl_id)
185
+ rescue Lob::ApiError => e
186
+ puts "Error when calling UploadsApi->delete_upload: #{e}"
187
+ end
188
+ ```
189
+
190
+ #### Using the upload_delete_with_http_info variant
191
+
192
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
193
+
194
+ > <Array(nil, Integer, Hash)> upload_delete_with_http_info(upl_id)
195
+
196
+ ```ruby
197
+ begin
198
+ # delete_upload
199
+ data, status_code, headers = api_instance.upload_delete_with_http_info(upl_id)
200
+ p status_code # => 2xx
201
+ p headers # => { ... }
202
+ p data # => nil
203
+ rescue Lob::ApiError => e
204
+ puts "Error when calling UploadsApi->upload_delete_with_http_info: #{e}"
205
+ end
206
+ ```
207
+
208
+ ### Parameters
209
+
210
+ | Name | Type | Description | Notes |
211
+ | ---- | ---- | ----------- | ----- |
212
+ | **upl_id** | **String** | id of the upload | |
213
+
214
+ ### Return type
215
+
216
+ nil (empty response body)
217
+
218
+ ### Authorization
219
+
220
+ [basicAuth](../README.md#basicAuth)
221
+
222
+ ### HTTP request headers
223
+
224
+ - **Content-Type**: Not defined
225
+ - **Accept**: application/json
226
+
227
+
228
+ ## upload_export_create
229
+
230
+ > <UploadCreateExport> upload_export_create(upl_id, export_model)
231
+
232
+ create_export
233
+
234
+ Campaign Exports can help you understand exactly which records in a campaign could not be created. By initiating and retrieving an export, you will get row-by-row errors for your campaign. For a step-by-step walkthrough of creating a campaign and exporting failures, see our [Campaigns Guide](https://help.lob.com/best-practices/launching-your-first-campaign). Create an export file associated with an upload.
235
+
236
+ ### Examples
237
+
238
+ ```ruby
239
+ require 'time'
240
+ require 'openapi_client'
241
+ # setup authorization
242
+ Lob.configure do |config|
243
+ # Configure HTTP basic authorization: basicAuth
244
+ config.username = 'YOUR USERNAME'
245
+ config.password = 'YOUR PASSWORD'
246
+ end
247
+
248
+ api_instance = Lob::UploadsApi.new
249
+ upl_id = 'upl_id_example' # String | ID of the upload
250
+ export_model = Lob::ExportModel.new # ExportModel |
251
+
252
+ begin
253
+ # create_export
254
+ result = api_instance.create_export(upl_id, export_model)
255
+ p result
256
+ rescue Lob::ApiError => e
257
+ puts "Error when calling UploadsApi->create_export: #{e}"
258
+ end
259
+ ```
260
+
261
+ #### Using the upload_export_create_with_http_info variant
262
+
263
+ This returns an Array which contains the response data, status code and headers.
264
+
265
+ > <Array(<UploadCreateExport>, Integer, Hash)> upload_export_create_with_http_info(upl_id, export_model)
266
+
267
+ ```ruby
268
+ begin
269
+ # create_export
270
+ data, status_code, headers = api_instance.upload_export_create_with_http_info(upl_id, export_model)
271
+ p status_code # => 2xx
272
+ p headers # => { ... }
273
+ p data # => <UploadCreateExport>
274
+ rescue Lob::ApiError => e
275
+ puts "Error when calling UploadsApi->upload_export_create_with_http_info: #{e}"
276
+ end
277
+ ```
278
+
279
+ ### Parameters
280
+
281
+ | Name | Type | Description | Notes |
282
+ | ---- | ---- | ----------- | ----- |
283
+ | **upl_id** | **String** | ID of the upload | |
284
+ | **export_model** | [**ExportModel**](ExportModel.md) | | |
285
+
286
+ ### Return type
287
+
288
+ [**UploadCreateExport**](UploadCreateExport.md)
289
+
290
+ ### Authorization
291
+
292
+ [basicAuth](../README.md#basicAuth)
293
+
294
+ ### HTTP request headers
295
+
296
+ - **Content-Type**: application/json
297
+ - **Accept**: application/json
298
+
299
+
300
+ ## upload_file_create
301
+
302
+ > <UploadFile> upload_file_create(upl_id, file)
303
+
304
+ upload_file
305
+
306
+ Upload an [audience file](https://help.lob.com/best-practices/campaign-audience-guide) and associate it with an upload.
307
+
308
+ ### Examples
309
+
310
+ ```ruby
311
+ require 'time'
312
+ require 'openapi_client'
313
+ # setup authorization
314
+ Lob.configure do |config|
315
+ # Configure HTTP basic authorization: basicAuth
316
+ config.username = 'YOUR USERNAME'
317
+ config.password = 'YOUR PASSWORD'
318
+ end
319
+
320
+ api_instance = Lob::UploadsApi.new
321
+ upl_id = 'upl_id_example' # String | ID of the upload
322
+ file = TODO # AnyType |
323
+
324
+ begin
325
+ # upload_file
326
+ result = api_instance.upload_file(upl_id, file)
327
+ p result
328
+ rescue Lob::ApiError => e
329
+ puts "Error when calling UploadsApi->upload_file: #{e}"
330
+ end
331
+ ```
332
+
333
+ #### Using the upload_file_create_with_http_info variant
334
+
335
+ This returns an Array which contains the response data, status code and headers.
336
+
337
+ > <Array(<UploadFile>, Integer, Hash)> upload_file_create_with_http_info(upl_id, file)
338
+
339
+ ```ruby
340
+ begin
341
+ # upload_file
342
+ data, status_code, headers = api_instance.upload_file_create_with_http_info(upl_id, file)
343
+ p status_code # => 2xx
344
+ p headers # => { ... }
345
+ p data # => <UploadFile>
346
+ rescue Lob::ApiError => e
347
+ puts "Error when calling UploadsApi->upload_file_create_with_http_info: #{e}"
348
+ end
349
+ ```
350
+
351
+ ### Parameters
352
+
353
+ | Name | Type | Description | Notes |
354
+ | ---- | ---- | ----------- | ----- |
355
+ | **upl_id** | **String** | ID of the upload | |
356
+ | **file** | [**AnyType**](AnyType.md) | | |
357
+
358
+ ### Return type
359
+
360
+ [**UploadFile**](UploadFile.md)
361
+
362
+ ### Authorization
363
+
364
+ [basicAuth](../README.md#basicAuth)
365
+
366
+ ### HTTP request headers
367
+
368
+ - **Content-Type**: multipart/form-data
369
+ - **Accept**: application/json
370
+
371
+
372
+ ## upload_retrieve
373
+
374
+ > <Upload> upload_retrieve(upl_id)
375
+
376
+ get_upload
377
+
378
+ Retrieves the details of an existing upload. You need only supply the unique upload identifier that was returned upon upload creation.
379
+
380
+ ### Examples
381
+
382
+ ```ruby
383
+ require 'time'
384
+ require 'openapi_client'
385
+ # setup authorization
386
+ Lob.configure do |config|
387
+ # Configure HTTP basic authorization: basicAuth
388
+ config.username = 'YOUR USERNAME'
389
+ config.password = 'YOUR PASSWORD'
390
+ end
391
+
392
+ api_instance = Lob::UploadsApi.new
393
+ upl_id = 'upl_id_example' # String | id of the upload
394
+
395
+ begin
396
+ # get_upload
397
+ result = api_instance.get_upload(upl_id)
398
+ p result
399
+ rescue Lob::ApiError => e
400
+ puts "Error when calling UploadsApi->get_upload: #{e}"
401
+ end
402
+ ```
403
+
404
+ #### Using the upload_retrieve_with_http_info variant
405
+
406
+ This returns an Array which contains the response data, status code and headers.
407
+
408
+ > <Array(<Upload>, Integer, Hash)> upload_retrieve_with_http_info(upl_id)
409
+
410
+ ```ruby
411
+ begin
412
+ # get_upload
413
+ data, status_code, headers = api_instance.upload_retrieve_with_http_info(upl_id)
414
+ p status_code # => 2xx
415
+ p headers # => { ... }
416
+ p data # => <Upload>
417
+ rescue Lob::ApiError => e
418
+ puts "Error when calling UploadsApi->upload_retrieve_with_http_info: #{e}"
419
+ end
420
+ ```
421
+
422
+ ### Parameters
423
+
424
+ | Name | Type | Description | Notes |
425
+ | ---- | ---- | ----------- | ----- |
426
+ | **upl_id** | **String** | id of the upload | |
427
+
428
+ ### Return type
429
+
430
+ [**Upload**](Upload.md)
431
+
432
+ ### Authorization
433
+
434
+ [basicAuth](../README.md#basicAuth)
435
+
436
+ ### HTTP request headers
437
+
438
+ - **Content-Type**: Not defined
439
+ - **Accept**: application/json
440
+
441
+
442
+ ## upload_update
443
+
444
+ > <Upload> upload_update(upl_id, upload_updatable)
445
+
446
+ update_upload
447
+
448
+ Update the details of an existing upload. You need only supply the unique identifier that was returned upon upload creation.
449
+
450
+ ### Examples
451
+
452
+ ```ruby
453
+ require 'time'
454
+ require 'openapi_client'
455
+ # setup authorization
456
+ Lob.configure do |config|
457
+ # Configure HTTP basic authorization: basicAuth
458
+ config.username = 'YOUR USERNAME'
459
+ config.password = 'YOUR PASSWORD'
460
+ end
461
+
462
+ api_instance = Lob::UploadsApi.new
463
+ upl_id = 'upl_id_example' # String | id of the upload
464
+ upload_updatable = Lob::UploadUpdatable.new # UploadUpdatable |
465
+
466
+ begin
467
+ # update_upload
468
+ result = api_instance.update_upload(upl_id, upload_updatable)
469
+ p result
470
+ rescue Lob::ApiError => e
471
+ puts "Error when calling UploadsApi->update_upload: #{e}"
472
+ end
473
+ ```
474
+
475
+ #### Using the upload_update_with_http_info variant
476
+
477
+ This returns an Array which contains the response data, status code and headers.
478
+
479
+ > <Array(<Upload>, Integer, Hash)> upload_update_with_http_info(upl_id, upload_updatable)
480
+
481
+ ```ruby
482
+ begin
483
+ # update_upload
484
+ data, status_code, headers = api_instance.upload_update_with_http_info(upl_id, upload_updatable)
485
+ p status_code # => 2xx
486
+ p headers # => { ... }
487
+ p data # => <Upload>
488
+ rescue Lob::ApiError => e
489
+ puts "Error when calling UploadsApi->upload_update_with_http_info: #{e}"
490
+ end
491
+ ```
492
+
493
+ ### Parameters
494
+
495
+ | Name | Type | Description | Notes |
496
+ | ---- | ---- | ----------- | ----- |
497
+ | **upl_id** | **String** | id of the upload | |
498
+ | **upload_updatable** | [**UploadUpdatable**](UploadUpdatable.md) | | |
499
+
500
+ ### Return type
501
+
502
+ [**Upload**](Upload.md)
503
+
504
+ ### Authorization
505
+
506
+ [basicAuth](../README.md#basicAuth)
507
+
508
+ ### HTTP request headers
509
+
510
+ - **Content-Type**: application/json
511
+ - **Accept**: application/json
512
+
513
+
514
+ ## uploads_list
515
+
516
+ > <Array<Upload>> uploads_list(opts)
517
+
518
+ list_upload
519
+
520
+ Returns a list of your uploads. Optionally, filter uploads by campaign.
521
+
522
+ ### Examples
523
+
524
+ ```ruby
525
+ require 'time'
526
+ require 'openapi_client'
527
+ # setup authorization
528
+ Lob.configure do |config|
529
+ # Configure HTTP basic authorization: basicAuth
530
+ config.username = 'YOUR USERNAME'
531
+ config.password = 'YOUR PASSWORD'
532
+ end
533
+
534
+ api_instance = Lob::UploadsApi.new
535
+ opts = {
536
+ campaign_id: 'campaign_id_example' # String | id of the campaign
537
+ }
538
+
539
+ begin
540
+ # list_upload
541
+ result = api_instance.list_upload(opts)
542
+ p result
543
+ rescue Lob::ApiError => e
544
+ puts "Error when calling UploadsApi->list_upload: #{e}"
545
+ end
546
+ ```
547
+
548
+ #### Using the uploads_list_with_http_info variant
549
+
550
+ This returns an Array which contains the response data, status code and headers.
551
+
552
+ > <Array(<Array<Upload>>, Integer, Hash)> uploads_list_with_http_info(opts)
553
+
554
+ ```ruby
555
+ begin
556
+ # list_upload
557
+ data, status_code, headers = api_instance.uploads_list_with_http_info(opts)
558
+ p status_code # => 2xx
559
+ p headers # => { ... }
560
+ p data # => <Array<Upload>>
561
+ rescue Lob::ApiError => e
562
+ puts "Error when calling UploadsApi->uploads_list_with_http_info: #{e}"
563
+ end
564
+ ```
565
+
566
+ ### Parameters
567
+
568
+ | Name | Type | Description | Notes |
569
+ | ---- | ---- | ----------- | ----- |
570
+ | **campaign_id** | **String** | id of the campaign | [optional] |
571
+
572
+ ### Return type
573
+
574
+ [**Array&lt;Upload&gt;**](Upload.md)
575
+
576
+ ### Authorization
577
+
578
+ [basicAuth](../README.md#basicAuth)
579
+
580
+ ### HTTP request headers
581
+
582
+ - **Content-Type**: Not defined
583
+ - **Accept**: application/json
584
+
@@ -0,0 +1,22 @@
1
+ # Lob::UsAutocompletions
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Unique identifier prefixed with &#x60;us_auto_&#x60;. | [optional] |
8
+ | **suggestions** | [**Array&lt;Suggestions&gt;**](Suggestions.md) | An array of objects representing suggested addresses. | [optional] |
9
+ | **object** | **String** | Value is resource type. | [optional][default to &#39;us_autocompletion&#39;] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'openapi_client'
15
+
16
+ instance = Lob::UsAutocompletions.new(
17
+ id: null,
18
+ suggestions: null,
19
+ object: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,78 @@
1
+ # Lob::UsAutocompletionsApi
2
+
3
+ All URIs are relative to *https://api.lob.com/v1*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**us_autocompletion**](UsAutocompletionsApi.md#us_autocompletion) | **POST** /us_autocompletions | autocomplete |
8
+
9
+
10
+ ## us_autocompletion
11
+
12
+ > <UsAutocompletions> us_autocompletion(us_autocompletions_writable)
13
+
14
+ autocomplete
15
+
16
+ Given an address prefix consisting of a partial primary line, as well as optional input of city, state, and zip code, this functionality returns up to 10 full US address suggestions. Not all of them will turn out to be valid addresses; they'll need to be [verified](#operation/verification_us).
17
+
18
+ ### Examples
19
+
20
+ ```ruby
21
+ require 'time'
22
+ require 'openapi_client'
23
+ # setup authorization
24
+ Lob.configure do |config|
25
+ # Configure HTTP basic authorization: basicAuth
26
+ config.username = 'YOUR USERNAME'
27
+ config.password = 'YOUR PASSWORD'
28
+ end
29
+
30
+ api_instance = Lob::UsAutocompletionsApi.new
31
+ us_autocompletions_writable = Lob::UsAutocompletionsWritable.new({address_prefix: 'address_prefix_example'}) # UsAutocompletionsWritable |
32
+
33
+ begin
34
+ # autocomplete
35
+ result = api_instance.autocomplete(us_autocompletions_writable)
36
+ p result
37
+ rescue Lob::ApiError => e
38
+ puts "Error when calling UsAutocompletionsApi->autocomplete: #{e}"
39
+ end
40
+ ```
41
+
42
+ #### Using the us_autocompletion_with_http_info variant
43
+
44
+ This returns an Array which contains the response data, status code and headers.
45
+
46
+ > <Array(<UsAutocompletions>, Integer, Hash)> us_autocompletion_with_http_info(us_autocompletions_writable)
47
+
48
+ ```ruby
49
+ begin
50
+ # autocomplete
51
+ data, status_code, headers = api_instance.us_autocompletion_with_http_info(us_autocompletions_writable)
52
+ p status_code # => 2xx
53
+ p headers # => { ... }
54
+ p data # => <UsAutocompletions>
55
+ rescue Lob::ApiError => e
56
+ puts "Error when calling UsAutocompletionsApi->us_autocompletion_with_http_info: #{e}"
57
+ end
58
+ ```
59
+
60
+ ### Parameters
61
+
62
+ | Name | Type | Description | Notes |
63
+ | ---- | ---- | ----------- | ----- |
64
+ | **us_autocompletions_writable** | [**UsAutocompletionsWritable**](UsAutocompletionsWritable.md) | | |
65
+
66
+ ### Return type
67
+
68
+ [**UsAutocompletions**](UsAutocompletions.md)
69
+
70
+ ### Authorization
71
+
72
+ [basicAuth](../README.md#basicAuth)
73
+
74
+ ### HTTP request headers
75
+
76
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
77
+ - **Accept**: application/json
78
+
@@ -0,0 +1,26 @@
1
+ # Lob::UsAutocompletionsWritable
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **address_prefix** | **String** | Only accepts numbers and street names in an alphanumeric format. | |
8
+ | **city** | **String** | An optional city input used to filter suggestions. Case insensitive and does not match partial abbreviations. | [optional] |
9
+ | **state** | **String** | An optional state input used to filter suggestions. Case insensitive and does not match partial abbreviations. | [optional] |
10
+ | **zip_code** | **String** | An optional ZIP Code input used to filter suggestions. Matches partial entries. | [optional] |
11
+ | **geo_ip_sort** | **Boolean** | If &#x60;true&#x60;, sort suggestions by proximity to the IP set in the &#x60;X-Forwarded-For&#x60; header. | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'openapi_client'
17
+
18
+ instance = Lob::UsAutocompletionsWritable.new(
19
+ address_prefix: null,
20
+ city: null,
21
+ state: null,
22
+ zip_code: null,
23
+ geo_ip_sort: null
24
+ )
25
+ ```
26
+