dropbox-sign 1.4.1 → 1.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (292) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +26 -24
  3. data/README.md +25 -4
  4. data/VERSION +1 -1
  5. data/docs/AccountCreateResponse.md +1 -1
  6. data/docs/AccountGetResponse.md +1 -1
  7. data/docs/AccountResponse.md +1 -0
  8. data/docs/AccountResponseQuotas.md +1 -0
  9. data/docs/AccountResponseUsage.md +10 -0
  10. data/docs/ApiAppGetResponse.md +1 -1
  11. data/docs/ApiAppListResponse.md +2 -2
  12. data/docs/BulkSendJobGetResponse.md +3 -3
  13. data/docs/BulkSendJobListResponse.md +2 -2
  14. data/docs/BulkSendJobSendResponse.md +1 -1
  15. data/docs/EmbeddedEditUrlResponse.md +1 -1
  16. data/docs/EmbeddedSignUrlResponse.md +1 -1
  17. data/docs/FaxLineAddUserRequest.md +12 -0
  18. data/docs/FaxLineApi.md +503 -0
  19. data/docs/FaxLineAreaCodeGetCountryEnum.md +9 -0
  20. data/docs/FaxLineAreaCodeGetProvinceEnum.md +9 -0
  21. data/docs/FaxLineAreaCodeGetResponse.md +10 -0
  22. data/docs/FaxLineAreaCodeGetStateEnum.md +9 -0
  23. data/docs/FaxLineCreateRequest.md +13 -0
  24. data/docs/FaxLineDeleteRequest.md +10 -0
  25. data/docs/FaxLineListResponse.md +12 -0
  26. data/docs/FaxLineRemoveUserRequest.md +12 -0
  27. data/docs/FaxLineResponse.md +11 -0
  28. data/docs/FaxLineResponseFaxLine.md +13 -0
  29. data/docs/FileResponse.md +2 -2
  30. data/docs/FileResponseDataUri.md +1 -1
  31. data/docs/ReportCreateResponse.md +1 -1
  32. data/docs/SignatureRequestGetResponse.md +1 -1
  33. data/docs/SignatureRequestListResponse.md +2 -2
  34. data/docs/TeamGetInfoResponse.md +1 -1
  35. data/docs/TeamGetResponse.md +1 -1
  36. data/docs/TeamInvitesResponse.md +1 -1
  37. data/docs/TeamMembersResponse.md +2 -2
  38. data/docs/TeamSubTeamsResponse.md +2 -2
  39. data/docs/TemplateCreateEmbeddedDraftResponse.md +1 -1
  40. data/docs/TemplateCreateResponse.md +1 -1
  41. data/docs/TemplateEditResponse.md +1 -1
  42. data/docs/TemplateGetResponse.md +1 -1
  43. data/docs/TemplateListResponse.md +2 -2
  44. data/docs/TemplateUpdateFilesResponse.md +1 -1
  45. data/docs/UnclaimedDraftCreateResponse.md +1 -1
  46. data/dropbox-sign.gemspec +2 -1
  47. data/examples/FaxLineAddUser.rb +19 -0
  48. data/examples/FaxLineAreaCodeGet.rb +15 -0
  49. data/examples/FaxLineCreate.rb +19 -0
  50. data/examples/FaxLineDelete.rb +17 -0
  51. data/examples/FaxLineGet.rb +15 -0
  52. data/examples/FaxLineList.rb +15 -0
  53. data/examples/FaxLineRemoveUser.rb +19 -0
  54. data/lib/dropbox-sign/api/account_api.rb +5 -5
  55. data/lib/dropbox-sign/api/api_app_api.rb +8 -8
  56. data/lib/dropbox-sign/api/bulk_send_job_api.rb +7 -7
  57. data/lib/dropbox-sign/api/embedded_api.rb +3 -3
  58. data/lib/dropbox-sign/api/fax_line_api.rb +746 -0
  59. data/lib/dropbox-sign/api/o_auth_api.rb +3 -3
  60. data/lib/dropbox-sign/api/report_api.rb +2 -2
  61. data/lib/dropbox-sign/api/signature_request_api.rb +21 -21
  62. data/lib/dropbox-sign/api/team_api.rb +15 -15
  63. data/lib/dropbox-sign/api/template_api.rb +15 -15
  64. data/lib/dropbox-sign/api/unclaimed_draft_api.rb +5 -5
  65. data/lib/dropbox-sign/api_client.rb +27 -25
  66. data/lib/dropbox-sign/api_error.rb +6 -2
  67. data/lib/dropbox-sign/configuration.rb +39 -9
  68. data/lib/dropbox-sign/event_callback_helper.rb +1 -1
  69. data/lib/dropbox-sign/models/account_create_request.rb +12 -15
  70. data/lib/dropbox-sign/models/account_create_response.rb +17 -15
  71. data/lib/dropbox-sign/models/account_get_response.rb +17 -15
  72. data/lib/dropbox-sign/models/account_response.rb +27 -20
  73. data/lib/dropbox-sign/models/account_response_quotas.rb +29 -20
  74. data/lib/dropbox-sign/models/account_response_usage.rb +250 -0
  75. data/lib/dropbox-sign/models/account_update_request.rb +12 -15
  76. data/lib/dropbox-sign/models/account_verify_request.rb +12 -15
  77. data/lib/dropbox-sign/models/account_verify_response.rb +12 -15
  78. data/lib/dropbox-sign/models/account_verify_response_account.rb +12 -15
  79. data/lib/dropbox-sign/models/api_app_create_request.rb +12 -16
  80. data/lib/dropbox-sign/models/api_app_get_response.rb +17 -15
  81. data/lib/dropbox-sign/models/api_app_list_response.rb +22 -15
  82. data/lib/dropbox-sign/models/api_app_response.rb +12 -15
  83. data/lib/dropbox-sign/models/api_app_response_o_auth.rb +12 -15
  84. data/lib/dropbox-sign/models/api_app_response_options.rb +12 -15
  85. data/lib/dropbox-sign/models/api_app_response_owner_account.rb +12 -15
  86. data/lib/dropbox-sign/models/api_app_response_white_labeling_options.rb +12 -15
  87. data/lib/dropbox-sign/models/api_app_update_request.rb +13 -16
  88. data/lib/dropbox-sign/models/bulk_send_job_get_response.rb +27 -15
  89. data/lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb +12 -15
  90. data/lib/dropbox-sign/models/bulk_send_job_list_response.rb +22 -15
  91. data/lib/dropbox-sign/models/bulk_send_job_response.rb +12 -15
  92. data/lib/dropbox-sign/models/bulk_send_job_send_response.rb +17 -15
  93. data/lib/dropbox-sign/models/embedded_edit_url_request.rb +12 -15
  94. data/lib/dropbox-sign/models/embedded_edit_url_response.rb +17 -15
  95. data/lib/dropbox-sign/models/embedded_edit_url_response_embedded.rb +12 -15
  96. data/lib/dropbox-sign/models/embedded_sign_url_response.rb +17 -15
  97. data/lib/dropbox-sign/models/embedded_sign_url_response_embedded.rb +12 -15
  98. data/lib/dropbox-sign/models/error_response.rb +12 -15
  99. data/lib/dropbox-sign/models/error_response_error.rb +12 -15
  100. data/lib/dropbox-sign/models/event_callback_request.rb +12 -15
  101. data/lib/dropbox-sign/models/event_callback_request_event.rb +12 -15
  102. data/lib/dropbox-sign/models/event_callback_request_event_metadata.rb +12 -15
  103. data/lib/dropbox-sign/models/fax_line_add_user_request.rb +275 -0
  104. data/lib/dropbox-sign/models/fax_line_area_code_get_country_enum.rb +44 -0
  105. data/lib/dropbox-sign/models/fax_line_area_code_get_province_enum.rb +54 -0
  106. data/lib/dropbox-sign/models/fax_line_area_code_get_response.rb +254 -0
  107. data/lib/dropbox-sign/models/fax_line_area_code_get_state_enum.rb +92 -0
  108. data/lib/dropbox-sign/models/fax_line_create_request.rb +325 -0
  109. data/lib/dropbox-sign/models/fax_line_delete_request.rb +253 -0
  110. data/lib/dropbox-sign/models/fax_line_list_response.rb +279 -0
  111. data/lib/dropbox-sign/models/fax_line_remove_user_request.rb +275 -0
  112. data/lib/dropbox-sign/models/fax_line_response.rb +262 -0
  113. data/lib/dropbox-sign/models/fax_line_response_fax_line.rb +282 -0
  114. data/lib/dropbox-sign/models/file_response.rb +22 -15
  115. data/lib/dropbox-sign/models/file_response_data_uri.rb +17 -15
  116. data/lib/dropbox-sign/models/list_info_response.rb +12 -15
  117. data/lib/dropbox-sign/models/o_auth_token_generate_request.rb +12 -15
  118. data/lib/dropbox-sign/models/o_auth_token_refresh_request.rb +12 -15
  119. data/lib/dropbox-sign/models/o_auth_token_response.rb +12 -15
  120. data/lib/dropbox-sign/models/report_create_request.rb +12 -15
  121. data/lib/dropbox-sign/models/report_create_response.rb +17 -15
  122. data/lib/dropbox-sign/models/report_response.rb +12 -15
  123. data/lib/dropbox-sign/models/signature_request_bulk_create_embedded_with_template_request.rb +15 -18
  124. data/lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb +15 -18
  125. data/lib/dropbox-sign/models/signature_request_create_embedded_request.rb +15 -18
  126. data/lib/dropbox-sign/models/signature_request_create_embedded_with_template_request.rb +15 -18
  127. data/lib/dropbox-sign/models/signature_request_get_response.rb +17 -15
  128. data/lib/dropbox-sign/models/signature_request_list_response.rb +22 -15
  129. data/lib/dropbox-sign/models/signature_request_remind_request.rb +12 -15
  130. data/lib/dropbox-sign/models/signature_request_response.rb +12 -15
  131. data/lib/dropbox-sign/models/signature_request_response_attachment.rb +13 -16
  132. data/lib/dropbox-sign/models/signature_request_response_custom_field_base.rb +12 -15
  133. data/lib/dropbox-sign/models/signature_request_response_custom_field_checkbox.rb +12 -15
  134. data/lib/dropbox-sign/models/signature_request_response_custom_field_text.rb +12 -15
  135. data/lib/dropbox-sign/models/signature_request_response_custom_field_type_enum.rb +7 -4
  136. data/lib/dropbox-sign/models/signature_request_response_data_base.rb +12 -15
  137. data/lib/dropbox-sign/models/signature_request_response_data_type_enum.rb +7 -4
  138. data/lib/dropbox-sign/models/signature_request_response_data_value_checkbox.rb +12 -15
  139. data/lib/dropbox-sign/models/signature_request_response_data_value_checkbox_merge.rb +12 -15
  140. data/lib/dropbox-sign/models/signature_request_response_data_value_date_signed.rb +12 -15
  141. data/lib/dropbox-sign/models/signature_request_response_data_value_dropdown.rb +12 -15
  142. data/lib/dropbox-sign/models/signature_request_response_data_value_initials.rb +12 -15
  143. data/lib/dropbox-sign/models/signature_request_response_data_value_radio.rb +12 -15
  144. data/lib/dropbox-sign/models/signature_request_response_data_value_signature.rb +12 -15
  145. data/lib/dropbox-sign/models/signature_request_response_data_value_text.rb +12 -15
  146. data/lib/dropbox-sign/models/signature_request_response_data_value_text_merge.rb +12 -15
  147. data/lib/dropbox-sign/models/signature_request_response_signatures.rb +12 -15
  148. data/lib/dropbox-sign/models/signature_request_send_request.rb +15 -18
  149. data/lib/dropbox-sign/models/signature_request_send_with_template_request.rb +16 -18
  150. data/lib/dropbox-sign/models/signature_request_update_request.rb +12 -15
  151. data/lib/dropbox-sign/models/sub_attachment.rb +12 -15
  152. data/lib/dropbox-sign/models/sub_bulk_signer_list.rb +12 -15
  153. data/lib/dropbox-sign/models/sub_bulk_signer_list_custom_field.rb +12 -15
  154. data/lib/dropbox-sign/models/sub_cc.rb +12 -15
  155. data/lib/dropbox-sign/models/sub_custom_field.rb +12 -15
  156. data/lib/dropbox-sign/models/sub_editor_options.rb +12 -15
  157. data/lib/dropbox-sign/models/sub_field_options.rb +12 -15
  158. data/lib/dropbox-sign/models/sub_form_field_group.rb +12 -15
  159. data/lib/dropbox-sign/models/sub_form_field_rule.rb +12 -17
  160. data/lib/dropbox-sign/models/sub_form_field_rule_action.rb +12 -15
  161. data/lib/dropbox-sign/models/sub_form_field_rule_trigger.rb +12 -15
  162. data/lib/dropbox-sign/models/sub_form_fields_per_document_base.rb +12 -15
  163. data/lib/dropbox-sign/models/sub_form_fields_per_document_checkbox.rb +12 -15
  164. data/lib/dropbox-sign/models/sub_form_fields_per_document_checkbox_merge.rb +12 -15
  165. data/lib/dropbox-sign/models/sub_form_fields_per_document_date_signed.rb +12 -15
  166. data/lib/dropbox-sign/models/sub_form_fields_per_document_dropdown.rb +12 -16
  167. data/lib/dropbox-sign/models/sub_form_fields_per_document_font_enum.rb +7 -4
  168. data/lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb +12 -15
  169. data/lib/dropbox-sign/models/sub_form_fields_per_document_initials.rb +12 -15
  170. data/lib/dropbox-sign/models/sub_form_fields_per_document_radio.rb +12 -15
  171. data/lib/dropbox-sign/models/sub_form_fields_per_document_signature.rb +12 -15
  172. data/lib/dropbox-sign/models/sub_form_fields_per_document_text.rb +12 -15
  173. data/lib/dropbox-sign/models/sub_form_fields_per_document_text_merge.rb +12 -15
  174. data/lib/dropbox-sign/models/sub_form_fields_per_document_type_enum.rb +7 -4
  175. data/lib/dropbox-sign/models/sub_merge_field.rb +12 -15
  176. data/lib/dropbox-sign/models/sub_o_auth.rb +12 -15
  177. data/lib/dropbox-sign/models/sub_options.rb +12 -15
  178. data/lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb +12 -15
  179. data/lib/dropbox-sign/models/sub_signature_request_signer.rb +14 -17
  180. data/lib/dropbox-sign/models/sub_signature_request_template_signer.rb +14 -17
  181. data/lib/dropbox-sign/models/sub_signing_options.rb +12 -15
  182. data/lib/dropbox-sign/models/sub_team_response.rb +12 -15
  183. data/lib/dropbox-sign/models/sub_template_role.rb +12 -15
  184. data/lib/dropbox-sign/models/sub_unclaimed_draft_signer.rb +12 -15
  185. data/lib/dropbox-sign/models/sub_unclaimed_draft_template_signer.rb +12 -15
  186. data/lib/dropbox-sign/models/sub_white_labeling_options.rb +12 -15
  187. data/lib/dropbox-sign/models/team_add_member_request.rb +12 -15
  188. data/lib/dropbox-sign/models/team_create_request.rb +12 -15
  189. data/lib/dropbox-sign/models/team_get_info_response.rb +17 -15
  190. data/lib/dropbox-sign/models/team_get_response.rb +17 -15
  191. data/lib/dropbox-sign/models/team_info_response.rb +12 -15
  192. data/lib/dropbox-sign/models/team_invite_response.rb +12 -15
  193. data/lib/dropbox-sign/models/team_invites_response.rb +17 -15
  194. data/lib/dropbox-sign/models/team_member_response.rb +12 -15
  195. data/lib/dropbox-sign/models/team_members_response.rb +22 -15
  196. data/lib/dropbox-sign/models/team_parent_response.rb +12 -15
  197. data/lib/dropbox-sign/models/team_remove_member_request.rb +12 -15
  198. data/lib/dropbox-sign/models/team_response.rb +12 -15
  199. data/lib/dropbox-sign/models/team_sub_teams_response.rb +22 -15
  200. data/lib/dropbox-sign/models/team_update_request.rb +12 -15
  201. data/lib/dropbox-sign/models/template_add_user_request.rb +12 -15
  202. data/lib/dropbox-sign/models/template_create_embedded_draft_request.rb +14 -17
  203. data/lib/dropbox-sign/models/template_create_embedded_draft_response.rb +17 -15
  204. data/lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb +12 -15
  205. data/lib/dropbox-sign/models/template_create_request.rb +14 -17
  206. data/lib/dropbox-sign/models/template_create_response.rb +17 -15
  207. data/lib/dropbox-sign/models/template_create_response_template.rb +12 -15
  208. data/lib/dropbox-sign/models/template_edit_response.rb +17 -15
  209. data/lib/dropbox-sign/models/template_get_response.rb +17 -15
  210. data/lib/dropbox-sign/models/template_list_response.rb +22 -15
  211. data/lib/dropbox-sign/models/template_remove_user_request.rb +12 -15
  212. data/lib/dropbox-sign/models/template_response.rb +12 -15
  213. data/lib/dropbox-sign/models/template_response_account.rb +12 -15
  214. data/lib/dropbox-sign/models/template_response_account_quota.rb +12 -15
  215. data/lib/dropbox-sign/models/template_response_cc_role.rb +12 -15
  216. data/lib/dropbox-sign/models/template_response_document.rb +12 -15
  217. data/lib/dropbox-sign/models/template_response_document_custom_field_base.rb +13 -16
  218. data/lib/dropbox-sign/models/template_response_document_custom_field_checkbox.rb +12 -15
  219. data/lib/dropbox-sign/models/template_response_document_custom_field_text.rb +12 -15
  220. data/lib/dropbox-sign/models/template_response_document_field_group.rb +12 -15
  221. data/lib/dropbox-sign/models/template_response_document_field_group_rule.rb +12 -15
  222. data/lib/dropbox-sign/models/template_response_document_form_field_base.rb +13 -16
  223. data/lib/dropbox-sign/models/template_response_document_form_field_checkbox.rb +12 -15
  224. data/lib/dropbox-sign/models/template_response_document_form_field_date_signed.rb +12 -15
  225. data/lib/dropbox-sign/models/template_response_document_form_field_dropdown.rb +12 -15
  226. data/lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb +12 -15
  227. data/lib/dropbox-sign/models/template_response_document_form_field_initials.rb +12 -15
  228. data/lib/dropbox-sign/models/template_response_document_form_field_radio.rb +12 -15
  229. data/lib/dropbox-sign/models/template_response_document_form_field_signature.rb +12 -15
  230. data/lib/dropbox-sign/models/template_response_document_form_field_text.rb +12 -15
  231. data/lib/dropbox-sign/models/template_response_document_static_field_base.rb +12 -15
  232. data/lib/dropbox-sign/models/template_response_document_static_field_checkbox.rb +12 -15
  233. data/lib/dropbox-sign/models/template_response_document_static_field_date_signed.rb +12 -15
  234. data/lib/dropbox-sign/models/template_response_document_static_field_dropdown.rb +12 -15
  235. data/lib/dropbox-sign/models/template_response_document_static_field_hyperlink.rb +12 -15
  236. data/lib/dropbox-sign/models/template_response_document_static_field_initials.rb +12 -15
  237. data/lib/dropbox-sign/models/template_response_document_static_field_radio.rb +12 -15
  238. data/lib/dropbox-sign/models/template_response_document_static_field_signature.rb +12 -15
  239. data/lib/dropbox-sign/models/template_response_document_static_field_text.rb +12 -15
  240. data/lib/dropbox-sign/models/template_response_field_avg_text_length.rb +12 -15
  241. data/lib/dropbox-sign/models/template_response_signer_role.rb +12 -15
  242. data/lib/dropbox-sign/models/template_update_files_request.rb +14 -17
  243. data/lib/dropbox-sign/models/template_update_files_response.rb +17 -15
  244. data/lib/dropbox-sign/models/template_update_files_response_template.rb +12 -15
  245. data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb +15 -17
  246. data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb +15 -18
  247. data/lib/dropbox-sign/models/unclaimed_draft_create_request.rb +15 -17
  248. data/lib/dropbox-sign/models/unclaimed_draft_create_response.rb +17 -15
  249. data/lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb +12 -15
  250. data/lib/dropbox-sign/models/unclaimed_draft_response.rb +12 -15
  251. data/lib/dropbox-sign/models/warning_response.rb +12 -15
  252. data/lib/dropbox-sign/version.rb +2 -2
  253. data/lib/dropbox-sign.rb +14 -1
  254. data/openapi-config.yaml +2 -1
  255. data/openapi-sdk.yaml +1164 -69
  256. data/run-build +2 -2
  257. data/spec/api_client_spec.rb +3 -1
  258. data/spec/configuration_spec.rb +1 -1
  259. data/spec/spec_helper.rb +1 -1
  260. data/templates/Gemfile.mustache +2 -0
  261. data/templates/README.mustache +91 -2
  262. data/templates/api.mustache +86 -14
  263. data/templates/api_client.mustache +23 -36
  264. data/templates/api_client_faraday_partial.mustache +108 -44
  265. data/templates/api_client_httpx_partial.mustache +134 -0
  266. data/templates/api_client_typhoeus_partial.mustache +23 -15
  267. data/templates/api_doc.mustache +88 -1
  268. data/templates/api_error.mustache +11 -0
  269. data/templates/api_info.mustache +1 -1
  270. data/templates/api_test.mustache +1 -1
  271. data/templates/base_object.mustache +75 -4
  272. data/templates/configuration.mustache +196 -33
  273. data/templates/{configuration_tls_faraday_partial.mustache → configuration_faraday_partial.mustache} +11 -0
  274. data/templates/configuration_httpx_partial.mustache +11 -0
  275. data/templates/{configuration_tls_typhoeus_partial.mustache → configuration_typhoeus_partial.mustache} +7 -0
  276. data/templates/gem.mustache +16 -0
  277. data/templates/gemspec.mustache +10 -4
  278. data/templates/gitignore.mustache +3 -1
  279. data/templates/gitlab-ci.mustache +26 -0
  280. data/templates/model.mustache +16 -0
  281. data/templates/model_test.mustache +8 -3
  282. data/templates/partial_anyof_module.mustache +96 -0
  283. data/templates/partial_model_enum_class.mustache +6 -3
  284. data/templates/partial_model_generic.mustache +77 -28
  285. data/templates/partial_model_generic_doc.mustache +28 -0
  286. data/templates/partial_oneof_module.mustache +4 -4
  287. data/templates/partial_oneof_module_doc.mustache +1 -0
  288. data/templates/travis.mustache +1 -4
  289. data/templates/version.mustache +2 -0
  290. metadata +46 -11
  291. data/templates/api_client_spec.mustache +0 -220
  292. data/templates/configuration_spec.mustache +0 -32
