lob 5.1.0 → 6.0.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (471) hide show
  1. checksums.yaml +5 -5
  2. data/CODE_SNIPPETS.md +1871 -0
  3. data/Gemfile +6 -1
  4. data/Gemfile.lock +72 -0
  5. data/LICENSE +21 -0
  6. data/MIGRATION.md +174 -0
  7. data/README.md +70 -154
  8. data/Rakefile +7 -5
  9. data/__tests__/Api/Address.unit.rb +210 -0
  10. data/__tests__/Api/BankAccount.unit.rb +244 -0
  11. data/__tests__/Api/BillingGroup.unit.rb +170 -0
  12. data/__tests__/Api/Card.unit.rb +183 -0
  13. data/__tests__/Api/CardOrder.unit.rb +89 -0
  14. data/__tests__/Api/Check.unit.rb +185 -0
  15. data/__tests__/Api/IntlAutocompletion.unit.rb +43 -0
  16. data/__tests__/Api/IntlVerification.unit.rb +71 -0
  17. data/__tests__/Api/Letter.unit.rb +191 -0
  18. data/__tests__/Api/Postcard.unit.rb +189 -0
  19. data/__tests__/Api/Require.unit.rb +21 -0
  20. data/__tests__/Api/ReverseGeocodeLookup.unit.rb +43 -0
  21. data/__tests__/Api/SelfMailer.unit.rb +190 -0
  22. data/__tests__/Api/Template.unit.rb +165 -0
  23. data/__tests__/Api/TemplateVersion.unit.rb +165 -0
  24. data/__tests__/Api/UsAutocompletion.unit.rb +42 -0
  25. data/__tests__/Api/UsVerification.unit.rb +71 -0
  26. data/__tests__/Api/ZipLookup.unit.rb +42 -0
  27. data/__tests__/Integration/Address.spec.rb +200 -0
  28. data/__tests__/Integration/BankAccount.spec.rb +243 -0
  29. data/__tests__/Integration/BillingGroup.spec.rb +163 -0
  30. data/__tests__/Integration/Card.spec.rb +198 -0
  31. data/__tests__/Integration/CardOrder.spec.rb +122 -0
  32. data/__tests__/Integration/Check.spec.rb +361 -0
  33. data/__tests__/Integration/IntlAutocompletion.spec.rb +54 -0
  34. data/__tests__/Integration/IntlVerification.spec.rb +90 -0
  35. data/__tests__/Integration/Letter.spec.rb +286 -0
  36. data/__tests__/Integration/Postcard.spec.rb +214 -0
  37. data/__tests__/Integration/ReverseGeocodeLookup.spec.rb +30 -0
  38. data/__tests__/Integration/SelfMailer.spec.rb +270 -0
  39. data/__tests__/Integration/Template.spec.rb +221 -0
  40. data/__tests__/Integration/TemplateVersion.spec.rb +275 -0
  41. data/__tests__/Integration/UsAutocompletion.spec.rb +54 -0
  42. data/__tests__/Integration/UsVerification.spec.rb +102 -0
  43. data/__tests__/Integration/ZipLookup.spec.rb +29 -0
  44. data/__tests__/TestFixtures.rb +36 -0
  45. data/docs/Address.md +52 -0
  46. data/docs/AddressDeletion.md +22 -0
  47. data/docs/AddressDomestic.md +40 -0
  48. data/docs/AddressDomesticExpanded.md +40 -0
  49. data/docs/AddressEditable.md +40 -0
  50. data/docs/AddressList.md +28 -0
  51. data/docs/AddressesApi.md +303 -0
  52. data/docs/BankAccount.md +44 -0
  53. data/docs/BankAccountDeletion.md +22 -0
  54. data/docs/BankAccountList.md +28 -0
  55. data/docs/BankAccountVerify.md +18 -0
  56. data/docs/BankAccountWritable.md +28 -0
  57. data/docs/BankAccountsApi.md +376 -0
  58. data/docs/BankTypeEnum.md +15 -0
  59. data/docs/BillingGroup.md +28 -0
  60. data/docs/BillingGroupEditable.md +20 -0
  61. data/docs/BillingGroupList.md +26 -0
  62. data/docs/BillingGroupsApi.md +305 -0
  63. data/docs/Buckslip.md +60 -0
  64. data/docs/BuckslipDeletion.md +20 -0
  65. data/docs/BuckslipEditable.md +24 -0
  66. data/docs/BuckslipOrder.md +42 -0
  67. data/docs/BuckslipOrderEditable.md +18 -0
  68. data/docs/BuckslipOrdersApi.md +157 -0
  69. data/docs/BuckslipOrdersList.md +26 -0
  70. data/docs/BuckslipUpdatable.md +22 -0
  71. data/docs/BuckslipsApi.md +372 -0
  72. data/docs/BuckslipsList.md +28 -0
  73. data/docs/BulkError.md +18 -0
  74. data/docs/BulkErrorProperties.md +20 -0
  75. data/docs/Campaign.md +52 -0
  76. data/docs/CampaignCreative.md +42 -0
  77. data/docs/CampaignDeletion.md +20 -0
  78. data/docs/CampaignUpdatable.md +36 -0
  79. data/docs/CampaignWritable.md +36 -0
  80. data/docs/CampaignsApi.md +376 -0
  81. data/docs/CampaignsList.md +28 -0
  82. data/docs/Card.md +54 -0
  83. data/docs/CardDeletion.md +22 -0
  84. data/docs/CardEditable.md +24 -0
  85. data/docs/CardList.md +28 -0
  86. data/docs/CardOrder.md +42 -0
  87. data/docs/CardOrderEditable.md +18 -0
  88. data/docs/CardOrderList.md +26 -0
  89. data/docs/CardOrdersApi.md +157 -0
  90. data/docs/CardUpdatable.md +22 -0
  91. data/docs/CardsApi.md +372 -0
  92. data/docs/Check.md +68 -0
  93. data/docs/CheckDeletion.md +22 -0
  94. data/docs/CheckEditable.md +48 -0
  95. data/docs/CheckList.md +28 -0
  96. data/docs/ChecksApi.md +315 -0
  97. data/docs/CmpScheduleType.md +15 -0
  98. data/docs/CmpUseType.md +15 -0
  99. data/docs/CountryExtended.md +15 -0
  100. data/docs/CountryExtendedExpanded.md +15 -0
  101. data/docs/CreativePatch.md +22 -0
  102. data/docs/CreativeResponse.md +42 -0
  103. data/docs/CreativeWritable.md +34 -0
  104. data/docs/CreativesApi.md +226 -0
  105. data/docs/CustomEnvelopeReturned.md +22 -0
  106. data/docs/DefaultApi.md +75 -0
  107. data/docs/DeliverabilityAnalysis.md +46 -0
  108. data/docs/DpvFootnote.md +15 -0
  109. data/docs/EngineHtml.md +15 -0
  110. data/docs/EventType.md +24 -0
  111. data/docs/Events.md +28 -0
  112. data/docs/Export.md +32 -0
  113. data/docs/ExportModel.md +18 -0
  114. data/docs/GeocodeAddresses.md +20 -0
  115. data/docs/GeocodeComponents.md +20 -0
  116. data/docs/HTTPValidationError.md +18 -0
  117. data/docs/IdentityValidation.md +34 -0
  118. data/docs/IdentityValidationApi.md +78 -0
  119. data/docs/InlineObject.md +18 -0
  120. data/docs/IntlAutocompletions.md +20 -0
  121. data/docs/IntlAutocompletionsApi.md +82 -0
  122. data/docs/IntlAutocompletionsWritable.md +26 -0
  123. data/docs/IntlComponents.md +26 -0
  124. data/docs/IntlSuggestions.md +30 -0
  125. data/docs/IntlVerification.md +38 -0
  126. data/docs/IntlVerificationOrError.md +40 -0
  127. data/docs/IntlVerificationWritable.md +32 -0
  128. data/docs/IntlVerifications.md +20 -0
  129. data/docs/IntlVerificationsApi.md +153 -0
  130. data/docs/IntlVerificationsPayload.md +18 -0
  131. data/docs/Letter.md +72 -0
  132. data/docs/LetterCustomEnvelope.md +22 -0
  133. data/docs/LetterDeletion.md +22 -0
  134. data/docs/LetterDetailsReturned.md +36 -0
  135. data/docs/LetterDetailsWritable.md +32 -0
  136. data/docs/LetterEditable.md +52 -0
  137. data/docs/LetterList.md +28 -0
  138. data/docs/LettersApi.md +317 -0
  139. data/docs/LobConfidenceScore.md +20 -0
  140. data/docs/LobError.md +22 -0
  141. data/docs/Location.md +20 -0
  142. data/docs/LocationAnalysis.md +22 -0
  143. data/docs/MailType.md +15 -0
  144. data/docs/MultiLineAddress.md +32 -0
  145. data/docs/MultipleComponents.md +30 -0
  146. data/docs/MultipleComponentsIntl.md +30 -0
  147. data/docs/MultipleComponentsList.md +18 -0
  148. data/docs/PlaceholderModel.md +28 -0
  149. data/docs/Postcard.md +60 -0
  150. data/docs/PostcardDeletion.md +22 -0
  151. data/docs/PostcardDetailsReturned.md +26 -0
  152. data/docs/PostcardDetailsWritable.md +20 -0
  153. data/docs/PostcardEditable.md +40 -0
  154. data/docs/PostcardList.md +28 -0
  155. data/docs/PostcardSize.md +15 -0
  156. data/docs/PostcardsApi.md +317 -0
  157. data/docs/QrCode.md +30 -0
  158. data/docs/ReturnEnvelope.md +24 -0
  159. data/docs/ReverseGeocode.md +22 -0
  160. data/docs/ReverseGeocodeLookupsApi.md +82 -0
  161. data/docs/SelfMailer.md +48 -0
  162. data/docs/SelfMailerDeletion.md +22 -0
  163. data/docs/SelfMailerEditable.md +38 -0
  164. data/docs/SelfMailerList.md +28 -0
  165. data/docs/SelfMailerSize.md +15 -0
  166. data/docs/SelfMailersApi.md +317 -0
  167. data/docs/SortBy.md +20 -0
  168. data/docs/SortBy1.md +20 -0
  169. data/docs/SortBy2.md +20 -0
  170. data/docs/SortBy3.md +20 -0
  171. data/docs/SortByDateModified.md +20 -0
  172. data/docs/Suggestions.md +26 -0
  173. data/docs/Template.md +34 -0
  174. data/docs/TemplateDeletion.md +22 -0
  175. data/docs/TemplateList.md +28 -0
  176. data/docs/TemplateUpdate.md +20 -0
  177. data/docs/TemplateVersion.md +36 -0
  178. data/docs/TemplateVersionDeletion.md +22 -0
  179. data/docs/TemplateVersionList.md +28 -0
  180. data/docs/TemplateVersionUpdatable.md +20 -0
  181. data/docs/TemplateVersionWritable.md +22 -0
  182. data/docs/TemplateVersionsApi.md +384 -0
  183. data/docs/TemplateWritable.md +24 -0
  184. data/docs/TemplatesApi.md +376 -0
  185. data/docs/Thumbnail.md +22 -0
  186. data/docs/TrackingEventCertified.md +34 -0
  187. data/docs/TrackingEventDetails.md +24 -0
  188. data/docs/TrackingEventNormal.md +34 -0
  189. data/docs/Upload.md +44 -0
  190. data/docs/UploadCreateExport.md +20 -0
  191. data/docs/UploadFile.md +20 -0
  192. data/docs/UploadState.md +15 -0
  193. data/docs/UploadUpdatable.md +20 -0
  194. data/docs/UploadWritable.md +18 -0
  195. data/docs/UploadsApi.md +584 -0
  196. data/docs/UsAutocompletions.md +22 -0
  197. data/docs/UsAutocompletionsApi.md +78 -0
  198. data/docs/UsAutocompletionsWritable.md +26 -0
  199. data/docs/UsComponents.md +70 -0
  200. data/docs/UsVerification.md +38 -0
  201. data/docs/UsVerificationOrError.md +40 -0
  202. data/docs/UsVerifications.md +20 -0
  203. data/docs/UsVerificationsApi.md +157 -0
  204. data/docs/UsVerificationsWritable.md +32 -0
  205. data/docs/ValidationError.md +22 -0
  206. data/docs/Zip.md +26 -0
  207. data/docs/ZipCodeType.md +15 -0
  208. data/docs/ZipEditable.md +18 -0
  209. data/docs/ZipLookupCity.md +26 -0
  210. data/docs/ZipLookupsApi.md +78 -0
  211. data/git_push.sh +57 -0
  212. data/lib/lob.rb +1 -7
  213. data/lib/openapi_client/api/addresses_api.rb +318 -0
  214. data/lib/openapi_client/api/bank_accounts_api.rb +397 -0
  215. data/lib/openapi_client/api/billing_groups_api.rb +320 -0
  216. data/lib/openapi_client/api/buckslip_orders_api.rb +183 -0
  217. data/lib/openapi_client/api/buckslips_api.rb +385 -0
  218. data/lib/openapi_client/api/campaigns_api.rb +389 -0
  219. data/lib/openapi_client/api/card_orders_api.rb +183 -0
  220. data/lib/openapi_client/api/cards_api.rb +382 -0
  221. data/lib/openapi_client/api/checks_api.rb +337 -0
  222. data/lib/openapi_client/api/creatives_api.rb +244 -0
  223. data/lib/openapi_client/api/default_api.rb +79 -0
  224. data/lib/openapi_client/api/identity_validation_api.rb +90 -0
  225. data/lib/openapi_client/api/intl_autocompletions_api.rb +97 -0
  226. data/lib/openapi_client/api/intl_verifications_api.rb +165 -0
  227. data/lib/openapi_client/api/letters_api.rb +343 -0
  228. data/lib/openapi_client/api/postcards_api.rb +340 -0
  229. data/lib/openapi_client/api/reverse_geocode_lookups_api.rb +101 -0
  230. data/lib/openapi_client/api/self_mailers_api.rb +340 -0
  231. data/lib/openapi_client/api/template_versions_api.rb +440 -0
  232. data/lib/openapi_client/api/templates_api.rb +397 -0
  233. data/lib/openapi_client/api/uploads_api.rb +604 -0
  234. data/lib/openapi_client/api/us_autocompletions_api.rb +90 -0
  235. data/lib/openapi_client/api/us_verifications_api.rb +172 -0
  236. data/lib/openapi_client/api/zip_lookups_api.rb +90 -0
  237. data/lib/openapi_client/api_client.rb +392 -0
  238. data/lib/openapi_client/api_error.rb +57 -0
  239. data/lib/openapi_client/configuration.rb +279 -0
  240. data/lib/openapi_client/models/address.rb +616 -0
  241. data/lib/openapi_client/models/address_deletion.rb +303 -0
  242. data/lib/openapi_client/models/address_domestic.rb +522 -0
  243. data/lib/openapi_client/models/address_domestic_expanded.rb +521 -0
  244. data/lib/openapi_client/models/address_editable.rb +503 -0
  245. data/lib/openapi_client/models/address_list.rb +324 -0
  246. data/lib/openapi_client/models/bank_account.rb +576 -0
  247. data/lib/openapi_client/models/bank_account_deletion.rb +303 -0
  248. data/lib/openapi_client/models/bank_account_list.rb +324 -0
  249. data/lib/openapi_client/models/bank_account_verify.rb +264 -0
  250. data/lib/openapi_client/models/bank_account_writable.rb +387 -0
  251. data/lib/openapi_client/models/bank_type_enum.rb +37 -0
  252. data/lib/openapi_client/models/billing_group.rb +395 -0
  253. data/lib/openapi_client/models/billing_group_editable.rb +278 -0
  254. data/lib/openapi_client/models/billing_group_list.rb +314 -0
  255. data/lib/openapi_client/models/buckslip.rb +814 -0
  256. data/lib/openapi_client/models/buckslip_deletion.rb +257 -0
  257. data/lib/openapi_client/models/buckslip_editable.rb +316 -0
  258. data/lib/openapi_client/models/buckslip_order.rb +438 -0
  259. data/lib/openapi_client/models/buckslip_order_editable.rb +262 -0
  260. data/lib/openapi_client/models/buckslip_orders_list.rb +312 -0
  261. data/lib/openapi_client/models/buckslip_updatable.rb +289 -0
  262. data/lib/openapi_client/models/buckslips_list.rb +324 -0
  263. data/lib/openapi_client/models/bulk_error.rb +229 -0
  264. data/lib/openapi_client/models/bulk_error_properties.rb +274 -0
  265. data/lib/openapi_client/models/campaign.rb +549 -0
  266. data/lib/openapi_client/models/campaign_creative.rb +467 -0
  267. data/lib/openapi_client/models/campaign_deletion.rb +257 -0
  268. data/lib/openapi_client/models/campaign_updatable.rb +341 -0
  269. data/lib/openapi_client/models/campaign_writable.rb +373 -0
  270. data/lib/openapi_client/models/campaigns_list.rb +324 -0
  271. data/lib/openapi_client/models/card.rb +681 -0
  272. data/lib/openapi_client/models/card_deletion.rb +303 -0
  273. data/lib/openapi_client/models/card_editable.rb +318 -0
  274. data/lib/openapi_client/models/card_list.rb +324 -0
  275. data/lib/openapi_client/models/card_order.rb +438 -0
  276. data/lib/openapi_client/models/card_order_editable.rb +261 -0
  277. data/lib/openapi_client/models/card_order_list.rb +273 -0
  278. data/lib/openapi_client/models/card_updatable.rb +289 -0
  279. data/lib/openapi_client/models/check.rb +812 -0
  280. data/lib/openapi_client/models/check_deletion.rb +303 -0
  281. data/lib/openapi_client/models/check_editable.rb +537 -0
  282. data/lib/openapi_client/models/check_list.rb +324 -0
  283. data/lib/openapi_client/models/chk_use_type.rb +38 -0
  284. data/lib/openapi_client/models/cmp_schedule_type.rb +36 -0
  285. data/lib/openapi_client/models/cmp_use_type.rb +38 -0
  286. data/lib/openapi_client/models/country_extended.rb +254 -0
  287. data/lib/openapi_client/models/country_extended_expanded.rb +255 -0
  288. data/lib/openapi_client/models/creative_patch.rb +274 -0
  289. data/lib/openapi_client/models/creative_response.rb +444 -0
  290. data/lib/openapi_client/models/creative_writable.rb +400 -0
  291. data/lib/openapi_client/models/custom_envelope_returned.rb +319 -0
  292. data/lib/openapi_client/models/deliverability_analysis.rb +601 -0
  293. data/lib/openapi_client/models/dpv_footnote.rb +54 -0
  294. data/lib/openapi_client/models/engine_html.rb +37 -0
  295. data/lib/openapi_client/models/event_type.rb +325 -0
  296. data/lib/openapi_client/models/events.rb +365 -0
  297. data/lib/openapi_client/models/export.rb +422 -0
  298. data/lib/openapi_client/models/export_model.rb +262 -0
  299. data/lib/openapi_client/models/geocode_addresses.rb +237 -0
  300. data/lib/openapi_client/models/geocode_components.rb +291 -0
  301. data/lib/openapi_client/models/http_validation_error.rb +230 -0
  302. data/lib/openapi_client/models/identity_validation.rb +460 -0
  303. data/lib/openapi_client/models/inline_object.rb +229 -0
  304. data/lib/openapi_client/models/intl_autocompletions.rb +282 -0
  305. data/lib/openapi_client/models/intl_autocompletions_writable.rb +278 -0
  306. data/lib/openapi_client/models/intl_components.rb +314 -0
  307. data/lib/openapi_client/models/intl_suggestions.rb +372 -0
  308. data/lib/openapi_client/models/intl_verification.rb +463 -0
  309. data/lib/openapi_client/models/intl_verification_or_error.rb +466 -0
  310. data/lib/openapi_client/models/intl_verification_writable.rb +388 -0
  311. data/lib/openapi_client/models/intl_verifications.rb +250 -0
  312. data/lib/openapi_client/models/intl_verifications_payload.rb +263 -0
  313. data/lib/openapi_client/models/letter.rb +737 -0
  314. data/lib/openapi_client/models/letter_custom_envelope.rb +300 -0
  315. data/lib/openapi_client/models/letter_deletion.rb +303 -0
  316. data/lib/openapi_client/models/letter_details_returned.rb +393 -0
  317. data/lib/openapi_client/models/letter_details_writable.rb +390 -0
  318. data/lib/openapi_client/models/letter_editable.rb +532 -0
  319. data/lib/openapi_client/models/letter_list.rb +324 -0
  320. data/lib/openapi_client/models/lob_confidence_score.rb +299 -0
  321. data/lib/openapi_client/models/lob_error.rb +296 -0
  322. data/lib/openapi_client/models/location.rb +289 -0
  323. data/lib/openapi_client/models/location_analysis.rb +305 -0
  324. data/lib/openapi_client/models/ltr_use_type.rb +38 -0
  325. data/lib/openapi_client/models/mail_type.rb +37 -0
  326. data/lib/openapi_client/models/multi_line_address.rb +431 -0
  327. data/lib/openapi_client/models/multiple_components.rb +405 -0
  328. data/lib/openapi_client/models/multiple_components_intl.rb +377 -0
  329. data/lib/openapi_client/models/multiple_components_list.rb +263 -0
  330. data/lib/openapi_client/models/optional_address_column_mapping.rb +259 -0
  331. data/lib/openapi_client/models/placeholder_model.rb +273 -0
  332. data/lib/openapi_client/models/postcard.rb +656 -0
  333. data/lib/openapi_client/models/postcard_deletion.rb +303 -0
  334. data/lib/openapi_client/models/postcard_details_returned.rb +321 -0
  335. data/lib/openapi_client/models/postcard_details_writable.rb +242 -0
  336. data/lib/openapi_client/models/postcard_editable.rb +393 -0
  337. data/lib/openapi_client/models/postcard_list.rb +324 -0
  338. data/lib/openapi_client/models/postcard_size.rb +38 -0
  339. data/lib/openapi_client/models/psc_use_type.rb +38 -0
  340. data/lib/openapi_client/models/qr_code.rb +339 -0
  341. data/lib/openapi_client/models/required_address_column_mapping.rb +285 -0
  342. data/lib/openapi_client/models/return_envelope.rb +258 -0
  343. data/lib/openapi_client/models/reverse_geocode.rb +304 -0
  344. data/lib/openapi_client/models/self_mailer.rb +584 -0
  345. data/lib/openapi_client/models/self_mailer_deletion.rb +303 -0
  346. data/lib/openapi_client/models/self_mailer_editable.rb +384 -0
  347. data/lib/openapi_client/models/self_mailer_list.rb +324 -0
  348. data/lib/openapi_client/models/self_mailer_size.rb +38 -0
  349. data/lib/openapi_client/models/sfm_use_type.rb +38 -0
  350. data/lib/openapi_client/models/sort_by.rb +283 -0
  351. data/lib/openapi_client/models/sort_by1.rb +283 -0
  352. data/lib/openapi_client/models/sort_by2.rb +283 -0
  353. data/lib/openapi_client/models/sort_by3.rb +283 -0
  354. data/lib/openapi_client/models/sort_by_date_modified.rb +283 -0
  355. data/lib/openapi_client/models/suggestions.rb +343 -0
  356. data/lib/openapi_client/models/template.rb +406 -0
  357. data/lib/openapi_client/models/template_deletion.rb +303 -0
  358. data/lib/openapi_client/models/template_list.rb +324 -0
  359. data/lib/openapi_client/models/template_update.rb +272 -0
  360. data/lib/openapi_client/models/template_version.rb +423 -0
  361. data/lib/openapi_client/models/template_version_deletion.rb +303 -0
  362. data/lib/openapi_client/models/template_version_list.rb +324 -0
  363. data/lib/openapi_client/models/template_version_updatable.rb +257 -0
  364. data/lib/openapi_client/models/template_version_writable.rb +291 -0
  365. data/lib/openapi_client/models/template_writable.rb +309 -0
  366. data/lib/openapi_client/models/thumbnail.rb +300 -0
  367. data/lib/openapi_client/models/tracking_event_certified.rb +419 -0
  368. data/lib/openapi_client/models/tracking_event_details.rb +308 -0
  369. data/lib/openapi_client/models/tracking_event_normal.rb +409 -0
  370. data/lib/openapi_client/models/upload.rb +498 -0
  371. data/lib/openapi_client/models/upload_create_export.rb +283 -0
  372. data/lib/openapi_client/models/upload_file.rb +283 -0
  373. data/lib/openapi_client/models/upload_state.rb +42 -0
  374. data/lib/openapi_client/models/upload_updatable.rb +267 -0
  375. data/lib/openapi_client/models/upload_writable.rb +271 -0
  376. data/lib/openapi_client/models/uploads_metadata.rb +237 -0
  377. data/lib/openapi_client/models/us_autocompletions.rb +328 -0
  378. data/lib/openapi_client/models/us_autocompletions_writable.rb +274 -0
  379. data/lib/openapi_client/models/us_components.rb +788 -0
  380. data/lib/openapi_client/models/us_verification.rb +461 -0
  381. data/lib/openapi_client/models/us_verification_or_error.rb +459 -0
  382. data/lib/openapi_client/models/us_verifications.rb +250 -0
  383. data/lib/openapi_client/models/us_verifications_writable.rb +421 -0
  384. data/lib/openapi_client/models/validation_error.rb +263 -0
  385. data/lib/openapi_client/models/zip.rb +363 -0
  386. data/lib/openapi_client/models/zip_code_type.rb +40 -0
  387. data/lib/openapi_client/models/zip_editable.rb +246 -0
  388. data/lib/openapi_client/models/zip_lookup_city.rb +331 -0
  389. data/lib/openapi_client/version.rb +15 -0
  390. data/lib/openapi_client.rb +212 -0
  391. data/openapi_client.gemspec +37 -0
  392. data/spec/api/addresses_api_spec.rb +88 -0
  393. data/spec/api/bank_accounts_api_spec.rb +101 -0
  394. data/spec/api/billing_groups_api_spec.rb +89 -0
  395. data/spec/api/campaigns_api_spec.rb +100 -0
  396. data/spec/api/card_orders_api_spec.rb +62 -0
  397. data/spec/api/cards_api_spec.rb +99 -0
  398. data/spec/api/checks_api_spec.rb +93 -0
  399. data/spec/api/creatives_api_spec.rb +73 -0
  400. data/spec/api/default_api_spec.rb +46 -0
  401. data/spec/api/identity_validation_api_spec.rb +47 -0
  402. data/spec/api/intl_autocompletions_api_spec.rb +48 -0
  403. data/spec/api/intl_verifications_api_spec.rb +60 -0
  404. data/spec/api/letters_api_spec.rb +94 -0
  405. data/spec/api/postcards_api_spec.rb +94 -0
  406. data/spec/api/reverse_geocode_lookups_api_spec.rb +48 -0
  407. data/spec/api/self_mailers_api_spec.rb +94 -0
  408. data/spec/api/template_versions_api_spec.rb +105 -0
  409. data/spec/api/templates_api_spec.rb +101 -0
  410. data/spec/api/uploads_api_spec.rb +135 -0
  411. data/spec/api/us_autocompletions_api_spec.rb +47 -0
  412. data/spec/api/us_verifications_api_spec.rb +61 -0
  413. data/spec/api/zip_lookups_api_spec.rb +47 -0
  414. data/spec/api_client_spec.rb +226 -0
  415. data/spec/configuration_spec.rb +42 -0
  416. data/spec/spec_helper.rb +107 -13
  417. metadata +452 -140
  418. data/.gitignore +0 -18
  419. data/.travis.yml +0 -16
  420. data/CHANGELOG.md +0 -114
  421. data/CONTRIBUTING.md +0 -19
  422. data/LICENSE.txt +0 -22
  423. data/examples/README.md +0 -33
  424. data/examples/checks.rb +0 -48
  425. data/examples/csv_checks/create_checks.rb +0 -47
  426. data/examples/csv_checks/input.csv +0 -6
  427. data/examples/csv_letters/create_letters.rb +0 -40
  428. data/examples/csv_letters/input.csv +0 -6
  429. data/examples/csv_letters/letter_template.html +0 -33
  430. data/examples/csv_postcards/create_postcards.rb +0 -45
  431. data/examples/csv_postcards/input.csv +0 -7
  432. data/examples/csv_postcards/postcard_back.html +0 -38
  433. data/examples/csv_postcards/postcard_front.html +0 -25
  434. data/examples/csv_verify/input.csv +0 -7
  435. data/examples/csv_verify/verify.rb +0 -36
  436. data/examples/letters.rb +0 -72
  437. data/examples/postcards.rb +0 -86
  438. data/lib/lob/client.rb +0 -71
  439. data/lib/lob/errors/invalid_request_error.rb +0 -4
  440. data/lib/lob/errors/lob_error.rb +0 -20
  441. data/lib/lob/resources/address.rb +0 -14
  442. data/lib/lob/resources/bank_account.rb +0 -30
  443. data/lib/lob/resources/check.rb +0 -14
  444. data/lib/lob/resources/group.rb +0 -14
  445. data/lib/lob/resources/groups_member.rb +0 -66
  446. data/lib/lob/resources/intl_verifications.rb +0 -26
  447. data/lib/lob/resources/letter.rb +0 -14
  448. data/lib/lob/resources/postcard.rb +0 -14
  449. data/lib/lob/resources/resource_base.rb +0 -139
  450. data/lib/lob/resources/us_autocompletions.rb +0 -26
  451. data/lib/lob/resources/us_verifications.rb +0 -27
  452. data/lib/lob/resources/us_zip_lookups.rb +0 -26
  453. data/lib/lob/version.rb +0 -3
  454. data/lob.gemspec +0 -28
  455. data/spec/lob/errors/lob_error_spec.rb +0 -19
  456. data/spec/lob/resources/address_spec.rb +0 -55
  457. data/spec/lob/resources/bank_account_spec.rb +0 -60
  458. data/spec/lob/resources/check_spec.rb +0 -98
  459. data/spec/lob/resources/group_spec.rb +0 -50
  460. data/spec/lob/resources/intl_verifications_spec.rb +0 -28
  461. data/spec/lob/resources/letter_spec.rb +0 -94
  462. data/spec/lob/resources/member_spec.rb +0 -65
  463. data/spec/lob/resources/postcard_spec.rb +0 -135
  464. data/spec/lob/resources/resource_base_spec.rb +0 -75
  465. data/spec/lob/resources/us_autocompletions_spec.rb +0 -24
  466. data/spec/lob/resources/us_verifications_spec.rb +0 -31
  467. data/spec/lob/resources/us_zip_lookups_spec.rb +0 -23
  468. data/spec/lob_spec.rb +0 -48
  469. data/spec/samples/8.5x11.pdf +0 -0
  470. data/spec/samples/postcardback.pdf +2 -2287
  471. data/spec/samples/postcardfront.pdf +1 -1549
