dropbox-sign 1.0.0.pre.beta2301
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 +7 -0
- data/Gemfile +10 -0
- data/Gemfile.lock +78 -0
- data/LICENSE +21 -0
- data/README.md +333 -0
- data/Rakefile +10 -0
- data/bin/generate-examples.php +269 -0
- data/bin/php +16 -0
- data/bin/replace +11 -0
- data/bin/ruby +16 -0
- data/bin/scan_for +32 -0
- data/composer.json +10 -0
- data/composer.lock +246 -0
- data/docs/AccountApi.md +301 -0
- data/docs/AccountCreateRequest.md +13 -0
- data/docs/AccountCreateResponse.md +12 -0
- data/docs/AccountGetResponse.md +11 -0
- data/docs/AccountResponse.md +19 -0
- data/docs/AccountResponseQuotas.md +14 -0
- data/docs/AccountUpdateRequest.md +12 -0
- data/docs/AccountVerifyRequest.md +10 -0
- data/docs/AccountVerifyResponse.md +11 -0
- data/docs/AccountVerifyResponseAccount.md +10 -0
- data/docs/ApiAppApi.md +402 -0
- data/docs/ApiAppCreateRequest.md +16 -0
- data/docs/ApiAppGetResponse.md +11 -0
- data/docs/ApiAppListResponse.md +12 -0
- data/docs/ApiAppResponse.md +19 -0
- data/docs/ApiAppResponseOAuth.md +13 -0
- data/docs/ApiAppResponseOptions.md +10 -0
- data/docs/ApiAppResponseOwnerAccount.md +11 -0
- data/docs/ApiAppResponseWhiteLabelingOptions.md +23 -0
- data/docs/ApiAppUpdateRequest.md +16 -0
- data/docs/BulkSendJobApi.md +155 -0
- data/docs/BulkSendJobGetResponse.md +13 -0
- data/docs/BulkSendJobGetResponseSignatureRequests.md +33 -0
- data/docs/BulkSendJobListResponse.md +12 -0
- data/docs/BulkSendJobResponse.md +13 -0
- data/docs/BulkSendJobSendResponse.md +11 -0
- data/docs/EmbeddedApi.md +158 -0
- data/docs/EmbeddedEditUrlRequest.md +19 -0
- data/docs/EmbeddedEditUrlResponse.md +11 -0
- data/docs/EmbeddedEditUrlResponseEmbedded.md +11 -0
- data/docs/EmbeddedSignUrlResponse.md +11 -0
- data/docs/EmbeddedSignUrlResponseEmbedded.md +11 -0
- data/docs/ErrorResponse.md +10 -0
- data/docs/ErrorResponseError.md +12 -0
- data/docs/EventCallbackRequest.md +13 -0
- data/docs/EventCallbackRequestEvent.md +13 -0
- data/docs/EventCallbackRequestEventMetadata.md +13 -0
- data/docs/FileResponse.md +11 -0
- data/docs/FileResponseDataUri.md +10 -0
- data/docs/ListInfoResponse.md +13 -0
- data/docs/OAuthApi.md +158 -0
- data/docs/OAuthTokenGenerateRequest.md +14 -0
- data/docs/OAuthTokenRefreshRequest.md +11 -0
- data/docs/OAuthTokenResponse.md +14 -0
- data/docs/ReportApi.md +83 -0
- data/docs/ReportCreateRequest.md +12 -0
- data/docs/ReportCreateResponse.md +11 -0
- data/docs/ReportResponse.md +13 -0
- data/docs/SignatureRequestApi.md +1377 -0
- data/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md +22 -0
- data/docs/SignatureRequestBulkSendWithTemplateRequest.md +22 -0
- data/docs/SignatureRequestCreateEmbeddedRequest.md +33 -0
- data/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md +24 -0
- data/docs/SignatureRequestGetResponse.md +11 -0
- data/docs/SignatureRequestListResponse.md +12 -0
- data/docs/SignatureRequestRemindRequest.md +11 -0
- data/docs/SignatureRequestResponse.md +32 -0
- data/docs/SignatureRequestResponseAttachment.md +15 -0
- data/docs/SignatureRequestResponseCustomFieldBase.md +17 -0
- data/docs/SignatureRequestResponseCustomFieldCheckbox.md +11 -0
- data/docs/SignatureRequestResponseCustomFieldText.md +11 -0
- data/docs/SignatureRequestResponseCustomFieldTypeEnum.md +9 -0
- data/docs/SignatureRequestResponseDataBase.md +14 -0
- data/docs/SignatureRequestResponseDataTypeEnum.md +9 -0
- data/docs/SignatureRequestResponseDataValueCheckbox.md +11 -0
- data/docs/SignatureRequestResponseDataValueCheckboxMerge.md +11 -0
- data/docs/SignatureRequestResponseDataValueDateSigned.md +11 -0
- data/docs/SignatureRequestResponseDataValueDropdown.md +11 -0
- data/docs/SignatureRequestResponseDataValueInitials.md +11 -0
- data/docs/SignatureRequestResponseDataValueRadio.md +11 -0
- data/docs/SignatureRequestResponseDataValueSignature.md +11 -0
- data/docs/SignatureRequestResponseDataValueText.md +11 -0
- data/docs/SignatureRequestResponseDataValueTextMerge.md +11 -0
- data/docs/SignatureRequestResponseSignatures.md +28 -0
- data/docs/SignatureRequestSendRequest.md +34 -0
- data/docs/SignatureRequestSendWithTemplateRequest.md +25 -0
- data/docs/SignatureRequestUpdateRequest.md +13 -0
- data/docs/SubAttachment.md +13 -0
- data/docs/SubBulkSignerList.md +11 -0
- data/docs/SubBulkSignerListCustomField.md +11 -0
- data/docs/SubCC.md +11 -0
- data/docs/SubCustomField.md +17 -0
- data/docs/SubEditorOptions.md +11 -0
- data/docs/SubFieldOptions.md +10 -0
- data/docs/SubFormFieldGroup.md +12 -0
- data/docs/SubFormFieldRule.md +13 -0
- data/docs/SubFormFieldRuleAction.md +13 -0
- data/docs/SubFormFieldRuleTrigger.md +13 -0
- data/docs/SubFormFieldsPerDocumentBase.md +33 -0
- data/docs/SubFormFieldsPerDocumentCheckbox.md +12 -0
- data/docs/SubFormFieldsPerDocumentCheckboxMerge.md +10 -0
- data/docs/SubFormFieldsPerDocumentDateSigned.md +10 -0
- data/docs/SubFormFieldsPerDocumentDropdown.md +12 -0
- data/docs/SubFormFieldsPerDocumentHyperlink.md +12 -0
- data/docs/SubFormFieldsPerDocumentInitials.md +10 -0
- data/docs/SubFormFieldsPerDocumentRadio.md +12 -0
- data/docs/SubFormFieldsPerDocumentSignature.md +10 -0
- data/docs/SubFormFieldsPerDocumentText.md +17 -0
- data/docs/SubFormFieldsPerDocumentTextMerge.md +10 -0
- data/docs/SubFormFieldsPerDocumentTypeEnum.md +9 -0
- data/docs/SubMergeField.md +11 -0
- data/docs/SubOAuth.md +11 -0
- data/docs/SubOptions.md +10 -0
- data/docs/SubSignatureRequestGroupedSigners.md +12 -0
- data/docs/SubSignatureRequestSigner.md +15 -0
- data/docs/SubSignatureRequestTemplateSigner.md +15 -0
- data/docs/SubSigningOptions.md +16 -0
- data/docs/SubTeamResponse.md +11 -0
- data/docs/SubTemplateRole.md +11 -0
- data/docs/SubUnclaimedDraftSigner.md +12 -0
- data/docs/SubUnclaimedDraftTemplateSigner.md +12 -0
- data/docs/SubWhiteLabelingOptions.md +26 -0
- data/docs/TeamAddMemberRequest.md +12 -0
- data/docs/TeamApi.md +737 -0
- data/docs/TeamCreateRequest.md +10 -0
- data/docs/TeamGetInfoResponse.md +11 -0
- data/docs/TeamGetResponse.md +11 -0
- data/docs/TeamInfoResponse.md +14 -0
- data/docs/TeamInviteResponse.md +15 -0
- data/docs/TeamInvitesResponse.md +11 -0
- data/docs/TeamMemberResponse.md +12 -0
- data/docs/TeamMembersResponse.md +12 -0
- data/docs/TeamParentResponse.md +11 -0
- data/docs/TeamRemoveMemberRequest.md +14 -0
- data/docs/TeamResponse.md +12 -0
- data/docs/TeamSubTeamsResponse.md +12 -0
- data/docs/TeamUpdateRequest.md +10 -0
- data/docs/TemplateAddUserRequest.md +12 -0
- data/docs/TemplateApi.md +782 -0
- data/docs/TemplateCreateEmbeddedDraftRequest.md +34 -0
- data/docs/TemplateCreateEmbeddedDraftResponse.md +11 -0
- data/docs/TemplateCreateEmbeddedDraftResponseTemplate.md +13 -0
- data/docs/TemplateEditResponse.md +10 -0
- data/docs/TemplateGetResponse.md +11 -0
- data/docs/TemplateListResponse.md +12 -0
- data/docs/TemplateRemoveUserRequest.md +11 -0
- data/docs/TemplateResponse.md +24 -0
- data/docs/TemplateResponseAccount.md +15 -0
- data/docs/TemplateResponseAccountQuota.md +13 -0
- data/docs/TemplateResponseCCRole.md +10 -0
- data/docs/TemplateResponseCustomField.md +22 -0
- data/docs/TemplateResponseDocument.md +15 -0
- data/docs/TemplateResponseDocumentCustomField.md +25 -0
- data/docs/TemplateResponseDocumentFieldGroup.md +11 -0
- data/docs/TemplateResponseDocumentFormField.md +23 -0
- data/docs/TemplateResponseDocumentStaticField.md +19 -0
- data/docs/TemplateResponseFieldAvgTextLength.md +11 -0
- data/docs/TemplateResponseNamedFormField.md +23 -0
- data/docs/TemplateResponseSignerRole.md +11 -0
- data/docs/TemplateUpdateFilesRequest.md +15 -0
- data/docs/TemplateUpdateFilesResponse.md +10 -0
- data/docs/TemplateUpdateFilesResponseTemplate.md +11 -0
- data/docs/UnclaimedDraftApi.md +359 -0
- data/docs/UnclaimedDraftCreateEmbeddedRequest.md +45 -0
- data/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md +38 -0
- data/docs/UnclaimedDraftCreateRequest.md +33 -0
- data/docs/UnclaimedDraftCreateResponse.md +11 -0
- data/docs/UnclaimedDraftEditAndResendRequest.md +17 -0
- data/docs/UnclaimedDraftResponse.md +15 -0
- data/docs/WarningResponse.md +11 -0
- data/dropbox-sign.gemspec +38 -0
- data/examples/AccountCreate.rb +21 -0
- data/examples/AccountGet.rb +18 -0
- data/examples/AccountUpdate.rb +21 -0
- data/examples/AccountVerify.rb +21 -0
- data/examples/ApiAppCreate.rb +35 -0
- data/examples/ApiAppDelete.rb +20 -0
- data/examples/ApiAppGet.rb +20 -0
- data/examples/ApiAppList.rb +21 -0
- data/examples/ApiAppUpdate.rb +32 -0
- data/examples/BulkSendJobGet.rb +20 -0
- data/examples/BulkSendJobList.rb +21 -0
- data/examples/EmbeddedEditUrl.rb +24 -0
- data/examples/EmbeddedSignUrl.rb +20 -0
- data/examples/EventCallback.rb +32 -0
- data/examples/OauthTokenGenerate.rb +24 -0
- data/examples/OauthTokenRefresh.rb +21 -0
- data/examples/ReportCreate.rb +23 -0
- data/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.rb +59 -0
- data/examples/SignatureRequestBulkSendWithTemplate.rb +58 -0
- data/examples/SignatureRequestCancel.rb +20 -0
- data/examples/SignatureRequestCreateEmbedded.rb +46 -0
- data/examples/SignatureRequestCreateEmbeddedWithTemplate.rb +39 -0
- data/examples/SignatureRequestFiles.rb +20 -0
- data/examples/SignatureRequestFilesAsDataUri.rb +20 -0
- data/examples/SignatureRequestFilesAsFileUrl.rb +20 -0
- data/examples/SignatureRequestGet.rb +20 -0
- data/examples/SignatureRequestList.rb +21 -0
- data/examples/SignatureRequestReleaseHold.rb +20 -0
- data/examples/SignatureRequestRemind.rb +23 -0
- data/examples/SignatureRequestRemove.rb +20 -0
- data/examples/SignatureRequestSend.rb +56 -0
- data/examples/SignatureRequestSendWithTemplate.rb +50 -0
- data/examples/SignatureRequestUpdate.rb +24 -0
- data/examples/TeamAddMember.rb +21 -0
- data/examples/TeamCreate.rb +21 -0
- data/examples/TeamDelete.rb +18 -0
- data/examples/TeamGet.rb +18 -0
- data/examples/TeamInfo.rb +18 -0
- data/examples/TeamInvites.rb +20 -0
- data/examples/TeamMembers.rb +20 -0
- data/examples/TeamRemoveMember.rb +22 -0
- data/examples/TeamSubTeams.rb +20 -0
- data/examples/TeamUpdate.rb +21 -0
- data/examples/TemplateAddUser.rb +23 -0
- data/examples/TemplateCreateEmbeddedDraft.rb +49 -0
- data/examples/TemplateDelete.rb +20 -0
- data/examples/TemplateFiles.rb +20 -0
- data/examples/TemplateFilesAsDataUri.rb +20 -0
- data/examples/TemplateFilesAsFileUrl.rb +20 -0
- data/examples/TemplateGet.rb +20 -0
- data/examples/TemplateList.rb +20 -0
- data/examples/TemplateRemoveUser.rb +23 -0
- data/examples/TemplateUpdateFiles.rb +23 -0
- data/examples/UnclaimedDraftCreate.rb +56 -0
- data/examples/UnclaimedDraftCreateEmbedded.rb +24 -0
- data/examples/UnclaimedDraftCreateEmbeddedWithTemplate.rb +35 -0
- data/examples/UnclaimedDraftEditAndResend.rb +24 -0
- data/lib/dropbox-sign/api/account_api.rb +446 -0
- data/lib/dropbox-sign/api/api_app_api.rb +504 -0
- data/lib/dropbox-sign/api/bulk_send_job_api.rb +213 -0
- data/lib/dropbox-sign/api/embedded_api.rb +234 -0
- data/lib/dropbox-sign/api/o_auth_api.rb +215 -0
- data/lib/dropbox-sign/api/report_api.rb +134 -0
- data/lib/dropbox-sign/api/signature_request_api.rb +1620 -0
- data/lib/dropbox-sign/api/team_api.rb +1011 -0
- data/lib/dropbox-sign/api/template_api.rb +1037 -0
- data/lib/dropbox-sign/api/unclaimed_draft_api.rb +467 -0
- data/lib/dropbox-sign/api_client.rb +417 -0
- data/lib/dropbox-sign/api_error.rb +60 -0
- data/lib/dropbox-sign/configuration.rb +303 -0
- data/lib/dropbox-sign/event_callback_helper.rb +54 -0
- data/lib/dropbox-sign/models/account_create_request.rb +285 -0
- data/lib/dropbox-sign/models/account_create_response.rb +270 -0
- data/lib/dropbox-sign/models/account_get_response.rb +261 -0
- data/lib/dropbox-sign/models/account_response.rb +343 -0
- data/lib/dropbox-sign/models/account_response_quotas.rb +296 -0
- data/lib/dropbox-sign/models/account_update_request.rb +271 -0
- data/lib/dropbox-sign/models/account_verify_request.rb +255 -0
- data/lib/dropbox-sign/models/account_verify_response.rb +261 -0
- data/lib/dropbox-sign/models/account_verify_response_account.rb +250 -0
- data/lib/dropbox-sign/models/api_app_create_request.rb +347 -0
- data/lib/dropbox-sign/models/api_app_get_response.rb +261 -0
- data/lib/dropbox-sign/models/api_app_list_response.rb +273 -0
- data/lib/dropbox-sign/models/api_app_response.rb +343 -0
- data/lib/dropbox-sign/models/api_app_response_o_auth.rb +283 -0
- data/lib/dropbox-sign/models/api_app_response_options.rb +251 -0
- data/lib/dropbox-sign/models/api_app_response_owner_account.rb +261 -0
- data/lib/dropbox-sign/models/api_app_response_white_labeling_options.rb +367 -0
- data/lib/dropbox-sign/models/api_app_update_request.rb +324 -0
- data/lib/dropbox-sign/models/bulk_send_job_get_response.rb +282 -0
- data/lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb +503 -0
- data/lib/dropbox-sign/models/bulk_send_job_list_response.rb +273 -0
- data/lib/dropbox-sign/models/bulk_send_job_response.rb +282 -0
- data/lib/dropbox-sign/models/bulk_send_job_send_response.rb +261 -0
- data/lib/dropbox-sign/models/embedded_edit_url_request.rb +357 -0
- data/lib/dropbox-sign/models/embedded_edit_url_response.rb +261 -0
- data/lib/dropbox-sign/models/embedded_edit_url_response_embedded.rb +261 -0
- data/lib/dropbox-sign/models/embedded_sign_url_response.rb +261 -0
- data/lib/dropbox-sign/models/embedded_sign_url_response_embedded.rb +261 -0
- data/lib/dropbox-sign/models/error_response.rb +254 -0
- data/lib/dropbox-sign/models/error_response_error.rb +281 -0
- data/lib/dropbox-sign/models/event_callback_request.rb +281 -0
- data/lib/dropbox-sign/models/event_callback_request_event.rb +334 -0
- data/lib/dropbox-sign/models/event_callback_request_event_metadata.rb +285 -0
- data/lib/dropbox-sign/models/file_response.rb +260 -0
- data/lib/dropbox-sign/models/file_response_data_uri.rb +250 -0
- data/lib/dropbox-sign/models/list_info_response.rb +282 -0
- data/lib/dropbox-sign/models/o_auth_token_generate_request.rb +317 -0
- data/lib/dropbox-sign/models/o_auth_token_refresh_request.rb +272 -0
- data/lib/dropbox-sign/models/o_auth_token_response.rb +287 -0
- data/lib/dropbox-sign/models/report_create_request.rb +319 -0
- data/lib/dropbox-sign/models/report_create_response.rb +261 -0
- data/lib/dropbox-sign/models/report_response.rb +305 -0
- data/lib/dropbox-sign/models/signature_request_bulk_create_embedded_with_template_request.rb +445 -0
- data/lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb +440 -0
- data/lib/dropbox-sign/models/signature_request_create_embedded_request.rb +569 -0
- data/lib/dropbox-sign/models/signature_request_create_embedded_with_template_request.rb +475 -0
- data/lib/dropbox-sign/models/signature_request_get_response.rb +261 -0
- data/lib/dropbox-sign/models/signature_request_list_response.rb +273 -0
- data/lib/dropbox-sign/models/signature_request_remind_request.rb +265 -0
- data/lib/dropbox-sign/models/signature_request_response.rb +494 -0
- data/lib/dropbox-sign/models/signature_request_response_attachment.rb +323 -0
- data/lib/dropbox-sign/models/signature_request_response_custom_field_base.rb +316 -0
- data/lib/dropbox-sign/models/signature_request_response_custom_field_checkbox.rb +272 -0
- data/lib/dropbox-sign/models/signature_request_response_custom_field_text.rb +272 -0
- data/lib/dropbox-sign/models/signature_request_response_custom_field_type_enum.rb +40 -0
- data/lib/dropbox-sign/models/signature_request_response_data_base.rb +326 -0
- data/lib/dropbox-sign/models/signature_request_response_data_type_enum.rb +47 -0
- data/lib/dropbox-sign/models/signature_request_response_data_value_checkbox.rb +266 -0
- data/lib/dropbox-sign/models/signature_request_response_data_value_checkbox_merge.rb +266 -0
- data/lib/dropbox-sign/models/signature_request_response_data_value_date_signed.rb +266 -0
- data/lib/dropbox-sign/models/signature_request_response_data_value_dropdown.rb +266 -0
- data/lib/dropbox-sign/models/signature_request_response_data_value_initials.rb +266 -0
- data/lib/dropbox-sign/models/signature_request_response_data_value_radio.rb +266 -0
- data/lib/dropbox-sign/models/signature_request_response_data_value_signature.rb +266 -0
- data/lib/dropbox-sign/models/signature_request_response_data_value_text.rb +266 -0
- data/lib/dropbox-sign/models/signature_request_response_data_value_text_merge.rb +266 -0
- data/lib/dropbox-sign/models/signature_request_response_signatures.rb +446 -0
- data/lib/dropbox-sign/models/signature_request_send_request.rb +574 -0
- data/lib/dropbox-sign/models/signature_request_send_with_template_request.rb +480 -0
- data/lib/dropbox-sign/models/signature_request_update_request.rb +286 -0
- data/lib/dropbox-sign/models/sub_attachment.rb +292 -0
- data/lib/dropbox-sign/models/sub_bulk_signer_list.rb +264 -0
- data/lib/dropbox-sign/models/sub_bulk_signer_list_custom_field.rb +270 -0
- data/lib/dropbox-sign/models/sub_cc.rb +270 -0
- data/lib/dropbox-sign/models/sub_custom_field.rb +288 -0
- data/lib/dropbox-sign/models/sub_editor_options.rb +265 -0
- data/lib/dropbox-sign/models/sub_field_options.rb +290 -0
- data/lib/dropbox-sign/models/sub_form_field_group.rb +285 -0
- data/lib/dropbox-sign/models/sub_form_field_rule.rb +353 -0
- data/lib/dropbox-sign/models/sub_form_field_rule_action.rb +323 -0
- data/lib/dropbox-sign/models/sub_form_field_rule_trigger.rb +326 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_base.rb +435 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_checkbox.rb +287 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_checkbox_merge.rb +262 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_date_signed.rb +262 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_dropdown.rb +308 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb +292 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_initials.rb +262 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_radio.rb +292 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_signature.rb +262 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_text.rb +364 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_text_merge.rb +262 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_type_enum.rb +48 -0
- data/lib/dropbox-sign/models/sub_merge_field.rb +304 -0
- data/lib/dropbox-sign/models/sub_o_auth.rb +285 -0
- data/lib/dropbox-sign/models/sub_options.rb +253 -0
- data/lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb +283 -0
- data/lib/dropbox-sign/models/sub_signature_request_signer.rb +369 -0
- data/lib/dropbox-sign/models/sub_signature_request_template_signer.rb +373 -0
- data/lib/dropbox-sign/models/sub_signing_options.rb +338 -0
- data/lib/dropbox-sign/models/sub_team_response.rb +260 -0
- data/lib/dropbox-sign/models/sub_template_role.rb +261 -0
- data/lib/dropbox-sign/models/sub_unclaimed_draft_signer.rb +281 -0
- data/lib/dropbox-sign/models/sub_unclaimed_draft_template_signer.rb +285 -0
- data/lib/dropbox-sign/models/sub_white_labeling_options.rb +439 -0
- data/lib/dropbox-sign/models/team_add_member_request.rb +304 -0
- data/lib/dropbox-sign/models/team_create_request.rb +252 -0
- data/lib/dropbox-sign/models/team_get_info_response.rb +261 -0
- data/lib/dropbox-sign/models/team_get_response.rb +261 -0
- data/lib/dropbox-sign/models/team_info_response.rb +290 -0
- data/lib/dropbox-sign/models/team_invite_response.rb +300 -0
- data/lib/dropbox-sign/models/team_invites_response.rb +263 -0
- data/lib/dropbox-sign/models/team_member_response.rb +270 -0
- data/lib/dropbox-sign/models/team_members_response.rb +272 -0
- data/lib/dropbox-sign/models/team_parent_response.rb +261 -0
- data/lib/dropbox-sign/models/team_remove_member_request.rb +324 -0
- data/lib/dropbox-sign/models/team_response.rb +274 -0
- data/lib/dropbox-sign/models/team_sub_teams_response.rb +272 -0
- data/lib/dropbox-sign/models/team_update_request.rb +250 -0
- data/lib/dropbox-sign/models/template_add_user_request.rb +272 -0
- data/lib/dropbox-sign/models/template_create_embedded_draft_request.rb +567 -0
- data/lib/dropbox-sign/models/template_create_embedded_draft_response.rb +261 -0
- data/lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb +283 -0
- data/lib/dropbox-sign/models/template_edit_response.rb +250 -0
- data/lib/dropbox-sign/models/template_get_response.rb +261 -0
- data/lib/dropbox-sign/models/template_list_response.rb +273 -0
- data/lib/dropbox-sign/models/template_remove_user_request.rb +260 -0
- data/lib/dropbox-sign/models/template_response.rb +410 -0
- data/lib/dropbox-sign/models/template_response_account.rb +299 -0
- data/lib/dropbox-sign/models/template_response_account_quota.rb +281 -0
- data/lib/dropbox-sign/models/template_response_cc_role.rb +250 -0
- data/lib/dropbox-sign/models/template_response_custom_field.rb +407 -0
- data/lib/dropbox-sign/models/template_response_document.rb +309 -0
- data/lib/dropbox-sign/models/template_response_document_custom_field.rb +438 -0
- data/lib/dropbox-sign/models/template_response_document_field_group.rb +260 -0
- data/lib/dropbox-sign/models/template_response_document_form_field.rb +417 -0
- data/lib/dropbox-sign/models/template_response_document_static_field.rb +341 -0
- data/lib/dropbox-sign/models/template_response_field_avg_text_length.rb +261 -0
- data/lib/dropbox-sign/models/template_response_named_form_field.rb +383 -0
- data/lib/dropbox-sign/models/template_response_signer_role.rb +260 -0
- data/lib/dropbox-sign/models/template_update_files_request.rb +336 -0
- data/lib/dropbox-sign/models/template_update_files_response.rb +249 -0
- data/lib/dropbox-sign/models/template_update_files_response_template.rb +263 -0
- data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb +728 -0
- data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb +631 -0
- data/lib/dropbox-sign/models/unclaimed_draft_create_request.rb +586 -0
- data/lib/dropbox-sign/models/unclaimed_draft_create_response.rb +261 -0
- data/lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb +328 -0
- data/lib/dropbox-sign/models/unclaimed_draft_response.rb +305 -0
- data/lib/dropbox-sign/models/warning_response.rb +271 -0
- data/lib/dropbox-sign/version.rb +18 -0
- data/lib/dropbox-sign.rb +204 -0
- data/openapi-config.yaml +21 -0
- data/openapi-sdk.yaml +11080 -0
- data/run-build +53 -0
- data/spec/api/account_api_spec.rb +107 -0
- data/spec/api/api_app_api_spec.rb +95 -0
- data/spec/api/bulk_send_job_api_spec.rb +52 -0
- data/spec/api/embedded_api_spec.rb +55 -0
- data/spec/api/oauth_api_spec.rb +55 -0
- data/spec/api/report_api_spec.rb +38 -0
- data/spec/api/signature_request_api_spec.rb +263 -0
- data/spec/api/team_api_spec.rb +105 -0
- data/spec/api/template_api_spec.rb +147 -0
- data/spec/api/unclaimed_draft_api_spec.rb +95 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/event_callback_helper_spec.rb +22 -0
- data/spec/fixtures_spec.rb +59 -0
- data/spec/models/sub_form_fields_per_document_base_spec.rb +24 -0
- data/spec/spec_helper.rb +111 -0
- data/spec/test_utils.rb +19 -0
- data/templates/Gemfile.mustache +10 -0
- data/templates/README.mustache +133 -0
- data/templates/Rakefile.mustache +10 -0
- data/templates/api.mustache +283 -0
- data/templates/api_client.mustache +291 -0
- data/templates/api_client_faraday_partial.mustache +136 -0
- data/templates/api_client_spec.mustache +220 -0
- data/templates/api_client_typhoeus_partial.mustache +153 -0
- data/templates/api_doc.mustache +77 -0
- data/templates/api_error.mustache +52 -0
- data/templates/api_info.mustache +12 -0
- data/templates/api_test.mustache +47 -0
- data/templates/base_object.mustache +132 -0
- data/templates/configuration.mustache +372 -0
- data/templates/configuration_spec.mustache +34 -0
- data/templates/configuration_tls_faraday_partial.mustache +29 -0
- data/templates/configuration_tls_typhoeus_partial.mustache +34 -0
- data/templates/event_callback_helper.mustache +46 -0
- data/templates/gem.mustache +55 -0
- data/templates/gemspec.mustache +35 -0
- data/templates/git_push.sh.mustache +57 -0
- data/templates/gitignore.mustache +41 -0
- data/templates/model.mustache +29 -0
- data/templates/model_doc.mustache +12 -0
- data/templates/model_test.mustache +77 -0
- data/templates/partial_model_enum_class.mustache +20 -0
- data/templates/partial_model_generic.mustache +414 -0
- data/templates/partial_model_generic_doc.mustache +10 -0
- data/templates/partial_oneof_module.mustache +137 -0
- data/templates/partial_oneof_module_doc.mustache +92 -0
- data/templates/rspec.mustache +2 -0
- data/templates/rubocop.mustache +148 -0
- data/templates/spec_helper.mustache +103 -0
- data/templates/travis.mustache +14 -0
- data/templates/version.mustache +10 -0
- data/test_fixtures/AccountCreateRequest.json +7 -0
- data/test_fixtures/AccountCreateResponse.json +15 -0
- data/test_fixtures/AccountGetResponse.json +14 -0
- data/test_fixtures/AccountUpdateRequest.json +5 -0
- data/test_fixtures/AccountVerifyRequest.json +5 -0
- data/test_fixtures/AccountVerifyResponse.json +7 -0
- data/test_fixtures/ApiAppCreateRequest.json +35 -0
- data/test_fixtures/ApiAppGetResponse.json +27 -0
- data/test_fixtures/ApiAppListResponse.json +42 -0
- data/test_fixtures/ApiAppUpdateRequest.json +35 -0
- data/test_fixtures/BulkSendJobGetResponse.json +67 -0
- data/test_fixtures/BulkSendJobListResponse.json +24 -0
- data/test_fixtures/BulkSendJobSendResponse.json +10 -0
- data/test_fixtures/EmbeddedEditUrlRequest.json +28 -0
- data/test_fixtures/EmbeddedEditUrlResponse.json +8 -0
- data/test_fixtures/EmbeddedSignUrlResponse.json +8 -0
- data/test_fixtures/ErrorResponse.json +9 -0
- data/test_fixtures/EventCallbackHelper.json +50 -0
- data/test_fixtures/FileResponse.json +6 -0
- data/test_fixtures/OAuthTokenGenerateRequest.json +9 -0
- data/test_fixtures/OAuthTokenRefreshRequest.json +6 -0
- data/test_fixtures/OAuthTokenResponse.json +15 -0
- data/test_fixtures/ReportCreateRequest.json +10 -0
- data/test_fixtures/ReportCreateResponse.json +13 -0
- data/test_fixtures/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.json +67 -0
- data/test_fixtures/SignatureRequestBulkSendWithTemplateRequest.json +66 -0
- data/test_fixtures/SignatureRequestCreateEmbeddedRequest.json +252 -0
- data/test_fixtures/SignatureRequestCreateEmbeddedWithTemplateRequest.json +60 -0
- data/test_fixtures/SignatureRequestGetResponse.json +146 -0
- data/test_fixtures/SignatureRequestListResponse.json +102 -0
- data/test_fixtures/SignatureRequestRemindRequest.json +5 -0
- data/test_fixtures/SignatureRequestSendRequest.json +463 -0
- data/test_fixtures/SignatureRequestSendWithTemplateRequest.json +48 -0
- data/test_fixtures/SignatureRequestUpdateRequest.json +7 -0
- data/test_fixtures/SubFormFieldsPerDocument.json +107 -0
- data/test_fixtures/TeamAddMemberRequest.json +6 -0
- data/test_fixtures/TeamCreateRequest.json +5 -0
- data/test_fixtures/TeamGetResponse.json +34 -0
- data/test_fixtures/TeamRemoveMemberRequest.json +7 -0
- data/test_fixtures/TeamUpdateRequest.json +5 -0
- data/test_fixtures/TemplateAddUserRequest.json +7 -0
- data/test_fixtures/TemplateCreateEmbeddedDraftRequest.json +118 -0
- data/test_fixtures/TemplateCreateEmbeddedDraftResponse.json +9 -0
- data/test_fixtures/TemplateGetResponse.json +102 -0
- data/test_fixtures/TemplateListResponse.json +143 -0
- data/test_fixtures/TemplateRemoveUserRequest.json +6 -0
- data/test_fixtures/TemplateUpdateFilesRequest.json +11 -0
- data/test_fixtures/TemplateUpdateFilesResponse.json +7 -0
- data/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json +134 -0
- data/test_fixtures/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json +67 -0
- data/test_fixtures/UnclaimedDraftCreateRequest.json +119 -0
- data/test_fixtures/UnclaimedDraftCreateResponse.json +9 -0
- data/test_fixtures/UnclaimedDraftEditAndResendRequest.json +15 -0
- data/test_fixtures/bulk-send-sample.csv +3 -0
- data/test_fixtures/pdf-sample-2.pdf +0 -0
- data/test_fixtures/pdf-sample.pdf +0 -0
- data/vendor/autoload.php +7 -0
- data/vendor/bin/yaml-lint +117 -0
- data/vendor/composer/ClassLoader.php +572 -0
- data/vendor/composer/InstalledVersions.php +350 -0
- data/vendor/composer/LICENSE +21 -0
- data/vendor/composer/autoload_classmap.php +10 -0
- data/vendor/composer/autoload_files.php +11 -0
- data/vendor/composer/autoload_namespaces.php +9 -0
- data/vendor/composer/autoload_psr4.php +11 -0
- data/vendor/composer/autoload_real.php +80 -0
- data/vendor/composer/autoload_static.php +46 -0
- data/vendor/composer/installed.json +239 -0
- data/vendor/composer/installed.php +50 -0
- data/vendor/composer/platform_check.php +26 -0
- data/vendor/symfony/deprecation-contracts/.gitignore +3 -0
- data/vendor/symfony/deprecation-contracts/CHANGELOG.md +5 -0
- data/vendor/symfony/deprecation-contracts/LICENSE +19 -0
- data/vendor/symfony/deprecation-contracts/README.md +26 -0
- data/vendor/symfony/deprecation-contracts/composer.json +35 -0
- data/vendor/symfony/deprecation-contracts/function.php +27 -0
- data/vendor/symfony/polyfill-ctype/Ctype.php +232 -0
- data/vendor/symfony/polyfill-ctype/LICENSE +19 -0
- data/vendor/symfony/polyfill-ctype/README.md +12 -0
- data/vendor/symfony/polyfill-ctype/bootstrap.php +50 -0
- data/vendor/symfony/polyfill-ctype/bootstrap80.php +46 -0
- data/vendor/symfony/polyfill-ctype/composer.json +41 -0
- data/vendor/symfony/yaml/CHANGELOG.md +237 -0
- data/vendor/symfony/yaml/Command/LintCommand.php +289 -0
- data/vendor/symfony/yaml/Dumper.php +140 -0
- data/vendor/symfony/yaml/Escaper.php +95 -0
- data/vendor/symfony/yaml/Exception/DumpException.php +21 -0
- data/vendor/symfony/yaml/Exception/ExceptionInterface.php +21 -0
- data/vendor/symfony/yaml/Exception/ParseException.php +132 -0
- data/vendor/symfony/yaml/Exception/RuntimeException.php +21 -0
- data/vendor/symfony/yaml/Inline.php +812 -0
- data/vendor/symfony/yaml/LICENSE +19 -0
- data/vendor/symfony/yaml/Parser.php +1305 -0
- data/vendor/symfony/yaml/README.md +13 -0
- data/vendor/symfony/yaml/Resources/bin/yaml-lint +45 -0
- data/vendor/symfony/yaml/Tag/TaggedValue.php +38 -0
- data/vendor/symfony/yaml/Unescaper.php +132 -0
- data/vendor/symfony/yaml/Yaml.php +100 -0
- data/vendor/symfony/yaml/composer.json +42 -0
- metadata +650 -0
@@ -0,0 +1,1011 @@
|
|
1
|
+
=begin
|
2
|
+
#Dropbox Sign API
|
3
|
+
|
4
|
+
#Dropbox Sign v3 API
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 3.0.0
|
7
|
+
Contact: apisupport@hellosign.com
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 5.3.0
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'cgi'
|
14
|
+
|
15
|
+
module Dropbox
|
16
|
+
end
|
17
|
+
|
18
|
+
module Dropbox::Sign
|
19
|
+
class TeamApi
|
20
|
+
attr_accessor :api_client
|
21
|
+
|
22
|
+
def initialize(api_client = ApiClient.default)
|
23
|
+
@api_client = api_client
|
24
|
+
end
|
25
|
+
# Add User to Team
|
26
|
+
# Invites a user (specified using the `email_address` parameter) to your Team. If the user does not currently have a Dropbox Sign Account, a new one will be created for them. If a user is already a part of another Team, a `team_invite_failed` error will be returned.
|
27
|
+
# @param team_add_member_request [TeamAddMemberRequest]
|
28
|
+
# @param [Hash] opts the optional parameters
|
29
|
+
# @option opts [String] :team_id The id of the team.
|
30
|
+
# @return [TeamGetResponse]
|
31
|
+
def team_add_member(team_add_member_request, opts = {})
|
32
|
+
data, _status_code, _headers = team_add_member_with_http_info(team_add_member_request, opts)
|
33
|
+
data
|
34
|
+
end
|
35
|
+
|
36
|
+
# Add User to Team
|
37
|
+
# Invites a user (specified using the `email_address` parameter) to your Team. If the user does not currently have a Dropbox Sign Account, a new one will be created for them. If a user is already a part of another Team, a `team_invite_failed` error will be returned.
|
38
|
+
# @param team_add_member_request [TeamAddMemberRequest]
|
39
|
+
# @param [Hash] opts the optional parameters
|
40
|
+
# @option opts [String] :team_id The id of the team.
|
41
|
+
# @return [Array<(TeamGetResponse, Integer, Hash)>] TeamGetResponse data, response status code and response headers
|
42
|
+
def team_add_member_with_http_info(team_add_member_request, opts = {})
|
43
|
+
if @api_client.config.debugging
|
44
|
+
@api_client.config.logger.debug 'Calling API: TeamApi.team_add_member ...'
|
45
|
+
end
|
46
|
+
# verify the required parameter 'team_add_member_request' is set
|
47
|
+
if @api_client.config.client_side_validation && team_add_member_request.nil?
|
48
|
+
fail ArgumentError, "Missing the required parameter 'team_add_member_request' when calling TeamApi.team_add_member"
|
49
|
+
end
|
50
|
+
# resource path
|
51
|
+
local_var_path = '/team/add_member'
|
52
|
+
|
53
|
+
# query parameters
|
54
|
+
query_params = opts[:query_params] || {}
|
55
|
+
query_params[:'team_id'] = opts[:'team_id'] if !opts[:'team_id'].nil?
|
56
|
+
|
57
|
+
# header parameters
|
58
|
+
header_params = opts[:header_params] || {}
|
59
|
+
# HTTP header 'Accept' (if needed)
|
60
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
61
|
+
# HTTP header 'Content-Type'
|
62
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
63
|
+
if !content_type.nil?
|
64
|
+
header_params['Content-Type'] = content_type
|
65
|
+
end
|
66
|
+
|
67
|
+
post_body = {}
|
68
|
+
form_params = opts[:form_params] || {}
|
69
|
+
result = @api_client.generate_form_data(
|
70
|
+
team_add_member_request,
|
71
|
+
Dropbox::Sign::TeamAddMemberRequest.openapi_types
|
72
|
+
)
|
73
|
+
|
74
|
+
# form parameters
|
75
|
+
if result[:has_file]
|
76
|
+
form_params = opts[:form_params] || result[:params]
|
77
|
+
header_params['Content-Type'] = 'multipart/form-data'
|
78
|
+
else
|
79
|
+
# http body (model)
|
80
|
+
post_body = opts[:debug_body] || result[:params]
|
81
|
+
end
|
82
|
+
|
83
|
+
# return_type
|
84
|
+
return_type = opts[:debug_return_type] || 'TeamGetResponse'
|
85
|
+
|
86
|
+
# auth_names
|
87
|
+
auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
|
88
|
+
|
89
|
+
new_options = opts.merge(
|
90
|
+
:operation => :"TeamApi.team_add_member",
|
91
|
+
:header_params => header_params,
|
92
|
+
:query_params => query_params,
|
93
|
+
:form_params => form_params,
|
94
|
+
:body => post_body,
|
95
|
+
:auth_names => auth_names,
|
96
|
+
:return_type => return_type
|
97
|
+
)
|
98
|
+
|
99
|
+
begin
|
100
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
101
|
+
rescue Dropbox::Sign::ApiError => e
|
102
|
+
if e.code === 200
|
103
|
+
body = @api_client.convert_to_type(
|
104
|
+
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
105
|
+
"Dropbox::Sign::TeamGetResponse"
|
106
|
+
)
|
107
|
+
|
108
|
+
fail ApiError.new(:code => e.code,
|
109
|
+
:response_headers => e.response_headers,
|
110
|
+
:response_body => body),
|
111
|
+
e.message
|
112
|
+
end
|
113
|
+
|
114
|
+
range_code = "4XX".split('').first
|
115
|
+
range_code_left = "#{range_code}00".to_i
|
116
|
+
range_code_right = "#{range_code}99".to_i
|
117
|
+
if e.code >= range_code_left && e.code <= range_code_right
|
118
|
+
body = @api_client.convert_to_type(
|
119
|
+
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
120
|
+
"Dropbox::Sign::ErrorResponse"
|
121
|
+
)
|
122
|
+
|
123
|
+
fail ApiError.new(:code => e.code,
|
124
|
+
:response_headers => e.response_headers,
|
125
|
+
:response_body => body),
|
126
|
+
e.message
|
127
|
+
end
|
128
|
+
|
129
|
+
end
|
130
|
+
|
131
|
+
if @api_client.config.debugging
|
132
|
+
@api_client.config.logger.debug "API called: TeamApi#team_add_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
133
|
+
end
|
134
|
+
return data, status_code, headers
|
135
|
+
end
|
136
|
+
|
137
|
+
# Create Team
|
138
|
+
# Creates a new Team and makes you a member. You must not currently belong to a Team to invoke.
|
139
|
+
# @param team_create_request [TeamCreateRequest]
|
140
|
+
# @param [Hash] opts the optional parameters
|
141
|
+
# @return [TeamGetResponse]
|
142
|
+
def team_create(team_create_request, opts = {})
|
143
|
+
data, _status_code, _headers = team_create_with_http_info(team_create_request, opts)
|
144
|
+
data
|
145
|
+
end
|
146
|
+
|
147
|
+
# Create Team
|
148
|
+
# Creates a new Team and makes you a member. You must not currently belong to a Team to invoke.
|
149
|
+
# @param team_create_request [TeamCreateRequest]
|
150
|
+
# @param [Hash] opts the optional parameters
|
151
|
+
# @return [Array<(TeamGetResponse, Integer, Hash)>] TeamGetResponse data, response status code and response headers
|
152
|
+
def team_create_with_http_info(team_create_request, opts = {})
|
153
|
+
if @api_client.config.debugging
|
154
|
+
@api_client.config.logger.debug 'Calling API: TeamApi.team_create ...'
|
155
|
+
end
|
156
|
+
# verify the required parameter 'team_create_request' is set
|
157
|
+
if @api_client.config.client_side_validation && team_create_request.nil?
|
158
|
+
fail ArgumentError, "Missing the required parameter 'team_create_request' when calling TeamApi.team_create"
|
159
|
+
end
|
160
|
+
# resource path
|
161
|
+
local_var_path = '/team/create'
|
162
|
+
|
163
|
+
# query parameters
|
164
|
+
query_params = opts[:query_params] || {}
|
165
|
+
|
166
|
+
# header parameters
|
167
|
+
header_params = opts[:header_params] || {}
|
168
|
+
# HTTP header 'Accept' (if needed)
|
169
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
170
|
+
# HTTP header 'Content-Type'
|
171
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
172
|
+
if !content_type.nil?
|
173
|
+
header_params['Content-Type'] = content_type
|
174
|
+
end
|
175
|
+
|
176
|
+
post_body = {}
|
177
|
+
form_params = opts[:form_params] || {}
|
178
|
+
result = @api_client.generate_form_data(
|
179
|
+
team_create_request,
|
180
|
+
Dropbox::Sign::TeamCreateRequest.openapi_types
|
181
|
+
)
|
182
|
+
|
183
|
+
# form parameters
|
184
|
+
if result[:has_file]
|
185
|
+
form_params = opts[:form_params] || result[:params]
|
186
|
+
header_params['Content-Type'] = 'multipart/form-data'
|
187
|
+
else
|
188
|
+
# http body (model)
|
189
|
+
post_body = opts[:debug_body] || result[:params]
|
190
|
+
end
|
191
|
+
|
192
|
+
# return_type
|
193
|
+
return_type = opts[:debug_return_type] || 'TeamGetResponse'
|
194
|
+
|
195
|
+
# auth_names
|
196
|
+
auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
|
197
|
+
|
198
|
+
new_options = opts.merge(
|
199
|
+
:operation => :"TeamApi.team_create",
|
200
|
+
:header_params => header_params,
|
201
|
+
:query_params => query_params,
|
202
|
+
:form_params => form_params,
|
203
|
+
:body => post_body,
|
204
|
+
:auth_names => auth_names,
|
205
|
+
:return_type => return_type
|
206
|
+
)
|
207
|
+
|
208
|
+
begin
|
209
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
210
|
+
rescue Dropbox::Sign::ApiError => e
|
211
|
+
if e.code === 200
|
212
|
+
body = @api_client.convert_to_type(
|
213
|
+
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
214
|
+
"Dropbox::Sign::TeamGetResponse"
|
215
|
+
)
|
216
|
+
|
217
|
+
fail ApiError.new(:code => e.code,
|
218
|
+
:response_headers => e.response_headers,
|
219
|
+
:response_body => body),
|
220
|
+
e.message
|
221
|
+
end
|
222
|
+
|
223
|
+
range_code = "4XX".split('').first
|
224
|
+
range_code_left = "#{range_code}00".to_i
|
225
|
+
range_code_right = "#{range_code}99".to_i
|
226
|
+
if e.code >= range_code_left && e.code <= range_code_right
|
227
|
+
body = @api_client.convert_to_type(
|
228
|
+
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
229
|
+
"Dropbox::Sign::ErrorResponse"
|
230
|
+
)
|
231
|
+
|
232
|
+
fail ApiError.new(:code => e.code,
|
233
|
+
:response_headers => e.response_headers,
|
234
|
+
:response_body => body),
|
235
|
+
e.message
|
236
|
+
end
|
237
|
+
|
238
|
+
end
|
239
|
+
|
240
|
+
if @api_client.config.debugging
|
241
|
+
@api_client.config.logger.debug "API called: TeamApi#team_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
242
|
+
end
|
243
|
+
return data, status_code, headers
|
244
|
+
end
|
245
|
+
|
246
|
+
# Delete Team
|
247
|
+
# Deletes your Team. Can only be invoked when you have a Team with only one member (yourself).
|
248
|
+
# @param [Hash] opts the optional parameters
|
249
|
+
# @return [nil]
|
250
|
+
def team_delete(opts = {})
|
251
|
+
team_delete_with_http_info(opts)
|
252
|
+
nil
|
253
|
+
end
|
254
|
+
|
255
|
+
# Delete Team
|
256
|
+
# Deletes your Team. Can only be invoked when you have a Team with only one member (yourself).
|
257
|
+
# @param [Hash] opts the optional parameters
|
258
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
259
|
+
def team_delete_with_http_info(opts = {})
|
260
|
+
if @api_client.config.debugging
|
261
|
+
@api_client.config.logger.debug 'Calling API: TeamApi.team_delete ...'
|
262
|
+
end
|
263
|
+
# resource path
|
264
|
+
local_var_path = '/team/destroy'
|
265
|
+
|
266
|
+
# query parameters
|
267
|
+
query_params = opts[:query_params] || {}
|
268
|
+
|
269
|
+
# header parameters
|
270
|
+
header_params = opts[:header_params] || {}
|
271
|
+
# HTTP header 'Accept' (if needed)
|
272
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
273
|
+
|
274
|
+
post_body = {}
|
275
|
+
form_params = opts[:form_params] || {}
|
276
|
+
|
277
|
+
# http body (model)
|
278
|
+
post_body = opts[:debug_body]
|
279
|
+
|
280
|
+
# return_type
|
281
|
+
return_type = opts[:debug_return_type]
|
282
|
+
|
283
|
+
# auth_names
|
284
|
+
auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
|
285
|
+
|
286
|
+
new_options = opts.merge(
|
287
|
+
:operation => :"TeamApi.team_delete",
|
288
|
+
:header_params => header_params,
|
289
|
+
:query_params => query_params,
|
290
|
+
:form_params => form_params,
|
291
|
+
:body => post_body,
|
292
|
+
:auth_names => auth_names,
|
293
|
+
:return_type => return_type
|
294
|
+
)
|
295
|
+
|
296
|
+
begin
|
297
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
298
|
+
rescue Dropbox::Sign::ApiError => e
|
299
|
+
end
|
300
|
+
|
301
|
+
if @api_client.config.debugging
|
302
|
+
@api_client.config.logger.debug "API called: TeamApi#team_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
303
|
+
end
|
304
|
+
return data, status_code, headers
|
305
|
+
end
|
306
|
+
|
307
|
+
# Get Team
|
308
|
+
# Returns information about your Team as well as a list of its members. If you do not belong to a Team, a 404 error with an error_name of \"not_found\" will be returned.
|
309
|
+
# @param [Hash] opts the optional parameters
|
310
|
+
# @return [TeamGetResponse]
|
311
|
+
def team_get(opts = {})
|
312
|
+
data, _status_code, _headers = team_get_with_http_info(opts)
|
313
|
+
data
|
314
|
+
end
|
315
|
+
|
316
|
+
# Get Team
|
317
|
+
# Returns information about your Team as well as a list of its members. If you do not belong to a Team, a 404 error with an error_name of \"not_found\" will be returned.
|
318
|
+
# @param [Hash] opts the optional parameters
|
319
|
+
# @return [Array<(TeamGetResponse, Integer, Hash)>] TeamGetResponse data, response status code and response headers
|
320
|
+
def team_get_with_http_info(opts = {})
|
321
|
+
if @api_client.config.debugging
|
322
|
+
@api_client.config.logger.debug 'Calling API: TeamApi.team_get ...'
|
323
|
+
end
|
324
|
+
# resource path
|
325
|
+
local_var_path = '/team'
|
326
|
+
|
327
|
+
# query parameters
|
328
|
+
query_params = opts[:query_params] || {}
|
329
|
+
|
330
|
+
# header parameters
|
331
|
+
header_params = opts[:header_params] || {}
|
332
|
+
# HTTP header 'Accept' (if needed)
|
333
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
334
|
+
|
335
|
+
post_body = {}
|
336
|
+
form_params = opts[:form_params] || {}
|
337
|
+
|
338
|
+
# http body (model)
|
339
|
+
post_body = opts[:debug_body]
|
340
|
+
|
341
|
+
# return_type
|
342
|
+
return_type = opts[:debug_return_type] || 'TeamGetResponse'
|
343
|
+
|
344
|
+
# auth_names
|
345
|
+
auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
|
346
|
+
|
347
|
+
new_options = opts.merge(
|
348
|
+
:operation => :"TeamApi.team_get",
|
349
|
+
:header_params => header_params,
|
350
|
+
:query_params => query_params,
|
351
|
+
:form_params => form_params,
|
352
|
+
:body => post_body,
|
353
|
+
:auth_names => auth_names,
|
354
|
+
:return_type => return_type
|
355
|
+
)
|
356
|
+
|
357
|
+
begin
|
358
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
359
|
+
rescue Dropbox::Sign::ApiError => e
|
360
|
+
if e.code === 200
|
361
|
+
body = @api_client.convert_to_type(
|
362
|
+
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
363
|
+
"Dropbox::Sign::TeamGetResponse"
|
364
|
+
)
|
365
|
+
|
366
|
+
fail ApiError.new(:code => e.code,
|
367
|
+
:response_headers => e.response_headers,
|
368
|
+
:response_body => body),
|
369
|
+
e.message
|
370
|
+
end
|
371
|
+
|
372
|
+
range_code = "4XX".split('').first
|
373
|
+
range_code_left = "#{range_code}00".to_i
|
374
|
+
range_code_right = "#{range_code}99".to_i
|
375
|
+
if e.code >= range_code_left && e.code <= range_code_right
|
376
|
+
body = @api_client.convert_to_type(
|
377
|
+
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
378
|
+
"Dropbox::Sign::ErrorResponse"
|
379
|
+
)
|
380
|
+
|
381
|
+
fail ApiError.new(:code => e.code,
|
382
|
+
:response_headers => e.response_headers,
|
383
|
+
:response_body => body),
|
384
|
+
e.message
|
385
|
+
end
|
386
|
+
|
387
|
+
end
|
388
|
+
|
389
|
+
if @api_client.config.debugging
|
390
|
+
@api_client.config.logger.debug "API called: TeamApi#team_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
391
|
+
end
|
392
|
+
return data, status_code, headers
|
393
|
+
end
|
394
|
+
|
395
|
+
# Get Team Info
|
396
|
+
# Provides information about a team.
|
397
|
+
# @param [Hash] opts the optional parameters
|
398
|
+
# @option opts [String] :team_id The id of the team.
|
399
|
+
# @return [TeamGetInfoResponse]
|
400
|
+
def team_info(opts = {})
|
401
|
+
data, _status_code, _headers = team_info_with_http_info(opts)
|
402
|
+
data
|
403
|
+
end
|
404
|
+
|
405
|
+
# Get Team Info
|
406
|
+
# Provides information about a team.
|
407
|
+
# @param [Hash] opts the optional parameters
|
408
|
+
# @option opts [String] :team_id The id of the team.
|
409
|
+
# @return [Array<(TeamGetInfoResponse, Integer, Hash)>] TeamGetInfoResponse data, response status code and response headers
|
410
|
+
def team_info_with_http_info(opts = {})
|
411
|
+
if @api_client.config.debugging
|
412
|
+
@api_client.config.logger.debug 'Calling API: TeamApi.team_info ...'
|
413
|
+
end
|
414
|
+
# resource path
|
415
|
+
local_var_path = '/team/info'
|
416
|
+
|
417
|
+
# query parameters
|
418
|
+
query_params = opts[:query_params] || {}
|
419
|
+
query_params[:'team_id'] = opts[:'team_id'] if !opts[:'team_id'].nil?
|
420
|
+
|
421
|
+
# header parameters
|
422
|
+
header_params = opts[:header_params] || {}
|
423
|
+
# HTTP header 'Accept' (if needed)
|
424
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
425
|
+
|
426
|
+
post_body = {}
|
427
|
+
form_params = opts[:form_params] || {}
|
428
|
+
|
429
|
+
# http body (model)
|
430
|
+
post_body = opts[:debug_body]
|
431
|
+
|
432
|
+
# return_type
|
433
|
+
return_type = opts[:debug_return_type] || 'TeamGetInfoResponse'
|
434
|
+
|
435
|
+
# auth_names
|
436
|
+
auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
|
437
|
+
|
438
|
+
new_options = opts.merge(
|
439
|
+
:operation => :"TeamApi.team_info",
|
440
|
+
:header_params => header_params,
|
441
|
+
:query_params => query_params,
|
442
|
+
:form_params => form_params,
|
443
|
+
:body => post_body,
|
444
|
+
:auth_names => auth_names,
|
445
|
+
:return_type => return_type
|
446
|
+
)
|
447
|
+
|
448
|
+
begin
|
449
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
450
|
+
rescue Dropbox::Sign::ApiError => e
|
451
|
+
if e.code === 200
|
452
|
+
body = @api_client.convert_to_type(
|
453
|
+
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
454
|
+
"Dropbox::Sign::TeamGetInfoResponse"
|
455
|
+
)
|
456
|
+
|
457
|
+
fail ApiError.new(:code => e.code,
|
458
|
+
:response_headers => e.response_headers,
|
459
|
+
:response_body => body),
|
460
|
+
e.message
|
461
|
+
end
|
462
|
+
|
463
|
+
range_code = "4XX".split('').first
|
464
|
+
range_code_left = "#{range_code}00".to_i
|
465
|
+
range_code_right = "#{range_code}99".to_i
|
466
|
+
if e.code >= range_code_left && e.code <= range_code_right
|
467
|
+
body = @api_client.convert_to_type(
|
468
|
+
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
469
|
+
"Dropbox::Sign::ErrorResponse"
|
470
|
+
)
|
471
|
+
|
472
|
+
fail ApiError.new(:code => e.code,
|
473
|
+
:response_headers => e.response_headers,
|
474
|
+
:response_body => body),
|
475
|
+
e.message
|
476
|
+
end
|
477
|
+
|
478
|
+
end
|
479
|
+
|
480
|
+
if @api_client.config.debugging
|
481
|
+
@api_client.config.logger.debug "API called: TeamApi#team_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
482
|
+
end
|
483
|
+
return data, status_code, headers
|
484
|
+
end
|
485
|
+
|
486
|
+
# List Team Invites
|
487
|
+
# Provides a list of team invites (and their roles).
|
488
|
+
# @param [Hash] opts the optional parameters
|
489
|
+
# @option opts [String] :email_address The email address for which to display the team invites.
|
490
|
+
# @return [TeamInvitesResponse]
|
491
|
+
def team_invites(opts = {})
|
492
|
+
data, _status_code, _headers = team_invites_with_http_info(opts)
|
493
|
+
data
|
494
|
+
end
|
495
|
+
|
496
|
+
# List Team Invites
|
497
|
+
# Provides a list of team invites (and their roles).
|
498
|
+
# @param [Hash] opts the optional parameters
|
499
|
+
# @option opts [String] :email_address The email address for which to display the team invites.
|
500
|
+
# @return [Array<(TeamInvitesResponse, Integer, Hash)>] TeamInvitesResponse data, response status code and response headers
|
501
|
+
def team_invites_with_http_info(opts = {})
|
502
|
+
if @api_client.config.debugging
|
503
|
+
@api_client.config.logger.debug 'Calling API: TeamApi.team_invites ...'
|
504
|
+
end
|
505
|
+
# resource path
|
506
|
+
local_var_path = '/team/invites'
|
507
|
+
|
508
|
+
# query parameters
|
509
|
+
query_params = opts[:query_params] || {}
|
510
|
+
query_params[:'email_address'] = opts[:'email_address'] if !opts[:'email_address'].nil?
|
511
|
+
|
512
|
+
# header parameters
|
513
|
+
header_params = opts[:header_params] || {}
|
514
|
+
# HTTP header 'Accept' (if needed)
|
515
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
516
|
+
|
517
|
+
post_body = {}
|
518
|
+
form_params = opts[:form_params] || {}
|
519
|
+
|
520
|
+
# http body (model)
|
521
|
+
post_body = opts[:debug_body]
|
522
|
+
|
523
|
+
# return_type
|
524
|
+
return_type = opts[:debug_return_type] || 'TeamInvitesResponse'
|
525
|
+
|
526
|
+
# auth_names
|
527
|
+
auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
|
528
|
+
|
529
|
+
new_options = opts.merge(
|
530
|
+
:operation => :"TeamApi.team_invites",
|
531
|
+
:header_params => header_params,
|
532
|
+
:query_params => query_params,
|
533
|
+
:form_params => form_params,
|
534
|
+
:body => post_body,
|
535
|
+
:auth_names => auth_names,
|
536
|
+
:return_type => return_type
|
537
|
+
)
|
538
|
+
|
539
|
+
begin
|
540
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
541
|
+
rescue Dropbox::Sign::ApiError => e
|
542
|
+
if e.code === 200
|
543
|
+
body = @api_client.convert_to_type(
|
544
|
+
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
545
|
+
"Dropbox::Sign::TeamInvitesResponse"
|
546
|
+
)
|
547
|
+
|
548
|
+
fail ApiError.new(:code => e.code,
|
549
|
+
:response_headers => e.response_headers,
|
550
|
+
:response_body => body),
|
551
|
+
e.message
|
552
|
+
end
|
553
|
+
|
554
|
+
range_code = "4XX".split('').first
|
555
|
+
range_code_left = "#{range_code}00".to_i
|
556
|
+
range_code_right = "#{range_code}99".to_i
|
557
|
+
if e.code >= range_code_left && e.code <= range_code_right
|
558
|
+
body = @api_client.convert_to_type(
|
559
|
+
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
560
|
+
"Dropbox::Sign::ErrorResponse"
|
561
|
+
)
|
562
|
+
|
563
|
+
fail ApiError.new(:code => e.code,
|
564
|
+
:response_headers => e.response_headers,
|
565
|
+
:response_body => body),
|
566
|
+
e.message
|
567
|
+
end
|
568
|
+
|
569
|
+
end
|
570
|
+
|
571
|
+
if @api_client.config.debugging
|
572
|
+
@api_client.config.logger.debug "API called: TeamApi#team_invites\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
573
|
+
end
|
574
|
+
return data, status_code, headers
|
575
|
+
end
|
576
|
+
|
577
|
+
# List Team Members
|
578
|
+
# Provides a paginated list of members (and their roles) that belong to a given team.
|
579
|
+
# @param team_id [String] The id of the team that a member list is being requested from.
|
580
|
+
# @param [Hash] opts the optional parameters
|
581
|
+
# @option opts [Integer] :page Which page number of the team member list to return. Defaults to `1`. (default to 1)
|
582
|
+
# @option opts [Integer] :page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (default to 20)
|
583
|
+
# @return [TeamMembersResponse]
|
584
|
+
def team_members(team_id, opts = {})
|
585
|
+
data, _status_code, _headers = team_members_with_http_info(team_id, opts)
|
586
|
+
data
|
587
|
+
end
|
588
|
+
|
589
|
+
# List Team Members
|
590
|
+
# Provides a paginated list of members (and their roles) that belong to a given team.
|
591
|
+
# @param team_id [String] The id of the team that a member list is being requested from.
|
592
|
+
# @param [Hash] opts the optional parameters
|
593
|
+
# @option opts [Integer] :page Which page number of the team member list to return. Defaults to `1`.
|
594
|
+
# @option opts [Integer] :page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.
|
595
|
+
# @return [Array<(TeamMembersResponse, Integer, Hash)>] TeamMembersResponse data, response status code and response headers
|
596
|
+
def team_members_with_http_info(team_id, opts = {})
|
597
|
+
if @api_client.config.debugging
|
598
|
+
@api_client.config.logger.debug 'Calling API: TeamApi.team_members ...'
|
599
|
+
end
|
600
|
+
# verify the required parameter 'team_id' is set
|
601
|
+
if @api_client.config.client_side_validation && team_id.nil?
|
602
|
+
fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamApi.team_members"
|
603
|
+
end
|
604
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
605
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling TeamApi.team_members, must be smaller than or equal to 100.'
|
606
|
+
end
|
607
|
+
|
608
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
609
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling TeamApi.team_members, must be greater than or equal to 1.'
|
610
|
+
end
|
611
|
+
|
612
|
+
# resource path
|
613
|
+
local_var_path = '/team/members/{team_id}'.sub('{' + 'team_id' + '}', CGI.escape(team_id.to_s))
|
614
|
+
|
615
|
+
# query parameters
|
616
|
+
query_params = opts[:query_params] || {}
|
617
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
618
|
+
query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
619
|
+
|
620
|
+
# header parameters
|
621
|
+
header_params = opts[:header_params] || {}
|
622
|
+
# HTTP header 'Accept' (if needed)
|
623
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
624
|
+
|
625
|
+
post_body = {}
|
626
|
+
form_params = opts[:form_params] || {}
|
627
|
+
|
628
|
+
# http body (model)
|
629
|
+
post_body = opts[:debug_body]
|
630
|
+
|
631
|
+
# return_type
|
632
|
+
return_type = opts[:debug_return_type] || 'TeamMembersResponse'
|
633
|
+
|
634
|
+
# auth_names
|
635
|
+
auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
|
636
|
+
|
637
|
+
new_options = opts.merge(
|
638
|
+
:operation => :"TeamApi.team_members",
|
639
|
+
:header_params => header_params,
|
640
|
+
:query_params => query_params,
|
641
|
+
:form_params => form_params,
|
642
|
+
:body => post_body,
|
643
|
+
:auth_names => auth_names,
|
644
|
+
:return_type => return_type
|
645
|
+
)
|
646
|
+
|
647
|
+
begin
|
648
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
649
|
+
rescue Dropbox::Sign::ApiError => e
|
650
|
+
if e.code === 200
|
651
|
+
body = @api_client.convert_to_type(
|
652
|
+
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
653
|
+
"Dropbox::Sign::TeamMembersResponse"
|
654
|
+
)
|
655
|
+
|
656
|
+
fail ApiError.new(:code => e.code,
|
657
|
+
:response_headers => e.response_headers,
|
658
|
+
:response_body => body),
|
659
|
+
e.message
|
660
|
+
end
|
661
|
+
|
662
|
+
range_code = "4XX".split('').first
|
663
|
+
range_code_left = "#{range_code}00".to_i
|
664
|
+
range_code_right = "#{range_code}99".to_i
|
665
|
+
if e.code >= range_code_left && e.code <= range_code_right
|
666
|
+
body = @api_client.convert_to_type(
|
667
|
+
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
668
|
+
"Dropbox::Sign::ErrorResponse"
|
669
|
+
)
|
670
|
+
|
671
|
+
fail ApiError.new(:code => e.code,
|
672
|
+
:response_headers => e.response_headers,
|
673
|
+
:response_body => body),
|
674
|
+
e.message
|
675
|
+
end
|
676
|
+
|
677
|
+
end
|
678
|
+
|
679
|
+
if @api_client.config.debugging
|
680
|
+
@api_client.config.logger.debug "API called: TeamApi#team_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
681
|
+
end
|
682
|
+
return data, status_code, headers
|
683
|
+
end
|
684
|
+
|
685
|
+
# Remove User from Team
|
686
|
+
# Removes the provided user Account from your Team. If the Account had an outstanding invitation to your Team, the invitation will be expired. If you choose to transfer documents from the removed Account to an Account provided in the `new_owner_email_address` parameter (available only for Enterprise plans), the response status code will be 201, which indicates that your request has been queued but not fully executed.
|
687
|
+
# @param team_remove_member_request [TeamRemoveMemberRequest]
|
688
|
+
# @param [Hash] opts the optional parameters
|
689
|
+
# @return [TeamGetResponse]
|
690
|
+
def team_remove_member(team_remove_member_request, opts = {})
|
691
|
+
data, _status_code, _headers = team_remove_member_with_http_info(team_remove_member_request, opts)
|
692
|
+
data
|
693
|
+
end
|
694
|
+
|
695
|
+
# Remove User from Team
|
696
|
+
# Removes the provided user Account from your Team. If the Account had an outstanding invitation to your Team, the invitation will be expired. If you choose to transfer documents from the removed Account to an Account provided in the `new_owner_email_address` parameter (available only for Enterprise plans), the response status code will be 201, which indicates that your request has been queued but not fully executed.
|
697
|
+
# @param team_remove_member_request [TeamRemoveMemberRequest]
|
698
|
+
# @param [Hash] opts the optional parameters
|
699
|
+
# @return [Array<(TeamGetResponse, Integer, Hash)>] TeamGetResponse data, response status code and response headers
|
700
|
+
def team_remove_member_with_http_info(team_remove_member_request, opts = {})
|
701
|
+
if @api_client.config.debugging
|
702
|
+
@api_client.config.logger.debug 'Calling API: TeamApi.team_remove_member ...'
|
703
|
+
end
|
704
|
+
# verify the required parameter 'team_remove_member_request' is set
|
705
|
+
if @api_client.config.client_side_validation && team_remove_member_request.nil?
|
706
|
+
fail ArgumentError, "Missing the required parameter 'team_remove_member_request' when calling TeamApi.team_remove_member"
|
707
|
+
end
|
708
|
+
# resource path
|
709
|
+
local_var_path = '/team/remove_member'
|
710
|
+
|
711
|
+
# query parameters
|
712
|
+
query_params = opts[:query_params] || {}
|
713
|
+
|
714
|
+
# header parameters
|
715
|
+
header_params = opts[:header_params] || {}
|
716
|
+
# HTTP header 'Accept' (if needed)
|
717
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
718
|
+
# HTTP header 'Content-Type'
|
719
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
720
|
+
if !content_type.nil?
|
721
|
+
header_params['Content-Type'] = content_type
|
722
|
+
end
|
723
|
+
|
724
|
+
post_body = {}
|
725
|
+
form_params = opts[:form_params] || {}
|
726
|
+
result = @api_client.generate_form_data(
|
727
|
+
team_remove_member_request,
|
728
|
+
Dropbox::Sign::TeamRemoveMemberRequest.openapi_types
|
729
|
+
)
|
730
|
+
|
731
|
+
# form parameters
|
732
|
+
if result[:has_file]
|
733
|
+
form_params = opts[:form_params] || result[:params]
|
734
|
+
header_params['Content-Type'] = 'multipart/form-data'
|
735
|
+
else
|
736
|
+
# http body (model)
|
737
|
+
post_body = opts[:debug_body] || result[:params]
|
738
|
+
end
|
739
|
+
|
740
|
+
# return_type
|
741
|
+
return_type = opts[:debug_return_type] || 'TeamGetResponse'
|
742
|
+
|
743
|
+
# auth_names
|
744
|
+
auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
|
745
|
+
|
746
|
+
new_options = opts.merge(
|
747
|
+
:operation => :"TeamApi.team_remove_member",
|
748
|
+
:header_params => header_params,
|
749
|
+
:query_params => query_params,
|
750
|
+
:form_params => form_params,
|
751
|
+
:body => post_body,
|
752
|
+
:auth_names => auth_names,
|
753
|
+
:return_type => return_type
|
754
|
+
)
|
755
|
+
|
756
|
+
begin
|
757
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
758
|
+
rescue Dropbox::Sign::ApiError => e
|
759
|
+
if e.code === 200
|
760
|
+
body = @api_client.convert_to_type(
|
761
|
+
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
762
|
+
"Dropbox::Sign::TeamGetResponse"
|
763
|
+
)
|
764
|
+
|
765
|
+
fail ApiError.new(:code => e.code,
|
766
|
+
:response_headers => e.response_headers,
|
767
|
+
:response_body => body),
|
768
|
+
e.message
|
769
|
+
end
|
770
|
+
|
771
|
+
range_code = "4XX".split('').first
|
772
|
+
range_code_left = "#{range_code}00".to_i
|
773
|
+
range_code_right = "#{range_code}99".to_i
|
774
|
+
if e.code >= range_code_left && e.code <= range_code_right
|
775
|
+
body = @api_client.convert_to_type(
|
776
|
+
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
777
|
+
"Dropbox::Sign::ErrorResponse"
|
778
|
+
)
|
779
|
+
|
780
|
+
fail ApiError.new(:code => e.code,
|
781
|
+
:response_headers => e.response_headers,
|
782
|
+
:response_body => body),
|
783
|
+
e.message
|
784
|
+
end
|
785
|
+
|
786
|
+
end
|
787
|
+
|
788
|
+
if @api_client.config.debugging
|
789
|
+
@api_client.config.logger.debug "API called: TeamApi#team_remove_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
790
|
+
end
|
791
|
+
return data, status_code, headers
|
792
|
+
end
|
793
|
+
|
794
|
+
# List Sub Teams
|
795
|
+
# Provides a paginated list of sub teams that belong to a given team.
|
796
|
+
# @param team_id [String] The id of the parent Team.
|
797
|
+
# @param [Hash] opts the optional parameters
|
798
|
+
# @option opts [Integer] :page Which page number of the SubTeam List to return. Defaults to `1`. (default to 1)
|
799
|
+
# @option opts [Integer] :page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (default to 20)
|
800
|
+
# @return [TeamSubTeamsResponse]
|
801
|
+
def team_sub_teams(team_id, opts = {})
|
802
|
+
data, _status_code, _headers = team_sub_teams_with_http_info(team_id, opts)
|
803
|
+
data
|
804
|
+
end
|
805
|
+
|
806
|
+
# List Sub Teams
|
807
|
+
# Provides a paginated list of sub teams that belong to a given team.
|
808
|
+
# @param team_id [String] The id of the parent Team.
|
809
|
+
# @param [Hash] opts the optional parameters
|
810
|
+
# @option opts [Integer] :page Which page number of the SubTeam List to return. Defaults to `1`.
|
811
|
+
# @option opts [Integer] :page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.
|
812
|
+
# @return [Array<(TeamSubTeamsResponse, Integer, Hash)>] TeamSubTeamsResponse data, response status code and response headers
|
813
|
+
def team_sub_teams_with_http_info(team_id, opts = {})
|
814
|
+
if @api_client.config.debugging
|
815
|
+
@api_client.config.logger.debug 'Calling API: TeamApi.team_sub_teams ...'
|
816
|
+
end
|
817
|
+
# verify the required parameter 'team_id' is set
|
818
|
+
if @api_client.config.client_side_validation && team_id.nil?
|
819
|
+
fail ArgumentError, "Missing the required parameter 'team_id' when calling TeamApi.team_sub_teams"
|
820
|
+
end
|
821
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
|
822
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling TeamApi.team_sub_teams, must be smaller than or equal to 100.'
|
823
|
+
end
|
824
|
+
|
825
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
826
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling TeamApi.team_sub_teams, must be greater than or equal to 1.'
|
827
|
+
end
|
828
|
+
|
829
|
+
# resource path
|
830
|
+
local_var_path = '/team/sub_teams/{team_id}'.sub('{' + 'team_id' + '}', CGI.escape(team_id.to_s))
|
831
|
+
|
832
|
+
# query parameters
|
833
|
+
query_params = opts[:query_params] || {}
|
834
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
835
|
+
query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
836
|
+
|
837
|
+
# header parameters
|
838
|
+
header_params = opts[:header_params] || {}
|
839
|
+
# HTTP header 'Accept' (if needed)
|
840
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
841
|
+
|
842
|
+
post_body = {}
|
843
|
+
form_params = opts[:form_params] || {}
|
844
|
+
|
845
|
+
# http body (model)
|
846
|
+
post_body = opts[:debug_body]
|
847
|
+
|
848
|
+
# return_type
|
849
|
+
return_type = opts[:debug_return_type] || 'TeamSubTeamsResponse'
|
850
|
+
|
851
|
+
# auth_names
|
852
|
+
auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
|
853
|
+
|
854
|
+
new_options = opts.merge(
|
855
|
+
:operation => :"TeamApi.team_sub_teams",
|
856
|
+
:header_params => header_params,
|
857
|
+
:query_params => query_params,
|
858
|
+
:form_params => form_params,
|
859
|
+
:body => post_body,
|
860
|
+
:auth_names => auth_names,
|
861
|
+
:return_type => return_type
|
862
|
+
)
|
863
|
+
|
864
|
+
begin
|
865
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
866
|
+
rescue Dropbox::Sign::ApiError => e
|
867
|
+
if e.code === 200
|
868
|
+
body = @api_client.convert_to_type(
|
869
|
+
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
870
|
+
"Dropbox::Sign::TeamSubTeamsResponse"
|
871
|
+
)
|
872
|
+
|
873
|
+
fail ApiError.new(:code => e.code,
|
874
|
+
:response_headers => e.response_headers,
|
875
|
+
:response_body => body),
|
876
|
+
e.message
|
877
|
+
end
|
878
|
+
|
879
|
+
range_code = "4XX".split('').first
|
880
|
+
range_code_left = "#{range_code}00".to_i
|
881
|
+
range_code_right = "#{range_code}99".to_i
|
882
|
+
if e.code >= range_code_left && e.code <= range_code_right
|
883
|
+
body = @api_client.convert_to_type(
|
884
|
+
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
885
|
+
"Dropbox::Sign::ErrorResponse"
|
886
|
+
)
|
887
|
+
|
888
|
+
fail ApiError.new(:code => e.code,
|
889
|
+
:response_headers => e.response_headers,
|
890
|
+
:response_body => body),
|
891
|
+
e.message
|
892
|
+
end
|
893
|
+
|
894
|
+
end
|
895
|
+
|
896
|
+
if @api_client.config.debugging
|
897
|
+
@api_client.config.logger.debug "API called: TeamApi#team_sub_teams\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
898
|
+
end
|
899
|
+
return data, status_code, headers
|
900
|
+
end
|
901
|
+
|
902
|
+
# Update Team
|
903
|
+
# Updates the name of your Team.
|
904
|
+
# @param team_update_request [TeamUpdateRequest]
|
905
|
+
# @param [Hash] opts the optional parameters
|
906
|
+
# @return [TeamGetResponse]
|
907
|
+
def team_update(team_update_request, opts = {})
|
908
|
+
data, _status_code, _headers = team_update_with_http_info(team_update_request, opts)
|
909
|
+
data
|
910
|
+
end
|
911
|
+
|
912
|
+
# Update Team
|
913
|
+
# Updates the name of your Team.
|
914
|
+
# @param team_update_request [TeamUpdateRequest]
|
915
|
+
# @param [Hash] opts the optional parameters
|
916
|
+
# @return [Array<(TeamGetResponse, Integer, Hash)>] TeamGetResponse data, response status code and response headers
|
917
|
+
def team_update_with_http_info(team_update_request, opts = {})
|
918
|
+
if @api_client.config.debugging
|
919
|
+
@api_client.config.logger.debug 'Calling API: TeamApi.team_update ...'
|
920
|
+
end
|
921
|
+
# verify the required parameter 'team_update_request' is set
|
922
|
+
if @api_client.config.client_side_validation && team_update_request.nil?
|
923
|
+
fail ArgumentError, "Missing the required parameter 'team_update_request' when calling TeamApi.team_update"
|
924
|
+
end
|
925
|
+
# resource path
|
926
|
+
local_var_path = '/team'
|
927
|
+
|
928
|
+
# query parameters
|
929
|
+
query_params = opts[:query_params] || {}
|
930
|
+
|
931
|
+
# header parameters
|
932
|
+
header_params = opts[:header_params] || {}
|
933
|
+
# HTTP header 'Accept' (if needed)
|
934
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
935
|
+
# HTTP header 'Content-Type'
|
936
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
937
|
+
if !content_type.nil?
|
938
|
+
header_params['Content-Type'] = content_type
|
939
|
+
end
|
940
|
+
|
941
|
+
post_body = {}
|
942
|
+
form_params = opts[:form_params] || {}
|
943
|
+
result = @api_client.generate_form_data(
|
944
|
+
team_update_request,
|
945
|
+
Dropbox::Sign::TeamUpdateRequest.openapi_types
|
946
|
+
)
|
947
|
+
|
948
|
+
# form parameters
|
949
|
+
if result[:has_file]
|
950
|
+
form_params = opts[:form_params] || result[:params]
|
951
|
+
header_params['Content-Type'] = 'multipart/form-data'
|
952
|
+
else
|
953
|
+
# http body (model)
|
954
|
+
post_body = opts[:debug_body] || result[:params]
|
955
|
+
end
|
956
|
+
|
957
|
+
# return_type
|
958
|
+
return_type = opts[:debug_return_type] || 'TeamGetResponse'
|
959
|
+
|
960
|
+
# auth_names
|
961
|
+
auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
|
962
|
+
|
963
|
+
new_options = opts.merge(
|
964
|
+
:operation => :"TeamApi.team_update",
|
965
|
+
:header_params => header_params,
|
966
|
+
:query_params => query_params,
|
967
|
+
:form_params => form_params,
|
968
|
+
:body => post_body,
|
969
|
+
:auth_names => auth_names,
|
970
|
+
:return_type => return_type
|
971
|
+
)
|
972
|
+
|
973
|
+
begin
|
974
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
975
|
+
rescue Dropbox::Sign::ApiError => e
|
976
|
+
if e.code === 200
|
977
|
+
body = @api_client.convert_to_type(
|
978
|
+
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
979
|
+
"Dropbox::Sign::TeamGetResponse"
|
980
|
+
)
|
981
|
+
|
982
|
+
fail ApiError.new(:code => e.code,
|
983
|
+
:response_headers => e.response_headers,
|
984
|
+
:response_body => body),
|
985
|
+
e.message
|
986
|
+
end
|
987
|
+
|
988
|
+
range_code = "4XX".split('').first
|
989
|
+
range_code_left = "#{range_code}00".to_i
|
990
|
+
range_code_right = "#{range_code}99".to_i
|
991
|
+
if e.code >= range_code_left && e.code <= range_code_right
|
992
|
+
body = @api_client.convert_to_type(
|
993
|
+
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
994
|
+
"Dropbox::Sign::ErrorResponse"
|
995
|
+
)
|
996
|
+
|
997
|
+
fail ApiError.new(:code => e.code,
|
998
|
+
:response_headers => e.response_headers,
|
999
|
+
:response_body => body),
|
1000
|
+
e.message
|
1001
|
+
end
|
1002
|
+
|
1003
|
+
end
|
1004
|
+
|
1005
|
+
if @api_client.config.debugging
|
1006
|
+
@api_client.config.logger.debug "API called: TeamApi#team_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1007
|
+
end
|
1008
|
+
return data, status_code, headers
|
1009
|
+
end
|
1010
|
+
end
|
1011
|
+
end
|