docusign_esign 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +7 -0
- data/LICENSE +21 -0
- data/README.md +101 -0
- data/Rakefile +8 -0
- data/docs/AccountAddress.md +19 -0
- data/docs/AccountBillingPlan.md +27 -0
- data/docs/AccountBillingPlanResponse.md +13 -0
- data/docs/AccountInformation.md +38 -0
- data/docs/AccountRoleSettings.md +71 -0
- data/docs/AccountSettingsInformation.md +8 -0
- data/docs/AccountSharedAccess.md +16 -0
- data/docs/AccountSignatureProvider.md +14 -0
- data/docs/AccountSignatureProviderOption.md +10 -0
- data/docs/AccountSignatureProviders.md +8 -0
- data/docs/AccountsApi.md +1997 -0
- data/docs/AddOn.md +11 -0
- data/docs/AddressInformation.md +15 -0
- data/docs/AddressInformationInput.md +10 -0
- data/docs/AddressInformationV2.md +15 -0
- data/docs/Agent.md +49 -0
- data/docs/ApiRequestLog.md +11 -0
- data/docs/ApiRequestLogsResult.md +8 -0
- data/docs/AppStoreProduct.md +9 -0
- data/docs/AppStoreReceipt.md +9 -0
- data/docs/Approve.md +40 -0
- data/docs/Attachment.md +14 -0
- data/docs/AuthenticationApi.md +356 -0
- data/docs/AuthenticationMethod.md +11 -0
- data/docs/AuthenticationStatus.md +24 -0
- data/docs/BccEmailAddress.md +9 -0
- data/docs/BillingApi.md +569 -0
- data/docs/BillingCharge.md +20 -0
- data/docs/BillingChargeResponse.md +8 -0
- data/docs/BillingDiscount.md +10 -0
- data/docs/BillingInvoice.md +17 -0
- data/docs/BillingInvoiceItem.md +12 -0
- data/docs/BillingInvoicesResponse.md +10 -0
- data/docs/BillingInvoicesSummary.md +10 -0
- data/docs/BillingPayment.md +10 -0
- data/docs/BillingPaymentItem.md +12 -0
- data/docs/BillingPaymentRequest.md +8 -0
- data/docs/BillingPaymentResponse.md +8 -0
- data/docs/BillingPaymentsResponse.md +10 -0
- data/docs/BillingPlan.md +22 -0
- data/docs/BillingPlanInformation.md +22 -0
- data/docs/BillingPlanPreview.md +13 -0
- data/docs/BillingPlanResponse.md +9 -0
- data/docs/BillingPlanUpdateResponse.md +14 -0
- data/docs/BillingPlansResponse.md +8 -0
- data/docs/BillingPrice.md +10 -0
- data/docs/Brand.md +20 -0
- data/docs/BrandEmailContent.md +11 -0
- data/docs/BrandLink.md +11 -0
- data/docs/BrandLogos.md +10 -0
- data/docs/BrandRequest.md +8 -0
- data/docs/BrandResourceUrls.md +11 -0
- data/docs/BrandResources.md +14 -0
- data/docs/BrandResourcesList.md +8 -0
- data/docs/BrandsRequest.md +8 -0
- data/docs/BrandsResponse.md +10 -0
- data/docs/BulkEnvelope.md +16 -0
- data/docs/BulkEnvelopeStatus.md +21 -0
- data/docs/BulkEnvelopesApi.md +295 -0
- data/docs/BulkEnvelopesResponse.md +14 -0
- data/docs/BulkRecipient.md +17 -0
- data/docs/BulkRecipientSignatureProvider.md +9 -0
- data/docs/BulkRecipientTabLabel.md +9 -0
- data/docs/BulkRecipientsRequest.md +8 -0
- data/docs/BulkRecipientsResponse.md +14 -0
- data/docs/BulkRecipientsSummaryResponse.md +11 -0
- data/docs/BulkRecipientsUpdateResponse.md +8 -0
- data/docs/CaptiveRecipient.md +11 -0
- data/docs/CaptiveRecipientInformation.md +8 -0
- data/docs/CarbonCopy.md +49 -0
- data/docs/CertifiedDelivery.md +49 -0
- data/docs/Checkbox.md +37 -0
- data/docs/ChunkedUploadPart.md +9 -0
- data/docs/ChunkedUploadRequest.md +9 -0
- data/docs/ChunkedUploadResponse.md +14 -0
- data/docs/CloudStorageApi.md +424 -0
- data/docs/CloudStorageProvider.md +12 -0
- data/docs/CloudStorageProviders.md +8 -0
- data/docs/Company.md +46 -0
- data/docs/CompositeTemplate.md +12 -0
- data/docs/ConnectApi.md +891 -0
- data/docs/ConnectConfigResults.md +9 -0
- data/docs/ConnectCustomConfiguration.md +28 -0
- data/docs/ConnectDebugLog.md +12 -0
- data/docs/ConnectFailureFilter.md +9 -0
- data/docs/ConnectFailureResult.md +12 -0
- data/docs/ConnectFailureResults.md +8 -0
- data/docs/ConnectLog.md +25 -0
- data/docs/ConnectLogs.md +11 -0
- data/docs/ConsoleViewRequest.md +9 -0
- data/docs/ConsumerDisclosure.md +37 -0
- data/docs/Contact.md +16 -0
- data/docs/ContactGetResponse.md +14 -0
- data/docs/ContactModRequest.md +8 -0
- data/docs/ContactUpdateResponse.md +8 -0
- data/docs/CorrectViewRequest.md +9 -0
- data/docs/Country.md +11 -0
- data/docs/CreditCardInformation.md +13 -0
- data/docs/CreditCardTypes.md +8 -0
- data/docs/CurrencyFeatureSetPrice.md +12 -0
- data/docs/CurrencyPlanPrice.md +13 -0
- data/docs/CustomFieldV2.md +14 -0
- data/docs/CustomFields.md +9 -0
- data/docs/CustomFieldsEnvelope.md +9 -0
- data/docs/CustomSettingsInformation.md +8 -0
- data/docs/CustomTabsApi.md +268 -0
- data/docs/Date.md +52 -0
- data/docs/DateSigned.md +39 -0
- data/docs/Decline.md +41 -0
- data/docs/DiagnosticsApi.md +321 -0
- data/docs/DiagnosticsSettingsInformation.md +10 -0
- data/docs/DobInformationInput.md +10 -0
- data/docs/Document.md +27 -0
- data/docs/DocumentFieldsInformation.md +8 -0
- data/docs/DocumentTemplate.md +12 -0
- data/docs/DocumentTemplateList.md +8 -0
- data/docs/DocumentVisibility.md +12 -0
- data/docs/DocumentVisibilityList.md +8 -0
- data/docs/ENoteConfiguration.md +12 -0
- data/docs/Editor.md +48 -0
- data/docs/Email.md +52 -0
- data/docs/EmailAddress.md +38 -0
- data/docs/EmailSettings.md +10 -0
- data/docs/Envelope.md +54 -0
- data/docs/EnvelopeAttachment.md +13 -0
- data/docs/EnvelopeAttachmentsRequest.md +8 -0
- data/docs/EnvelopeAttachmentsResult.md +8 -0
- data/docs/EnvelopeAuditEvent.md +8 -0
- data/docs/EnvelopeAuditEventResponse.md +8 -0
- data/docs/EnvelopeDefinition.md +63 -0
- data/docs/EnvelopeDocument.md +24 -0
- data/docs/EnvelopeDocumentsResult.md +9 -0
- data/docs/EnvelopeEvent.md +9 -0
- data/docs/EnvelopeFormData.md +13 -0
- data/docs/EnvelopeId.md +38 -0
- data/docs/EnvelopeIdsRequest.md +9 -0
- data/docs/EnvelopeNotificationRequest.md +10 -0
- data/docs/EnvelopeSummary.md +11 -0
- data/docs/EnvelopeTemplate.md +56 -0
- data/docs/EnvelopeTemplateDefinition.md +22 -0
- data/docs/EnvelopeTemplateResult.md +68 -0
- data/docs/EnvelopeTemplateResults.md +15 -0
- data/docs/EnvelopeTransactionStatus.md +11 -0
- data/docs/EnvelopeUpdateSummary.md +15 -0
- data/docs/EnvelopesApi.md +4306 -0
- data/docs/EnvelopesInformation.md +15 -0
- data/docs/ErrorDetails.md +9 -0
- data/docs/EventNotification.md +22 -0
- data/docs/EventResult.md +11 -0
- data/docs/Expirations.md +10 -0
- data/docs/ExternalDocServiceErrorDetails.md +10 -0
- data/docs/ExternalFile.md +15 -0
- data/docs/ExternalFolder.md +17 -0
- data/docs/FeatureSet.md +16 -0
- data/docs/FileType.md +9 -0
- data/docs/FileTypeList.md +8 -0
- data/docs/Filter.md +18 -0
- data/docs/FirstName.md +38 -0
- data/docs/Folder.md +19 -0
- data/docs/FolderItem.md +28 -0
- data/docs/FolderItemResponse.md +14 -0
- data/docs/FolderItemV2.md +27 -0
- data/docs/FolderItemsResponse.md +14 -0
- data/docs/FoldersApi.md +261 -0
- data/docs/FoldersRequest.md +9 -0
- data/docs/FoldersResponse.md +8 -0
- data/docs/ForgottenPasswordInformation.md +15 -0
- data/docs/FormulaTab.md +56 -0
- data/docs/FullName.md +38 -0
- data/docs/Group.md +13 -0
- data/docs/GroupInformation.md +14 -0
- data/docs/GroupsApi.md +552 -0
- data/docs/IdCheckInformationInput.md +11 -0
- data/docs/InPersonSigner.md +62 -0
- data/docs/InitialHere.md +34 -0
- data/docs/InlineTemplate.md +12 -0
- data/docs/IntegratedUserInfoList.md +15 -0
- data/docs/Intermediary.md +49 -0
- data/docs/LastName.md +38 -0
- data/docs/List.md +46 -0
- data/docs/ListCustomField.md +15 -0
- data/docs/ListItem.md +10 -0
- data/docs/LockInformation.md +15 -0
- data/docs/LockRequest.md +12 -0
- data/docs/LoginAccount.md +18 -0
- data/docs/LoginInformation.md +9 -0
- data/docs/MatchBox.md +12 -0
- data/docs/MemberGroupSharedItem.md +10 -0
- data/docs/MemberSharedItems.md +11 -0
- data/docs/MergeField.md +12 -0
- data/docs/MobileNotifierConfiguration.md +10 -0
- data/docs/MobileNotifierConfigurationInformation.md +8 -0
- data/docs/Money.md +10 -0
- data/docs/NameValue.md +11 -0
- data/docs/NewAccountDefinition.md +17 -0
- data/docs/NewAccountSummary.md +14 -0
- data/docs/NewUser.md +17 -0
- data/docs/NewUsersDefinition.md +8 -0
- data/docs/NewUsersSummary.md +8 -0
- data/docs/NotaryHost.md +47 -0
- data/docs/Note.md +42 -0
- data/docs/Notification.md +10 -0
- data/docs/Number.md +54 -0
- data/docs/OauthAccess.md +13 -0
- data/docs/OfflineAttributes.md +13 -0
- data/docs/Page.md +15 -0
- data/docs/PageImages.md +14 -0
- data/docs/PageRequest.md +9 -0
- data/docs/PaymentDetails.md +12 -0
- data/docs/PaymentLineItem.md +11 -0
- data/docs/PermissionProfile.md +14 -0
- data/docs/PermissionProfileInformation.md +8 -0
- data/docs/PlanInformation.md +13 -0
- data/docs/PostTransactionsRequest.md +11 -0
- data/docs/PostTransactionsResponse.md +9 -0
- data/docs/PowerForm.md +31 -0
- data/docs/PowerFormFormDataEnvelope.md +9 -0
- data/docs/PowerFormFormDataRecipient.md +11 -0
- data/docs/PowerFormRecipient.md +20 -0
- data/docs/PowerFormSendersResponse.md +14 -0
- data/docs/PowerFormsApi.md +419 -0
- data/docs/PowerFormsFormDataResponse.md +8 -0
- data/docs/PowerFormsRequest.md +8 -0
- data/docs/PowerFormsResponse.md +14 -0
- data/docs/PropertyMetadata.md +9 -0
- data/docs/Province.md +9 -0
- data/docs/ProvisioningInformation.md +14 -0
- data/docs/PurchasedEnvelopesInformation.md +16 -0
- data/docs/Radio.md +25 -0
- data/docs/RadioGroup.md +16 -0
- data/docs/RecipientAttachment.md +13 -0
- data/docs/RecipientDomain.md +11 -0
- data/docs/RecipientEmailNotification.md +10 -0
- data/docs/RecipientEvent.md +9 -0
- data/docs/RecipientFormData.md +15 -0
- data/docs/RecipientNamesResponse.md +10 -0
- data/docs/RecipientPhoneAuthentication.md +11 -0
- data/docs/RecipientSAMLAuthentication.md +8 -0
- data/docs/RecipientSMSAuthentication.md +8 -0
- data/docs/RecipientSignatureInformation.md +10 -0
- data/docs/RecipientSignatureProvider.md +9 -0
- data/docs/RecipientSignatureProviderOptions.md +11 -0
- data/docs/RecipientUpdateResponse.md +10 -0
- data/docs/RecipientViewRequest.md +21 -0
- data/docs/Recipients.md +17 -0
- data/docs/RecipientsUpdateSummary.md +8 -0
- data/docs/ReferralInformation.md +25 -0
- data/docs/Reminders.md +10 -0
- data/docs/ResourceInformation.md +8 -0
- data/docs/ReturnUrlRequest.md +8 -0
- data/docs/SamlAssertionAttribute.md +11 -0
- data/docs/SeatDiscount.md +10 -0
- data/docs/SenderEmailNotifications.md +14 -0
- data/docs/ServerTemplate.md +9 -0
- data/docs/ServiceInformation.md +13 -0
- data/docs/ServiceVersion.md +9 -0
- data/docs/SettingsMetadata.md +13 -0
- data/docs/SharedItem.md +10 -0
- data/docs/SignHere.md +34 -0
- data/docs/SignatureProviderRequiredOption.md +9 -0
- data/docs/SignatureType.md +9 -0
- data/docs/Signer.md +63 -0
- data/docs/SignerAttachment.md +34 -0
- data/docs/SignerEmailNotifications.md +21 -0
- data/docs/SigningGroup.md +17 -0
- data/docs/SigningGroupInformation.md +8 -0
- data/docs/SigningGroupUser.md +10 -0
- data/docs/SigningGroupUsers.md +8 -0
- data/docs/SigningGroupsApi.md +485 -0
- data/docs/SocialAccountInformation.md +12 -0
- data/docs/SocialAuthentication.md +8 -0
- data/docs/Ssn.md +52 -0
- data/docs/Ssn4InformationInput.md +10 -0
- data/docs/Ssn9InformationInput.md +9 -0
- data/docs/TabAccountSettings.md +45 -0
- data/docs/TabMetadata.md +46 -0
- data/docs/TabMetadataList.md +8 -0
- data/docs/Tabs.md +32 -0
- data/docs/TemplateCustomFields.md +9 -0
- data/docs/TemplateDocumentVisibilityList.md +8 -0
- data/docs/TemplateDocumentsResult.md +9 -0
- data/docs/TemplateInformation.md +8 -0
- data/docs/TemplateMatch.md +10 -0
- data/docs/TemplateNotificationRequest.md +11 -0
- data/docs/TemplateRecipients.md +17 -0
- data/docs/TemplateRole.md +19 -0
- data/docs/TemplateSharedItem.md +14 -0
- data/docs/TemplateSummary.md +14 -0
- data/docs/TemplateTabs.md +32 -0
- data/docs/TemplateUpdateSummary.md +15 -0
- data/docs/TemplatesApi.md +2349 -0
- data/docs/Text.md +55 -0
- data/docs/TextCustomField.md +14 -0
- data/docs/Title.md +46 -0
- data/docs/UsageHistory.md +11 -0
- data/docs/UserAccountManagementGranularInformation.md +15 -0
- data/docs/UserInfo.md +17 -0
- data/docs/UserInfoList.md +8 -0
- data/docs/UserInformation.md +41 -0
- data/docs/UserInformationList.md +14 -0
- data/docs/UserPasswordInformation.md +11 -0
- data/docs/UserProfile.md +19 -0
- data/docs/UserSettingsInformation.md +11 -0
- data/docs/UserSharedItem.md +10 -0
- data/docs/UserSignature.md +20 -0
- data/docs/UserSignatureDefinition.md +11 -0
- data/docs/UserSignaturesInformation.md +8 -0
- data/docs/UserSocialIdResult.md +9 -0
- data/docs/UsersApi.md +1566 -0
- data/docs/UsersResponse.md +14 -0
- data/docs/View.md +42 -0
- data/docs/ViewLinkRequest.md +9 -0
- data/docs/ViewUrl.md +8 -0
- data/docs/Workspace.md +18 -0
- data/docs/WorkspaceFolderContents.md +15 -0
- data/docs/WorkspaceItem.md +26 -0
- data/docs/WorkspaceItemList.md +8 -0
- data/docs/WorkspaceList.md +12 -0
- data/docs/WorkspaceUser.md +23 -0
- data/docs/WorkspaceUserAuthorization.md +18 -0
- data/docs/WorkspacesApi.md +630 -0
- data/docs/Zip.md +53 -0
- data/docusign_esign-1.0.0.gem +0 -0
- data/docusign_esign.gemspec +47 -0
- data/git_push.sh +55 -0
- data/lib/docusign_esign/.DS_Store +0 -0
- data/lib/docusign_esign/api/accounts_api.rb +2230 -0
- data/lib/docusign_esign/api/authentication_api.rb +393 -0
- data/lib/docusign_esign/api/billing_api.rb +636 -0
- data/lib/docusign_esign/api/bulk_envelopes_api.rb +355 -0
- data/lib/docusign_esign/api/cloud_storage_api.rb +507 -0
- data/lib/docusign_esign/api/connect_api.rb +967 -0
- data/lib/docusign_esign/api/custom_tabs_api.rb +296 -0
- data/lib/docusign_esign/api/diagnostics_api.rb +356 -0
- data/lib/docusign_esign/api/envelopes_api.rb +4737 -0
- data/lib/docusign_esign/api/folders_api.rb +342 -0
- data/lib/docusign_esign/api/groups_api.rb +596 -0
- data/lib/docusign_esign/api/power_forms_api.rb +489 -0
- data/lib/docusign_esign/api/signing_groups_api.rb +513 -0
- data/lib/docusign_esign/api/templates_api.rb +2555 -0
- data/lib/docusign_esign/api/users_api.rb +1694 -0
- data/lib/docusign_esign/api/workspaces_api.rb +719 -0
- data/lib/docusign_esign/api_client.rb +421 -0
- data/lib/docusign_esign/api_error.rb +37 -0
- data/lib/docusign_esign/configuration.rb +195 -0
- data/lib/docusign_esign/models/account_address.rb +300 -0
- data/lib/docusign_esign/models/account_billing_plan.rb +384 -0
- data/lib/docusign_esign/models/account_billing_plan_response.rb +236 -0
- data/lib/docusign_esign/models/account_information.rb +488 -0
- data/lib/docusign_esign/models/account_role_settings.rb +786 -0
- data/lib/docusign_esign/models/account_settings_information.rb +190 -0
- data/lib/docusign_esign/models/account_shared_access.rb +269 -0
- data/lib/docusign_esign/models/account_signature_provider.rb +252 -0
- data/lib/docusign_esign/models/account_signature_provider_option.rb +208 -0
- data/lib/docusign_esign/models/account_signature_providers.rb +190 -0
- data/lib/docusign_esign/models/add_on.rb +218 -0
- data/lib/docusign_esign/models/address_information.rb +258 -0
- data/lib/docusign_esign/models/address_information_input.rb +207 -0
- data/lib/docusign_esign/models/address_information_v2.rb +258 -0
- data/lib/docusign_esign/models/agent.rb +603 -0
- data/lib/docusign_esign/models/api_request_log.rb +218 -0
- data/lib/docusign_esign/models/api_request_logs_result.rb +190 -0
- data/lib/docusign_esign/models/app_store_product.rb +198 -0
- data/lib/docusign_esign/models/app_store_receipt.rb +198 -0
- data/lib/docusign_esign/models/approve.rb +506 -0
- data/lib/docusign_esign/models/attachment.rb +248 -0
- data/lib/docusign_esign/models/authentication_method.rb +218 -0
- data/lib/docusign_esign/models/authentication_status.rb +331 -0
- data/lib/docusign_esign/models/bcc_email_address.rb +198 -0
- data/lib/docusign_esign/models/billing_charge.rb +312 -0
- data/lib/docusign_esign/models/billing_charge_response.rb +190 -0
- data/lib/docusign_esign/models/billing_discount.rb +208 -0
- data/lib/docusign_esign/models/billing_invoice.rb +280 -0
- data/lib/docusign_esign/models/billing_invoice_item.rb +228 -0
- data/lib/docusign_esign/models/billing_invoices_response.rb +210 -0
- data/lib/docusign_esign/models/billing_invoices_summary.rb +210 -0
- data/lib/docusign_esign/models/billing_payment.rb +208 -0
- data/lib/docusign_esign/models/billing_payment_item.rb +228 -0
- data/lib/docusign_esign/models/billing_payment_request.rb +188 -0
- data/lib/docusign_esign/models/billing_payment_response.rb +190 -0
- data/lib/docusign_esign/models/billing_payments_response.rb +210 -0
- data/lib/docusign_esign/models/billing_plan.rb +336 -0
- data/lib/docusign_esign/models/billing_plan_information.rb +323 -0
- data/lib/docusign_esign/models/billing_plan_preview.rb +237 -0
- data/lib/docusign_esign/models/billing_plan_response.rb +199 -0
- data/lib/docusign_esign/models/billing_plan_update_response.rb +247 -0
- data/lib/docusign_esign/models/billing_plans_response.rb +190 -0
- data/lib/docusign_esign/models/billing_price.rb +208 -0
- data/lib/docusign_esign/models/brand.rb +313 -0
- data/lib/docusign_esign/models/brand_email_content.rb +218 -0
- data/lib/docusign_esign/models/brand_link.rb +218 -0
- data/lib/docusign_esign/models/brand_logos.rb +208 -0
- data/lib/docusign_esign/models/brand_request.rb +188 -0
- data/lib/docusign_esign/models/brand_resource_urls.rb +218 -0
- data/lib/docusign_esign/models/brand_resources.rb +248 -0
- data/lib/docusign_esign/models/brand_resources_list.rb +190 -0
- data/lib/docusign_esign/models/brands_request.rb +190 -0
- data/lib/docusign_esign/models/brands_response.rb +210 -0
- data/lib/docusign_esign/models/bulk_envelope.rb +267 -0
- data/lib/docusign_esign/models/bulk_envelope_status.rb +320 -0
- data/lib/docusign_esign/models/bulk_envelopes_response.rb +250 -0
- data/lib/docusign_esign/models/bulk_recipient.rb +284 -0
- data/lib/docusign_esign/models/bulk_recipient_signature_provider.rb +198 -0
- data/lib/docusign_esign/models/bulk_recipient_tab_label.rb +198 -0
- data/lib/docusign_esign/models/bulk_recipients_request.rb +190 -0
- data/lib/docusign_esign/models/bulk_recipients_response.rb +250 -0
- data/lib/docusign_esign/models/bulk_recipients_summary_response.rb +222 -0
- data/lib/docusign_esign/models/bulk_recipients_update_response.rb +187 -0
- data/lib/docusign_esign/models/captive_recipient.rb +217 -0
- data/lib/docusign_esign/models/captive_recipient_information.rb +190 -0
- data/lib/docusign_esign/models/carbon_copy.rb +603 -0
- data/lib/docusign_esign/models/certified_delivery.rb +603 -0
- data/lib/docusign_esign/models/checkbox.rb +476 -0
- data/lib/docusign_esign/models/chunked_upload_part.rb +198 -0
- data/lib/docusign_esign/models/chunked_upload_request.rb +198 -0
- data/lib/docusign_esign/models/chunked_upload_response.rb +250 -0
- data/lib/docusign_esign/models/cloud_storage_provider.rb +227 -0
- data/lib/docusign_esign/models/cloud_storage_providers.rb +190 -0
- data/lib/docusign_esign/models/company.rb +566 -0
- data/lib/docusign_esign/models/composite_template.rb +231 -0
- data/lib/docusign_esign/models/connect_config_results.rb +200 -0
- data/lib/docusign_esign/models/connect_custom_configuration.rb +388 -0
- data/lib/docusign_esign/models/connect_debug_log.rb +227 -0
- data/lib/docusign_esign/models/connect_failure_filter.rb +200 -0
- data/lib/docusign_esign/models/connect_failure_result.rb +228 -0
- data/lib/docusign_esign/models/connect_failure_results.rb +190 -0
- data/lib/docusign_esign/models/connect_log.rb +360 -0
- data/lib/docusign_esign/models/connect_logs.rb +222 -0
- data/lib/docusign_esign/models/console_view_request.rb +198 -0
- data/lib/docusign_esign/models/consumer_disclosure.rb +478 -0
- data/lib/docusign_esign/models/contact.rb +269 -0
- data/lib/docusign_esign/models/contact_get_response.rb +250 -0
- data/lib/docusign_esign/models/contact_mod_request.rb +190 -0
- data/lib/docusign_esign/models/contact_update_response.rb +190 -0
- data/lib/docusign_esign/models/correct_view_request.rb +198 -0
- data/lib/docusign_esign/models/country.rb +220 -0
- data/lib/docusign_esign/models/credit_card_information.rb +237 -0
- data/lib/docusign_esign/models/credit_card_types.rb +190 -0
- data/lib/docusign_esign/models/currency_feature_set_price.rb +228 -0
- data/lib/docusign_esign/models/currency_plan_price.rb +237 -0
- data/lib/docusign_esign/models/custom_field_v2.rb +247 -0
- data/lib/docusign_esign/models/custom_fields.rb +202 -0
- data/lib/docusign_esign/models/custom_fields_envelope.rb +202 -0
- data/lib/docusign_esign/models/custom_settings_information.rb +190 -0
- data/lib/docusign_esign/models/date.rb +626 -0
- data/lib/docusign_esign/models/date_signed.rb +496 -0
- data/lib/docusign_esign/models/decline.rb +516 -0
- data/lib/docusign_esign/models/diagnostics_settings_information.rb +208 -0
- data/lib/docusign_esign/models/dob_information_input.rb +208 -0
- data/lib/docusign_esign/models/document.rb +382 -0
- data/lib/docusign_esign/models/document_fields_information.rb +190 -0
- data/lib/docusign_esign/models/document_template.rb +227 -0
- data/lib/docusign_esign/models/document_template_list.rb +190 -0
- data/lib/docusign_esign/models/document_visibility.rb +227 -0
- data/lib/docusign_esign/models/document_visibility_list.rb +190 -0
- data/lib/docusign_esign/models/e_note_configuration.rb +228 -0
- data/lib/docusign_esign/models/editor.rb +591 -0
- data/lib/docusign_esign/models/email.rb +626 -0
- data/lib/docusign_esign/models/email_address.rb +486 -0
- data/lib/docusign_esign/models/email_settings.rb +210 -0
- data/lib/docusign_esign/models/envelope.rb +643 -0
- data/lib/docusign_esign/models/envelope_attachment.rb +237 -0
- data/lib/docusign_esign/models/envelope_attachments_request.rb +190 -0
- data/lib/docusign_esign/models/envelope_attachments_result.rb +190 -0
- data/lib/docusign_esign/models/envelope_audit_event.rb +190 -0
- data/lib/docusign_esign/models/envelope_audit_event_response.rb +190 -0
- data/lib/docusign_esign/models/envelope_definition.rb +740 -0
- data/lib/docusign_esign/models/envelope_document.rb +351 -0
- data/lib/docusign_esign/models/envelope_documents_result.rb +200 -0
- data/lib/docusign_esign/models/envelope_event.rb +198 -0
- data/lib/docusign_esign/models/envelope_form_data.rb +242 -0
- data/lib/docusign_esign/models/envelope_id.rb +486 -0
- data/lib/docusign_esign/models/envelope_ids_request.rb +202 -0
- data/lib/docusign_esign/models/envelope_notification_request.rb +206 -0
- data/lib/docusign_esign/models/envelope_summary.rb +218 -0
- data/lib/docusign_esign/models/envelope_template.rb +664 -0
- data/lib/docusign_esign/models/envelope_template_definition.rb +326 -0
- data/lib/docusign_esign/models/envelope_template_result.rb +784 -0
- data/lib/docusign_esign/models/envelope_template_results.rb +262 -0
- data/lib/docusign_esign/models/envelope_transaction_status.rb +217 -0
- data/lib/docusign_esign/models/envelope_update_summary.rb +260 -0
- data/lib/docusign_esign/models/envelopes_information.rb +262 -0
- data/lib/docusign_esign/models/error_details.rb +198 -0
- data/lib/docusign_esign/models/event_notification.rb +332 -0
- data/lib/docusign_esign/models/event_result.rb +218 -0
- data/lib/docusign_esign/models/expirations.rb +208 -0
- data/lib/docusign_esign/models/external_doc_service_error_details.rb +208 -0
- data/lib/docusign_esign/models/external_file.rb +258 -0
- data/lib/docusign_esign/models/external_folder.rb +279 -0
- data/lib/docusign_esign/models/feature_set.rb +270 -0
- data/lib/docusign_esign/models/file_type.rb +198 -0
- data/lib/docusign_esign/models/file_type_list.rb +190 -0
- data/lib/docusign_esign/models/filter.rb +288 -0
- data/lib/docusign_esign/models/first_name.rb +486 -0
- data/lib/docusign_esign/models/folder.rb +298 -0
- data/lib/docusign_esign/models/folder_item.rb +390 -0
- data/lib/docusign_esign/models/folder_item_response.rb +250 -0
- data/lib/docusign_esign/models/folder_item_v2.rb +377 -0
- data/lib/docusign_esign/models/folder_items_response.rb +250 -0
- data/lib/docusign_esign/models/folders_request.rb +200 -0
- data/lib/docusign_esign/models/folders_response.rb +190 -0
- data/lib/docusign_esign/models/forgotten_password_information.rb +258 -0
- data/lib/docusign_esign/models/formula_tab.rb +665 -0
- data/lib/docusign_esign/models/full_name.rb +486 -0
- data/lib/docusign_esign/models/group.rb +239 -0
- data/lib/docusign_esign/models/group_information.rb +250 -0
- data/lib/docusign_esign/models/id_check_information_input.rb +214 -0
- data/lib/docusign_esign/models/in_person_signer.rb +729 -0
- data/lib/docusign_esign/models/initial_here.rb +446 -0
- data/lib/docusign_esign/models/inline_template.rb +227 -0
- data/lib/docusign_esign/models/integrated_user_info_list.rb +260 -0
- data/lib/docusign_esign/models/intermediary.rb +603 -0
- data/lib/docusign_esign/models/last_name.rb +486 -0
- data/lib/docusign_esign/models/list.rb +568 -0
- data/lib/docusign_esign/models/list_custom_field.rb +259 -0
- data/lib/docusign_esign/models/list_item.rb +208 -0
- data/lib/docusign_esign/models/lock_information.rb +256 -0
- data/lib/docusign_esign/models/lock_request.rb +228 -0
- data/lib/docusign_esign/models/login_account.rb +292 -0
- data/lib/docusign_esign/models/login_information.rb +200 -0
- data/lib/docusign_esign/models/match_box.rb +228 -0
- data/lib/docusign_esign/models/member_group_shared_item.rb +206 -0
- data/lib/docusign_esign/models/member_shared_items.rb +220 -0
- data/lib/docusign_esign/models/merge_field.rb +228 -0
- data/lib/docusign_esign/models/mobile_notifier_configuration.rb +207 -0
- data/lib/docusign_esign/models/mobile_notifier_configuration_information.rb +190 -0
- data/lib/docusign_esign/models/money.rb +208 -0
- data/lib/docusign_esign/models/name_value.rb +217 -0
- data/lib/docusign_esign/models/new_account_definition.rb +274 -0
- data/lib/docusign_esign/models/new_account_summary.rb +247 -0
- data/lib/docusign_esign/models/new_user.rb +277 -0
- data/lib/docusign_esign/models/new_users_definition.rb +190 -0
- data/lib/docusign_esign/models/new_users_summary.rb +190 -0
- data/lib/docusign_esign/models/notary_host.rb +577 -0
- data/lib/docusign_esign/models/note.rb +526 -0
- data/lib/docusign_esign/models/notification.rb +206 -0
- data/lib/docusign_esign/models/number.rb +646 -0
- data/lib/docusign_esign/models/oauth_access.rb +240 -0
- data/lib/docusign_esign/models/offline_attributes.rb +238 -0
- data/lib/docusign_esign/models/page.rb +257 -0
- data/lib/docusign_esign/models/page_images.rb +250 -0
- data/lib/docusign_esign/models/page_request.rb +198 -0
- data/lib/docusign_esign/models/payment_details.rb +229 -0
- data/lib/docusign_esign/models/payment_line_item.rb +218 -0
- data/lib/docusign_esign/models/permission_profile.rb +249 -0
- data/lib/docusign_esign/models/permission_profile_information.rb +190 -0
- data/lib/docusign_esign/models/plan_information.rb +244 -0
- data/lib/docusign_esign/models/post_transactions_request.rb +218 -0
- data/lib/docusign_esign/models/post_transactions_response.rb +198 -0
- data/lib/docusign_esign/models/power_form.rb +421 -0
- data/lib/docusign_esign/models/power_form_form_data_envelope.rb +200 -0
- data/lib/docusign_esign/models/power_form_form_data_recipient.rb +220 -0
- data/lib/docusign_esign/models/power_form_recipient.rb +308 -0
- data/lib/docusign_esign/models/power_form_senders_response.rb +250 -0
- data/lib/docusign_esign/models/power_forms_form_data_response.rb +190 -0
- data/lib/docusign_esign/models/power_forms_request.rb +190 -0
- data/lib/docusign_esign/models/power_forms_response.rb +250 -0
- data/lib/docusign_esign/models/property_metadata.rb +200 -0
- data/lib/docusign_esign/models/province.rb +198 -0
- data/lib/docusign_esign/models/provisioning_information.rb +248 -0
- data/lib/docusign_esign/models/purchased_envelopes_information.rb +268 -0
- data/lib/docusign_esign/models/radio.rb +357 -0
- data/lib/docusign_esign/models/radio_group.rb +270 -0
- data/lib/docusign_esign/models/recipient_attachment.rb +238 -0
- data/lib/docusign_esign/models/recipient_domain.rb +218 -0
- data/lib/docusign_esign/models/recipient_email_notification.rb +208 -0
- data/lib/docusign_esign/models/recipient_event.rb +198 -0
- data/lib/docusign_esign/models/recipient_form_data.rb +260 -0
- data/lib/docusign_esign/models/recipient_names_response.rb +210 -0
- data/lib/docusign_esign/models/recipient_phone_authentication.rb +220 -0
- data/lib/docusign_esign/models/recipient_saml_authentication.rb +190 -0
- data/lib/docusign_esign/models/recipient_signature_information.rb +208 -0
- data/lib/docusign_esign/models/recipient_signature_provider.rb +197 -0
- data/lib/docusign_esign/models/recipient_signature_provider_options.rb +218 -0
- data/lib/docusign_esign/models/recipient_sms_authentication.rb +190 -0
- data/lib/docusign_esign/models/recipient_update_response.rb +206 -0
- data/lib/docusign_esign/models/recipient_view_request.rb +318 -0
- data/lib/docusign_esign/models/recipients.rb +291 -0
- data/lib/docusign_esign/models/recipients_update_summary.rb +190 -0
- data/lib/docusign_esign/models/referral_information.rb +358 -0
- data/lib/docusign_esign/models/reminders.rb +208 -0
- data/lib/docusign_esign/models/resource_information.rb +190 -0
- data/lib/docusign_esign/models/return_url_request.rb +188 -0
- data/lib/docusign_esign/models/saml_assertion_attribute.rb +217 -0
- data/lib/docusign_esign/models/seat_discount.rb +208 -0
- data/lib/docusign_esign/models/sender_email_notifications.rb +248 -0
- data/lib/docusign_esign/models/server_template.rb +198 -0
- data/lib/docusign_esign/models/service_information.rb +242 -0
- data/lib/docusign_esign/models/service_version.rb +198 -0
- data/lib/docusign_esign/models/settings_metadata.rb +240 -0
- data/lib/docusign_esign/models/shared_item.rb +206 -0
- data/lib/docusign_esign/models/sign_here.rb +446 -0
- data/lib/docusign_esign/models/signature_provider_required_option.rb +200 -0
- data/lib/docusign_esign/models/signature_type.rb +198 -0
- data/lib/docusign_esign/models/signer.rb +742 -0
- data/lib/docusign_esign/models/signer_attachment.rb +446 -0
- data/lib/docusign_esign/models/signer_email_notifications.rb +318 -0
- data/lib/docusign_esign/models/signing_group.rb +279 -0
- data/lib/docusign_esign/models/signing_group_information.rb +190 -0
- data/lib/docusign_esign/models/signing_group_user.rb +207 -0
- data/lib/docusign_esign/models/signing_group_users.rb +190 -0
- data/lib/docusign_esign/models/social_account_information.rb +227 -0
- data/lib/docusign_esign/models/social_authentication.rb +188 -0
- data/lib/docusign_esign/models/ssn.rb +626 -0
- data/lib/docusign_esign/models/ssn4_information_input.rb +208 -0
- data/lib/docusign_esign/models/ssn9_information_input.rb +198 -0
- data/lib/docusign_esign/models/tab_account_settings.rb +539 -0
- data/lib/docusign_esign/models/tab_metadata.rb +569 -0
- data/lib/docusign_esign/models/tab_metadata_list.rb +190 -0
- data/lib/docusign_esign/models/tabs.rb +478 -0
- data/lib/docusign_esign/models/template_custom_fields.rb +202 -0
- data/lib/docusign_esign/models/template_document_visibility_list.rb +190 -0
- data/lib/docusign_esign/models/template_documents_result.rb +200 -0
- data/lib/docusign_esign/models/template_information.rb +190 -0
- data/lib/docusign_esign/models/template_match.rb +208 -0
- data/lib/docusign_esign/models/template_notification_request.rb +216 -0
- data/lib/docusign_esign/models/template_recipients.rb +291 -0
- data/lib/docusign_esign/models/template_role.rb +296 -0
- data/lib/docusign_esign/models/template_shared_item.rb +250 -0
- data/lib/docusign_esign/models/template_summary.rb +247 -0
- data/lib/docusign_esign/models/template_tabs.rb +478 -0
- data/lib/docusign_esign/models/template_update_summary.rb +260 -0
- data/lib/docusign_esign/models/text.rb +656 -0
- data/lib/docusign_esign/models/text_custom_field.rb +247 -0
- data/lib/docusign_esign/models/title.rb +566 -0
- data/lib/docusign_esign/models/usage_history.rb +218 -0
- data/lib/docusign_esign/models/user_account_management_granular_information.rb +254 -0
- data/lib/docusign_esign/models/user_info.rb +277 -0
- data/lib/docusign_esign/models/user_info_list.rb +190 -0
- data/lib/docusign_esign/models/user_information.rb +519 -0
- data/lib/docusign_esign/models/user_information_list.rb +250 -0
- data/lib/docusign_esign/models/user_password_information.rb +217 -0
- data/lib/docusign_esign/models/user_profile.rb +297 -0
- data/lib/docusign_esign/models/user_settings_information.rb +217 -0
- data/lib/docusign_esign/models/user_shared_item.rb +206 -0
- data/lib/docusign_esign/models/user_signature.rb +307 -0
- data/lib/docusign_esign/models/user_signature_definition.rb +218 -0
- data/lib/docusign_esign/models/user_signatures_information.rb +190 -0
- data/lib/docusign_esign/models/user_social_id_result.rb +200 -0
- data/lib/docusign_esign/models/users_response.rb +250 -0
- data/lib/docusign_esign/models/view.rb +526 -0
- data/lib/docusign_esign/models/view_link_request.rb +198 -0
- data/lib/docusign_esign/models/view_url.rb +188 -0
- data/lib/docusign_esign/models/workspace.rb +286 -0
- data/lib/docusign_esign/models/workspace_folder_contents.rb +261 -0
- data/lib/docusign_esign/models/workspace_item.rb +365 -0
- data/lib/docusign_esign/models/workspace_item_list.rb +190 -0
- data/lib/docusign_esign/models/workspace_list.rb +230 -0
- data/lib/docusign_esign/models/workspace_user.rb +337 -0
- data/lib/docusign_esign/models/workspace_user_authorization.rb +286 -0
- data/lib/docusign_esign/models/zip.rb +636 -0
- data/lib/docusign_esign/version.rb +14 -0
- data/lib/docusign_esign.rb +360 -0
- data/spec/api/accounts_api_spec.rb +556 -0
- data/spec/api/authentication_api_spec.rb +125 -0
- data/spec/api/billing_api_spec.rb +178 -0
- data/spec/api/bulk_envelopes_api_spec.rb +110 -0
- data/spec/api/cloud_storage_api_spec.rb +146 -0
- data/spec/api/connect_api_spec.rb +261 -0
- data/spec/api/custom_tabs_api_spec.rb +100 -0
- data/spec/api/diagnostics_api_spec.rb +114 -0
- data/spec/api/envelopes_api_spec.rb +1171 -0
- data/spec/api/folders_api_spec.rb +107 -0
- data/spec/api/groups_api_spec.rb +174 -0
- data/spec/api/power_forms_api_spec.rb +144 -0
- data/spec/api/signing_groups_api_spec.rb +155 -0
- data/spec/api/templates_api_spec.rb +649 -0
- data/spec/api/users_api_spec.rb +442 -0
- data/spec/api/workspaces_api_spec.rb +201 -0
- data/spec/api_client_spec.rb +225 -0
- data/spec/configuration_spec.rb +41 -0
- data/spec/models/account_address_spec.rb +107 -0
- data/spec/models/account_billing_plan_response_spec.rb +71 -0
- data/spec/models/account_billing_plan_spec.rb +155 -0
- data/spec/models/account_information_spec.rb +221 -0
- data/spec/models/account_role_settings_spec.rb +419 -0
- data/spec/models/account_settings_information_spec.rb +41 -0
- data/spec/models/account_shared_access_spec.rb +89 -0
- data/spec/models/account_signature_provider_option_spec.rb +53 -0
- data/spec/models/account_signature_provider_spec.rb +77 -0
- data/spec/models/account_signature_providers_spec.rb +41 -0
- data/spec/models/add_on_spec.rb +59 -0
- data/spec/models/address_information_input_spec.rb +53 -0
- data/spec/models/address_information_spec.rb +83 -0
- data/spec/models/address_information_v2_spec.rb +83 -0
- data/spec/models/agent_spec.rb +287 -0
- data/spec/models/api_request_log_spec.rb +59 -0
- data/spec/models/api_request_logs_result_spec.rb +41 -0
- data/spec/models/app_store_product_spec.rb +47 -0
- data/spec/models/app_store_receipt_spec.rb +47 -0
- data/spec/models/approve_spec.rb +233 -0
- data/spec/models/attachment_spec.rb +77 -0
- data/spec/models/authentication_method_spec.rb +59 -0
- data/spec/models/authentication_status_spec.rb +137 -0
- data/spec/models/bcc_email_address_spec.rb +47 -0
- data/spec/models/billing_charge_response_spec.rb +41 -0
- data/spec/models/billing_charge_spec.rb +113 -0
- data/spec/models/billing_discount_spec.rb +53 -0
- data/spec/models/billing_invoice_item_spec.rb +65 -0
- data/spec/models/billing_invoice_spec.rb +95 -0
- data/spec/models/billing_invoices_response_spec.rb +53 -0
- data/spec/models/billing_invoices_summary_spec.rb +53 -0
- data/spec/models/billing_payment_item_spec.rb +65 -0
- data/spec/models/billing_payment_request_spec.rb +41 -0
- data/spec/models/billing_payment_response_spec.rb +41 -0
- data/spec/models/billing_payment_spec.rb +53 -0
- data/spec/models/billing_payments_response_spec.rb +53 -0
- data/spec/models/billing_plan_information_spec.rb +125 -0
- data/spec/models/billing_plan_preview_spec.rb +71 -0
- data/spec/models/billing_plan_response_spec.rb +47 -0
- data/spec/models/billing_plan_spec.rb +125 -0
- data/spec/models/billing_plan_update_response_spec.rb +77 -0
- data/spec/models/billing_plans_response_spec.rb +41 -0
- data/spec/models/billing_price_spec.rb +53 -0
- data/spec/models/brand_email_content_spec.rb +59 -0
- data/spec/models/brand_link_spec.rb +59 -0
- data/spec/models/brand_logos_spec.rb +53 -0
- data/spec/models/brand_request_spec.rb +41 -0
- data/spec/models/brand_resource_urls_spec.rb +59 -0
- data/spec/models/brand_resources_list_spec.rb +41 -0
- data/spec/models/brand_resources_spec.rb +77 -0
- data/spec/models/brand_spec.rb +113 -0
- data/spec/models/brands_request_spec.rb +41 -0
- data/spec/models/brands_response_spec.rb +53 -0
- data/spec/models/bulk_envelope_spec.rb +89 -0
- data/spec/models/bulk_envelope_status_spec.rb +119 -0
- data/spec/models/bulk_envelopes_response_spec.rb +77 -0
- data/spec/models/bulk_recipient_signature_provider_spec.rb +47 -0
- data/spec/models/bulk_recipient_spec.rb +95 -0
- data/spec/models/bulk_recipient_tab_label_spec.rb +47 -0
- data/spec/models/bulk_recipients_request_spec.rb +41 -0
- data/spec/models/bulk_recipients_response_spec.rb +77 -0
- data/spec/models/bulk_recipients_summary_response_spec.rb +59 -0
- data/spec/models/bulk_recipients_update_response_spec.rb +41 -0
- data/spec/models/captive_recipient_information_spec.rb +41 -0
- data/spec/models/captive_recipient_spec.rb +59 -0
- data/spec/models/carbon_copy_spec.rb +287 -0
- data/spec/models/certified_delivery_spec.rb +287 -0
- data/spec/models/checkbox_spec.rb +215 -0
- data/spec/models/chunked_upload_part_spec.rb +47 -0
- data/spec/models/chunked_upload_request_spec.rb +47 -0
- data/spec/models/chunked_upload_response_spec.rb +77 -0
- data/spec/models/cloud_storage_provider_spec.rb +65 -0
- data/spec/models/cloud_storage_providers_spec.rb +41 -0
- data/spec/models/company_spec.rb +269 -0
- data/spec/models/composite_template_spec.rb +65 -0
- data/spec/models/connect_config_results_spec.rb +47 -0
- data/spec/models/connect_custom_configuration_spec.rb +161 -0
- data/spec/models/connect_debug_log_spec.rb +65 -0
- data/spec/models/connect_failure_filter_spec.rb +47 -0
- data/spec/models/connect_failure_result_spec.rb +65 -0
- data/spec/models/connect_failure_results_spec.rb +41 -0
- data/spec/models/connect_log_spec.rb +143 -0
- data/spec/models/connect_logs_spec.rb +59 -0
- data/spec/models/console_view_request_spec.rb +47 -0
- data/spec/models/consumer_disclosure_spec.rb +215 -0
- data/spec/models/contact_get_response_spec.rb +77 -0
- data/spec/models/contact_mod_request_spec.rb +41 -0
- data/spec/models/contact_spec.rb +89 -0
- data/spec/models/contact_update_response_spec.rb +41 -0
- data/spec/models/correct_view_request_spec.rb +47 -0
- data/spec/models/country_spec.rb +59 -0
- data/spec/models/credit_card_information_spec.rb +71 -0
- data/spec/models/credit_card_types_spec.rb +41 -0
- data/spec/models/currency_feature_set_price_spec.rb +65 -0
- data/spec/models/currency_plan_price_spec.rb +71 -0
- data/spec/models/custom_field_v2_spec.rb +77 -0
- data/spec/models/custom_fields_envelope_spec.rb +47 -0
- data/spec/models/custom_fields_spec.rb +47 -0
- data/spec/models/custom_settings_information_spec.rb +41 -0
- data/spec/models/date_signed_spec.rb +227 -0
- data/spec/models/date_spec.rb +305 -0
- data/spec/models/decline_spec.rb +239 -0
- data/spec/models/diagnostics_settings_information_spec.rb +53 -0
- data/spec/models/dob_information_input_spec.rb +53 -0
- data/spec/models/document_fields_information_spec.rb +41 -0
- data/spec/models/document_spec.rb +155 -0
- data/spec/models/document_template_list_spec.rb +41 -0
- data/spec/models/document_template_spec.rb +65 -0
- data/spec/models/document_visibility_list_spec.rb +41 -0
- data/spec/models/document_visibility_spec.rb +65 -0
- data/spec/models/e_note_configuration_spec.rb +65 -0
- data/spec/models/editor_spec.rb +281 -0
- data/spec/models/email_address_spec.rb +221 -0
- data/spec/models/email_settings_spec.rb +53 -0
- data/spec/models/email_spec.rb +305 -0
- data/spec/models/envelope_attachment_spec.rb +71 -0
- data/spec/models/envelope_attachments_request_spec.rb +41 -0
- data/spec/models/envelope_attachments_result_spec.rb +41 -0
- data/spec/models/envelope_audit_event_response_spec.rb +41 -0
- data/spec/models/envelope_audit_event_spec.rb +41 -0
- data/spec/models/envelope_definition_spec.rb +371 -0
- data/spec/models/envelope_document_spec.rb +137 -0
- data/spec/models/envelope_documents_result_spec.rb +47 -0
- data/spec/models/envelope_event_spec.rb +47 -0
- data/spec/models/envelope_form_data_spec.rb +71 -0
- data/spec/models/envelope_id_spec.rb +221 -0
- data/spec/models/envelope_ids_request_spec.rb +47 -0
- data/spec/models/envelope_notification_request_spec.rb +53 -0
- data/spec/models/envelope_spec.rb +317 -0
- data/spec/models/envelope_summary_spec.rb +59 -0
- data/spec/models/envelope_template_definition_spec.rb +125 -0
- data/spec/models/envelope_template_result_spec.rb +401 -0
- data/spec/models/envelope_template_results_spec.rb +83 -0
- data/spec/models/envelope_template_spec.rb +329 -0
- data/spec/models/envelope_transaction_status_spec.rb +59 -0
- data/spec/models/envelope_update_summary_spec.rb +83 -0
- data/spec/models/envelopes_information_spec.rb +83 -0
- data/spec/models/error_details_spec.rb +47 -0
- data/spec/models/event_notification_spec.rb +125 -0
- data/spec/models/event_result_spec.rb +59 -0
- data/spec/models/expirations_spec.rb +53 -0
- data/spec/models/external_doc_service_error_details_spec.rb +53 -0
- data/spec/models/external_file_spec.rb +83 -0
- data/spec/models/external_folder_spec.rb +95 -0
- data/spec/models/feature_set_spec.rb +89 -0
- data/spec/models/file_type_list_spec.rb +41 -0
- data/spec/models/file_type_spec.rb +47 -0
- data/spec/models/filter_spec.rb +101 -0
- data/spec/models/first_name_spec.rb +221 -0
- data/spec/models/folder_item_response_spec.rb +77 -0
- data/spec/models/folder_item_spec.rb +161 -0
- data/spec/models/folder_item_v2_spec.rb +155 -0
- data/spec/models/folder_items_response_spec.rb +77 -0
- data/spec/models/folder_spec.rb +107 -0
- data/spec/models/folders_request_spec.rb +47 -0
- data/spec/models/folders_response_spec.rb +41 -0
- data/spec/models/forgotten_password_information_spec.rb +83 -0
- data/spec/models/formula_tab_spec.rb +329 -0
- data/spec/models/full_name_spec.rb +221 -0
- data/spec/models/group_information_spec.rb +77 -0
- data/spec/models/group_spec.rb +71 -0
- data/spec/models/id_check_information_input_spec.rb +59 -0
- data/spec/models/in_person_signer_spec.rb +365 -0
- data/spec/models/initial_here_spec.rb +197 -0
- data/spec/models/inline_template_spec.rb +65 -0
- data/spec/models/integrated_user_info_list_spec.rb +83 -0
- data/spec/models/intermediary_spec.rb +287 -0
- data/spec/models/last_name_spec.rb +221 -0
- data/spec/models/list_custom_field_spec.rb +83 -0
- data/spec/models/list_item_spec.rb +53 -0
- data/spec/models/list_spec.rb +269 -0
- data/spec/models/lock_information_spec.rb +83 -0
- data/spec/models/lock_request_spec.rb +65 -0
- data/spec/models/login_account_spec.rb +101 -0
- data/spec/models/login_information_spec.rb +47 -0
- data/spec/models/match_box_spec.rb +65 -0
- data/spec/models/member_group_shared_item_spec.rb +53 -0
- data/spec/models/member_shared_items_spec.rb +59 -0
- data/spec/models/merge_field_spec.rb +65 -0
- data/spec/models/mobile_notifier_configuration_information_spec.rb +41 -0
- data/spec/models/mobile_notifier_configuration_spec.rb +53 -0
- data/spec/models/money_spec.rb +53 -0
- data/spec/models/name_value_spec.rb +59 -0
- data/spec/models/new_account_definition_spec.rb +95 -0
- data/spec/models/new_account_summary_spec.rb +77 -0
- data/spec/models/new_user_spec.rb +95 -0
- data/spec/models/new_users_definition_spec.rb +41 -0
- data/spec/models/new_users_summary_spec.rb +41 -0
- data/spec/models/notary_host_spec.rb +275 -0
- data/spec/models/note_spec.rb +245 -0
- data/spec/models/notification_spec.rb +53 -0
- data/spec/models/number_spec.rb +317 -0
- data/spec/models/oauth_access_spec.rb +71 -0
- data/spec/models/offline_attributes_spec.rb +71 -0
- data/spec/models/page_images_spec.rb +77 -0
- data/spec/models/page_request_spec.rb +47 -0
- data/spec/models/page_spec.rb +83 -0
- data/spec/models/payment_details_spec.rb +65 -0
- data/spec/models/payment_line_item_spec.rb +59 -0
- data/spec/models/permission_profile_information_spec.rb +41 -0
- data/spec/models/permission_profile_spec.rb +77 -0
- data/spec/models/plan_information_spec.rb +71 -0
- data/spec/models/post_transactions_request_spec.rb +59 -0
- data/spec/models/post_transactions_response_spec.rb +47 -0
- data/spec/models/power_form_form_data_envelope_spec.rb +47 -0
- data/spec/models/power_form_form_data_recipient_spec.rb +59 -0
- data/spec/models/power_form_recipient_spec.rb +113 -0
- data/spec/models/power_form_senders_response_spec.rb +77 -0
- data/spec/models/power_form_spec.rb +179 -0
- data/spec/models/power_forms_form_data_response_spec.rb +41 -0
- data/spec/models/power_forms_request_spec.rb +41 -0
- data/spec/models/power_forms_response_spec.rb +77 -0
- data/spec/models/property_metadata_spec.rb +47 -0
- data/spec/models/province_spec.rb +47 -0
- data/spec/models/provisioning_information_spec.rb +77 -0
- data/spec/models/purchased_envelopes_information_spec.rb +89 -0
- data/spec/models/radio_group_spec.rb +89 -0
- data/spec/models/radio_spec.rb +143 -0
- data/spec/models/recipient_attachment_spec.rb +71 -0
- data/spec/models/recipient_domain_spec.rb +59 -0
- data/spec/models/recipient_email_notification_spec.rb +53 -0
- data/spec/models/recipient_event_spec.rb +47 -0
- data/spec/models/recipient_form_data_spec.rb +83 -0
- data/spec/models/recipient_names_response_spec.rb +53 -0
- data/spec/models/recipient_phone_authentication_spec.rb +59 -0
- data/spec/models/recipient_saml_authentication_spec.rb +41 -0
- data/spec/models/recipient_signature_information_spec.rb +53 -0
- data/spec/models/recipient_signature_provider_options_spec.rb +59 -0
- data/spec/models/recipient_signature_provider_spec.rb +47 -0
- data/spec/models/recipient_sms_authentication_spec.rb +41 -0
- data/spec/models/recipient_update_response_spec.rb +53 -0
- data/spec/models/recipient_view_request_spec.rb +119 -0
- data/spec/models/recipients_spec.rb +95 -0
- data/spec/models/recipients_update_summary_spec.rb +41 -0
- data/spec/models/referral_information_spec.rb +143 -0
- data/spec/models/reminders_spec.rb +53 -0
- data/spec/models/resource_information_spec.rb +41 -0
- data/spec/models/return_url_request_spec.rb +41 -0
- data/spec/models/saml_assertion_attribute_spec.rb +59 -0
- data/spec/models/seat_discount_spec.rb +53 -0
- data/spec/models/sender_email_notifications_spec.rb +77 -0
- data/spec/models/server_template_spec.rb +47 -0
- data/spec/models/service_information_spec.rb +71 -0
- data/spec/models/service_version_spec.rb +47 -0
- data/spec/models/settings_metadata_spec.rb +71 -0
- data/spec/models/shared_item_spec.rb +53 -0
- data/spec/models/sign_here_spec.rb +197 -0
- data/spec/models/signature_provider_required_option_spec.rb +47 -0
- data/spec/models/signature_type_spec.rb +47 -0
- data/spec/models/signer_attachment_spec.rb +197 -0
- data/spec/models/signer_email_notifications_spec.rb +119 -0
- data/spec/models/signer_spec.rb +371 -0
- data/spec/models/signing_group_information_spec.rb +41 -0
- data/spec/models/signing_group_spec.rb +95 -0
- data/spec/models/signing_group_user_spec.rb +53 -0
- data/spec/models/signing_group_users_spec.rb +41 -0
- data/spec/models/social_account_information_spec.rb +65 -0
- data/spec/models/social_authentication_spec.rb +41 -0
- data/spec/models/ssn4_information_input_spec.rb +53 -0
- data/spec/models/ssn9_information_input_spec.rb +47 -0
- data/spec/models/ssn_spec.rb +305 -0
- data/spec/models/tab_account_settings_spec.rb +263 -0
- data/spec/models/tab_metadata_list_spec.rb +41 -0
- data/spec/models/tab_metadata_spec.rb +269 -0
- data/spec/models/tabs_spec.rb +185 -0
- data/spec/models/template_custom_fields_spec.rb +47 -0
- data/spec/models/template_document_visibility_list_spec.rb +41 -0
- data/spec/models/template_documents_result_spec.rb +47 -0
- data/spec/models/template_information_spec.rb +41 -0
- data/spec/models/template_match_spec.rb +53 -0
- data/spec/models/template_notification_request_spec.rb +59 -0
- data/spec/models/template_recipients_spec.rb +95 -0
- data/spec/models/template_role_spec.rb +107 -0
- data/spec/models/template_shared_item_spec.rb +77 -0
- data/spec/models/template_summary_spec.rb +77 -0
- data/spec/models/template_tabs_spec.rb +185 -0
- data/spec/models/template_update_summary_spec.rb +83 -0
- data/spec/models/text_custom_field_spec.rb +77 -0
- data/spec/models/text_spec.rb +323 -0
- data/spec/models/title_spec.rb +269 -0
- data/spec/models/usage_history_spec.rb +59 -0
- data/spec/models/user_account_management_granular_information_spec.rb +83 -0
- data/spec/models/user_info_list_spec.rb +41 -0
- data/spec/models/user_info_spec.rb +95 -0
- data/spec/models/user_information_list_spec.rb +77 -0
- data/spec/models/user_information_spec.rb +239 -0
- data/spec/models/user_password_information_spec.rb +59 -0
- data/spec/models/user_profile_spec.rb +107 -0
- data/spec/models/user_settings_information_spec.rb +59 -0
- data/spec/models/user_shared_item_spec.rb +53 -0
- data/spec/models/user_signature_definition_spec.rb +59 -0
- data/spec/models/user_signature_spec.rb +113 -0
- data/spec/models/user_signatures_information_spec.rb +41 -0
- data/spec/models/user_social_id_result_spec.rb +47 -0
- data/spec/models/users_response_spec.rb +77 -0
- data/spec/models/view_link_request_spec.rb +47 -0
- data/spec/models/view_spec.rb +245 -0
- data/spec/models/view_url_spec.rb +41 -0
- data/spec/models/workspace_folder_contents_spec.rb +83 -0
- data/spec/models/workspace_item_list_spec.rb +41 -0
- data/spec/models/workspace_item_spec.rb +149 -0
- data/spec/models/workspace_list_spec.rb +65 -0
- data/spec/models/workspace_spec.rb +101 -0
- data/spec/models/workspace_user_authorization_spec.rb +101 -0
- data/spec/models/workspace_user_spec.rb +131 -0
- data/spec/models/zip_spec.rb +311 -0
- data/spec/spec_helper.rb +110 -0
- data/tests/.DS_Store +0 -0
- data/tests/Gemfile +5 -0
- data/tests/Gemfile.lock +42 -0
- data/tests/docs/Test.pdf +0 -0
- data/tests/rsa_keys/private.pem +27 -0
- data/tests/rsa_keys/public.pem +9 -0
- data/tests/spec/unit_tests_spec.rb +360 -0
- data/tests/spec/unit_tests_using_jwt_spec.rb +361 -0
- metadata +1560 -0
|
@@ -0,0 +1,719 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#DocuSign REST API
|
|
3
|
+
|
|
4
|
+
#The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
|
|
5
|
+
|
|
6
|
+
OpenAPI spec version: v2
|
|
7
|
+
Contact: devcenter@docusign.com
|
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
9
|
+
|
|
10
|
+
=end
|
|
11
|
+
|
|
12
|
+
require "uri"
|
|
13
|
+
|
|
14
|
+
module DocuSign_eSign
|
|
15
|
+
|
|
16
|
+
class GetWorkspaceFileOptions
|
|
17
|
+
# When set to **true**, the Content-Disposition header is set in the response. The value of the header provides the filename of the file. Default is **false**.
|
|
18
|
+
attr_accessor :is_download
|
|
19
|
+
|
|
20
|
+
# When set to **true** the file returned as a PDF.
|
|
21
|
+
attr_accessor :pdf_version
|
|
22
|
+
|
|
23
|
+
def self.default
|
|
24
|
+
@@default ||= GetWorkspaceFileOptions.new
|
|
25
|
+
end
|
|
26
|
+
end
|
|
27
|
+
|
|
28
|
+
class ListWorkspaceFilePagesOptions
|
|
29
|
+
# The maximum number of results to be returned by this request.
|
|
30
|
+
attr_accessor :count
|
|
31
|
+
|
|
32
|
+
# Number of dots per inch for the resulting image. The default if not used is 94. The range is 1-310.
|
|
33
|
+
attr_accessor :dpi
|
|
34
|
+
|
|
35
|
+
# Sets the maximum height (in pixels) of the returned image.
|
|
36
|
+
attr_accessor :max_height
|
|
37
|
+
|
|
38
|
+
# Sets the maximum width (in pixels) of the returned image.
|
|
39
|
+
attr_accessor :max_width
|
|
40
|
+
|
|
41
|
+
# The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.
|
|
42
|
+
attr_accessor :start_position
|
|
43
|
+
|
|
44
|
+
def self.default
|
|
45
|
+
@@default ||= ListWorkspaceFilePagesOptions.new
|
|
46
|
+
end
|
|
47
|
+
end
|
|
48
|
+
|
|
49
|
+
class ListWorkspaceFolderItemsOptions
|
|
50
|
+
# The maximum number of results to be returned by this request.
|
|
51
|
+
attr_accessor :count
|
|
52
|
+
|
|
53
|
+
# When set to **true**, file information is returned in the response along with folder information. The default is **false**.
|
|
54
|
+
attr_accessor :include_files
|
|
55
|
+
|
|
56
|
+
# When set to **true**, information about the sub-folders of the current folder is returned. The default is **false**.
|
|
57
|
+
attr_accessor :include_sub_folders
|
|
58
|
+
|
|
59
|
+
# When set to **true**, thumbnails are returned as part of the response. The default is **false**.
|
|
60
|
+
attr_accessor :include_thumbnails
|
|
61
|
+
|
|
62
|
+
# Set to **true** to return extended details about the user. The default is **false**.
|
|
63
|
+
attr_accessor :include_user_detail
|
|
64
|
+
|
|
65
|
+
# The position within the total result set from which to start returning values.
|
|
66
|
+
attr_accessor :start_position
|
|
67
|
+
|
|
68
|
+
# If set, then the results are filtered to those associated with the specified userId.
|
|
69
|
+
attr_accessor :workspace_user_id
|
|
70
|
+
|
|
71
|
+
def self.default
|
|
72
|
+
@@default ||= ListWorkspaceFolderItemsOptions.new
|
|
73
|
+
end
|
|
74
|
+
end
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
class WorkspacesApi
|
|
78
|
+
attr_accessor :api_client
|
|
79
|
+
|
|
80
|
+
def initialize(api_client = WorkspacesApi.default)
|
|
81
|
+
@api_client = api_client
|
|
82
|
+
end
|
|
83
|
+
|
|
84
|
+
# Create a Workspace
|
|
85
|
+
# Creates a new workspace.
|
|
86
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
87
|
+
# @param workspace (optional parameter)
|
|
88
|
+
# @return [Workspace]
|
|
89
|
+
def create_workspace(account_id, workspace)
|
|
90
|
+
data, _status_code, _headers = create_workspace_with_http_info(account_id, workspace)
|
|
91
|
+
return data
|
|
92
|
+
end
|
|
93
|
+
|
|
94
|
+
# Create a Workspace
|
|
95
|
+
# Creates a new workspace.
|
|
96
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
97
|
+
# @param workspace (optional parameter)
|
|
98
|
+
# @return [Array<(Workspace, Fixnum, Hash)>] Workspace data, response status code and response headers
|
|
99
|
+
def create_workspace_with_http_info(account_id, workspace)
|
|
100
|
+
if @api_client.config.debugging
|
|
101
|
+
@api_client.config.logger.debug "Calling API: WorkspacesApi.create_workspace ..."
|
|
102
|
+
end
|
|
103
|
+
# verify the required parameter 'account_id' is set
|
|
104
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling WorkspacesApi.create_workspace" if account_id.nil?
|
|
105
|
+
# resource path
|
|
106
|
+
local_var_path = "/v2/accounts/{accountId}/workspaces".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
|
107
|
+
|
|
108
|
+
# query parameters
|
|
109
|
+
query_params = {}
|
|
110
|
+
|
|
111
|
+
# header parameters
|
|
112
|
+
header_params = {}
|
|
113
|
+
# HTTP header 'Accept' (if needed)
|
|
114
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
115
|
+
|
|
116
|
+
# form parameters
|
|
117
|
+
form_params = {}
|
|
118
|
+
|
|
119
|
+
# http body (model)
|
|
120
|
+
post_body = @api_client.object_to_http_body(workspace)
|
|
121
|
+
auth_names = []
|
|
122
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
123
|
+
:header_params => header_params,
|
|
124
|
+
:query_params => query_params,
|
|
125
|
+
:form_params => form_params,
|
|
126
|
+
:body => post_body,
|
|
127
|
+
:auth_names => auth_names,
|
|
128
|
+
:return_type => 'Workspace')
|
|
129
|
+
if @api_client.config.debugging
|
|
130
|
+
@api_client.config.logger.debug "API called: WorkspacesApi#create_workspace\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
131
|
+
end
|
|
132
|
+
return data, status_code, headers
|
|
133
|
+
end
|
|
134
|
+
|
|
135
|
+
# Creates a workspace file.
|
|
136
|
+
#
|
|
137
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
138
|
+
# @param folder_id The ID of the folder being accessed.
|
|
139
|
+
# @param workspace_id Specifies the workspace ID GUID.
|
|
140
|
+
# @return [WorkspaceItem]
|
|
141
|
+
def create_workspace_file(account_id, folder_id, workspace_id)
|
|
142
|
+
data, _status_code, _headers = create_workspace_file_with_http_info(account_id, folder_id, workspace_id)
|
|
143
|
+
return data
|
|
144
|
+
end
|
|
145
|
+
|
|
146
|
+
# Creates a workspace file.
|
|
147
|
+
#
|
|
148
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
149
|
+
# @param folder_id The ID of the folder being accessed.
|
|
150
|
+
# @param workspace_id Specifies the workspace ID GUID.
|
|
151
|
+
# @return [Array<(WorkspaceItem, Fixnum, Hash)>] WorkspaceItem data, response status code and response headers
|
|
152
|
+
def create_workspace_file_with_http_info(account_id, folder_id, workspace_id)
|
|
153
|
+
if @api_client.config.debugging
|
|
154
|
+
@api_client.config.logger.debug "Calling API: WorkspacesApi.create_workspace_file ..."
|
|
155
|
+
end
|
|
156
|
+
# verify the required parameter 'account_id' is set
|
|
157
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling WorkspacesApi.create_workspace_file" if account_id.nil?
|
|
158
|
+
# verify the required parameter 'folder_id' is set
|
|
159
|
+
fail ArgumentError, "Missing the required parameter 'folder_id' when calling WorkspacesApi.create_workspace_file" if folder_id.nil?
|
|
160
|
+
# verify the required parameter 'workspace_id' is set
|
|
161
|
+
fail ArgumentError, "Missing the required parameter 'workspace_id' when calling WorkspacesApi.create_workspace_file" if workspace_id.nil?
|
|
162
|
+
# resource path
|
|
163
|
+
local_var_path = "/v2/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'folderId' + '}', folder_id.to_s).sub('{' + 'workspaceId' + '}', workspace_id.to_s)
|
|
164
|
+
|
|
165
|
+
# query parameters
|
|
166
|
+
query_params = {}
|
|
167
|
+
|
|
168
|
+
# header parameters
|
|
169
|
+
header_params = {}
|
|
170
|
+
# HTTP header 'Accept' (if needed)
|
|
171
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
172
|
+
|
|
173
|
+
# form parameters
|
|
174
|
+
form_params = {}
|
|
175
|
+
|
|
176
|
+
# http body (model)
|
|
177
|
+
post_body = nil
|
|
178
|
+
auth_names = []
|
|
179
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
180
|
+
:header_params => header_params,
|
|
181
|
+
:query_params => query_params,
|
|
182
|
+
:form_params => form_params,
|
|
183
|
+
:body => post_body,
|
|
184
|
+
:auth_names => auth_names,
|
|
185
|
+
:return_type => 'WorkspaceItem')
|
|
186
|
+
if @api_client.config.debugging
|
|
187
|
+
@api_client.config.logger.debug "API called: WorkspacesApi#create_workspace_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
188
|
+
end
|
|
189
|
+
return data, status_code, headers
|
|
190
|
+
end
|
|
191
|
+
|
|
192
|
+
# Delete Workspace
|
|
193
|
+
# Deletes an existing workspace (logically).
|
|
194
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
195
|
+
# @param workspace_id Specifies the workspace ID GUID.
|
|
196
|
+
# @return [Workspace]
|
|
197
|
+
def delete_workspace(account_id, workspace_id)
|
|
198
|
+
data, _status_code, _headers = delete_workspace_with_http_info(account_id, workspace_id)
|
|
199
|
+
return data
|
|
200
|
+
end
|
|
201
|
+
|
|
202
|
+
# Delete Workspace
|
|
203
|
+
# Deletes an existing workspace (logically).
|
|
204
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
205
|
+
# @param workspace_id Specifies the workspace ID GUID.
|
|
206
|
+
# @return [Array<(Workspace, Fixnum, Hash)>] Workspace data, response status code and response headers
|
|
207
|
+
def delete_workspace_with_http_info(account_id, workspace_id)
|
|
208
|
+
if @api_client.config.debugging
|
|
209
|
+
@api_client.config.logger.debug "Calling API: WorkspacesApi.delete_workspace ..."
|
|
210
|
+
end
|
|
211
|
+
# verify the required parameter 'account_id' is set
|
|
212
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling WorkspacesApi.delete_workspace" if account_id.nil?
|
|
213
|
+
# verify the required parameter 'workspace_id' is set
|
|
214
|
+
fail ArgumentError, "Missing the required parameter 'workspace_id' when calling WorkspacesApi.delete_workspace" if workspace_id.nil?
|
|
215
|
+
# resource path
|
|
216
|
+
local_var_path = "/v2/accounts/{accountId}/workspaces/{workspaceId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'workspaceId' + '}', workspace_id.to_s)
|
|
217
|
+
|
|
218
|
+
# query parameters
|
|
219
|
+
query_params = {}
|
|
220
|
+
|
|
221
|
+
# header parameters
|
|
222
|
+
header_params = {}
|
|
223
|
+
# HTTP header 'Accept' (if needed)
|
|
224
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
225
|
+
|
|
226
|
+
# form parameters
|
|
227
|
+
form_params = {}
|
|
228
|
+
|
|
229
|
+
# http body (model)
|
|
230
|
+
post_body = nil
|
|
231
|
+
auth_names = []
|
|
232
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
|
233
|
+
:header_params => header_params,
|
|
234
|
+
:query_params => query_params,
|
|
235
|
+
:form_params => form_params,
|
|
236
|
+
:body => post_body,
|
|
237
|
+
:auth_names => auth_names,
|
|
238
|
+
:return_type => 'Workspace')
|
|
239
|
+
if @api_client.config.debugging
|
|
240
|
+
@api_client.config.logger.debug "API called: WorkspacesApi#delete_workspace\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
241
|
+
end
|
|
242
|
+
return data, status_code, headers
|
|
243
|
+
end
|
|
244
|
+
|
|
245
|
+
# Deletes workspace one or more specific files/folders from the given folder or root.
|
|
246
|
+
#
|
|
247
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
248
|
+
# @param folder_id The ID of the folder being accessed.
|
|
249
|
+
# @param workspace_id Specifies the workspace ID GUID.
|
|
250
|
+
# @param workspace_item_list (optional parameter)
|
|
251
|
+
# @return [nil]
|
|
252
|
+
def delete_workspace_folder_items(account_id, folder_id, workspace_id, workspace_item_list)
|
|
253
|
+
delete_workspace_folder_items_with_http_info(account_id, folder_id, workspace_id, workspace_item_list)
|
|
254
|
+
return nil
|
|
255
|
+
end
|
|
256
|
+
|
|
257
|
+
# Deletes workspace one or more specific files/folders from the given folder or root.
|
|
258
|
+
#
|
|
259
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
260
|
+
# @param folder_id The ID of the folder being accessed.
|
|
261
|
+
# @param workspace_id Specifies the workspace ID GUID.
|
|
262
|
+
# @param workspace_item_list (optional parameter)
|
|
263
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
264
|
+
def delete_workspace_folder_items_with_http_info(account_id, folder_id, workspace_id, workspace_item_list)
|
|
265
|
+
if @api_client.config.debugging
|
|
266
|
+
@api_client.config.logger.debug "Calling API: WorkspacesApi.delete_workspace_folder_items ..."
|
|
267
|
+
end
|
|
268
|
+
# verify the required parameter 'account_id' is set
|
|
269
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling WorkspacesApi.delete_workspace_folder_items" if account_id.nil?
|
|
270
|
+
# verify the required parameter 'folder_id' is set
|
|
271
|
+
fail ArgumentError, "Missing the required parameter 'folder_id' when calling WorkspacesApi.delete_workspace_folder_items" if folder_id.nil?
|
|
272
|
+
# verify the required parameter 'workspace_id' is set
|
|
273
|
+
fail ArgumentError, "Missing the required parameter 'workspace_id' when calling WorkspacesApi.delete_workspace_folder_items" if workspace_id.nil?
|
|
274
|
+
# resource path
|
|
275
|
+
local_var_path = "/v2/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'folderId' + '}', folder_id.to_s).sub('{' + 'workspaceId' + '}', workspace_id.to_s)
|
|
276
|
+
|
|
277
|
+
# query parameters
|
|
278
|
+
query_params = {}
|
|
279
|
+
|
|
280
|
+
# header parameters
|
|
281
|
+
header_params = {}
|
|
282
|
+
# HTTP header 'Accept' (if needed)
|
|
283
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
284
|
+
|
|
285
|
+
# form parameters
|
|
286
|
+
form_params = {}
|
|
287
|
+
|
|
288
|
+
# http body (model)
|
|
289
|
+
post_body = @api_client.object_to_http_body(workspace_item_list)
|
|
290
|
+
auth_names = []
|
|
291
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
|
292
|
+
:header_params => header_params,
|
|
293
|
+
:query_params => query_params,
|
|
294
|
+
:form_params => form_params,
|
|
295
|
+
:body => post_body,
|
|
296
|
+
:auth_names => auth_names)
|
|
297
|
+
if @api_client.config.debugging
|
|
298
|
+
@api_client.config.logger.debug "API called: WorkspacesApi#delete_workspace_folder_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
299
|
+
end
|
|
300
|
+
return data, status_code, headers
|
|
301
|
+
end
|
|
302
|
+
|
|
303
|
+
# Get Workspace
|
|
304
|
+
# Retrives properties about a workspace given a unique workspaceId.
|
|
305
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
306
|
+
# @param workspace_id Specifies the workspace ID GUID.
|
|
307
|
+
# @return [Workspace]
|
|
308
|
+
def get_workspace(account_id, workspace_id)
|
|
309
|
+
data, _status_code, _headers = get_workspace_with_http_info(account_id, workspace_id)
|
|
310
|
+
return data
|
|
311
|
+
end
|
|
312
|
+
|
|
313
|
+
# Get Workspace
|
|
314
|
+
# Retrives properties about a workspace given a unique workspaceId.
|
|
315
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
316
|
+
# @param workspace_id Specifies the workspace ID GUID.
|
|
317
|
+
# @return [Array<(Workspace, Fixnum, Hash)>] Workspace data, response status code and response headers
|
|
318
|
+
def get_workspace_with_http_info(account_id, workspace_id)
|
|
319
|
+
if @api_client.config.debugging
|
|
320
|
+
@api_client.config.logger.debug "Calling API: WorkspacesApi.get_workspace ..."
|
|
321
|
+
end
|
|
322
|
+
# verify the required parameter 'account_id' is set
|
|
323
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling WorkspacesApi.get_workspace" if account_id.nil?
|
|
324
|
+
# verify the required parameter 'workspace_id' is set
|
|
325
|
+
fail ArgumentError, "Missing the required parameter 'workspace_id' when calling WorkspacesApi.get_workspace" if workspace_id.nil?
|
|
326
|
+
# resource path
|
|
327
|
+
local_var_path = "/v2/accounts/{accountId}/workspaces/{workspaceId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'workspaceId' + '}', workspace_id.to_s)
|
|
328
|
+
|
|
329
|
+
# query parameters
|
|
330
|
+
query_params = {}
|
|
331
|
+
|
|
332
|
+
# header parameters
|
|
333
|
+
header_params = {}
|
|
334
|
+
# HTTP header 'Accept' (if needed)
|
|
335
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
336
|
+
|
|
337
|
+
# form parameters
|
|
338
|
+
form_params = {}
|
|
339
|
+
|
|
340
|
+
# http body (model)
|
|
341
|
+
post_body = nil
|
|
342
|
+
auth_names = []
|
|
343
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
344
|
+
:header_params => header_params,
|
|
345
|
+
:query_params => query_params,
|
|
346
|
+
:form_params => form_params,
|
|
347
|
+
:body => post_body,
|
|
348
|
+
:auth_names => auth_names,
|
|
349
|
+
:return_type => 'Workspace')
|
|
350
|
+
if @api_client.config.debugging
|
|
351
|
+
@api_client.config.logger.debug "API called: WorkspacesApi#get_workspace\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
352
|
+
end
|
|
353
|
+
return data, status_code, headers
|
|
354
|
+
end
|
|
355
|
+
|
|
356
|
+
# Get Workspace File
|
|
357
|
+
# Retrieves a workspace file (the binary).
|
|
358
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
359
|
+
# @param file_id Specifies the room file ID GUID.
|
|
360
|
+
# @param folder_id The ID of the folder being accessed.
|
|
361
|
+
# @param workspace_id Specifies the workspace ID GUID.
|
|
362
|
+
# @param DocuSign_eSign::GetWorkspaceFileOptions Options for modifying the behavior of the function.
|
|
363
|
+
# @return [nil]
|
|
364
|
+
def get_workspace_file(account_id, file_id, folder_id, workspace_id, options = DocuSign_eSign::GetWorkspaceFileOptions.default)
|
|
365
|
+
get_workspace_file_with_http_info(account_id, file_id, folder_id, workspace_id, options)
|
|
366
|
+
return nil
|
|
367
|
+
end
|
|
368
|
+
|
|
369
|
+
# Get Workspace File
|
|
370
|
+
# Retrieves a workspace file (the binary).
|
|
371
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
372
|
+
# @param file_id Specifies the room file ID GUID.
|
|
373
|
+
# @param folder_id The ID of the folder being accessed.
|
|
374
|
+
# @param workspace_id Specifies the workspace ID GUID.
|
|
375
|
+
# @param DocuSign_eSign::GetWorkspaceFileOptions Options for modifying the behavior of the function.
|
|
376
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
377
|
+
def get_workspace_file_with_http_info(account_id, file_id, folder_id, workspace_id, options = DocuSign_eSign::GetWorkspaceFileOptions.default)
|
|
378
|
+
if @api_client.config.debugging
|
|
379
|
+
@api_client.config.logger.debug "Calling API: WorkspacesApi.get_workspace_file ..."
|
|
380
|
+
end
|
|
381
|
+
# verify the required parameter 'account_id' is set
|
|
382
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling WorkspacesApi.get_workspace_file" if account_id.nil?
|
|
383
|
+
# verify the required parameter 'file_id' is set
|
|
384
|
+
fail ArgumentError, "Missing the required parameter 'file_id' when calling WorkspacesApi.get_workspace_file" if file_id.nil?
|
|
385
|
+
# verify the required parameter 'folder_id' is set
|
|
386
|
+
fail ArgumentError, "Missing the required parameter 'folder_id' when calling WorkspacesApi.get_workspace_file" if folder_id.nil?
|
|
387
|
+
# verify the required parameter 'workspace_id' is set
|
|
388
|
+
fail ArgumentError, "Missing the required parameter 'workspace_id' when calling WorkspacesApi.get_workspace_file" if workspace_id.nil?
|
|
389
|
+
# resource path
|
|
390
|
+
local_var_path = "/v2/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'fileId' + '}', file_id.to_s).sub('{' + 'folderId' + '}', folder_id.to_s).sub('{' + 'workspaceId' + '}', workspace_id.to_s)
|
|
391
|
+
|
|
392
|
+
# query parameters
|
|
393
|
+
query_params = {}
|
|
394
|
+
query_params[:'is_download'] = options.is_download if !options.is_download.nil?
|
|
395
|
+
query_params[:'pdf_version'] = options.pdf_version if !options.pdf_version.nil?
|
|
396
|
+
|
|
397
|
+
# header parameters
|
|
398
|
+
header_params = {}
|
|
399
|
+
# HTTP header 'Accept' (if needed)
|
|
400
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
401
|
+
|
|
402
|
+
# form parameters
|
|
403
|
+
form_params = {}
|
|
404
|
+
|
|
405
|
+
# http body (model)
|
|
406
|
+
post_body = nil
|
|
407
|
+
auth_names = []
|
|
408
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
409
|
+
:header_params => header_params,
|
|
410
|
+
:query_params => query_params,
|
|
411
|
+
:form_params => form_params,
|
|
412
|
+
:body => post_body,
|
|
413
|
+
:auth_names => auth_names)
|
|
414
|
+
if @api_client.config.debugging
|
|
415
|
+
@api_client.config.logger.debug "API called: WorkspacesApi#get_workspace_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
416
|
+
end
|
|
417
|
+
return data, status_code, headers
|
|
418
|
+
end
|
|
419
|
+
|
|
420
|
+
# List File Pages
|
|
421
|
+
# Retrieves a workspace file as rasterized pages.
|
|
422
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
423
|
+
# @param file_id Specifies the room file ID GUID.
|
|
424
|
+
# @param folder_id The ID of the folder being accessed.
|
|
425
|
+
# @param workspace_id Specifies the workspace ID GUID.
|
|
426
|
+
# @param DocuSign_eSign::ListWorkspaceFilePagesOptions Options for modifying the behavior of the function.
|
|
427
|
+
# @return [PageImages]
|
|
428
|
+
def list_workspace_file_pages(account_id, file_id, folder_id, workspace_id, options = DocuSign_eSign::ListWorkspaceFilePagesOptions.default)
|
|
429
|
+
data, _status_code, _headers = list_workspace_file_pages_with_http_info(account_id, file_id, folder_id, workspace_id, options)
|
|
430
|
+
return data
|
|
431
|
+
end
|
|
432
|
+
|
|
433
|
+
# List File Pages
|
|
434
|
+
# Retrieves a workspace file as rasterized pages.
|
|
435
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
436
|
+
# @param file_id Specifies the room file ID GUID.
|
|
437
|
+
# @param folder_id The ID of the folder being accessed.
|
|
438
|
+
# @param workspace_id Specifies the workspace ID GUID.
|
|
439
|
+
# @param DocuSign_eSign::ListWorkspaceFilePagesOptions Options for modifying the behavior of the function.
|
|
440
|
+
# @return [Array<(PageImages, Fixnum, Hash)>] PageImages data, response status code and response headers
|
|
441
|
+
def list_workspace_file_pages_with_http_info(account_id, file_id, folder_id, workspace_id, options = DocuSign_eSign::ListWorkspaceFilePagesOptions.default)
|
|
442
|
+
if @api_client.config.debugging
|
|
443
|
+
@api_client.config.logger.debug "Calling API: WorkspacesApi.list_workspace_file_pages ..."
|
|
444
|
+
end
|
|
445
|
+
# verify the required parameter 'account_id' is set
|
|
446
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling WorkspacesApi.list_workspace_file_pages" if account_id.nil?
|
|
447
|
+
# verify the required parameter 'file_id' is set
|
|
448
|
+
fail ArgumentError, "Missing the required parameter 'file_id' when calling WorkspacesApi.list_workspace_file_pages" if file_id.nil?
|
|
449
|
+
# verify the required parameter 'folder_id' is set
|
|
450
|
+
fail ArgumentError, "Missing the required parameter 'folder_id' when calling WorkspacesApi.list_workspace_file_pages" if folder_id.nil?
|
|
451
|
+
# verify the required parameter 'workspace_id' is set
|
|
452
|
+
fail ArgumentError, "Missing the required parameter 'workspace_id' when calling WorkspacesApi.list_workspace_file_pages" if workspace_id.nil?
|
|
453
|
+
# resource path
|
|
454
|
+
local_var_path = "/v2/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}/pages".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'fileId' + '}', file_id.to_s).sub('{' + 'folderId' + '}', folder_id.to_s).sub('{' + 'workspaceId' + '}', workspace_id.to_s)
|
|
455
|
+
|
|
456
|
+
# query parameters
|
|
457
|
+
query_params = {}
|
|
458
|
+
query_params[:'count'] = options.count if !options.count.nil?
|
|
459
|
+
query_params[:'dpi'] = options.dpi if !options.dpi.nil?
|
|
460
|
+
query_params[:'max_height'] = options.max_height if !options.max_height.nil?
|
|
461
|
+
query_params[:'max_width'] = options.max_width if !options.max_width.nil?
|
|
462
|
+
query_params[:'start_position'] = options.start_position if !options.start_position.nil?
|
|
463
|
+
|
|
464
|
+
# header parameters
|
|
465
|
+
header_params = {}
|
|
466
|
+
# HTTP header 'Accept' (if needed)
|
|
467
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
468
|
+
|
|
469
|
+
# form parameters
|
|
470
|
+
form_params = {}
|
|
471
|
+
|
|
472
|
+
# http body (model)
|
|
473
|
+
post_body = nil
|
|
474
|
+
auth_names = []
|
|
475
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
476
|
+
:header_params => header_params,
|
|
477
|
+
:query_params => query_params,
|
|
478
|
+
:form_params => form_params,
|
|
479
|
+
:body => post_body,
|
|
480
|
+
:auth_names => auth_names,
|
|
481
|
+
:return_type => 'PageImages')
|
|
482
|
+
if @api_client.config.debugging
|
|
483
|
+
@api_client.config.logger.debug "API called: WorkspacesApi#list_workspace_file_pages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
484
|
+
end
|
|
485
|
+
return data, status_code, headers
|
|
486
|
+
end
|
|
487
|
+
|
|
488
|
+
# List Workspace Folder Contents
|
|
489
|
+
# Retrieves workspace folder contents, which can include sub folders and files.
|
|
490
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
491
|
+
# @param folder_id The ID of the folder being accessed.
|
|
492
|
+
# @param workspace_id Specifies the workspace ID GUID.
|
|
493
|
+
# @param DocuSign_eSign::ListWorkspaceFolderItemsOptions Options for modifying the behavior of the function.
|
|
494
|
+
# @return [WorkspaceFolderContents]
|
|
495
|
+
def list_workspace_folder_items(account_id, folder_id, workspace_id, options = DocuSign_eSign::ListWorkspaceFolderItemsOptions.default)
|
|
496
|
+
data, _status_code, _headers = list_workspace_folder_items_with_http_info(account_id, folder_id, workspace_id, options)
|
|
497
|
+
return data
|
|
498
|
+
end
|
|
499
|
+
|
|
500
|
+
# List Workspace Folder Contents
|
|
501
|
+
# Retrieves workspace folder contents, which can include sub folders and files.
|
|
502
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
503
|
+
# @param folder_id The ID of the folder being accessed.
|
|
504
|
+
# @param workspace_id Specifies the workspace ID GUID.
|
|
505
|
+
# @param DocuSign_eSign::ListWorkspaceFolderItemsOptions Options for modifying the behavior of the function.
|
|
506
|
+
# @return [Array<(WorkspaceFolderContents, Fixnum, Hash)>] WorkspaceFolderContents data, response status code and response headers
|
|
507
|
+
def list_workspace_folder_items_with_http_info(account_id, folder_id, workspace_id, options = DocuSign_eSign::ListWorkspaceFolderItemsOptions.default)
|
|
508
|
+
if @api_client.config.debugging
|
|
509
|
+
@api_client.config.logger.debug "Calling API: WorkspacesApi.list_workspace_folder_items ..."
|
|
510
|
+
end
|
|
511
|
+
# verify the required parameter 'account_id' is set
|
|
512
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling WorkspacesApi.list_workspace_folder_items" if account_id.nil?
|
|
513
|
+
# verify the required parameter 'folder_id' is set
|
|
514
|
+
fail ArgumentError, "Missing the required parameter 'folder_id' when calling WorkspacesApi.list_workspace_folder_items" if folder_id.nil?
|
|
515
|
+
# verify the required parameter 'workspace_id' is set
|
|
516
|
+
fail ArgumentError, "Missing the required parameter 'workspace_id' when calling WorkspacesApi.list_workspace_folder_items" if workspace_id.nil?
|
|
517
|
+
# resource path
|
|
518
|
+
local_var_path = "/v2/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'folderId' + '}', folder_id.to_s).sub('{' + 'workspaceId' + '}', workspace_id.to_s)
|
|
519
|
+
|
|
520
|
+
# query parameters
|
|
521
|
+
query_params = {}
|
|
522
|
+
query_params[:'count'] = options.count if !options.count.nil?
|
|
523
|
+
query_params[:'include_files'] = options.include_files if !options.include_files.nil?
|
|
524
|
+
query_params[:'include_sub_folders'] = options.include_sub_folders if !options.include_sub_folders.nil?
|
|
525
|
+
query_params[:'include_thumbnails'] = options.include_thumbnails if !options.include_thumbnails.nil?
|
|
526
|
+
query_params[:'include_user_detail'] = options.include_user_detail if !options.include_user_detail.nil?
|
|
527
|
+
query_params[:'start_position'] = options.start_position if !options.start_position.nil?
|
|
528
|
+
query_params[:'workspace_user_id'] = options.workspace_user_id if !options.workspace_user_id.nil?
|
|
529
|
+
|
|
530
|
+
# header parameters
|
|
531
|
+
header_params = {}
|
|
532
|
+
# HTTP header 'Accept' (if needed)
|
|
533
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
534
|
+
|
|
535
|
+
# form parameters
|
|
536
|
+
form_params = {}
|
|
537
|
+
|
|
538
|
+
# http body (model)
|
|
539
|
+
post_body = nil
|
|
540
|
+
auth_names = []
|
|
541
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
542
|
+
:header_params => header_params,
|
|
543
|
+
:query_params => query_params,
|
|
544
|
+
:form_params => form_params,
|
|
545
|
+
:body => post_body,
|
|
546
|
+
:auth_names => auth_names,
|
|
547
|
+
:return_type => 'WorkspaceFolderContents')
|
|
548
|
+
if @api_client.config.debugging
|
|
549
|
+
@api_client.config.logger.debug "API called: WorkspacesApi#list_workspace_folder_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
550
|
+
end
|
|
551
|
+
return data, status_code, headers
|
|
552
|
+
end
|
|
553
|
+
|
|
554
|
+
# List Workspaces
|
|
555
|
+
# Gets information about the Workspaces that have been created.
|
|
556
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
557
|
+
# @return [WorkspaceList]
|
|
558
|
+
def list_workspaces(account_id)
|
|
559
|
+
data, _status_code, _headers = list_workspaces_with_http_info(account_id)
|
|
560
|
+
return data
|
|
561
|
+
end
|
|
562
|
+
|
|
563
|
+
# List Workspaces
|
|
564
|
+
# Gets information about the Workspaces that have been created.
|
|
565
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
566
|
+
# @return [Array<(WorkspaceList, Fixnum, Hash)>] WorkspaceList data, response status code and response headers
|
|
567
|
+
def list_workspaces_with_http_info(account_id)
|
|
568
|
+
if @api_client.config.debugging
|
|
569
|
+
@api_client.config.logger.debug "Calling API: WorkspacesApi.list_workspaces ..."
|
|
570
|
+
end
|
|
571
|
+
# verify the required parameter 'account_id' is set
|
|
572
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling WorkspacesApi.list_workspaces" if account_id.nil?
|
|
573
|
+
# resource path
|
|
574
|
+
local_var_path = "/v2/accounts/{accountId}/workspaces".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
|
575
|
+
|
|
576
|
+
# query parameters
|
|
577
|
+
query_params = {}
|
|
578
|
+
|
|
579
|
+
# header parameters
|
|
580
|
+
header_params = {}
|
|
581
|
+
# HTTP header 'Accept' (if needed)
|
|
582
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
583
|
+
|
|
584
|
+
# form parameters
|
|
585
|
+
form_params = {}
|
|
586
|
+
|
|
587
|
+
# http body (model)
|
|
588
|
+
post_body = nil
|
|
589
|
+
auth_names = []
|
|
590
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
591
|
+
:header_params => header_params,
|
|
592
|
+
:query_params => query_params,
|
|
593
|
+
:form_params => form_params,
|
|
594
|
+
:body => post_body,
|
|
595
|
+
:auth_names => auth_names,
|
|
596
|
+
:return_type => 'WorkspaceList')
|
|
597
|
+
if @api_client.config.debugging
|
|
598
|
+
@api_client.config.logger.debug "API called: WorkspacesApi#list_workspaces\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
599
|
+
end
|
|
600
|
+
return data, status_code, headers
|
|
601
|
+
end
|
|
602
|
+
|
|
603
|
+
# Update Workspace
|
|
604
|
+
# Updates information about a specific workspace.
|
|
605
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
606
|
+
# @param workspace_id Specifies the workspace ID GUID.
|
|
607
|
+
# @param workspace (optional parameter)
|
|
608
|
+
# @return [Workspace]
|
|
609
|
+
def update_workspace(account_id, workspace_id, workspace)
|
|
610
|
+
data, _status_code, _headers = update_workspace_with_http_info(account_id, workspace_id, workspace)
|
|
611
|
+
return data
|
|
612
|
+
end
|
|
613
|
+
|
|
614
|
+
# Update Workspace
|
|
615
|
+
# Updates information about a specific workspace.
|
|
616
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
617
|
+
# @param workspace_id Specifies the workspace ID GUID.
|
|
618
|
+
# @param workspace (optional parameter)
|
|
619
|
+
# @return [Array<(Workspace, Fixnum, Hash)>] Workspace data, response status code and response headers
|
|
620
|
+
def update_workspace_with_http_info(account_id, workspace_id, workspace)
|
|
621
|
+
if @api_client.config.debugging
|
|
622
|
+
@api_client.config.logger.debug "Calling API: WorkspacesApi.update_workspace ..."
|
|
623
|
+
end
|
|
624
|
+
# verify the required parameter 'account_id' is set
|
|
625
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling WorkspacesApi.update_workspace" if account_id.nil?
|
|
626
|
+
# verify the required parameter 'workspace_id' is set
|
|
627
|
+
fail ArgumentError, "Missing the required parameter 'workspace_id' when calling WorkspacesApi.update_workspace" if workspace_id.nil?
|
|
628
|
+
# resource path
|
|
629
|
+
local_var_path = "/v2/accounts/{accountId}/workspaces/{workspaceId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'workspaceId' + '}', workspace_id.to_s)
|
|
630
|
+
|
|
631
|
+
# query parameters
|
|
632
|
+
query_params = {}
|
|
633
|
+
|
|
634
|
+
# header parameters
|
|
635
|
+
header_params = {}
|
|
636
|
+
# HTTP header 'Accept' (if needed)
|
|
637
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
638
|
+
|
|
639
|
+
# form parameters
|
|
640
|
+
form_params = {}
|
|
641
|
+
|
|
642
|
+
# http body (model)
|
|
643
|
+
post_body = @api_client.object_to_http_body(workspace)
|
|
644
|
+
auth_names = []
|
|
645
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
646
|
+
:header_params => header_params,
|
|
647
|
+
:query_params => query_params,
|
|
648
|
+
:form_params => form_params,
|
|
649
|
+
:body => post_body,
|
|
650
|
+
:auth_names => auth_names,
|
|
651
|
+
:return_type => 'Workspace')
|
|
652
|
+
if @api_client.config.debugging
|
|
653
|
+
@api_client.config.logger.debug "API called: WorkspacesApi#update_workspace\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
654
|
+
end
|
|
655
|
+
return data, status_code, headers
|
|
656
|
+
end
|
|
657
|
+
|
|
658
|
+
# Update Workspace File Metadata
|
|
659
|
+
# Updates workspace item metadata for one or more specific files/folders.
|
|
660
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
661
|
+
# @param file_id Specifies the room file ID GUID.
|
|
662
|
+
# @param folder_id The ID of the folder being accessed.
|
|
663
|
+
# @param workspace_id Specifies the workspace ID GUID.
|
|
664
|
+
# @return [WorkspaceItem]
|
|
665
|
+
def update_workspace_file(account_id, file_id, folder_id, workspace_id)
|
|
666
|
+
data, _status_code, _headers = update_workspace_file_with_http_info(account_id, file_id, folder_id, workspace_id)
|
|
667
|
+
return data
|
|
668
|
+
end
|
|
669
|
+
|
|
670
|
+
# Update Workspace File Metadata
|
|
671
|
+
# Updates workspace item metadata for one or more specific files/folders.
|
|
672
|
+
# @param account_id The external account number (int) or account ID Guid.
|
|
673
|
+
# @param file_id Specifies the room file ID GUID.
|
|
674
|
+
# @param folder_id The ID of the folder being accessed.
|
|
675
|
+
# @param workspace_id Specifies the workspace ID GUID.
|
|
676
|
+
# @return [Array<(WorkspaceItem, Fixnum, Hash)>] WorkspaceItem data, response status code and response headers
|
|
677
|
+
def update_workspace_file_with_http_info(account_id, file_id, folder_id, workspace_id)
|
|
678
|
+
if @api_client.config.debugging
|
|
679
|
+
@api_client.config.logger.debug "Calling API: WorkspacesApi.update_workspace_file ..."
|
|
680
|
+
end
|
|
681
|
+
# verify the required parameter 'account_id' is set
|
|
682
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling WorkspacesApi.update_workspace_file" if account_id.nil?
|
|
683
|
+
# verify the required parameter 'file_id' is set
|
|
684
|
+
fail ArgumentError, "Missing the required parameter 'file_id' when calling WorkspacesApi.update_workspace_file" if file_id.nil?
|
|
685
|
+
# verify the required parameter 'folder_id' is set
|
|
686
|
+
fail ArgumentError, "Missing the required parameter 'folder_id' when calling WorkspacesApi.update_workspace_file" if folder_id.nil?
|
|
687
|
+
# verify the required parameter 'workspace_id' is set
|
|
688
|
+
fail ArgumentError, "Missing the required parameter 'workspace_id' when calling WorkspacesApi.update_workspace_file" if workspace_id.nil?
|
|
689
|
+
# resource path
|
|
690
|
+
local_var_path = "/v2/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'fileId' + '}', file_id.to_s).sub('{' + 'folderId' + '}', folder_id.to_s).sub('{' + 'workspaceId' + '}', workspace_id.to_s)
|
|
691
|
+
|
|
692
|
+
# query parameters
|
|
693
|
+
query_params = {}
|
|
694
|
+
|
|
695
|
+
# header parameters
|
|
696
|
+
header_params = {}
|
|
697
|
+
# HTTP header 'Accept' (if needed)
|
|
698
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
699
|
+
|
|
700
|
+
# form parameters
|
|
701
|
+
form_params = {}
|
|
702
|
+
|
|
703
|
+
# http body (model)
|
|
704
|
+
post_body = nil
|
|
705
|
+
auth_names = []
|
|
706
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
707
|
+
:header_params => header_params,
|
|
708
|
+
:query_params => query_params,
|
|
709
|
+
:form_params => form_params,
|
|
710
|
+
:body => post_body,
|
|
711
|
+
:auth_names => auth_names,
|
|
712
|
+
:return_type => 'WorkspaceItem')
|
|
713
|
+
if @api_client.config.debugging
|
|
714
|
+
@api_client.config.logger.debug "API called: WorkspacesApi#update_workspace_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
715
|
+
end
|
|
716
|
+
return data, status_code, headers
|
|
717
|
+
end
|
|
718
|
+
end
|
|
719
|
+
end
|