data/openapi-sdk.yaml CHANGED
@@ -1409,6 +1409,803 @@ paths:
1409
1409
  seo:
1410
1410
  title: 'Get Embedded Sign URL | iFrame | Dropbox Sign for Developers'
1411
1411
  description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to retrieve an embedded iFrame object containing a signature url, click here.'
1412
+ /fax_line/add_user:
1413
+ put:
1414
+ tags:
1415
+ - 'Fax Line'
1416
+ summary: 'Add Fax Line User'
1417
+ description: 'Grants a user access to the specified Fax Line.'
1418
+ operationId: faxLineAddUser
1419
+ requestBody:
1420
+ required: true
1421
+ content:
1422
+ application/json:
1423
+ schema:
1424
+ $ref: '#/components/schemas/FaxLineAddUserRequest'
1425
+ examples:
1426
+ default_example:
1427
+ $ref: '#/components/examples/FaxLineAddUserRequestExample'
1428
+ responses:
1429
+ 200:
1430
+ description: 'successful operation'
1431
+ headers:
1432
+ X-RateLimit-Limit:
1433
+ $ref: '#/components/headers/X-RateLimit-Limit'
1434
+ X-RateLimit-Remaining:
1435
+ $ref: '#/components/headers/X-RateLimit-Remaining'
1436
+ X-Ratelimit-Reset:
1437
+ $ref: '#/components/headers/X-Ratelimit-Reset'
1438
+ content:
1439
+ application/json:
1440
+ schema:
1441
+ $ref: '#/components/schemas/FaxLineResponse'
1442
+ examples:
1443
+ default_example:
1444
+ $ref: '#/components/examples/FaxLineResponseExample'
1445
+ 4XX:
1446
+ description: failed_operation
1447
+ content:
1448
+ application/json:
1449
+ schema:
1450
+ $ref: '#/components/schemas/ErrorResponse'
1451
+ examples:
1452
+ 400_example:
1453
+ $ref: '#/components/examples/Error400ResponseExample'
1454
+ 401_example:
1455
+ $ref: '#/components/examples/Error401ResponseExample'
1456
+ 402_example:
1457
+ $ref: '#/components/examples/Error402ResponseExample'
1458
+ 403_example:
1459
+ $ref: '#/components/examples/Error403ResponseExample'
1460
+ 404_example:
1461
+ $ref: '#/components/examples/Error404ResponseExample'
1462
+ 4XX_example:
1463
+ $ref: '#/components/examples/Error4XXResponseExample'
1464
+ security:
1465
+ -
1466
+ api_key: []
1467
+ x-codeSamples:
1468
+ -
1469
+ lang: PHP
1470
+ label: PHP
1471
+ source:
1472
+ $ref: examples/FaxLineAddUser.php
1473
+ -
1474
+ lang: 'C#'
1475
+ label: 'C#'
1476
+ source:
1477
+ $ref: examples/FaxLineAddUser.cs
1478
+ -
1479
+ lang: JavaScript
1480
+ label: JavaScript
1481
+ source:
1482
+ $ref: examples/FaxLineAddUser.js
1483
+ -
1484
+ lang: TypeScript
1485
+ label: TypeScript
1486
+ source:
1487
+ $ref: examples/FaxLineAddUser.ts
1488
+ -
1489
+ lang: Java
1490
+ label: Java
1491
+ source:
1492
+ $ref: examples/FaxLineAddUser.java
1493
+ -
1494
+ lang: Ruby
1495
+ label: Ruby
1496
+ source:
1497
+ $ref: examples/FaxLineAddUser.rb
1498
+ -
1499
+ lang: Python
1500
+ label: Python
1501
+ source:
1502
+ $ref: examples/FaxLineAddUser.py
1503
+ -
1504
+ lang: cURL
1505
+ label: cURL
1506
+ source:
1507
+ $ref: examples/FaxLineAddUser.sh
1508
+ x-meta:
1509
+ seo:
1510
+ title: 'Fax Line Add User | API Documentation | Dropbox Fax for Developers'
1511
+ description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to add a user to an existing fax line, click here.'
1512
+ /fax_line/area_codes:
1513
+ get:
1514
+ tags:
1515
+ - 'Fax Line'
1516
+ summary: 'Get Available Fax Line Area Codes'
1517
+ description: 'Returns a response with the area codes available for a given state/provice and city.'
1518
+ operationId: faxLineAreaCodeGet
1519
+ parameters:
1520
+ -
1521
+ name: country
1522
+ in: query
1523
+ description: 'Filter area codes by country.'
1524
+ required: true
1525
+ schema:
1526
+ type: string
1527
+ enum:
1528
+ - CA
1529
+ - US
1530
+ - UK
1531
+ -
1532
+ name: state
1533
+ in: query
1534
+ description: 'Filter area codes by state.'
1535
+ schema:
1536
+ type: string
1537
+ enum:
1538
+ - AK
1539
+ - AL
1540
+ - AR
1541
+ - AZ
1542
+ - CA
1543
+ - CO
1544
+ - CT
1545
+ - DC
1546
+ - DE
1547
+ - FL
1548
+ - GA
1549
+ - HI
1550
+ - IA
1551
+ - ID
1552
+ - IL
1553
+ - IN
1554
+ - KS
1555
+ - KY
1556
+ - LA
1557
+ - MA
1558
+ - MD
1559
+ - ME
1560
+ - MI
1561
+ - MN
1562
+ - MO
1563
+ - MS
1564
+ - MT
1565
+ - NC
1566
+ - ND
1567
+ - NE
1568
+ - NH
1569
+ - NJ
1570
+ - NM
1571
+ - NV
1572
+ - NY
1573
+ - OH
1574
+ - OK
1575
+ - OR
1576
+ - PA
1577
+ - RI
1578
+ - SC
1579
+ - SD
1580
+ - TN
1581
+ - TX
1582
+ - UT
1583
+ - VA
1584
+ - VT
1585
+ - WA
1586
+ - WI
1587
+ - WV
1588
+ - WY
1589
+ -
1590
+ name: province
1591
+ in: query
1592
+ description: 'Filter area codes by province.'
1593
+ schema:
1594
+ type: string
1595
+ enum:
1596
+ - AB
1597
+ - BC
1598
+ - MB
1599
+ - NB
1600
+ - NL
1601
+ - NT
1602
+ - NS
1603
+ - NU
1604
+ - 'ON'
1605
+ - PE
1606
+ - QC
1607
+ - SK
1608
+ - YT
1609
+ -
1610
+ name: city
1611
+ in: query
1612
+ description: 'Filter area codes by city.'
1613
+ schema:
1614
+ type: string
1615
+ responses:
1616
+ 200:
1617
+ description: 'successful operation'
1618
+ headers:
1619
+ X-RateLimit-Limit:
1620
+ $ref: '#/components/headers/X-RateLimit-Limit'
1621
+ X-RateLimit-Remaining:
1622
+ $ref: '#/components/headers/X-RateLimit-Remaining'
1623
+ X-Ratelimit-Reset:
1624
+ $ref: '#/components/headers/X-Ratelimit-Reset'
1625
+ content:
1626
+ application/json:
1627
+ schema:
1628
+ $ref: '#/components/schemas/FaxLineAreaCodeGetResponse'
1629
+ examples:
1630
+ default_example:
1631
+ $ref: '#/components/examples/FaxLineAreaCodeGetResponseExample'
1632
+ 4XX:
1633
+ description: failed_operation
1634
+ content:
1635
+ application/json:
1636
+ schema:
1637
+ $ref: '#/components/schemas/ErrorResponse'
1638
+ examples:
1639
+ 400_example:
1640
+ $ref: '#/components/examples/Error400ResponseExample'
1641
+ 401_example:
1642
+ $ref: '#/components/examples/Error401ResponseExample'
1643
+ 402_example:
1644
+ $ref: '#/components/examples/Error402ResponseExample'
1645
+ 403_example:
1646
+ $ref: '#/components/examples/Error403ResponseExample'
1647
+ 4XX_example:
1648
+ $ref: '#/components/examples/Error4XXResponseExample'
1649
+ security:
1650
+ -
1651
+ api_key: []
1652
+ x-codeSamples:
1653
+ -
1654
+ lang: PHP
1655
+ label: PHP
1656
+ source:
1657
+ $ref: examples/FaxLineAreaCodeGet.php
1658
+ -
1659
+ lang: 'C#'
1660
+ label: 'C#'
1661
+ source:
1662
+ $ref: examples/FaxLineAreaCodeGet.cs
1663
+ -
1664
+ lang: JavaScript
1665
+ label: JavaScript
1666
+ source:
1667
+ $ref: examples/FaxLineAreaCodeGet.js
1668
+ -
1669
+ lang: TypeScript
1670
+ label: TypeScript
1671
+ source:
1672
+ $ref: examples/FaxLineAreaCodeGet.ts
1673
+ -
1674
+ lang: Java
1675
+ label: Java
1676
+ source:
1677
+ $ref: examples/FaxLineAreaCodeGet.java
1678
+ -
1679
+ lang: Ruby
1680
+ label: Ruby
1681
+ source:
1682
+ $ref: examples/FaxLineAreaCodeGet.rb
1683
+ -
1684
+ lang: Python
1685
+ label: Python
1686
+ source:
1687
+ $ref: examples/FaxLineAreaCodeGet.py
1688
+ -
1689
+ lang: cURL
1690
+ label: cURL
1691
+ source:
1692
+ $ref: examples/FaxLineAreaCodeGet.sh
1693
+ x-meta:
1694
+ seo:
1695
+ title: 'Fax Line Get Area Codes | API Documentation | Dropbox Fax for Developers'
1696
+ description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to purchase a new fax line, click here.'
1697
+ /fax_line/create:
1698
+ post:
1699
+ tags:
1700
+ - 'Fax Line'
1701
+ summary: 'Purchase Fax Line'
1702
+ description: 'Purchases a new Fax Line.'
1703
+ operationId: faxLineCreate
1704
+ requestBody:
1705
+ required: true
1706
+ content:
1707
+ application/json:
1708
+ schema:
1709
+ $ref: '#/components/schemas/FaxLineCreateRequest'
1710
+ examples:
1711
+ default_example:
1712
+ $ref: '#/components/examples/FaxLineCreateRequestExample'
1713
+ responses:
1714
+ 200:
1715
+ description: 'successful operation'
1716
+ headers:
1717
+ X-RateLimit-Limit:
1718
+ $ref: '#/components/headers/X-RateLimit-Limit'
1719
+ X-RateLimit-Remaining:
1720
+ $ref: '#/components/headers/X-RateLimit-Remaining'
1721
+ X-Ratelimit-Reset:
1722
+ $ref: '#/components/headers/X-Ratelimit-Reset'
1723
+ content:
1724
+ application/json:
1725
+ schema:
1726
+ $ref: '#/components/schemas/FaxLineResponse'
1727
+ examples:
1728
+ default_example:
1729
+ $ref: '#/components/examples/FaxLineResponseExample'
1730
+ 4XX:
1731
+ description: failed_operation
1732
+ content:
1733
+ application/json:
1734
+ schema:
1735
+ $ref: '#/components/schemas/ErrorResponse'
1736
+ examples:
1737
+ 400_example:
1738
+ $ref: '#/components/examples/Error400ResponseExample'
1739
+ 401_example:
1740
+ $ref: '#/components/examples/Error401ResponseExample'
1741
+ 402_example:
1742
+ $ref: '#/components/examples/Error402ResponseExample'
1743
+ 403_example:
1744
+ $ref: '#/components/examples/Error403ResponseExample'
1745
+ 404_example:
1746
+ $ref: '#/components/examples/Error404ResponseExample'
1747
+ 4XX_example:
1748
+ $ref: '#/components/examples/Error4XXResponseExample'
1749
+ security:
1750
+ -
1751
+ api_key: []
1752
+ x-codeSamples:
1753
+ -
1754
+ lang: PHP
1755
+ label: PHP
1756
+ source:
1757
+ $ref: examples/FaxLineCreate.php
1758
+ -
1759
+ lang: 'C#'
1760
+ label: 'C#'
1761
+ source:
1762
+ $ref: examples/FaxLineCreate.cs
1763
+ -
1764
+ lang: JavaScript
1765
+ label: JavaScript
1766
+ source:
1767
+ $ref: examples/FaxLineCreate.js
1768
+ -
1769
+ lang: TypeScript
1770
+ label: TypeScript
1771
+ source:
1772
+ $ref: examples/FaxLineCreate.ts
1773
+ -
1774
+ lang: Java
1775
+ label: Java
1776
+ source:
1777
+ $ref: examples/FaxLineCreate.java
1778
+ -
1779
+ lang: Ruby
1780
+ label: Ruby
1781
+ source:
1782
+ $ref: examples/FaxLineCreate.rb
1783
+ -
1784
+ lang: Python
1785
+ label: Python
1786
+ source:
1787
+ $ref: examples/FaxLineCreate.py
1788
+ -
1789
+ lang: cURL
1790
+ label: cURL
1791
+ source:
1792
+ $ref: examples/FaxLineCreate.sh
1793
+ x-meta:
1794
+ seo:
1795
+ title: 'Purchase Fax Line | API Documentation | Dropbox Fax for Developers'
1796
+ description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to purchase a new fax line, click here.'
1797
+ /fax_line:
1798
+ get:
1799
+ tags:
1800
+ - 'Fax Line'
1801
+ summary: 'Get Fax Line'
1802
+ description: 'Returns the properties and settings of a Fax Line.'
1803
+ operationId: faxLineGet
1804
+ parameters:
1805
+ -
1806
+ name: number
1807
+ in: query
1808
+ description: 'The Fax Line number.'
1809
+ required: true
1810
+ schema:
1811
+ type: string
1812
+ responses:
1813
+ 200:
1814
+ description: 'successful operation'
1815
+ headers:
1816
+ X-RateLimit-Limit:
1817
+ $ref: '#/components/headers/X-RateLimit-Limit'
1818
+ X-RateLimit-Remaining:
1819
+ $ref: '#/components/headers/X-RateLimit-Remaining'
1820
+ X-Ratelimit-Reset:
1821
+ $ref: '#/components/headers/X-Ratelimit-Reset'
1822
+ content:
1823
+ application/json:
1824
+ schema:
1825
+ $ref: '#/components/schemas/FaxLineResponse'
1826
+ examples:
1827
+ default_example:
1828
+ $ref: '#/components/examples/FaxLineResponseExample'
1829
+ 4XX:
1830
+ description: failed_operation
1831
+ content:
1832
+ application/json:
1833
+ schema:
1834
+ $ref: '#/components/schemas/ErrorResponse'
1835
+ examples:
1836
+ 400_example:
1837
+ $ref: '#/components/examples/Error400ResponseExample'
1838
+ 401_example:
1839
+ $ref: '#/components/examples/Error401ResponseExample'
1840
+ 402_example:
1841
+ $ref: '#/components/examples/Error402ResponseExample'
1842
+ 403_example:
1843
+ $ref: '#/components/examples/Error403ResponseExample'
1844
+ 404_example:
1845
+ $ref: '#/components/examples/Error404ResponseExample'
1846
+ 4XX_example:
1847
+ $ref: '#/components/examples/Error4XXResponseExample'
1848
+ security:
1849
+ -
1850
+ api_key: []
1851
+ x-codeSamples:
1852
+ -
1853
+ lang: PHP
1854
+ label: PHP
1855
+ source:
1856
+ $ref: examples/FaxLineGet.php
1857
+ -
1858
+ lang: 'C#'
1859
+ label: 'C#'
1860
+ source:
1861
+ $ref: examples/FaxLineGet.cs
1862
+ -
1863
+ lang: JavaScript
1864
+ label: JavaScript
1865
+ source:
1866
+ $ref: examples/FaxLineGet.js
1867
+ -
1868
+ lang: TypeScript
1869
+ label: TypeScript
1870
+ source:
1871
+ $ref: examples/FaxLineGet.ts
1872
+ -
1873
+ lang: Java
1874
+ label: Java
1875
+ source:
1876
+ $ref: examples/FaxLineGet.java
1877
+ -
1878
+ lang: Ruby
1879
+ label: Ruby
1880
+ source:
1881
+ $ref: examples/FaxLineGet.rb
1882
+ -
1883
+ lang: Python
1884
+ label: Python
1885
+ source:
1886
+ $ref: examples/FaxLineGet.py
1887
+ -
1888
+ lang: cURL
1889
+ label: cURL
1890
+ source:
1891
+ $ref: examples/FaxLineGet.sh
1892
+ x-meta:
1893
+ seo:
1894
+ title: 'Get Fax Line | API Documentation | Dropbox Fax for Developers'
1895
+ description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve a fax line, click here.'
1896
+ delete:
1897
+ tags:
1898
+ - 'Fax Line'
1899
+ summary: 'Delete Fax Line'
1900
+ description: 'Deletes the specified Fax Line from the subscription.'
1901
+ operationId: faxLineDelete
1902
+ requestBody:
1903
+ required: true
1904
+ content:
1905
+ application/json:
1906
+ schema:
1907
+ $ref: '#/components/schemas/FaxLineDeleteRequest'
1908
+ examples:
1909
+ default_example:
1910
+ $ref: '#/components/examples/FaxLineDeleteRequestExample'
1911
+ responses:
1912
+ 200:
1913
+ description: 'successful operation'
1914
+ headers:
1915
+ X-RateLimit-Limit:
1916
+ $ref: '#/components/headers/X-RateLimit-Limit'
1917
+ X-RateLimit-Remaining:
1918
+ $ref: '#/components/headers/X-RateLimit-Remaining'
1919
+ X-Ratelimit-Reset:
1920
+ $ref: '#/components/headers/X-Ratelimit-Reset'
1921
+ content:
1922
+ application/json: {}
1923
+ 4XX:
1924
+ description: failed_operation
1925
+ content:
1926
+ application/json:
1927
+ schema:
1928
+ $ref: '#/components/schemas/ErrorResponse'
1929
+ examples:
1930
+ 400_example:
1931
+ $ref: '#/components/examples/Error400ResponseExample'
1932
+ 401_example:
1933
+ $ref: '#/components/examples/Error401ResponseExample'
1934
+ 402_example:
1935
+ $ref: '#/components/examples/Error402ResponseExample'
1936
+ 403_example:
1937
+ $ref: '#/components/examples/Error403ResponseExample'
1938
+ 404_example:
1939
+ $ref: '#/components/examples/Error404ResponseExample'
1940
+ 4XX_example:
1941
+ $ref: '#/components/examples/Error4XXResponseExample'
1942
+ security:
1943
+ -
1944
+ api_key: []
1945
+ x-codeSamples:
1946
+ -
1947
+ lang: PHP
1948
+ label: PHP
1949
+ source:
1950
+ $ref: examples/FaxLineDelete.php
1951
+ -
1952
+ lang: 'C#'
1953
+ label: 'C#'
1954
+ source:
1955
+ $ref: examples/FaxLineDelete.cs
1956
+ -
1957
+ lang: JavaScript
1958
+ label: JavaScript
1959
+ source:
1960
+ $ref: examples/FaxLineDelete.js
1961
+ -
1962
+ lang: TypeScript
1963
+ label: TypeScript
1964
+ source:
1965
+ $ref: examples/FaxLineDelete.ts
1966
+ -
1967
+ lang: Java
1968
+ label: Java
1969
+ source:
1970
+ $ref: examples/FaxLineDelete.java
1971
+ -
1972
+ lang: Ruby
1973
+ label: Ruby
1974
+ source:
1975
+ $ref: examples/FaxLineDelete.rb
1976
+ -
1977
+ lang: Python
1978
+ label: Python
1979
+ source:
1980
+ $ref: examples/FaxLineDelete.py
1981
+ -
1982
+ lang: cURL
1983
+ label: cURL
1984
+ source:
1985
+ $ref: examples/FaxLineDelete.sh
1986
+ x-meta:
1987
+ seo:
1988
+ title: 'Delete Fax Line | API Documentation | Dropbox Fax for Developers'
1989
+ description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to delete a fax line, click here.'
1990
+ /fax_line/list:
1991
+ get:
1992
+ tags:
1993
+ - 'Fax Line'
1994
+ summary: 'List Fax Lines'
1995
+ description: 'Returns the properties and settings of multiple Fax Lines.'
1996
+ operationId: faxLineList
1997
+ parameters:
1998
+ -
1999
+ name: account_id
2000
+ in: query
2001
+ description: 'Account ID'
2002
+ schema:
2003
+ type: string
2004
+ example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97
2005
+ -
2006
+ name: page
2007
+ in: query
2008
+ description: Page
2009
+ schema:
2010
+ type: integer
2011
+ default: 1
2012
+ example: 1
2013
+ -
2014
+ name: page_size
2015
+ in: query
2016
+ description: 'Page size'
2017
+ schema:
2018
+ type: integer
2019
+ default: 20
2020
+ example: 20
2021
+ -
2022
+ name: show_team_lines
2023
+ in: query
2024
+ description: 'Show team lines'
2025
+ schema:
2026
+ type: boolean
2027
+ responses:
2028
+ 200:
2029
+ description: 'successful operation'
2030
+ headers:
2031
+ X-RateLimit-Limit:
2032
+ $ref: '#/components/headers/X-RateLimit-Limit'
2033
+ X-RateLimit-Remaining:
2034
+ $ref: '#/components/headers/X-RateLimit-Remaining'
2035
+ X-Ratelimit-Reset:
2036
+ $ref: '#/components/headers/X-Ratelimit-Reset'
2037
+ content:
2038
+ application/json:
2039
+ schema:
2040
+ $ref: '#/components/schemas/FaxLineListResponse'
2041
+ examples:
2042
+ default_example:
2043
+ $ref: '#/components/examples/FaxLineListResponseExample'
2044
+ 4XX:
2045
+ description: failed_operation
2046
+ content:
2047
+ application/json:
2048
+ schema:
2049
+ $ref: '#/components/schemas/ErrorResponse'
2050
+ examples:
2051
+ 400_example:
2052
+ $ref: '#/components/examples/Error400ResponseExample'
2053
+ 401_example:
2054
+ $ref: '#/components/examples/Error401ResponseExample'
2055
+ 402_example:
2056
+ $ref: '#/components/examples/Error402ResponseExample'
2057
+ 403_example:
2058
+ $ref: '#/components/examples/Error403ResponseExample'
2059
+ 4XX_example:
2060
+ $ref: '#/components/examples/Error4XXResponseExample'
2061
+ security:
2062
+ -
2063
+ api_key: []
2064
+ x-codeSamples:
2065
+ -
2066
+ lang: PHP
2067
+ label: PHP
2068
+ source:
2069
+ $ref: examples/FaxLineList.php
2070
+ -
2071
+ lang: 'C#'
2072
+ label: 'C#'
2073
+ source:
2074
+ $ref: examples/FaxLineList.cs
2075
+ -
2076
+ lang: JavaScript
2077
+ label: JavaScript
2078
+ source:
2079
+ $ref: examples/FaxLineList.js
2080
+ -
2081
+ lang: TypeScript
2082
+ label: TypeScript
2083
+ source:
2084
+ $ref: examples/FaxLineList.ts
2085
+ -
2086
+ lang: Java
2087
+ label: Java
2088
+ source:
2089
+ $ref: examples/FaxLineList.java
2090
+ -
2091
+ lang: Ruby
2092
+ label: Ruby
2093
+ source:
2094
+ $ref: examples/FaxLineList.rb
2095
+ -
2096
+ lang: Python
2097
+ label: Python
2098
+ source:
2099
+ $ref: examples/FaxLineList.py
2100
+ -
2101
+ lang: cURL
2102
+ label: cURL
2103
+ source:
2104
+ $ref: examples/FaxLineList.sh
2105
+ x-meta:
2106
+ seo:
2107
+ title: 'List Fax Lines | API Documentation | Dropbox Fax for Developers'
2108
+ description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list your fax lines, click here.'
2109
+ /fax_line/remove_user:
2110
+ put:
2111
+ tags:
2112
+ - 'Fax Line'
2113
+ summary: 'Remove Fax Line Access'
2114
+ description: 'Removes a user''s access to the specified Fax Line.'
2115
+ operationId: faxLineRemoveUser
2116
+ requestBody:
2117
+ required: true
2118
+ content:
2119
+ application/json:
2120
+ schema:
2121
+ $ref: '#/components/schemas/FaxLineRemoveUserRequest'
2122
+ examples:
2123
+ default_example:
2124
+ $ref: '#/components/examples/FaxLineRemoveUserRequestExample'
2125
+ responses:
2126
+ 200:
2127
+ description: 'successful operation'
2128
+ headers:
2129
+ X-RateLimit-Limit:
2130
+ $ref: '#/components/headers/X-RateLimit-Limit'
2131
+ X-RateLimit-Remaining:
2132
+ $ref: '#/components/headers/X-RateLimit-Remaining'
2133
+ X-Ratelimit-Reset:
2134
+ $ref: '#/components/headers/X-Ratelimit-Reset'
2135
+ content:
2136
+ application/json:
2137
+ schema:
2138
+ $ref: '#/components/schemas/FaxLineResponse'
2139
+ examples:
2140
+ default_example:
2141
+ $ref: '#/components/examples/FaxLineResponseExample'
2142
+ 4XX:
2143
+ description: failed_operation
2144
+ content:
2145
+ application/json:
2146
+ schema:
2147
+ $ref: '#/components/schemas/ErrorResponse'
2148
+ examples:
2149
+ 400_example:
2150
+ $ref: '#/components/examples/Error400ResponseExample'
2151
+ 401_example:
2152
+ $ref: '#/components/examples/Error401ResponseExample'
2153
+ 402_example:
2154
+ $ref: '#/components/examples/Error402ResponseExample'
2155
+ 403_example:
2156
+ $ref: '#/components/examples/Error403ResponseExample'
2157
+ 404_example:
2158
+ $ref: '#/components/examples/Error404ResponseExample'
2159
+ 4XX_example:
2160
+ $ref: '#/components/examples/Error4XXResponseExample'
2161
+ security:
2162
+ -
2163
+ api_key: []
2164
+ x-codeSamples:
2165
+ -
2166
+ lang: PHP
2167
+ label: PHP
2168
+ source:
2169
+ $ref: examples/FaxLineRemoveUser.php
2170
+ -
2171
+ lang: 'C#'
2172
+ label: 'C#'
2173
+ source:
2174
+ $ref: examples/FaxLineRemoveUser.cs
2175
+ -
2176
+ lang: JavaScript
2177
+ label: JavaScript
2178
+ source:
2179
+ $ref: examples/FaxLineRemoveUser.js
2180
+ -
2181
+ lang: TypeScript
2182
+ label: TypeScript
2183
+ source:
2184
+ $ref: examples/FaxLineRemoveUser.ts
2185
+ -
2186
+ lang: Java
2187
+ label: Java
2188
+ source:
2189
+ $ref: examples/FaxLineRemoveUser.java
2190
+ -
2191
+ lang: Ruby
2192
+ label: Ruby
2193
+ source:
2194
+ $ref: examples/FaxLineRemoveUser.rb
2195
+ -
2196
+ lang: Python
2197
+ label: Python
2198
+ source:
2199
+ $ref: examples/FaxLineRemoveUser.py
2200
+ -
2201
+ lang: cURL
2202
+ label: cURL
2203
+ source:
2204
+ $ref: examples/FaxLineRemoveUser.sh
2205
+ x-meta:
2206
+ seo:
2207
+ title: 'Fax Line Remove User | API Documentation | Dropbox Fax for Developers'
2208
+ description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to remove a user from an existing fax line, click here.'
1412
2209
  /oauth/token:
