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.
- checksums.yaml +4 -4
- data/Gemfile.lock +26 -24
- data/README.md +25 -4
- data/VERSION +1 -1
- data/docs/AccountCreateResponse.md +1 -1
- data/docs/AccountGetResponse.md +1 -1
- data/docs/AccountResponse.md +1 -0
- data/docs/AccountResponseQuotas.md +1 -0
- data/docs/AccountResponseUsage.md +10 -0
- data/docs/ApiAppGetResponse.md +1 -1
- data/docs/ApiAppListResponse.md +2 -2
- data/docs/BulkSendJobGetResponse.md +3 -3
- data/docs/BulkSendJobListResponse.md +2 -2
- data/docs/BulkSendJobSendResponse.md +1 -1
- data/docs/EmbeddedEditUrlResponse.md +1 -1
- data/docs/EmbeddedSignUrlResponse.md +1 -1
- data/docs/FaxLineAddUserRequest.md +12 -0
- data/docs/FaxLineApi.md +503 -0
- data/docs/FaxLineAreaCodeGetCountryEnum.md +9 -0
- data/docs/FaxLineAreaCodeGetProvinceEnum.md +9 -0
- data/docs/FaxLineAreaCodeGetResponse.md +10 -0
- data/docs/FaxLineAreaCodeGetStateEnum.md +9 -0
- data/docs/FaxLineCreateRequest.md +13 -0
- data/docs/FaxLineDeleteRequest.md +10 -0
- data/docs/FaxLineListResponse.md +12 -0
- data/docs/FaxLineRemoveUserRequest.md +12 -0
- data/docs/FaxLineResponse.md +11 -0
- data/docs/FaxLineResponseFaxLine.md +13 -0
- data/docs/FileResponse.md +2 -2
- data/docs/FileResponseDataUri.md +1 -1
- data/docs/ReportCreateResponse.md +1 -1
- data/docs/SignatureRequestGetResponse.md +1 -1
- data/docs/SignatureRequestListResponse.md +2 -2
- data/docs/TeamGetInfoResponse.md +1 -1
- data/docs/TeamGetResponse.md +1 -1
- data/docs/TeamInvitesResponse.md +1 -1
- data/docs/TeamMembersResponse.md +2 -2
- data/docs/TeamSubTeamsResponse.md +2 -2
- data/docs/TemplateCreateEmbeddedDraftResponse.md +1 -1
- data/docs/TemplateCreateResponse.md +1 -1
- data/docs/TemplateEditResponse.md +1 -1
- data/docs/TemplateGetResponse.md +1 -1
- data/docs/TemplateListResponse.md +2 -2
- data/docs/TemplateUpdateFilesResponse.md +1 -1
- data/docs/UnclaimedDraftCreateResponse.md +1 -1
- data/dropbox-sign.gemspec +2 -1
- data/examples/FaxLineAddUser.rb +19 -0
- data/examples/FaxLineAreaCodeGet.rb +15 -0
- data/examples/FaxLineCreate.rb +19 -0
- data/examples/FaxLineDelete.rb +17 -0
- data/examples/FaxLineGet.rb +15 -0
- data/examples/FaxLineList.rb +15 -0
- data/examples/FaxLineRemoveUser.rb +19 -0
- data/lib/dropbox-sign/api/account_api.rb +5 -5
- data/lib/dropbox-sign/api/api_app_api.rb +8 -8
- data/lib/dropbox-sign/api/bulk_send_job_api.rb +7 -7
- data/lib/dropbox-sign/api/embedded_api.rb +3 -3
- data/lib/dropbox-sign/api/fax_line_api.rb +746 -0
- data/lib/dropbox-sign/api/o_auth_api.rb +3 -3
- data/lib/dropbox-sign/api/report_api.rb +2 -2
- data/lib/dropbox-sign/api/signature_request_api.rb +21 -21
- data/lib/dropbox-sign/api/team_api.rb +15 -15
- data/lib/dropbox-sign/api/template_api.rb +15 -15
- data/lib/dropbox-sign/api/unclaimed_draft_api.rb +5 -5
- data/lib/dropbox-sign/api_client.rb +27 -25
- data/lib/dropbox-sign/api_error.rb +6 -2
- data/lib/dropbox-sign/configuration.rb +39 -9
- data/lib/dropbox-sign/event_callback_helper.rb +1 -1
- data/lib/dropbox-sign/models/account_create_request.rb +12 -15
- data/lib/dropbox-sign/models/account_create_response.rb +17 -15
- data/lib/dropbox-sign/models/account_get_response.rb +17 -15
- data/lib/dropbox-sign/models/account_response.rb +27 -20
- data/lib/dropbox-sign/models/account_response_quotas.rb +29 -20
- data/lib/dropbox-sign/models/account_response_usage.rb +250 -0
- data/lib/dropbox-sign/models/account_update_request.rb +12 -15
- data/lib/dropbox-sign/models/account_verify_request.rb +12 -15
- data/lib/dropbox-sign/models/account_verify_response.rb +12 -15
- data/lib/dropbox-sign/models/account_verify_response_account.rb +12 -15
- data/lib/dropbox-sign/models/api_app_create_request.rb +12 -16
- data/lib/dropbox-sign/models/api_app_get_response.rb +17 -15
- data/lib/dropbox-sign/models/api_app_list_response.rb +22 -15
- data/lib/dropbox-sign/models/api_app_response.rb +12 -15
- data/lib/dropbox-sign/models/api_app_response_o_auth.rb +12 -15
- data/lib/dropbox-sign/models/api_app_response_options.rb +12 -15
- data/lib/dropbox-sign/models/api_app_response_owner_account.rb +12 -15
- data/lib/dropbox-sign/models/api_app_response_white_labeling_options.rb +12 -15
- data/lib/dropbox-sign/models/api_app_update_request.rb +13 -16
- data/lib/dropbox-sign/models/bulk_send_job_get_response.rb +27 -15
- data/lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb +12 -15
- data/lib/dropbox-sign/models/bulk_send_job_list_response.rb +22 -15
- data/lib/dropbox-sign/models/bulk_send_job_response.rb +12 -15
- data/lib/dropbox-sign/models/bulk_send_job_send_response.rb +17 -15
- data/lib/dropbox-sign/models/embedded_edit_url_request.rb +12 -15
- data/lib/dropbox-sign/models/embedded_edit_url_response.rb +17 -15
- data/lib/dropbox-sign/models/embedded_edit_url_response_embedded.rb +12 -15
- data/lib/dropbox-sign/models/embedded_sign_url_response.rb +17 -15
- data/lib/dropbox-sign/models/embedded_sign_url_response_embedded.rb +12 -15
- data/lib/dropbox-sign/models/error_response.rb +12 -15
- data/lib/dropbox-sign/models/error_response_error.rb +12 -15
- data/lib/dropbox-sign/models/event_callback_request.rb +12 -15
- data/lib/dropbox-sign/models/event_callback_request_event.rb +12 -15
- data/lib/dropbox-sign/models/event_callback_request_event_metadata.rb +12 -15
- data/lib/dropbox-sign/models/fax_line_add_user_request.rb +275 -0
- data/lib/dropbox-sign/models/fax_line_area_code_get_country_enum.rb +44 -0
- data/lib/dropbox-sign/models/fax_line_area_code_get_province_enum.rb +54 -0
- data/lib/dropbox-sign/models/fax_line_area_code_get_response.rb +254 -0
- data/lib/dropbox-sign/models/fax_line_area_code_get_state_enum.rb +92 -0
- data/lib/dropbox-sign/models/fax_line_create_request.rb +325 -0
- data/lib/dropbox-sign/models/fax_line_delete_request.rb +253 -0
- data/lib/dropbox-sign/models/fax_line_list_response.rb +279 -0
- data/lib/dropbox-sign/models/fax_line_remove_user_request.rb +275 -0
- data/lib/dropbox-sign/models/fax_line_response.rb +262 -0
- data/lib/dropbox-sign/models/fax_line_response_fax_line.rb +282 -0
- data/lib/dropbox-sign/models/file_response.rb +22 -15
- data/lib/dropbox-sign/models/file_response_data_uri.rb +17 -15
- data/lib/dropbox-sign/models/list_info_response.rb +12 -15
- data/lib/dropbox-sign/models/o_auth_token_generate_request.rb +12 -15
- data/lib/dropbox-sign/models/o_auth_token_refresh_request.rb +12 -15
- data/lib/dropbox-sign/models/o_auth_token_response.rb +12 -15
- data/lib/dropbox-sign/models/report_create_request.rb +12 -15
- data/lib/dropbox-sign/models/report_create_response.rb +17 -15
- data/lib/dropbox-sign/models/report_response.rb +12 -15
- data/lib/dropbox-sign/models/signature_request_bulk_create_embedded_with_template_request.rb +15 -18
- data/lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb +15 -18
- data/lib/dropbox-sign/models/signature_request_create_embedded_request.rb +15 -18
- data/lib/dropbox-sign/models/signature_request_create_embedded_with_template_request.rb +15 -18
- data/lib/dropbox-sign/models/signature_request_get_response.rb +17 -15
- data/lib/dropbox-sign/models/signature_request_list_response.rb +22 -15
- data/lib/dropbox-sign/models/signature_request_remind_request.rb +12 -15
- data/lib/dropbox-sign/models/signature_request_response.rb +12 -15
- data/lib/dropbox-sign/models/signature_request_response_attachment.rb +13 -16
- data/lib/dropbox-sign/models/signature_request_response_custom_field_base.rb +12 -15
- data/lib/dropbox-sign/models/signature_request_response_custom_field_checkbox.rb +12 -15
- data/lib/dropbox-sign/models/signature_request_response_custom_field_text.rb +12 -15
- data/lib/dropbox-sign/models/signature_request_response_custom_field_type_enum.rb +7 -4
- data/lib/dropbox-sign/models/signature_request_response_data_base.rb +12 -15
- data/lib/dropbox-sign/models/signature_request_response_data_type_enum.rb +7 -4
- data/lib/dropbox-sign/models/signature_request_response_data_value_checkbox.rb +12 -15
- data/lib/dropbox-sign/models/signature_request_response_data_value_checkbox_merge.rb +12 -15
- data/lib/dropbox-sign/models/signature_request_response_data_value_date_signed.rb +12 -15
- data/lib/dropbox-sign/models/signature_request_response_data_value_dropdown.rb +12 -15
- data/lib/dropbox-sign/models/signature_request_response_data_value_initials.rb +12 -15
- data/lib/dropbox-sign/models/signature_request_response_data_value_radio.rb +12 -15
- data/lib/dropbox-sign/models/signature_request_response_data_value_signature.rb +12 -15
- data/lib/dropbox-sign/models/signature_request_response_data_value_text.rb +12 -15
- data/lib/dropbox-sign/models/signature_request_response_data_value_text_merge.rb +12 -15
- data/lib/dropbox-sign/models/signature_request_response_signatures.rb +12 -15
- data/lib/dropbox-sign/models/signature_request_send_request.rb +15 -18
- data/lib/dropbox-sign/models/signature_request_send_with_template_request.rb +16 -18
- data/lib/dropbox-sign/models/signature_request_update_request.rb +12 -15
- data/lib/dropbox-sign/models/sub_attachment.rb +12 -15
- data/lib/dropbox-sign/models/sub_bulk_signer_list.rb +12 -15
- data/lib/dropbox-sign/models/sub_bulk_signer_list_custom_field.rb +12 -15
- data/lib/dropbox-sign/models/sub_cc.rb +12 -15
- data/lib/dropbox-sign/models/sub_custom_field.rb +12 -15
- data/lib/dropbox-sign/models/sub_editor_options.rb +12 -15
- data/lib/dropbox-sign/models/sub_field_options.rb +12 -15
- data/lib/dropbox-sign/models/sub_form_field_group.rb +12 -15
- data/lib/dropbox-sign/models/sub_form_field_rule.rb +12 -17
- data/lib/dropbox-sign/models/sub_form_field_rule_action.rb +12 -15
- data/lib/dropbox-sign/models/sub_form_field_rule_trigger.rb +12 -15
- data/lib/dropbox-sign/models/sub_form_fields_per_document_base.rb +12 -15
- data/lib/dropbox-sign/models/sub_form_fields_per_document_checkbox.rb +12 -15
- data/lib/dropbox-sign/models/sub_form_fields_per_document_checkbox_merge.rb +12 -15
- data/lib/dropbox-sign/models/sub_form_fields_per_document_date_signed.rb +12 -15
- data/lib/dropbox-sign/models/sub_form_fields_per_document_dropdown.rb +12 -16
- data/lib/dropbox-sign/models/sub_form_fields_per_document_font_enum.rb +7 -4
- data/lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb +12 -15
- data/lib/dropbox-sign/models/sub_form_fields_per_document_initials.rb +12 -15
- data/lib/dropbox-sign/models/sub_form_fields_per_document_radio.rb +12 -15
- data/lib/dropbox-sign/models/sub_form_fields_per_document_signature.rb +12 -15
- data/lib/dropbox-sign/models/sub_form_fields_per_document_text.rb +12 -15
- data/lib/dropbox-sign/models/sub_form_fields_per_document_text_merge.rb +12 -15
- data/lib/dropbox-sign/models/sub_form_fields_per_document_type_enum.rb +7 -4
- data/lib/dropbox-sign/models/sub_merge_field.rb +12 -15
- data/lib/dropbox-sign/models/sub_o_auth.rb +12 -15
- data/lib/dropbox-sign/models/sub_options.rb +12 -15
- data/lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb +12 -15
- data/lib/dropbox-sign/models/sub_signature_request_signer.rb +14 -17
- data/lib/dropbox-sign/models/sub_signature_request_template_signer.rb +14 -17
- data/lib/dropbox-sign/models/sub_signing_options.rb +12 -15
- data/lib/dropbox-sign/models/sub_team_response.rb +12 -15
- data/lib/dropbox-sign/models/sub_template_role.rb +12 -15
- data/lib/dropbox-sign/models/sub_unclaimed_draft_signer.rb +12 -15
- data/lib/dropbox-sign/models/sub_unclaimed_draft_template_signer.rb +12 -15
- data/lib/dropbox-sign/models/sub_white_labeling_options.rb +12 -15
- data/lib/dropbox-sign/models/team_add_member_request.rb +12 -15
- data/lib/dropbox-sign/models/team_create_request.rb +12 -15
- data/lib/dropbox-sign/models/team_get_info_response.rb +17 -15
- data/lib/dropbox-sign/models/team_get_response.rb +17 -15
- data/lib/dropbox-sign/models/team_info_response.rb +12 -15
- data/lib/dropbox-sign/models/team_invite_response.rb +12 -15
- data/lib/dropbox-sign/models/team_invites_response.rb +17 -15
- data/lib/dropbox-sign/models/team_member_response.rb +12 -15
- data/lib/dropbox-sign/models/team_members_response.rb +22 -15
- data/lib/dropbox-sign/models/team_parent_response.rb +12 -15
- data/lib/dropbox-sign/models/team_remove_member_request.rb +12 -15
- data/lib/dropbox-sign/models/team_response.rb +12 -15
- data/lib/dropbox-sign/models/team_sub_teams_response.rb +22 -15
- data/lib/dropbox-sign/models/team_update_request.rb +12 -15
- data/lib/dropbox-sign/models/template_add_user_request.rb +12 -15
- data/lib/dropbox-sign/models/template_create_embedded_draft_request.rb +14 -17
- data/lib/dropbox-sign/models/template_create_embedded_draft_response.rb +17 -15
- data/lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb +12 -15
- data/lib/dropbox-sign/models/template_create_request.rb +14 -17
- data/lib/dropbox-sign/models/template_create_response.rb +17 -15
- data/lib/dropbox-sign/models/template_create_response_template.rb +12 -15
- data/lib/dropbox-sign/models/template_edit_response.rb +17 -15
- data/lib/dropbox-sign/models/template_get_response.rb +17 -15
- data/lib/dropbox-sign/models/template_list_response.rb +22 -15
- data/lib/dropbox-sign/models/template_remove_user_request.rb +12 -15
- data/lib/dropbox-sign/models/template_response.rb +12 -15
- data/lib/dropbox-sign/models/template_response_account.rb +12 -15
- data/lib/dropbox-sign/models/template_response_account_quota.rb +12 -15
- data/lib/dropbox-sign/models/template_response_cc_role.rb +12 -15
- data/lib/dropbox-sign/models/template_response_document.rb +12 -15
- data/lib/dropbox-sign/models/template_response_document_custom_field_base.rb +13 -16
- data/lib/dropbox-sign/models/template_response_document_custom_field_checkbox.rb +12 -15
- data/lib/dropbox-sign/models/template_response_document_custom_field_text.rb +12 -15
- data/lib/dropbox-sign/models/template_response_document_field_group.rb +12 -15
- data/lib/dropbox-sign/models/template_response_document_field_group_rule.rb +12 -15
- data/lib/dropbox-sign/models/template_response_document_form_field_base.rb +13 -16
- data/lib/dropbox-sign/models/template_response_document_form_field_checkbox.rb +12 -15
- data/lib/dropbox-sign/models/template_response_document_form_field_date_signed.rb +12 -15
- data/lib/dropbox-sign/models/template_response_document_form_field_dropdown.rb +12 -15
- data/lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb +12 -15
- data/lib/dropbox-sign/models/template_response_document_form_field_initials.rb +12 -15
- data/lib/dropbox-sign/models/template_response_document_form_field_radio.rb +12 -15
- data/lib/dropbox-sign/models/template_response_document_form_field_signature.rb +12 -15
- data/lib/dropbox-sign/models/template_response_document_form_field_text.rb +12 -15
- data/lib/dropbox-sign/models/template_response_document_static_field_base.rb +12 -15
- data/lib/dropbox-sign/models/template_response_document_static_field_checkbox.rb +12 -15
- data/lib/dropbox-sign/models/template_response_document_static_field_date_signed.rb +12 -15
- data/lib/dropbox-sign/models/template_response_document_static_field_dropdown.rb +12 -15
- data/lib/dropbox-sign/models/template_response_document_static_field_hyperlink.rb +12 -15
- data/lib/dropbox-sign/models/template_response_document_static_field_initials.rb +12 -15
- data/lib/dropbox-sign/models/template_response_document_static_field_radio.rb +12 -15
- data/lib/dropbox-sign/models/template_response_document_static_field_signature.rb +12 -15
- data/lib/dropbox-sign/models/template_response_document_static_field_text.rb +12 -15
- data/lib/dropbox-sign/models/template_response_field_avg_text_length.rb +12 -15
- data/lib/dropbox-sign/models/template_response_signer_role.rb +12 -15
- data/lib/dropbox-sign/models/template_update_files_request.rb +14 -17
- data/lib/dropbox-sign/models/template_update_files_response.rb +17 -15
- data/lib/dropbox-sign/models/template_update_files_response_template.rb +12 -15
- data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb +15 -17
- data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb +15 -18
- data/lib/dropbox-sign/models/unclaimed_draft_create_request.rb +15 -17
- data/lib/dropbox-sign/models/unclaimed_draft_create_response.rb +17 -15
- data/lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb +12 -15
- data/lib/dropbox-sign/models/unclaimed_draft_response.rb +12 -15
- data/lib/dropbox-sign/models/warning_response.rb +12 -15
- data/lib/dropbox-sign/version.rb +2 -2
- data/lib/dropbox-sign.rb +14 -1
- data/openapi-config.yaml +2 -1
- data/openapi-sdk.yaml +1164 -69
- data/run-build +2 -2
- data/spec/api_client_spec.rb +3 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- data/templates/Gemfile.mustache +2 -0
- data/templates/README.mustache +91 -2
- data/templates/api.mustache +86 -14
- data/templates/api_client.mustache +23 -36
- data/templates/api_client_faraday_partial.mustache +108 -44
- data/templates/api_client_httpx_partial.mustache +134 -0
- data/templates/api_client_typhoeus_partial.mustache +23 -15
- data/templates/api_doc.mustache +88 -1
- data/templates/api_error.mustache +11 -0
- data/templates/api_info.mustache +1 -1
- data/templates/api_test.mustache +1 -1
- data/templates/base_object.mustache +75 -4
- data/templates/configuration.mustache +196 -33
- data/templates/{configuration_tls_faraday_partial.mustache → configuration_faraday_partial.mustache} +11 -0
- data/templates/configuration_httpx_partial.mustache +11 -0
- data/templates/{configuration_tls_typhoeus_partial.mustache → configuration_typhoeus_partial.mustache} +7 -0
- data/templates/gem.mustache +16 -0
- data/templates/gemspec.mustache +10 -4
- data/templates/gitignore.mustache +3 -1
- data/templates/gitlab-ci.mustache +26 -0
- data/templates/model.mustache +16 -0
- data/templates/model_test.mustache +8 -3
- data/templates/partial_anyof_module.mustache +96 -0
- data/templates/partial_model_enum_class.mustache +6 -3
- data/templates/partial_model_generic.mustache +77 -28
- data/templates/partial_model_generic_doc.mustache +28 -0
- data/templates/partial_oneof_module.mustache +4 -4
- data/templates/partial_oneof_module_doc.mustache +1 -0
- data/templates/travis.mustache +1 -4
- data/templates/version.mustache +2 -0
- metadata +46 -11
- data/templates/api_client_spec.mustache +0 -220
- data/templates/configuration_spec.mustache +0 -32
data/run-build
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
#!/usr/bin/env bash
|
2
2
|
|
3
|
-
# see https://github.com/OpenAPITools/openapi-generator/tree/
|
3
|
+
# see https://github.com/OpenAPITools/openapi-generator/tree/v7.8.0/modules/openapi-generator/src/main/resources/ruby-client
|
4
4
|
|
5
5
|
set -e
|
6
6
|
|
@@ -9,7 +9,7 @@ WORKING_DIR="/app/ruby"
|
|
9
9
|
|
10
10
|
docker run --rm \
|
11
11
|
-v "${DIR}/:/local" \
|
12
|
-
openapitools/openapi-generator-cli:
|
12
|
+
openapitools/openapi-generator-cli:v7.8.0 generate \
|
13
13
|
-i "/local/openapi-sdk.yaml" \
|
14
14
|
-c "/local/openapi-config.yaml" \
|
15
15
|
-t "/local/templates" \
|
data/spec/api_client_spec.rb
CHANGED
@@ -6,7 +6,7 @@
|
|
6
6
|
The version of the OpenAPI document: 3.0.0
|
7
7
|
Contact: apisupport@hellosign.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
|
9
|
+
Generator version: 6.6.0
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -89,6 +89,8 @@ describe Dropbox::Sign::ApiClient do
|
|
89
89
|
end
|
90
90
|
end
|
91
91
|
|
92
|
+
|
93
|
+
|
92
94
|
describe '#deserialize' do
|
93
95
|
it "handles Array<Integer>" do
|
94
96
|
api_client = Dropbox::Sign::ApiClient.new
|
data/spec/configuration_spec.rb
CHANGED
data/spec/spec_helper.rb
CHANGED
data/templates/Gemfile.mustache
CHANGED
data/templates/README.mustache
CHANGED
@@ -6,6 +6,7 @@
|
|
6
6
|
{{{.}}}
|
7
7
|
{{/appDescriptionWithNewLines}}
|
8
8
|
|
9
|
+
{{#useCustomTemplateCode}}
|
9
10
|
## Migrating from legacy SDK
|
10
11
|
|
11
12
|
This SDK is generated from our officially maintained [OpenAPI spec](https://github.com/hellosign/hellosign-openapi/blob/main/openapi.yaml).
|
@@ -24,6 +25,7 @@ Pull Requests *must* be opened against the
|
|
24
25
|
You must make SDK code changes in the mustache file within the `templates`
|
25
26
|
directory that corresponds to the file you want updated.
|
26
27
|
|
28
|
+
{{/useCustomTemplateCode}}
|
27
29
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
28
30
|
|
29
31
|
- API version: {{appVersion}}
|
@@ -31,6 +33,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
|
|
31
33
|
{{^hideGenerationTimestamp}}
|
32
34
|
- Build date: {{generatedDate}}
|
33
35
|
{{/hideGenerationTimestamp}}
|
36
|
+
- Generator version: {{generatorVersion}}
|
34
37
|
- Build package: {{generatorClass}}
|
35
38
|
{{#infoUrl}}
|
36
39
|
For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}})
|
@@ -38,11 +41,13 @@ For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}})
|
|
38
41
|
|
39
42
|
## Installation
|
40
43
|
|
44
|
+
{{#useCustomTemplateCode}}
|
41
45
|
### Install gem
|
42
46
|
```shell
|
43
47
|
gem install {{{gemName}}}
|
44
48
|
```
|
45
49
|
|
50
|
+
{{/useCustomTemplateCode}}
|
46
51
|
### Build a gem
|
47
52
|
|
48
53
|
To build the Ruby code into a gem:
|
@@ -51,7 +56,12 @@ To build the Ruby code into a gem:
|
|
51
56
|
gem build {{{gemName}}}.gemspec
|
52
57
|
```
|
53
58
|
|
59
|
+
{{^useCustomTemplateCode}}
|
60
|
+
Then either install the gem locally:
|
61
|
+
{{/useCustomTemplateCode}}
|
62
|
+
{{#useCustomTemplateCode}}
|
54
63
|
Then install the gem locally:
|
64
|
+
{{/useCustomTemplateCode}}
|
55
65
|
|
56
66
|
```shell
|
57
67
|
gem install ./{{{gemName}}}-{{{gemVersion}}}.gem
|
@@ -59,6 +69,10 @@ gem install ./{{{gemName}}}-{{{gemVersion}}}.gem
|
|
59
69
|
|
60
70
|
(for development, run `gem install --dev ./{{{gemName}}}-{{{gemVersion}}}.gem` to install the development dependencies)
|
61
71
|
|
72
|
+
{{^useCustomTemplateCode}}
|
73
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
74
|
+
{{/useCustomTemplateCode}}
|
75
|
+
|
62
76
|
Finally add this to the Gemfile:
|
63
77
|
|
64
78
|
gem '{{{gemName}}}', '~> {{{gemVersion}}}'
|
@@ -81,20 +95,87 @@ ruby -Ilib script.rb
|
|
81
95
|
|
82
96
|
Please follow the [installation](#installation) procedure and then run the following code:
|
83
97
|
|
98
|
+
{{^useCustomTemplateCode}}
|
99
|
+
```ruby
|
100
|
+
# Load the gem
|
101
|
+
require '{{{gemName}}}'
|
102
|
+
{{#apiInfo}}{{#apis}}{{#-first}}{{#operations}}{{#operation}}{{#-first}}{{#hasAuthMethods}}
|
103
|
+
# Setup authorization
|
104
|
+
{{{moduleName}}}.configure do |config|{{#authMethods}}{{#isBasic}}{{#isBasicBasic}}
|
105
|
+
# Configure HTTP basic authorization: {{{name}}}
|
106
|
+
config.username = 'YOUR_USERNAME'
|
107
|
+
config.password = 'YOUR_PASSWORD'{{/isBasicBasic}}{{#isBasicBearer}}
|
108
|
+
# Configure Bearer authorization{{#bearerFormat}} ({{{.}}}){{/bearerFormat}}: {{{name}}}
|
109
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
110
|
+
# Configure a proc to get access tokens in lieu of the static access_token configuration
|
111
|
+
config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } {{/isBasicBearer}}{{/isBasic}}{{#isApiKey}}
|
112
|
+
# Configure API key authorization: {{{name}}}
|
113
|
+
config.api_key['{{{name}}}'] = 'YOUR API KEY'
|
114
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
115
|
+
# config.api_key_prefix['{{{name}}}'] = 'Bearer'{{/isApiKey}}{{#isOAuth}}
|
116
|
+
# Configure OAuth2 access token for authorization: {{{name}}}
|
117
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
118
|
+
# Configure a proc to get access tokens in lieu of the static access_token configuration
|
119
|
+
config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } {{/isOAuth}}
|
120
|
+
{{#isFaraday}}
|
121
|
+
# Configure faraday connection
|
122
|
+
config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
|
123
|
+
{{/isFaraday}}
|
124
|
+
{{#isHttpx}}
|
125
|
+
# Configure httpx session
|
126
|
+
config.configure_session { |session| 'YOUR CONNECTION CONFIG PROC' }
|
127
|
+
{{/isHttpx}}
|
128
|
+
{{/authMethods}}end
|
129
|
+
{{/hasAuthMethods}}
|
130
|
+
|
131
|
+
api_instance = {{{moduleName}}}::{{{classname}}}.new
|
132
|
+
{{#requiredParams}}
|
133
|
+
{{{paramName}}} = {{{vendorExtensions.x-ruby-example}}} # {{{dataType}}} | {{{description}}}
|
134
|
+
{{/requiredParams}}
|
135
|
+
{{#optionalParams}}
|
136
|
+
{{#-first}}
|
137
|
+
opts = {
|
138
|
+
{{/-first}}
|
139
|
+
{{{paramName}}}: {{{vendorExtensions.x-ruby-example}}}{{^-last}},{{/-last}} # {{{dataType}}} | {{{description}}}
|
140
|
+
{{#-last}}
|
141
|
+
}
|
142
|
+
{{/-last}}
|
143
|
+
{{/optionalParams}}
|
144
|
+
|
145
|
+
begin
|
146
|
+
{{#summary}} #{{{.}}}
|
147
|
+
{{/summary}} {{#returnType}}result = {{/returnType}}api_instance.{{{operationId}}}{{#hasParams}}({{#requiredParams}}{{{paramName}}}{{^-last}}, {{/-last}}{{/requiredParams}}{{#optionalParams}}{{#-last}}{{#hasRequiredParams}}, {{/hasRequiredParams}}opts{{/-last}}{{/optionalParams}}){{/hasParams}}{{#returnType}}
|
148
|
+
p result{{/returnType}}
|
149
|
+
rescue {{{moduleName}}}::ApiError => e
|
150
|
+
puts "Exception when calling {{classname}}->{{{operationId}}}: #{e}"
|
151
|
+
end
|
152
|
+
{{/-first}}{{/operation}}{{/operations}}{{/-first}}{{/apis}}{{/apiInfo}}
|
153
|
+
```
|
154
|
+
{{/useCustomTemplateCode}}
|
155
|
+
{{#useCustomTemplateCode}}
|
84
156
|
{{#apiInfo}}{{#apis}}{{#-first}}{{#operations}}{{#operation}}{{#-first}}
|
85
157
|
```ruby
|
86
158
|
REPLACE_ME_WITH_EXAMPLE_FOR__{{{operationId}}}_Ruby_CODE
|
87
159
|
```
|
88
160
|
{{/-first}}{{/operation}}{{/operations}}{{/-first}}{{/apis}}{{/apiInfo}}
|
161
|
+
{{/useCustomTemplateCode}}
|
89
162
|
|
90
163
|
## Documentation for API Endpoints
|
91
164
|
|
92
165
|
All URIs are relative to *{{basePath}}*
|
93
166
|
|
167
|
+
{{^useCustomTemplateCode}}
|
168
|
+
Class | Method | HTTP request | Description
|
169
|
+
------------ | ------------- | ------------- | -------------
|
170
|
+
{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{moduleName}}::{{classname}}* | [**{{operationId}}**]({{apiDocPath}}{{classname}}.md#{{operationId}}) | **{{httpMethod}}** {{path}} | {{{summary}}}
|
171
|
+
{{/operation}}{{/operations}}{{/apis}}{{/apiInfo}}
|
172
|
+
{{/useCustomTemplateCode}}
|
173
|
+
{{#useCustomTemplateCode}}
|
94
174
|
|Class | Method | HTTP request | Description|
|
95
175
|
|------------ | ------------- | ------------- | -------------|
|
96
176
|
{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}|*{{moduleName}}::{{classname}}* | [**{{operationId}}**]({{apiDocPath}}{{classname}}.md#{{operationId}}) | **{{httpMethod}}** {{path}} | {{{summary}}} |
|
97
177
|
{{/operation}}{{/operations}}{{/apis}}{{/apiInfo}}
|
178
|
+
{{/useCustomTemplateCode}}
|
98
179
|
|
99
180
|
## Documentation for Models
|
100
181
|
|
@@ -103,9 +184,16 @@ All URIs are relative to *{{basePath}}*
|
|
103
184
|
|
104
185
|
## Documentation for Authorization
|
105
186
|
|
187
|
+
{{^useCustomTemplateCode}}
|
188
|
+
{{^authMethods}}Endpoints do not require authorization.{{/authMethods}}
|
189
|
+
{{#hasAuthMethods}}Authentication schemes defined for the API:{{/hasAuthMethods}}
|
190
|
+
{{/useCustomTemplateCode}}
|
191
|
+
{{#useCustomTemplateCode}}
|
106
192
|
{{^authMethods}} All endpoints do not require authorization.
|
107
193
|
{{/authMethods}}{{#authMethods}}{{#last}} Authentication schemes defined for the API:{{/last}}{{/authMethods}}
|
108
|
-
{{
|
194
|
+
{{/useCustomTemplateCode}}
|
195
|
+
{{#authMethods}}
|
196
|
+
### {{name}}
|
109
197
|
|
110
198
|
{{#isApiKey}}
|
111
199
|
|
@@ -116,7 +204,8 @@ All URIs are relative to *{{basePath}}*
|
|
116
204
|
{{#isBasic}}
|
117
205
|
{{#isBasicBasic}}- **Type**: HTTP basic authentication
|
118
206
|
{{/isBasicBasic}}{{#isBasicBearer}}- **Type**: Bearer authentication{{#bearerFormat}} ({{{.}}}){{/bearerFormat}}
|
119
|
-
{{/isBasicBearer}}
|
207
|
+
{{/isBasicBearer}}{{#isHttpSignature}}- **Type**: HTTP signature authentication
|
208
|
+
{{/isHttpSignature}}
|
120
209
|
{{/isBasic}}
|
121
210
|
{{#isOAuth}}
|
122
211
|
|
data/templates/api.mustache
CHANGED
@@ -4,9 +4,11 @@
|
|
4
4
|
|
5
5
|
require 'cgi'
|
6
6
|
|
7
|
+
{{#useCustomTemplateCode}}
|
7
8
|
module Dropbox
|
8
9
|
end
|
9
10
|
|
11
|
+
{{/useCustomTemplateCode}}
|
10
12
|
module {{moduleName}}
|
11
13
|
{{#operations}}
|
12
14
|
class {{classname}}
|
@@ -22,12 +24,30 @@ module {{moduleName}}
|
|
22
24
|
{{#notes}}
|
23
25
|
# {{{.}}}
|
24
26
|
{{/notes}}
|
25
|
-
{{#
|
26
|
-
|
27
|
-
{{#allParams}}
|
28
|
-
{{
|
29
|
-
|
30
|
-
|
27
|
+
{{#vendorExtensions.x-group-parameters}}
|
28
|
+
# @param [Hash] opts the parameters
|
29
|
+
{{#allParams}}
|
30
|
+
{{#required}}
|
31
|
+
# @option opts [{{{dataType}}}] :{{paramName}} {{description}} (required)
|
32
|
+
{{/required}}
|
33
|
+
{{/allParams}}
|
34
|
+
{{/vendorExtensions.x-group-parameters}}
|
35
|
+
{{^vendorExtensions.x-group-parameters}}
|
36
|
+
{{#allParams}}
|
37
|
+
{{#required}}
|
38
|
+
# @param {{paramName}} [{{{dataType}}}] {{description}}
|
39
|
+
{{/required}}
|
40
|
+
{{/allParams}}
|
41
|
+
# @param [Hash] opts the optional parameters
|
42
|
+
{{/vendorExtensions.x-group-parameters}}
|
43
|
+
{{#allParams}}
|
44
|
+
{{^required}}
|
45
|
+
# @option opts [{{{dataType}}}] :{{paramName}} {{description}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}}
|
46
|
+
{{/required}}
|
47
|
+
{{/allParams}}
|
48
|
+
# @return [{{{returnType}}}{{^returnType}}nil{{/returnType}}]
|
49
|
+
def {{operationId}}({{^vendorExtensions.x-group-parameters}}{{#allParams}}{{#required}}{{paramName}}, {{/required}}{{/allParams}}{{/vendorExtensions.x-group-parameters}}opts = {})
|
50
|
+
{{#returnType}}data, _status_code, _headers = {{/returnType}}{{operationId}}_with_http_info({{^vendorExtensions.x-group-parameters}}{{#allParams}}{{#required}}{{paramName}}, {{/required}}{{/allParams}}{{/vendorExtensions.x-group-parameters}}opts)
|
31
51
|
{{#returnType}}data{{/returnType}}{{^returnType}}nil{{/returnType}}
|
32
52
|
end
|
33
53
|
|
@@ -37,14 +57,42 @@ module {{moduleName}}
|
|
37
57
|
{{#notes}}
|
38
58
|
# {{.}}
|
39
59
|
{{/notes}}
|
40
|
-
{{#
|
41
|
-
|
42
|
-
{{#allParams}}
|
43
|
-
{{
|
44
|
-
|
60
|
+
{{#vendorExtensions.x-group-parameters}}
|
61
|
+
# @param [Hash] opts the parameters
|
62
|
+
{{#allParams}}
|
63
|
+
{{#required}}
|
64
|
+
# @option opts [{{{dataType}}}] :{{paramName}} {{description}} (required)
|
65
|
+
{{/required}}
|
66
|
+
{{/allParams}}
|
67
|
+
{{/vendorExtensions.x-group-parameters}}
|
68
|
+
{{^vendorExtensions.x-group-parameters}}
|
69
|
+
{{#allParams}}
|
70
|
+
{{#required}}
|
71
|
+
# @param {{paramName}} [{{{dataType}}}] {{description}}
|
72
|
+
{{/required}}
|
73
|
+
{{/allParams}}
|
74
|
+
# @param [Hash] opts the optional parameters
|
75
|
+
{{/vendorExtensions.x-group-parameters}}
|
76
|
+
{{#allParams}}
|
77
|
+
{{^required}}
|
78
|
+
# @option opts [{{{dataType}}}] :{{paramName}} {{description}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}}
|
79
|
+
{{/required}}
|
80
|
+
{{/allParams}}
|
81
|
+
# @return [Array<({{{returnType}}}{{^returnType}}nil{{/returnType}}, Integer, Hash)>] {{#returnType}}{{{.}}} data{{/returnType}}{{^returnType}}nil{{/returnType}}, response status code and response headers
|
82
|
+
def {{operationId}}_with_http_info({{^vendorExtensions.x-group-parameters}}{{#allParams}}{{#required}}{{paramName}}, {{/required}}{{/allParams}}{{/vendorExtensions.x-group-parameters}}opts = {})
|
45
83
|
if @api_client.config.debugging
|
46
84
|
@api_client.config.logger.debug 'Calling API: {{classname}}.{{operationId}} ...'
|
47
85
|
end
|
86
|
+
{{#vendorExtensions.x-group-parameters}}
|
87
|
+
# unbox the parameters from the hash
|
88
|
+
{{#allParams}}
|
89
|
+
{{^isNullable}}
|
90
|
+
{{#required}}
|
91
|
+
{{{paramName}}} = opts[:'{{{paramName}}}']
|
92
|
+
{{/required}}
|
93
|
+
{{/isNullable}}
|
94
|
+
{{/allParams}}
|
95
|
+
{{/vendorExtensions.x-group-parameters}}
|
48
96
|
{{#allParams}}
|
49
97
|
{{^isNullable}}
|
50
98
|
{{#required}}
|
@@ -145,7 +193,7 @@ module {{moduleName}}
|
|
145
193
|
header_params = opts[:header_params] || {}
|
146
194
|
{{#hasProduces}}
|
147
195
|
# HTTP header 'Accept' (if needed)
|
148
|
-
header_params['Accept'] = @api_client.select_header_accept([{{#produces}}'{{{mediaType}}}'{{^-last}}, {{/-last}}{{/produces}}])
|
196
|
+
header_params['Accept'] = @api_client.select_header_accept([{{#produces}}'{{{mediaType}}}'{{^-last}}, {{/-last}}{{/produces}}]) unless header_params['Accept']
|
149
197
|
{{/hasProduces}}
|
150
198
|
{{#hasConsumes}}
|
151
199
|
# HTTP header 'Content-Type'
|
@@ -156,15 +204,33 @@ module {{moduleName}}
|
|
156
204
|
{{/hasConsumes}}
|
157
205
|
{{#headerParams}}
|
158
206
|
{{#required}}
|
159
|
-
header_params[:'{{{baseName}}}'] = {{#collectionFormat}}@api_client.build_collection_param({{{paramName}}}, :{{{collectionFormat}}}){{/collectionFormat}}{{^collectionFormat}}{{{paramName}}}{{/collectionFormat}}
|
207
|
+
header_params[{{#lambdaFixHeaderKey}}:'{{{baseName}}}'{{/lambdaFixHeaderKey}}] = {{#collectionFormat}}@api_client.build_collection_param({{{paramName}}}, :{{{collectionFormat}}}){{/collectionFormat}}{{^collectionFormat}}{{{paramName}}}{{/collectionFormat}}
|
160
208
|
{{/required}}
|
161
209
|
{{/headerParams}}
|
162
210
|
{{#headerParams}}
|
163
211
|
{{^required}}
|
164
|
-
header_params[:'{{{baseName}}}'] = {{#collectionFormat}}@api_client.build_collection_param(opts[:'{{{paramName}}}'], :{{{collectionFormat}}}){{/collectionFormat}}{{^collectionFormat}}opts[:'{{{paramName}}}']{{/collectionFormat}} if !opts[:'{{{paramName}}}'].nil?
|
212
|
+
header_params[{{#lambdaFixHeaderKey}}:'{{{baseName}}}'{{/lambdaFixHeaderKey}}] = {{#collectionFormat}}@api_client.build_collection_param(opts[:'{{{paramName}}}'], :{{{collectionFormat}}}){{/collectionFormat}}{{^collectionFormat}}opts[:'{{{paramName}}}']{{/collectionFormat}} if !opts[:'{{{paramName}}}'].nil?
|
165
213
|
{{/required}}
|
166
214
|
{{/headerParams}}
|
167
215
|
|
216
|
+
{{^useCustomTemplateCode}}
|
217
|
+
# form parameters
|
218
|
+
form_params = opts[:form_params] || {}
|
219
|
+
{{#formParams}}
|
220
|
+
{{#required}}
|
221
|
+
form_params['{{baseName}}'] = {{#collectionFormat}}@api_client.build_collection_param({{{paramName}}}, :{{{collectionFormat}}}){{/collectionFormat}}{{^collectionFormat}}{{{paramName}}}{{/collectionFormat}}
|
222
|
+
{{/required}}
|
223
|
+
{{/formParams}}
|
224
|
+
{{#formParams}}
|
225
|
+
{{^required}}
|
226
|
+
form_params['{{baseName}}'] = {{#collectionFormat}}@api_client.build_collection_param(opts[:'{{{paramName}}}'], :{{{collectionFormat}}}){{/collectionFormat}}{{^collectionFormat}}opts[:'{{{paramName}}}']{{/collectionFormat}} if !opts[:'{{paramName}}'].nil?
|
227
|
+
{{/required}}
|
228
|
+
{{/formParams}}
|
229
|
+
|
230
|
+
# http body (model)
|
231
|
+
post_body = opts[:debug_body]{{#bodyParam}} || @api_client.object_to_http_body({{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:'{{{paramName}}}']{{/required}}){{/bodyParam}}
|
232
|
+
{{/useCustomTemplateCode}}
|
233
|
+
{{#useCustomTemplateCode}}
|
168
234
|
post_body = {}
|
169
235
|
form_params = opts[:form_params] || {}
|
170
236
|
{{#bodyParam}}
|
@@ -187,6 +253,7 @@ module {{moduleName}}
|
|
187
253
|
# http body (model)
|
188
254
|
post_body = opts[:debug_body]{{#bodyParam}} || @api_client.object_to_http_body({{#required}}{{{paramName}}}{{/required}}{{^required}}opts[:'{{{paramName}}}']{{/required}}){{/bodyParam}}
|
189
255
|
{{/bodyParam}}
|
256
|
+
{{/useCustomTemplateCode}}
|
190
257
|
|
191
258
|
# return_type
|
192
259
|
return_type = opts[:debug_return_type]{{#returnType}} || '{{{.}}}'{{/returnType}}
|
@@ -204,6 +271,10 @@ module {{moduleName}}
|
|
204
271
|
:return_type => return_type
|
205
272
|
)
|
206
273
|
|
274
|
+
{{^useCustomTemplateCode}}
|
275
|
+
data, status_code, headers = @api_client.call_api(:{{httpMethod}}, local_var_path, new_options)
|
276
|
+
{{/useCustomTemplateCode}}
|
277
|
+
{{#useCustomTemplateCode}}
|
207
278
|
begin
|
208
279
|
data, status_code, headers = @api_client.call_api(:{{httpMethod}}, local_var_path, new_options)
|
209
280
|
rescue Dropbox::Sign::ApiError => e
|
@@ -269,6 +340,7 @@ module {{moduleName}}
|
|
269
340
|
{{/returnType}}
|
270
341
|
end
|
271
342
|
|
343
|
+
{{/useCustomTemplateCode}}
|
272
344
|
if @api_client.config.debugging
|
273
345
|
@api_client.config.logger.debug "API called: {{classname}}#{{operationId}}\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
274
346
|
end
|
@@ -7,15 +7,23 @@ require 'json'
|
|
7
7
|
require 'logger'
|
8
8
|
require 'tempfile'
|
9
9
|
require 'time'
|
10
|
-
{{
|
10
|
+
{{#isTyphoeus}}
|
11
11
|
require 'typhoeus'
|
12
|
-
{{/
|
12
|
+
{{/isTyphoeus}}
|
13
13
|
{{#isFaraday}}
|
14
14
|
require 'faraday'
|
15
|
+
require 'faraday/multipart' if Gem::Version.new(Faraday::VERSION) >= Gem::Version.new('2.0')
|
16
|
+
require 'marcel'
|
15
17
|
{{/isFaraday}}
|
18
|
+
{{#isHttpx}}
|
19
|
+
require 'httpx'
|
20
|
+
require 'net/http/status'
|
21
|
+
{{/isHttpx}}
|
16
22
|
|
23
|
+
{{#useCustomTemplateCode}}
|
17
24
|
module Dropbox
|
18
25
|
end
|
26
|
+
{{/useCustomTemplateCode}}
|
19
27
|
|
20
28
|
module {{moduleName}}
|
21
29
|
class ApiClient
|
@@ -42,12 +50,15 @@ module {{moduleName}}
|
|
42
50
|
@@default ||= ApiClient.new
|
43
51
|
end
|
44
52
|
|
45
|
-
{{
|
53
|
+
{{#isTyphoeus}}
|
46
54
|
{{> api_client_typhoeus_partial}}
|
47
|
-
{{/
|
55
|
+
{{/isTyphoeus}}
|
48
56
|
{{#isFaraday}}
|
49
57
|
{{> api_client_faraday_partial}}
|
50
58
|
{{/isFaraday}}
|
59
|
+
{{#isHttpx}}
|
60
|
+
{{> api_client_httpx_partial}}
|
61
|
+
{{/isHttpx}}
|
51
62
|
# Check if the given MIME is a JSON MIME.
|
52
63
|
# JSON MIME examples:
|
53
64
|
# application/json
|
@@ -57,7 +68,7 @@ module {{moduleName}}
|
|
57
68
|
# @param [String] mime MIME
|
58
69
|
# @return [Boolean] True if the MIME is application/json
|
59
70
|
def json_mime?(mime)
|
60
|
-
(mime == '*/*') || !(mime =~
|
71
|
+
(mime == '*/*') || !(mime =~ /^Application\/.*json(?!p)(;.*)?/i).nil?
|
61
72
|
end
|
62
73
|
|
63
74
|
# Deserialize the response to the given return type.
|
@@ -66,38 +77,10 @@ module {{moduleName}}
|
|
66
77
|
# @param [String] return_type some examples: "User", "Array<User>", "Hash<String, Integer>"
|
67
78
|
def deserialize(response, return_type)
|
68
79
|
body = response.body
|
69
|
-
|
70
|
-
# handle file downloading - return the File instance processed in request callbacks
|
71
|
-
# note that response body is empty when the file is written in chunks in request on_body callback
|
72
|
-
{{^isFaraday}}
|
73
|
-
return @tempfile if return_type == 'File'
|
74
|
-
{{/isFaraday}}
|
75
|
-
{{#isFaraday}}
|
76
|
-
if return_type == 'File'
|
77
|
-
content_disposition = response.headers['Content-Disposition']
|
78
|
-
if content_disposition && content_disposition =~ /filename=/i
|
79
|
-
filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
|
80
|
-
prefix = sanitize_filename(filename)
|
81
|
-
else
|
82
|
-
prefix = 'download-'
|
83
|
-
end
|
84
|
-
prefix = prefix + '-' unless prefix.end_with?('-')
|
85
|
-
encoding = body.encoding
|
86
|
-
@tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
|
87
|
-
@tempfile.write(@stream.join.force_encoding(encoding))
|
88
|
-
@tempfile.close
|
89
|
-
@config.logger.info "Temp file written to #{@tempfile.path}, please copy the file to a proper folder "\
|
90
|
-
"with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
|
91
|
-
"will be deleted automatically with GC. It's also recommended to delete the temp file "\
|
92
|
-
"explicitly with `tempfile.delete`"
|
93
|
-
return @tempfile
|
94
|
-
end
|
95
|
-
{{/isFaraday}}
|
96
|
-
|
97
80
|
return nil if body.nil? || body.empty?
|
98
81
|
|
99
82
|
# return response body directly for String return type
|
100
|
-
return body if return_type == 'String'
|
83
|
+
return body.to_s if return_type == 'String'
|
101
84
|
|
102
85
|
# ensuring a default content type
|
103
86
|
content_type = response.headers['Content-Type'] || 'application/json'
|
@@ -152,7 +135,9 @@ module {{moduleName}}
|
|
152
135
|
data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
|
153
136
|
end
|
154
137
|
else
|
155
|
-
|
138
|
+
{{^useCustomTemplateCode}}
|
139
|
+
# models (e.g. Pet) or oneOf
|
140
|
+
{{/useCustomTemplateCode}}
|
156
141
|
klass = {{moduleName}}.const_get(return_type)
|
157
142
|
klass.respond_to?(:openapi_one_of) ? klass.build(data) : klass.build_from_hash(data)
|
158
143
|
end
|
@@ -164,7 +149,7 @@ module {{moduleName}}
|
|
164
149
|
# @param [String] filename the filename to be sanitized
|
165
150
|
# @return [String] the sanitized filename
|
166
151
|
def sanitize_filename(filename)
|
167
|
-
filename.
|
152
|
+
filename.split(/[\/\\]/).last
|
168
153
|
end
|
169
154
|
|
170
155
|
def build_request_url(path, opts = {})
|
@@ -263,6 +248,7 @@ module {{moduleName}}
|
|
263
248
|
fail "unknown collection format: #{collection_format.inspect}"
|
264
249
|
end
|
265
250
|
end
|
251
|
+
{{#useCustomTemplateCode}}
|
266
252
|
|
267
253
|
def generate_form_data(obj, openapi_types)
|
268
254
|
params = {}
|
@@ -287,5 +273,6 @@ module {{moduleName}}
|
|
287
273
|
:params => params,
|
288
274
|
}
|
289
275
|
end
|
276
|
+
{{/useCustomTemplateCode}}
|
290
277
|
end
|
291
278
|
end
|