@@ -0,0 +1,440 @@
1
+ =begin
2
+ #Lob
3
+
4
+ #The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors. <p> Looking for our [previous documentation](https://lob.github.io/legacy-docs/)?
5
+
6
+ The version of the OpenAPI document: 1.3.0
7
+ Contact: lob-openapi@lob.com
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.2.1
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module Lob
16
+ class TemplateVersionsApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # create
23
+ # Creates a new template version attached to the specified template.
24
+ # @param tmpl_id [String] The ID of the template the new version will be attached to
25
+ # @param template_version_writable [TemplateVersionWritable]
26
+ # @param [Hash] opts the optional parameters
27
+ # @return [TemplateVersion]
28
+ def create(tmpl_id, template_version_writable, opts = {})
29
+ data, _status_code, _headers = create_template_version_with_http_info(tmpl_id, template_version_writable, opts)
30
+ data
31
+ end
32
+
33
+ # create
34
+ # Creates a new template version attached to the specified template.
35
+ # @param tmpl_id [String] The ID of the template the new version will be attached to
36
+ # @param template_version_writable [TemplateVersionWritable]
37
+ # @param [Hash] opts the optional parameters
38
+ # @return [Array<(TemplateVersion, Integer, Hash)>] TemplateVersion data, response status code and response headers
39
+ def create_template_version_with_http_info(tmpl_id, template_version_writable, opts = {})
40
+ if @api_client.config.debugging
41
+ @api_client.config.logger.debug 'Calling API: TemplateVersionsApi.create_template_version ...'
42
+ end
43
+ # verify the required parameter 'tmpl_id' is set
44
+ if @api_client.config.client_side_validation && tmpl_id.nil?
45
+ fail ArgumentError, "Missing the required parameter 'tmpl_id' when calling TemplateVersionsApi.create_template_version"
46
+ end
47
+ pattern = Regexp.new(/^tmpl_[a-zA-Z0-9]+$/)
48
+ if @api_client.config.client_side_validation && tmpl_id !~ pattern
49
+ fail ArgumentError, "invalid value for 'tmpl_id' when calling TemplateVersionsApi.create_template_version, must conform to the pattern #{pattern}."
50
+ end
51
+
52
+ # verify the required parameter 'template_version_writable' is set
53
+ if @api_client.config.client_side_validation && template_version_writable.nil?
54
+ fail ArgumentError, "Missing the required parameter 'template_version_writable' when calling TemplateVersionsApi.create_template_version"
55
+ end
56
+ # resource path
57
+ local_var_path = '/templates/{tmpl_id}/versions'.sub('{' + 'tmpl_id' + '}', CGI.escape(tmpl_id.to_s))
58
+
59
+ # query parameters
60
+ query_params = opts[:query_params] || {}
61
+
62
+ # header parameters
63
+ header_params = opts[:header_params] || {}
64
+ # HTTP header 'Accept' (if needed)
65
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
66
+ # HTTP header 'Content-Type'
67
+ content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
68
+ if !content_type.nil?
69
+ header_params['Content-Type'] = content_type
70
+ end
71
+
72
+ # form parameters
73
+ form_params = opts[:form_params] || {}
74
+
75
+ # http body (model)
76
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(template_version_writable)
77
+
78
+ # return_type
79
+ return_type = opts[:debug_return_type] || 'TemplateVersion'
80
+
81
+ # auth_names
82
+ auth_names = opts[:debug_auth_names] || ['basicAuth']
83
+
84
+ new_options = opts.merge(
85
+ :operation => :"TemplateVersionsApi.create_template_version",
86
+ :header_params => header_params,
87
+ :query_params => query_params,
88
+ :form_params => form_params,
89
+ :body => post_body,
90
+ :auth_names => auth_names,
91
+ :return_type => return_type
92
+ )
93
+
94
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
95
+ if @api_client.config.debugging
96
+ @api_client.config.logger.debug "API called: TemplateVersionsApi#create_template_version\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
97
+ end
98
+ return data, status_code, headers
99
+ end
100
+
101
+ # delete
102
+ # Permanently deletes a template version. A template's `published_version` can not be deleted.
103
+ # @param tmpl_id [String] The ID of the template to which the version belongs.
104
+ # @param vrsn_id [String] id of the template_version
105
+ # @param [Hash] opts the optional parameters
106
+ # @return [TemplateVersionDeletion]
107
+ def delete(tmpl_id, vrsn_id, opts = {})
108
+ data, _status_code, _headers = template_version_delete_with_http_info(tmpl_id, vrsn_id, opts)
109
+ data
110
+ end
111
+
112
+ # delete
113
+ # Permanently deletes a template version. A template&#39;s &#x60;published_version&#x60; can not be deleted.
114
+ # @param tmpl_id [String] The ID of the template to which the version belongs.
115
+ # @param vrsn_id [String] id of the template_version
116
+ # @param [Hash] opts the optional parameters
117
+ # @return [Array<(TemplateVersionDeletion, Integer, Hash)>] TemplateVersionDeletion data, response status code and response headers
118
+ def template_version_delete_with_http_info(tmpl_id, vrsn_id, opts = {})
119
+ if @api_client.config.debugging
120
+ @api_client.config.logger.debug 'Calling API: TemplateVersionsApi.template_version_delete ...'
121
+ end
122
+ # verify the required parameter 'tmpl_id' is set
123
+ if @api_client.config.client_side_validation && tmpl_id.nil?
124
+ fail ArgumentError, "Missing the required parameter 'tmpl_id' when calling TemplateVersionsApi.template_version_delete"
125
+ end
126
+ pattern = Regexp.new(/^tmpl_[a-zA-Z0-9]+$/)
127
+ if @api_client.config.client_side_validation && tmpl_id !~ pattern
128
+ fail ArgumentError, "invalid value for 'tmpl_id' when calling TemplateVersionsApi.template_version_delete, must conform to the pattern #{pattern}."
129
+ end
130
+
131
+ # verify the required parameter 'vrsn_id' is set
132
+ if @api_client.config.client_side_validation && vrsn_id.nil?
133
+ fail ArgumentError, "Missing the required parameter 'vrsn_id' when calling TemplateVersionsApi.template_version_delete"
134
+ end
135
+ pattern = Regexp.new(/^vrsn_[a-zA-Z0-9]+$/)
136
+ if @api_client.config.client_side_validation && vrsn_id !~ pattern
137
+ fail ArgumentError, "invalid value for 'vrsn_id' when calling TemplateVersionsApi.template_version_delete, must conform to the pattern #{pattern}."
138
+ end
139
+
140
+ # resource path
141
+ local_var_path = '/templates/{tmpl_id}/versions/{vrsn_id}'.sub('{' + 'tmpl_id' + '}', CGI.escape(tmpl_id.to_s)).sub('{' + 'vrsn_id' + '}', CGI.escape(vrsn_id.to_s))
142
+
143
+ # query parameters
144
+ query_params = opts[:query_params] || {}
145
+
146
+ # header parameters
147
+ header_params = opts[:header_params] || {}
148
+ # HTTP header 'Accept' (if needed)
149
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
150
+
151
+ # form parameters
152
+ form_params = opts[:form_params] || {}
153
+
154
+ # http body (model)
155
+ post_body = opts[:debug_body]
156
+
157
+ # return_type
158
+ return_type = opts[:debug_return_type] || 'TemplateVersionDeletion'
159
+
160
+ # auth_names
161
+ auth_names = opts[:debug_auth_names] || ['basicAuth']
162
+
163
+ new_options = opts.merge(
164
+ :operation => :"TemplateVersionsApi.template_version_delete",
165
+ :header_params => header_params,
166
+ :query_params => query_params,
167
+ :form_params => form_params,
168
+ :body => post_body,
169
+ :auth_names => auth_names,
170
+ :return_type => return_type
171
+ )
172
+
173
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
174
+ if @api_client.config.debugging
175
+ @api_client.config.logger.debug "API called: TemplateVersionsApi#template_version_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
176
+ end
177
+ return data, status_code, headers
178
+ end
179
+
180
+ # get
181
+ # Retrieves the template version with the given template and version ids.
182
+ # @param tmpl_id [String] The ID of the template to which the version belongs.
183
+ # @param vrsn_id [String] id of the template_version
184
+ # @param [Hash] opts the optional parameters
185
+ # @return [TemplateVersion]
186
+ def get(tmpl_id, vrsn_id, opts = {})
187
+ data, _status_code, _headers = template_version_retrieve_with_http_info(tmpl_id, vrsn_id, opts)
188
+ data
189
+ end
190
+
191
+ # get
192
+ # Retrieves the template version with the given template and version ids.
193
+ # @param tmpl_id [String] The ID of the template to which the version belongs.
194
+ # @param vrsn_id [String] id of the template_version
195
+ # @param [Hash] opts the optional parameters
196
+ # @return [Array<(TemplateVersion, Integer, Hash)>] TemplateVersion data, response status code and response headers
197
+ def template_version_retrieve_with_http_info(tmpl_id, vrsn_id, opts = {})
198
+ if @api_client.config.debugging
199
+ @api_client.config.logger.debug 'Calling API: TemplateVersionsApi.template_version_retrieve ...'
200
+ end
201
+ # verify the required parameter 'tmpl_id' is set
202
+ if @api_client.config.client_side_validation && tmpl_id.nil?
203
+ fail ArgumentError, "Missing the required parameter 'tmpl_id' when calling TemplateVersionsApi.template_version_retrieve"
204
+ end
205
+ pattern = Regexp.new(/^tmpl_[a-zA-Z0-9]+$/)
206
+ if @api_client.config.client_side_validation && tmpl_id !~ pattern
207
+ fail ArgumentError, "invalid value for 'tmpl_id' when calling TemplateVersionsApi.template_version_retrieve, must conform to the pattern #{pattern}."
208
+ end
209
+
210
+ # verify the required parameter 'vrsn_id' is set
211
+ if @api_client.config.client_side_validation && vrsn_id.nil?
212
+ fail ArgumentError, "Missing the required parameter 'vrsn_id' when calling TemplateVersionsApi.template_version_retrieve"
213
+ end
214
+ pattern = Regexp.new(/^vrsn_[a-zA-Z0-9]+$/)
215
+ if @api_client.config.client_side_validation && vrsn_id !~ pattern
216
+ fail ArgumentError, "invalid value for 'vrsn_id' when calling TemplateVersionsApi.template_version_retrieve, must conform to the pattern #{pattern}."
217
+ end
218
+
219
+ # resource path
220
+ local_var_path = '/templates/{tmpl_id}/versions/{vrsn_id}'.sub('{' + 'tmpl_id' + '}', CGI.escape(tmpl_id.to_s)).sub('{' + 'vrsn_id' + '}', CGI.escape(vrsn_id.to_s))
221
+
222
+ # query parameters
223
+ query_params = opts[:query_params] || {}
224
+
225
+ # header parameters
226
+ header_params = opts[:header_params] || {}
227
+ # HTTP header 'Accept' (if needed)
228
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
229
+
230
+ # form parameters
231
+ form_params = opts[:form_params] || {}
232
+
233
+ # http body (model)
234
+ post_body = opts[:debug_body]
235
+
236
+ # return_type
237
+ return_type = opts[:debug_return_type] || 'TemplateVersion'
238
+
239
+ # auth_names
240
+ auth_names = opts[:debug_auth_names] || ['basicAuth']
241
+
242
+ new_options = opts.merge(
243
+ :operation => :"TemplateVersionsApi.template_version_retrieve",
244
+ :header_params => header_params,
245
+ :query_params => query_params,
246
+ :form_params => form_params,
247
+ :body => post_body,
248
+ :auth_names => auth_names,
249
+ :return_type => return_type
250
+ )
251
+
252
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
253
+ if @api_client.config.debugging
254
+ @api_client.config.logger.debug "API called: TemplateVersionsApi#template_version_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
255
+ end
256
+ return data, status_code, headers
257
+ end
258
+
259
+ # update
260
+ # Updates the template version with the given template and version ids.
261
+ # @param tmpl_id [String] The ID of the template to which the version belongs.
262
+ # @param vrsn_id [String] id of the template_version
263
+ # @param template_version_updatable [TemplateVersionUpdatable]
264
+ # @param [Hash] opts the optional parameters
265
+ # @return [TemplateVersion]
266
+ def update(tmpl_id, vrsn_id, template_version_updatable, opts = {})
267
+ data, _status_code, _headers = template_version_update_with_http_info(tmpl_id, vrsn_id, template_version_updatable, opts)
268
+ data
269
+ end
270
+
271
+ # update
272
+ # Updates the template version with the given template and version ids.
273
+ # @param tmpl_id [String] The ID of the template to which the version belongs.
274
+ # @param vrsn_id [String] id of the template_version
275
+ # @param template_version_updatable [TemplateVersionUpdatable]
276
+ # @param [Hash] opts the optional parameters
277
+ # @return [Array<(TemplateVersion, Integer, Hash)>] TemplateVersion data, response status code and response headers
278
+ def template_version_update_with_http_info(tmpl_id, vrsn_id, template_version_updatable, opts = {})
279
+ if @api_client.config.debugging
280
+ @api_client.config.logger.debug 'Calling API: TemplateVersionsApi.template_version_update ...'
281
+ end
282
+ # verify the required parameter 'tmpl_id' is set
283
+ if @api_client.config.client_side_validation && tmpl_id.nil?
284
+ fail ArgumentError, "Missing the required parameter 'tmpl_id' when calling TemplateVersionsApi.template_version_update"
285
+ end
286
+ pattern = Regexp.new(/^tmpl_[a-zA-Z0-9]+$/)
287
+ if @api_client.config.client_side_validation && tmpl_id !~ pattern
288
+ fail ArgumentError, "invalid value for 'tmpl_id' when calling TemplateVersionsApi.template_version_update, must conform to the pattern #{pattern}."
289
+ end
290
+
291
+ # verify the required parameter 'vrsn_id' is set
292
+ if @api_client.config.client_side_validation && vrsn_id.nil?
293
+ fail ArgumentError, "Missing the required parameter 'vrsn_id' when calling TemplateVersionsApi.template_version_update"
294
+ end
295
+ pattern = Regexp.new(/^vrsn_[a-zA-Z0-9]+$/)
296
+ if @api_client.config.client_side_validation && vrsn_id !~ pattern
297
+ fail ArgumentError, "invalid value for 'vrsn_id' when calling TemplateVersionsApi.template_version_update, must conform to the pattern #{pattern}."
298
+ end
299
+
300
+ # verify the required parameter 'template_version_updatable' is set
301
+ if @api_client.config.client_side_validation && template_version_updatable.nil?
302
+ fail ArgumentError, "Missing the required parameter 'template_version_updatable' when calling TemplateVersionsApi.template_version_update"
303
+ end
304
+ # resource path
305
+ local_var_path = '/templates/{tmpl_id}/versions/{vrsn_id}'.sub('{' + 'tmpl_id' + '}', CGI.escape(tmpl_id.to_s)).sub('{' + 'vrsn_id' + '}', CGI.escape(vrsn_id.to_s))
306
+
307
+ # query parameters
308
+ query_params = opts[:query_params] || {}
309
+
310
+ # header parameters
311
+ header_params = opts[:header_params] || {}
312
+ # HTTP header 'Accept' (if needed)
313
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
314
+ # HTTP header 'Content-Type'
315
+ content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
316
+ if !content_type.nil?
317
+ header_params['Content-Type'] = content_type
318
+ end
319
+
320
+ # form parameters
321
+ form_params = opts[:form_params] || {}
322
+
323
+ # http body (model)
324
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(template_version_updatable)
325
+
326
+ # return_type
327
+ return_type = opts[:debug_return_type] || 'TemplateVersion'
328
+
329
+ # auth_names
330
+ auth_names = opts[:debug_auth_names] || ['basicAuth']
331
+
332
+ new_options = opts.merge(
333
+ :operation => :"TemplateVersionsApi.template_version_update",
334
+ :header_params => header_params,
335
+ :query_params => query_params,
336
+ :form_params => form_params,
337
+ :body => post_body,
338
+ :auth_names => auth_names,
339
+ :return_type => return_type
340
+ )
341
+
342
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
343
+ if @api_client.config.debugging
344
+ @api_client.config.logger.debug "API called: TemplateVersionsApi#template_version_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
345
+ end
346
+ return data, status_code, headers
347
+ end
348
+
349
+ # list
350
+ # Returns a list of template versions for the given template ID. The template versions are sorted by creation date, with the most recently created appearing first.
351
+ # @param tmpl_id [String] The ID of the template associated with the retrieved versions
352
+ # @param [Hash] opts the optional parameters
353
+ # @option opts [Integer] :limit How many results to return. (default to 10)
354
+ # @option opts [String] :before A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the &#x60;previous_url&#x60; field in the return response.
355
+ # @option opts [String] :after A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the &#x60;next_url&#x60; field in the return response.
356
+ # @option opts [Array<String>] :include Request that the response include the total count by specifying &#x60;include[]&#x3D;total_count&#x60;.
357
+ # @option opts [Hash<String, Time>] :date_created Filter by date created.
358
+ # @return [TemplateVersionList]
359
+ def list(tmpl_id, opts = {})
360
+ data, _status_code, _headers = template_versions_list_with_http_info(tmpl_id, opts)
361
+ data
362
+ end
363
+
364
+ # list
365
+ # Returns a list of template versions for the given template ID. The template versions are sorted by creation date, with the most recently created appearing first.
366
+ # @param tmpl_id [String] The ID of the template associated with the retrieved versions
367
+ # @param [Hash] opts the optional parameters
368
+ # @option opts [Integer] :limit How many results to return. (default to 10)
369
+ # @option opts [String] :before A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the &#x60;previous_url&#x60; field in the return response.
370
+ # @option opts [String] :after A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the &#x60;next_url&#x60; field in the return response.
371
+ # @option opts [Array<String>] :include Request that the response include the total count by specifying &#x60;include[]&#x3D;total_count&#x60;.
372
+ # @option opts [Hash<String, Time>] :date_created Filter by date created.
373
+ # @return [Array<(TemplateVersionList, Integer, Hash)>] TemplateVersionList data, response status code and response headers
374
+ def template_versions_list_with_http_info(tmpl_id, opts = {})
375
+ if @api_client.config.debugging
376
+ @api_client.config.logger.debug 'Calling API: TemplateVersionsApi.template_versions_list ...'
377
+ end
378
+ # verify the required parameter 'tmpl_id' is set
379
+ if @api_client.config.client_side_validation && tmpl_id.nil?
380
+ fail ArgumentError, "Missing the required parameter 'tmpl_id' when calling TemplateVersionsApi.template_versions_list"
381
+ end
382
+ pattern = Regexp.new(/^tmpl_[a-zA-Z0-9]+$/)
383
+ if @api_client.config.client_side_validation && tmpl_id !~ pattern
384
+ fail ArgumentError, "invalid value for 'tmpl_id' when calling TemplateVersionsApi.template_versions_list, must conform to the pattern #{pattern}."
385
+ end
386
+
387
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
388
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TemplateVersionsApi.template_versions_list, must be smaller than or equal to 100.'
389
+ end
390
+
391
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
392
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TemplateVersionsApi.template_versions_list, must be greater than or equal to 1.'
393
+ end
394
+
395
+ # resource path
396
+ local_var_path = '/templates/{tmpl_id}/versions'.sub('{' + 'tmpl_id' + '}', CGI.escape(tmpl_id.to_s))
397
+
398
+ # query parameters
399
+ query_params = opts[:query_params] || {}
400
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
401
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
402
+ query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
403
+ query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :multi) if !opts[:'include'].nil?
404
+ query_params[:'date_created'] = opts[:'date_created'] if !opts[:'date_created'].nil?
405
+
406
+ # header parameters
407
+ header_params = opts[:header_params] || {}
408
+ # HTTP header 'Accept' (if needed)
409
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
410
+
411
+ # form parameters
412
+ form_params = opts[:form_params] || {}
413
+
414
+ # http body (model)
415
+ post_body = opts[:debug_body]
416
+
417
+ # return_type
418
+ return_type = opts[:debug_return_type] || 'TemplateVersionList'
419
+
420
+ # auth_names
421
+ auth_names = opts[:debug_auth_names] || ['basicAuth']
422
+
423
+ new_options = opts.merge(
424
+ :operation => :"TemplateVersionsApi.template_versions_list",
425
+ :header_params => header_params,
426
+ :query_params => query_params,
427
+ :form_params => form_params,
428
+ :body => post_body,
429
+ :auth_names => auth_names,
430
+ :return_type => return_type
431
+ )
432
+
433
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
434
+ if @api_client.config.debugging
435
+ @api_client.config.logger.debug "API called: TemplateVersionsApi#template_versions_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
436
+ end
437
+ return data, status_code, headers
438
+ end
439
+ end
440
+ end