1413
2210
  post:
1414
2211
  tags:
@@ -6409,6 +7206,145 @@ components:
6409
7206
  type: boolean
6410
7207
  default: false
6411
7208
  type: object
7209
+ FaxLineAddUserRequest:
7210
+ required:
7211
+ - number
7212
+ properties:
7213
+ number:
7214
+ description: 'The Fax Line number.'
7215
+ type: string
7216
+ account_id:
7217
+ description: 'Account ID'
7218
+ type: string
7219
+ example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97
7220
+ email_address:
7221
+ description: 'Email address'
7222
+ type: string
7223
+ format: email
7224
+ type: object
7225
+ FaxLineAreaCodeGetStateEnum:
7226
+ type: string
7227
+ enum:
7228
+ - AK
7229
+ - AL
7230
+ - AR
7231
+ - AZ
7232
+ - CA
7233
+ - CO
7234
+ - CT
7235
+ - DC
7236
+ - DE
7237
+ - FL
7238
+ - GA
7239
+ - HI
7240
+ - IA
7241
+ - ID
7242
+ - IL
7243
+ - IN
7244
+ - KS
7245
+ - KY
7246
+ - LA
7247
+ - MA
7248
+ - MD
7249
+ - ME
7250
+ - MI
7251
+ - MN
7252
+ - MO
7253
+ - MS
7254
+ - MT
7255
+ - NC
7256
+ - ND
7257
+ - NE
7258
+ - NH
7259
+ - NJ
7260
+ - NM
7261
+ - NV
7262
+ - NY
7263
+ - OH
7264
+ - OK
7265
+ - OR
7266
+ - PA
7267
+ - RI
7268
+ - SC
7269
+ - SD
7270
+ - TN
7271
+ - TX
7272
+ - UT
7273
+ - VA
7274
+ - VT
7275
+ - WA
7276
+ - WI
7277
+ - WV
7278
+ - WY
7279
+ FaxLineAreaCodeGetProvinceEnum:
7280
+ type: string
7281
+ enum:
7282
+ - AB
7283
+ - BC
7284
+ - MB
7285
+ - NB
7286
+ - NL
7287
+ - NT
7288
+ - NS
7289
+ - NU
7290
+ - 'ON'
7291
+ - PE
7292
+ - QC
7293
+ - SK
7294
+ - YT
7295
+ FaxLineAreaCodeGetCountryEnum:
7296
+ type: string
7297
+ enum:
7298
+ - CA
7299
+ - US
7300
+ - UK
7301
+ FaxLineCreateRequest:
7302
+ required:
7303
+ - area_code
7304
+ - country
7305
+ properties:
7306
+ area_code:
7307
+ description: 'Area code'
7308
+ type: integer
7309
+ country:
7310
+ description: Country
7311
+ type: string
7312
+ enum:
7313
+ - CA
7314
+ - US
7315
+ - UK
7316
+ city:
7317
+ description: City
7318
+ type: string
7319
+ account_id:
7320
+ description: 'Account ID'
7321
+ type: string
7322
+ example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97
7323
+ type: object
7324
+ FaxLineDeleteRequest:
7325
+ required:
7326
+ - number
7327
+ properties:
7328
+ number:
7329
+ description: 'The Fax Line number.'
7330
+ type: string
7331
+ type: object
7332
+ FaxLineRemoveUserRequest:
7333
+ required:
7334
+ - number
7335
+ properties:
7336
+ number:
7337
+ description: 'The Fax Line number.'
7338
+ type: string
7339
+ account_id:
7340
+ description: 'Account ID'
7341
+ type: string
7342
+ example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97
7343
+ email_address:
7344
+ description: 'Email address'
7345
+ type: string
7346
+ format: email
7347
+ type: object
6412
7348
  OAuthTokenGenerateRequest:
6413
7349
  required:
6414
7350
  - client_id
@@ -7918,7 +8854,7 @@ components:
7918
8854
  initials: '#/components/schemas/SubFormFieldsPerDocumentInitials'
7919
8855
  text-merge: '#/components/schemas/SubFormFieldsPerDocumentTextMerge'
7920
8856
  checkbox-merge: '#/components/schemas/SubFormFieldsPerDocumentCheckboxMerge'
7921
- x-internal: true
8857
+ x-internal-class: true
7922
8858
  x-base-class: true
7923
8859
  SubSignatureRequestGroupedSigners:
7924
8860
  required:
@@ -9118,6 +10054,8 @@ components:
9118
10054
  default: false
9119
10055
  type: object
9120
10056
  AccountCreateResponse:
10057
+ required:
10058
+ - account
9121
10059
  properties:
9122
10060
  account:
9123
10061
  $ref: '#/components/schemas/AccountResponse'
@@ -9129,8 +10067,10 @@ components:
9129
10067
  items:
9130
10068
  $ref: '#/components/schemas/WarningResponse'
9131
10069
  type: object
9132
- x-internal: true
10070
+ x-internal-class: true
9133
10071
  AccountGetResponse:
10072
+ required:
10073
+ - account
9134
10074
  properties:
9135
10075
  account:
9136
10076
  $ref: '#/components/schemas/AccountResponse'
@@ -9140,7 +10080,7 @@ components:
9140
10080
  items:
9141
10081
  $ref: '#/components/schemas/WarningResponse'
9142
10082
  type: object
9143
- x-internal: true
10083
+ x-internal-class: true
9144
10084
  AccountVerifyResponse:
9145
10085
  properties:
9146
10086
  account:
@@ -9151,8 +10091,10 @@ components:
9151
10091
  items:
9152
10092
  $ref: '#/components/schemas/WarningResponse'
9153
10093
  type: object
9154
- x-internal: true
10094
+ x-internal-class: true
9155
10095
  ApiAppGetResponse:
10096
+ required:
10097
+ - api_app
9156
10098
  properties:
9157
10099
  api_app:
9158
10100
  $ref: '#/components/schemas/ApiAppResponse'
@@ -9162,8 +10104,11 @@ components:
9162
10104
  items:
9163
10105
  $ref: '#/components/schemas/WarningResponse'
9164
10106
  type: object
9165
- x-internal: true
10107
+ x-internal-class: true
9166
10108
  ApiAppListResponse:
10109
+ required:
10110
+ - api_apps
10111
+ - list_info
9167
10112
  properties:
9168
10113
  api_apps:
9169
10114
  description: 'Contains information about API Apps.'
@@ -9178,8 +10123,12 @@ components:
9178
10123
  items:
9179
10124
  $ref: '#/components/schemas/WarningResponse'
9180
10125
  type: object
9181
- x-internal: true
10126
+ x-internal-class: true
9182
10127
  BulkSendJobGetResponse:
10128
+ required:
10129
+ - bulk_send_job
10130
+ - list_info
10131
+ - signature_requests
9183
10132
  properties:
9184
10133
  bulk_send_job:
9185
10134
  $ref: '#/components/schemas/BulkSendJobResponse'
@@ -9196,8 +10145,11 @@ components:
9196
10145
  items:
9197
10146
  $ref: '#/components/schemas/WarningResponse'
9198
10147
  type: object
9199
- x-internal: true
10148
+ x-internal-class: true
9200
10149
  BulkSendJobListResponse:
10150
+ required:
10151
+ - bulk_send_jobs
10152
+ - list_info
9201
10153
  properties:
9202
10154
  bulk_send_jobs:
9203
10155
  description: 'Contains a list of BulkSendJobs that the API caller has access to.'
@@ -9212,8 +10164,10 @@ components:
9212
10164
  items:
9213
10165
  $ref: '#/components/schemas/WarningResponse'
9214
10166
  type: object
9215
- x-internal: true
10167
+ x-internal-class: true
9216
10168
  BulkSendJobSendResponse:
10169
+ required:
10170
+ - bulk_send_job
9217
10171
  properties:
9218
10172
  bulk_send_job:
9219
10173
  $ref: '#/components/schemas/BulkSendJobResponse'
@@ -9223,8 +10177,10 @@ components:
9223
10177
  items:
9224
10178
  $ref: '#/components/schemas/WarningResponse'
9225
10179
  type: object
9226
- x-internal: true
10180
+ x-internal-class: true
9227
10181
  EmbeddedEditUrlResponse:
10182
+ required:
10183
+ - embedded
9228
10184
  properties:
9229
10185
  embedded:
9230
10186
  $ref: '#/components/schemas/EmbeddedEditUrlResponseEmbedded'
@@ -9234,8 +10190,10 @@ components:
9234
10190
  items:
9235
10191
  $ref: '#/components/schemas/WarningResponse'
9236
10192
  type: object
9237
- x-internal: true
10193
+ x-internal-class: true
9238
10194
  EmbeddedSignUrlResponse:
10195
+ required:
10196
+ - embedded
9239
10197
  properties:
9240
10198
  embedded:
9241
10199
  $ref: '#/components/schemas/EmbeddedSignUrlResponseEmbedded'
@@ -9245,7 +10203,7 @@ components:
9245
10203
  items:
9246
10204
  $ref: '#/components/schemas/WarningResponse'
9247
10205
  type: object
9248
- x-internal: true
10206
+ x-internal-class: true
9249
10207
  ErrorResponse:
9250
10208
  required:
9251
10209
  - error
@@ -9253,7 +10211,45 @@ components:
9253
10211
  error:
9254
10212
  $ref: '#/components/schemas/ErrorResponseError'
9255
10213
  type: object
10214
+ FaxLineResponse:
10215
+ required:
10216
+ - fax_line
10217
+ properties:
10218
+ fax_line:
10219
+ $ref: '#/components/schemas/FaxLineResponseFaxLine'
10220
+ warnings:
10221
+ $ref: '#/components/schemas/WarningResponse'
10222
+ type: object
10223
+ x-internal-class: true
10224
+ FaxLineAreaCodeGetResponse:
10225
+ required:
10226
+ - area_codes
10227
+ properties:
10228
+ area_codes:
10229
+ type: array
10230
+ items:
10231
+ type: integer
10232
+ type: object
10233
+ x-internal-class: true
10234
+ FaxLineListResponse:
10235
+ required:
10236
+ - fax_lines
10237
+ - list_info
10238
+ properties:
10239
+ list_info:
10240
+ $ref: '#/components/schemas/ListInfoResponse'
10241
+ fax_lines:
10242
+ type: array
10243
+ items:
10244
+ $ref: '#/components/schemas/FaxLineResponseFaxLine'
10245
+ warnings:
10246
+ $ref: '#/components/schemas/WarningResponse'
10247
+ type: object
10248
+ x-internal-class: true
9256
10249
  FileResponse:
10250
+ required:
10251
+ - file_url
10252
+ - expires_at
9257
10253
  properties:
9258
10254
  file_url:
9259
10255
  description: 'URL to the file.'
@@ -9262,15 +10258,19 @@ components:
9262
10258
  description: 'When the link expires.'
9263
10259
  type: integer
9264
10260
  type: object
9265
- x-internal: true
10261
+ x-internal-class: true
9266
10262
  FileResponseDataUri:
10263
+ required:
10264
+ - data_uri
9267
10265
  properties:
9268
10266
  data_uri:
9269
10267
  description: 'File as base64 encoded string.'
9270
10268
  type: string
9271
10269
  type: object
9272
- x-internal: true
10270
+ x-internal-class: true
9273
10271
  ReportCreateResponse:
10272
+ required:
10273
+ - report
9274
10274
  properties:
9275
10275
  report:
9276
10276
  $ref: '#/components/schemas/ReportResponse'
@@ -9280,8 +10280,10 @@ components:
9280
10280
  items:
9281
10281
  $ref: '#/components/schemas/WarningResponse'
9282
10282
  type: object
9283
- x-internal: true
10283
+ x-internal-class: true
9284
10284
  SignatureRequestGetResponse:
10285
+ required:
10286
+ - signature_request
9285
10287
  properties:
9286
10288
  signature_request:
9287
10289
  $ref: '#/components/schemas/SignatureRequestResponse'
@@ -9291,8 +10293,11 @@ components:
9291
10293
  items:
9292
10294
  $ref: '#/components/schemas/WarningResponse'
9293
10295
  type: object
9294
- x-internal: true
10296
+ x-internal-class: true
9295
10297
  SignatureRequestListResponse:
10298
+ required:
10299
+ - signature_requests
10300
+ - list_info
9296
10301
  properties:
9297
10302
  signature_requests:
9298
10303
  description: 'Contains information about signature requests.'
@@ -9307,7 +10312,7 @@ components:
9307
10312
  items:
9308
10313
  $ref: '#/components/schemas/WarningResponse'
9309
10314
  type: object
9310
- x-internal: true
10315
+ x-internal-class: true
9311
10316
  AccountResponse:
9312
10317
  properties:
9313
10318
  account_id:
@@ -9343,8 +10348,10 @@ components:
9343
10348
  description: 'The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values.'
9344
10349
  type: string
9345
10350
  nullable: true
10351
+ usage:
10352
+ $ref: '#/components/schemas/AccountResponseUsage'
9346
10353
  type: object
9347
- x-internal: true
10354
+ x-internal-class: true
9348
10355
  OAuthTokenResponse:
9349
10356
  properties:
9350
10357
  access_token:
@@ -9360,7 +10367,7 @@ components:
9360
10367
  type: string
9361
10368
  nullable: true
9362
10369
  type: object
9363
- x-internal: true
10370
+ x-internal-class: true
9364
10371
  AccountResponseQuotas:
9365
10372
  description: 'Details concerning remaining monthly quotas.'
9366
10373
  properties:
@@ -9384,15 +10391,28 @@ components:
9384
10391
  description: 'SMS verifications remaining.'
9385
10392
  type: integer
9386
10393
  nullable: true
10394
+ num_fax_pages_left:
10395
+ description: 'Number of fax pages left'
10396
+ type: integer
10397
+ nullable: true
10398
+ type: object
10399
+ x-internal-class: true
10400
+ AccountResponseUsage:
10401
+ description: 'Details concerning monthly usage'
10402
+ properties:
10403
+ fax_pages_sent:
10404
+ description: 'Number of fax pages sent'
10405
+ type: integer
10406
+ nullable: true
9387
10407
  type: object
9388
- x-internal: true
10408
+ x-internal-class: true
9389
10409
  AccountVerifyResponseAccount:
9390
10410
  properties:
9391
10411
  email_address:
9392
10412
  description: 'The email address associated with the Account.'
9393
10413
  type: string
9394
10414
  type: object
9395
- x-internal: true
10415
+ x-internal-class: true
9396
10416
  ApiAppResponse:
9397
10417
  description: 'Contains information about an API App.'
9398
10418
  properties:
@@ -9426,7 +10446,7 @@ components:
9426
10446
  white_labeling_options:
9427
10447
  $ref: '#/components/schemas/ApiAppResponseWhiteLabelingOptions'
9428
10448
  type: object
9429
- x-internal: true
10449
+ x-internal-class: true
9430
10450
  ApiAppResponseOAuth:
9431
10451
  description: 'An object describing the app''s OAuth properties, or null if OAuth is not configured for the app.'
9432
10452
  properties:
@@ -9446,7 +10466,7 @@ components:
9446
10466
  type: boolean
9447
10467
  type: object
9448
10468
  nullable: true
9449
- x-internal: true
10469
+ x-internal-class: true
9450
10470
  ApiAppResponseOptions:
9451
10471
  description: 'An object with options that override account settings.'
9452
10472
  properties:
@@ -9455,7 +10475,7 @@ components:
9455
10475
  type: boolean
9456
10476
  type: object
9457
10477
  nullable: true
9458
- x-internal: true
10478
+ x-internal-class: true
9459
10479
  ApiAppResponseOwnerAccount:
9460
10480
  description: 'An object describing the app''s owner'
9461
10481
  properties:
@@ -9466,7 +10486,7 @@ components:
9466
10486
  description: 'The owner account''s email address'
9467
10487
  type: string
9468
10488
  type: object
9469
- x-internal: true
10489
+ x-internal-class: true
9470
10490
  ApiAppResponseWhiteLabelingOptions:
9471
10491
  description: 'An object with options to customize the app''s signer page'
9472
10492
  properties:
@@ -9500,7 +10520,7 @@ components:
9500
10520
  type: string
9501
10521
  type: object
9502
10522
  nullable: true
9503
- x-internal: true
10523
+ x-internal-class: true
9504
10524
  BulkSendJobResponse:
9505
10525
  description: 'Contains information about the BulkSendJob such as when it was created and how many signature requests are queued.'
9506
10526
  properties:
@@ -9518,7 +10538,7 @@ components:
9518
10538
  description: 'Time that the BulkSendJob was created.'
9519
10539
  type: integer
9520
10540
  type: object
9521
- x-internal: true
10541
+ x-internal-class: true
9522
10542
  BulkSendJobGetResponseSignatureRequests:
9523
10543
  title: BulkSendJobGetResponseSignatureRequests
9524
10544
  type: object
@@ -9530,7 +10550,7 @@ components:
9530
10550
  bulk_send_job_id:
9531
10551
  description: 'The id of the BulkSendJob.'
9532
10552
  type: string
9533
- x-internal: true
10553
+ x-internal-class: true
9534
10554
  EmbeddedEditUrlResponseEmbedded:
9535
10555
  description: 'An embedded template object.'
9536
10556
  properties:
@@ -9541,7 +10561,7 @@ components:
9541
10561
  description: 'The specific time that the the `edit_url` link expires, in epoch.'
9542
10562
  type: integer
9543
10563
  type: object
9544
- x-internal: true
10564
+ x-internal-class: true
9545
10565
  EmbeddedSignUrlResponseEmbedded:
9546
10566
  description: 'An object that contains necessary information to set up embedded signing.'
9547
10567
  properties:
@@ -9552,7 +10572,7 @@ components:
9552
10572
  description: 'The specific time that the the `sign_url` link expires, in epoch.'
9553
10573
  type: integer
9554
10574
  type: object
9555
- x-internal: true
10575
+ x-internal-class: true
9556
10576
  ErrorResponseError:
9557
10577
  description: 'Contains information about an error that occurred.'
9558
10578
  required:
@@ -9569,6 +10589,23 @@ components:
9569
10589
  description: 'Name of the error.'
9570
10590
  type: string
9571
10591
  type: object
10592
+ FaxLineResponseFaxLine:
10593
+ properties:
10594
+ number:
10595
+ description: Number
10596
+ type: string
10597
+ created_at:
10598
+ description: 'Created at'
10599
+ type: integer
10600
+ updated_at:
10601
+ description: 'Updated at'
10602
+ type: integer
10603
+ accounts:
10604
+ type: array
10605
+ items:
10606
+ $ref: '#/components/schemas/AccountResponse'
10607
+ type: object
10608
+ x-internal-class: true
9572
10609
  ListInfoResponse:
9573
10610
  description: 'Contains pagination information about the data returned.'
9574
10611
  properties:
@@ -9586,7 +10623,7 @@ components:
9586
10623
  description: 'Objects returned per page.'
9587
10624
  type: integer
9588
10625
  type: object
9589
- x-internal: true
10626
+ x-internal-class: true
9590
10627
  ReportResponse:
9591
10628
  description: 'Contains information about the report request.'
9592
10629
  properties:
@@ -9607,7 +10644,7 @@ components:
9607
10644
  - user_activity
9608
10645
  - document_status
9609
10646
  type: object
9610
- x-internal: true
10647
+ x-internal-class: true
9611
10648
  SignatureRequestResponse:
9612
10649
  description: 'Contains information about a signature request.'
9613
10650
  properties:
@@ -9715,7 +10752,7 @@ components:
9715
10752
  type: string
9716
10753
  nullable: true
9717
10754
  type: object
9718
- x-internal: true
10755
+ x-internal-class: true
9719
10756
  SignatureRequestResponseAttachment:
9720
10757
  description: 'Signer attachments.'
9721
10758
  required:
@@ -9730,6 +10767,7 @@ components:
9730
10767
  signer:
9731
10768
  description: 'The Signer this attachment is assigned to.'
9732
10769
  type: string
10770
+ x-int-or-string: true
9733
10771
  name:
9734
10772
  description: 'The name of this attachment.'
9735
10773
  type: string
@@ -9745,7 +10783,7 @@ components:
9745
10783
  type: integer
9746
10784
  nullable: true
9747
10785
  type: object
9748
- x-internal: true
10786
+ x-internal-class: true
9749
10787
  SignatureRequestResponseCustomFieldBase:
9750
10788
  description: |-
9751
10789
  An array of Custom Field objects containing the name and type of each custom field.
@@ -9777,7 +10815,7 @@ components:
9777
10815
  mapping:
9778
10816
  text: '#/components/schemas/SignatureRequestResponseCustomFieldText'
9779
10817
  checkbox: '#/components/schemas/SignatureRequestResponseCustomFieldCheckbox'
9780
- x-internal: true
10818
+ x-internal-class: true
9781
10819
  x-base-class: true
9782
10820
  SignatureRequestResponseCustomFieldCheckbox:
9783
10821
  description: 'This class extends `SignatureRequestResponseCustomFieldBase`.'
@@ -9850,7 +10888,7 @@ components:
9850
10888
  initials: '#/components/schemas/SignatureRequestResponseDataValueInitials'
9851
10889
  text-merge: '#/components/schemas/SignatureRequestResponseDataValueTextMerge'
9852
10890
  checkbox-merge: '#/components/schemas/SignatureRequestResponseDataValueCheckboxMerge'
9853
- x-internal: true
10891
+ x-internal-class: true
9854
10892
  x-base-class: true
9855
10893
  SignatureRequestResponseDataTypeEnum:
9856
10894
  type: string
@@ -10066,7 +11104,7 @@ components:
10066
11104
  type: string
10067
11105
  nullable: true
10068
11106
  type: object
10069
- x-internal: true
11107
+ x-internal-class: true
10070
11108
  TeamResponse:
10071
11109
  description: 'Contains information about your team and its members'
10072
11110
  properties:
@@ -10088,7 +11126,7 @@ components:
10088
11126
  items:
10089
11127
  type: string
10090
11128
  type: object
10091
- x-internal: true
11129
+ x-internal-class: true
10092
11130
  TeamInfoResponse:
10093
11131
  properties:
10094
11132
  team_id:
@@ -10106,7 +11144,7 @@ components:
10106
11144
  description: 'Number of sub teams within a team'
10107
11145
  type: integer
10108
11146
  type: object
10109
- x-internal: true
11147
+ x-internal-class: true
10110
11148
  TeamInviteResponse:
10111
11149
  properties:
10112
11150
  email_address:
@@ -10128,7 +11166,7 @@ components:
10128
11166
  description: 'Timestamp when the invitation is expiring.'
10129
11167
  type: integer
10130
11168
  type: object
10131
- x-internal: true
11169
+ x-internal-class: true
10132
11170
  TeamMemberResponse:
10133
11171
  properties:
10134
11172
  account_id:
@@ -10141,7 +11179,7 @@ components:
10141
11179
  description: 'The specific role a member has on the team.'
10142
11180
  type: string
10143
11181
  type: object
10144
- x-internal: true
11182
+ x-internal-class: true
10145
11183
  TeamParentResponse:
10146
11184
  description: 'Information about the parent team if a team has one, set to `null` otherwise.'
10147
11185
  properties:
@@ -10153,7 +11191,7 @@ components:
10153
11191
  type: string
10154
11192
  type: object
10155
11193
  nullable: true
10156
- x-internal: true
11194
+ x-internal-class: true
10157
11195
  SubTeamResponse:
10158
11196
  properties:
10159
11197
  team_id:
@@ -10163,7 +11201,7 @@ components:
10163
11201
  description: 'The name of a team'
10164
11202
  type: string
10165
11203
  type: object
10166
- x-internal: true
11204
+ x-internal-class: true
10167
11205
  TemplateResponse:
10168
11206
  description: 'Contains information about the templates you and your team have created.'
10169
11207
  properties:
@@ -10237,7 +11275,7 @@ components:
10237
11275
  $ref: '#/components/schemas/TemplateResponseAccount'
10238
11276
  nullable: true
10239
11277
  type: object
10240
- x-internal: true
11278
+ x-internal-class: true
10241
11279
  TemplateResponseAccount:
10242
11280
  properties:
10243
11281
  account_id:
@@ -10258,7 +11296,7 @@ components:
10258
11296
  quotas:
10259
11297
  $ref: '#/components/schemas/TemplateResponseAccountQuota'
10260
11298
  type: object
10261
- x-internal: true
11299
+ x-internal-class: true
10262
11300
  TemplateResponseAccountQuota:
10263
11301
  description: 'An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.'
10264
11302
  properties:
@@ -10275,14 +11313,14 @@ components:
10275
11313
  description: 'SMS verifications remaining.'
10276
11314
  type: integer
10277
11315
  type: object
10278
- x-internal: true
11316
+ x-internal-class: true
10279
11317
  TemplateResponseCCRole:
10280
11318
  properties:
10281
11319
  name:
10282
11320
  description: 'The name of the Role.'
10283
11321
  type: string
10284
11322
  type: object
10285
- x-internal: true
11323
+ x-internal-class: true
10286
11324
  TemplateCreateEmbeddedDraftResponseTemplate:
10287
11325
  description: 'Template object with parameters: `template_id`, `edit_url`, `expires_at`.'
10288
11326
  properties:
@@ -10302,7 +11340,7 @@ components:
10302
11340
  $ref: '#/components/schemas/WarningResponse'
10303
11341
  deprecated: true
10304
11342
  type: object
10305
- x-internal: true
11343
+ x-internal-class: true
10306
11344
  TemplateCreateResponseTemplate:
10307
11345
  description: 'Template object with parameters: `template_id`.'
10308
11346
  properties:
@@ -10310,7 +11348,7 @@ components:
10310
11348
  description: 'The id of the Template.'
10311
11349
  type: string
10312
11350
  type: object
10313
- x-internal: true
11351
+ x-internal-class: true
10314
11352
  TemplateResponseDocument:
10315
11353
  properties:
10316
11354
  name:
@@ -10341,7 +11379,7 @@ components:
10341
11379
  $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
10342
11380
  nullable: true
10343
11381
  type: object
10344
- x-internal: true
11382
+ x-internal-class: true
10345
11383
  TemplateResponseDocumentCustomFieldBase:
10346
11384
  description: 'An array of Form Field objects containing the name and type of each named field.'
10347
11385
  required:
@@ -10359,6 +11397,7 @@ components:
10359
11397
  description: 'The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender).'
10360
11398
  type: string
10361
11399
  nullable: true
11400
+ x-int-or-string: true
10362
11401
  x:
10363
11402
  description: 'The horizontal offset in pixels for this form field.'
10364
11403
  type: integer
@@ -10384,7 +11423,7 @@ components:
10384
11423
  mapping:
10385
11424
  text: '#/components/schemas/TemplateResponseDocumentCustomFieldText'
10386
11425
  checkbox: '#/components/schemas/TemplateResponseDocumentCustomFieldCheckbox'
10387
- x-internal: true
11426
+ x-internal-class: true
10388
11427
  x-base-class: true
10389
11428
  TemplateResponseDocumentCustomFieldCheckbox:
10390
11429
  description: 'This class extends `TemplateResponseDocumentCustomFieldBase`'
@@ -10441,7 +11480,7 @@ components:
10441
11480
  rule:
10442
11481
  $ref: '#/components/schemas/TemplateResponseDocumentFieldGroupRule'
10443
11482
  type: object
10444
- x-internal: true
11483
+ x-internal-class: true
10445
11484
  TemplateResponseDocumentFieldGroupRule:
10446
11485
  description: 'The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping).'
10447
11486
  properties:
@@ -10457,7 +11496,7 @@ components:
10457
11496
  description: 'Name of the group'
10458
11497
  type: string
10459
11498
  type: object
10460
- x-internal: true
11499
+ x-internal-class: true
10461
11500
  TemplateResponseDocumentFormFieldBase:
10462
11501
  description: 'An array of Form Field objects containing the name and type of each named field.'
10463
11502
  required:
@@ -10474,6 +11513,7 @@ components:
10474
11513
  signer:
10475
11514
  description: 'The signer of the Form Field.'
10476
11515
  type: string
11516
+ x-int-or-string: true
10477
11517
  x:
10478
11518
  description: 'The horizontal offset in pixels for this form field.'
10479
11519
  type: integer
@@ -10505,7 +11545,7 @@ components:
10505
11545
  signature: '#/components/schemas/TemplateResponseDocumentFormFieldSignature'
10506
11546
  date_signed: '#/components/schemas/TemplateResponseDocumentFormFieldDateSigned'
10507
11547
  initials: '#/components/schemas/TemplateResponseDocumentFormFieldInitials'
10508
- x-internal: true
11548
+ x-internal-class: true
10509
11549
  x-base-class: true
10510
11550
  TemplateResponseDocumentFormFieldCheckbox:
10511
11551
  description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
@@ -10799,7 +11839,7 @@ components:
10799
11839
  signature: '#/components/schemas/TemplateResponseDocumentStaticFieldSignature'
10800
11840
  date_signed: '#/components/schemas/TemplateResponseDocumentStaticFieldDateSigned'
10801
11841
  initials: '#/components/schemas/TemplateResponseDocumentStaticFieldInitials'
10802
- x-internal: true
11842
+ x-internal-class: true
10803
11843
  x-base-class: true
10804
11844
  TemplateResponseDocumentStaticFieldCheckbox:
10805
11845
  description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
@@ -11019,7 +12059,7 @@ components:
11019
12059
  description: 'Number of characters per line.'
11020
12060
  type: integer
11021
12061
  type: object
11022
- x-internal: true
12062
+ x-internal-class: true
11023
12063
  TemplateResponseSignerRole:
11024
12064
  properties:
11025
12065
  name:
@@ -11029,7 +12069,7 @@ components:
11029
12069
  description: 'If signer order is assigned this is the 0-based index for this role.'
11030
12070
  type: integer
11031
12071
  type: object
11032
- x-internal: true
12072
+ x-internal-class: true
11033
12073
  TemplateUpdateFilesResponseTemplate:
11034
12074
  description: 'Contains template id'
11035
12075
  properties:
@@ -11043,7 +12083,7 @@ components:
11043
12083
  $ref: '#/components/schemas/WarningResponse'
11044
12084
  deprecated: true
11045
12085
  type: object
11046
- x-internal: true
12086
+ x-internal-class: true
11047
12087
  UnclaimedDraftResponse:
11048
12088
  description: 'A group of documents that a user can take ownership of via the claim URL.'
11049
12089
  properties:
@@ -11070,7 +12110,7 @@ components:
11070
12110
  description: 'Whether this is a test draft. Signature requests made from test drafts have no legal value.'
11071
12111
  type: boolean
11072
12112
  type: object
11073
- x-internal: true
12113
+ x-internal-class: true
11074
12114
  WarningResponse:
11075
12115
  description: 'A list of warnings.'
11076
12116
  required:
@@ -11085,6 +12125,8 @@ components:
11085
12125
  type: string
11086
12126
  type: object
11087
12127
  TeamGetResponse:
12128
+ required:
12129
+ - team
11088
12130
  properties:
11089
12131
  team:
11090
12132
  $ref: '#/components/schemas/TeamResponse'
@@ -11094,8 +12136,10 @@ components:
11094
12136
  items:
11095
12137
  $ref: '#/components/schemas/WarningResponse'
11096
12138
  type: object
11097
- x-internal: true
12139
+ x-internal-class: true
11098
12140
  TeamGetInfoResponse:
12141
+ required:
12142
+ - team
11099
12143
  properties:
11100
12144
  team:
11101
12145
  $ref: '#/components/schemas/TeamInfoResponse'
@@ -11105,8 +12149,10 @@ components:
11105
12149
  items:
11106
12150
  $ref: '#/components/schemas/WarningResponse'
11107
12151
  type: object
11108
- x-internal: true
12152
+ x-internal-class: true
11109
12153
  TeamInvitesResponse:
12154
+ required:
12155
+ - team_invites
11110
12156
  properties:
11111
12157
  team_invites:
11112
12158
  description: 'Contains a list of team invites and their roles.'
@@ -11118,8 +12164,11 @@ components:
11118
12164
  items:
11119
12165
  $ref: '#/components/schemas/WarningResponse'
11120
12166
  type: object
11121
- x-internal: true
12167
+ x-internal-class: true
11122
12168
  TeamMembersResponse:
12169
+ required:
12170
+ - team_members
12171
+ - list_info
11123
12172
  properties:
11124
12173
  team_members:
11125
12174
  description: 'Contains a list of team members and their roles for a specific team.'
@@ -11133,8 +12182,11 @@ components:
11133
12182
  items:
11134
12183
  $ref: '#/components/schemas/WarningResponse'
11135
12184
  type: object
11136
- x-internal: true
12185
+ x-internal-class: true
11137
12186
  TeamSubTeamsResponse:
12187
+ required:
12188
+ - sub_teams
12189
+ - list_info
11138
12190
  properties:
11139
12191
  sub_teams:
11140
12192
  description: 'Contains a list with sub teams.'
@@ -11148,8 +12200,10 @@ components:
11148
12200
  items:
11149
12201
  $ref: '#/components/schemas/WarningResponse'
11150
12202
  type: object
11151
- x-internal: true
12203
+ x-internal-class: true
11152
12204
  TemplateCreateResponse:
12205
+ required:
12206
+ - template
11153
12207
  properties:
11154
12208
  template:
11155
12209
  $ref: '#/components/schemas/TemplateCreateResponseTemplate'
@@ -11159,8 +12213,10 @@ components:
11159
12213
  items:
11160
12214
  $ref: '#/components/schemas/WarningResponse'
11161
12215
  type: object
11162
- x-internal: true
12216
+ x-internal-class: true
11163
12217
  TemplateCreateEmbeddedDraftResponse:
12218
+ required:
12219
+ - template
11164
12220
  properties:
11165
12221
  template:
11166
12222
  $ref: '#/components/schemas/TemplateCreateEmbeddedDraftResponseTemplate'
@@ -11170,14 +12226,18 @@ components:
11170
12226
  items:
11171
12227
  $ref: '#/components/schemas/WarningResponse'
11172
12228
  type: object
11173
- x-internal: true
12229
+ x-internal-class: true
11174
12230
  TemplateEditResponse:
12231
+ required:
12232
+ - template_id
11175
12233
  properties:
11176
12234
  template_id:
11177
12235
  description: 'The id of the Template.'
11178
12236
  type: string
11179
12237
  type: object
11180
12238
  TemplateGetResponse:
12239
+ required:
12240
+ - template
11181
12241
  properties:
11182
12242
  template:
11183
12243
  $ref: '#/components/schemas/TemplateResponse'
@@ -11187,8 +12247,11 @@ components:
11187
12247
  items:
11188
12248
  $ref: '#/components/schemas/WarningResponse'
11189
12249
  type: object
11190
- x-internal: true
12250
+ x-internal-class: true
11191
12251
  TemplateListResponse:
12252
+ required:
12253
+ - templates
12254
+ - list_info
11192
12255
  properties:
11193
12256
  templates:
11194
12257
  description: 'List of templates that the API caller has access to.'
@@ -11203,14 +12266,18 @@ components:
11203
12266
  items:
11204
12267
  $ref: '#/components/schemas/WarningResponse'
11205
12268
  type: object
11206
- x-internal: true
12269
+ x-internal-class: true
11207
12270
  TemplateUpdateFilesResponse:
12271
+ required:
12272
+ - template
11208
12273
  properties:
11209
12274
  template:
11210
12275
  $ref: '#/components/schemas/TemplateUpdateFilesResponseTemplate'
11211
12276
  type: object
11212
- x-internal: true
12277
+ x-internal-class: true
11213
12278
  UnclaimedDraftCreateResponse:
12279
+ required:
12280
+ - unclaimed_draft
11214
12281
  properties:
11215
12282
  unclaimed_draft:
11216
12283
  $ref: '#/components/schemas/UnclaimedDraftResponse'
@@ -11220,7 +12287,7 @@ components:
11220
12287
  items:
11221
12288
  $ref: '#/components/schemas/WarningResponse'
11222
12289
  type: object
11223
- x-internal: true
12290
+ x-internal-class: true
11224
12291
  EventCallbackRequest:
11225
12292
  title: EventCallbackRequest
11226
12293
  required:
@@ -11335,6 +12402,22 @@ components:
11335
12402
  summary: 'Default Example'
11336
12403
  value:
11337
12404
  $ref: examples/json/EmbeddedEditUrlRequestDefaultExample.json
12405
+ FaxLineAddUserRequestExample:
12406
+ summary: 'Default Example'
12407
+ value:
12408
+ $ref: examples/json/FaxLineAddUserRequestExample.json
12409
+ FaxLineCreateRequestExample:
12410
+ summary: 'Default Example'
12411
+ value:
12412
+ $ref: examples/json/FaxLineCreateRequestExample.json
12413
+ FaxLineDeleteRequestExample:
12414
+ summary: 'Default Example'
12415
+ value:
12416
+ $ref: examples/json/FaxLineDeleteRequestExample.json
12417
+ FaxLineRemoveUserRequestExample:
12418
+ summary: 'Default Example'
12419
+ value:
12420
+ $ref: examples/json/FaxLineRemoveUserRequestExample.json
11338
12421
  OAuthTokenGenerateRequestExample:
11339
12422
  summary: 'OAuth Token Generate Example'
11340
12423
  value:
@@ -11579,6 +12662,18 @@ components:
11579
12662
  summary: 'Error 4XX failed_operation'
11580
12663
  value:
11581
12664
  $ref: examples/json/Error4XXResponseExample.json
12665
+ FaxLineResponseExample:
12666
+ summary: 'Sample Fax Line Response'
12667
+ value:
12668
+ $ref: examples/json/FaxLineResponseExample.json
12669
+ FaxLineAreaCodeGetResponseExample:
12670
+ summary: 'Sample Area Code Response'
12671
+ value:
12672
+ $ref: examples/json/FaxLineAreaCodeGetResponseExample.json
12673
+ FaxLineListResponseExample:
12674
+ summary: 'Sample Fax Line List Response'
12675
+ value:
12676
+ $ref: examples/json/FaxLineListResponseExample.json
11582
12677
  ReportCreateResponseExample:
11583
12678
  summary: Report
11584
12679
  value: