docusign_esign 1.0.0 → 1.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (335) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/README.md +18 -66
  4. data/docusign_esign-1.0.0.gem +0 -0
  5. data/docusign_esign.gemspec +2 -2
  6. data/lib/docusign_esign/version.rb +1 -1
  7. data/tests/Gemfile.lock +13 -9
  8. data/tests/keys/docusign_private_key.txt.enc +0 -0
  9. data/tests/rsa_keys/private.pem +25 -25
  10. data/tests/spec/unit_tests_spec.rb +8 -8
  11. data/tests/spec/unit_tests_using_jwt_spec.rb +9 -10
  12. metadata +11 -331
  13. data/docs/AccountAddress.md +0 -19
  14. data/docs/AccountBillingPlan.md +0 -27
  15. data/docs/AccountBillingPlanResponse.md +0 -13
  16. data/docs/AccountInformation.md +0 -38
  17. data/docs/AccountRoleSettings.md +0 -71
  18. data/docs/AccountSettingsInformation.md +0 -8
  19. data/docs/AccountSharedAccess.md +0 -16
  20. data/docs/AccountSignatureProvider.md +0 -14
  21. data/docs/AccountSignatureProviderOption.md +0 -10
  22. data/docs/AccountSignatureProviders.md +0 -8
  23. data/docs/AccountsApi.md +0 -1997
  24. data/docs/AddOn.md +0 -11
  25. data/docs/AddressInformation.md +0 -15
  26. data/docs/AddressInformationInput.md +0 -10
  27. data/docs/AddressInformationV2.md +0 -15
  28. data/docs/Agent.md +0 -49
  29. data/docs/ApiRequestLog.md +0 -11
  30. data/docs/ApiRequestLogsResult.md +0 -8
  31. data/docs/AppStoreProduct.md +0 -9
  32. data/docs/AppStoreReceipt.md +0 -9
  33. data/docs/Approve.md +0 -40
  34. data/docs/Attachment.md +0 -14
  35. data/docs/AuthenticationApi.md +0 -356
  36. data/docs/AuthenticationMethod.md +0 -11
  37. data/docs/AuthenticationStatus.md +0 -24
  38. data/docs/BccEmailAddress.md +0 -9
  39. data/docs/BillingApi.md +0 -569
  40. data/docs/BillingCharge.md +0 -20
  41. data/docs/BillingChargeResponse.md +0 -8
  42. data/docs/BillingDiscount.md +0 -10
  43. data/docs/BillingInvoice.md +0 -17
  44. data/docs/BillingInvoiceItem.md +0 -12
  45. data/docs/BillingInvoicesResponse.md +0 -10
  46. data/docs/BillingInvoicesSummary.md +0 -10
  47. data/docs/BillingPayment.md +0 -10
  48. data/docs/BillingPaymentItem.md +0 -12
  49. data/docs/BillingPaymentRequest.md +0 -8
  50. data/docs/BillingPaymentResponse.md +0 -8
  51. data/docs/BillingPaymentsResponse.md +0 -10
  52. data/docs/BillingPlan.md +0 -22
  53. data/docs/BillingPlanInformation.md +0 -22
  54. data/docs/BillingPlanPreview.md +0 -13
  55. data/docs/BillingPlanResponse.md +0 -9
  56. data/docs/BillingPlanUpdateResponse.md +0 -14
  57. data/docs/BillingPlansResponse.md +0 -8
  58. data/docs/BillingPrice.md +0 -10
  59. data/docs/Brand.md +0 -20
  60. data/docs/BrandEmailContent.md +0 -11
  61. data/docs/BrandLink.md +0 -11
  62. data/docs/BrandLogos.md +0 -10
  63. data/docs/BrandRequest.md +0 -8
  64. data/docs/BrandResourceUrls.md +0 -11
  65. data/docs/BrandResources.md +0 -14
  66. data/docs/BrandResourcesList.md +0 -8
  67. data/docs/BrandsRequest.md +0 -8
  68. data/docs/BrandsResponse.md +0 -10
  69. data/docs/BulkEnvelope.md +0 -16
  70. data/docs/BulkEnvelopeStatus.md +0 -21
  71. data/docs/BulkEnvelopesApi.md +0 -295
  72. data/docs/BulkEnvelopesResponse.md +0 -14
  73. data/docs/BulkRecipient.md +0 -17
  74. data/docs/BulkRecipientSignatureProvider.md +0 -9
  75. data/docs/BulkRecipientTabLabel.md +0 -9
  76. data/docs/BulkRecipientsRequest.md +0 -8
  77. data/docs/BulkRecipientsResponse.md +0 -14
  78. data/docs/BulkRecipientsSummaryResponse.md +0 -11
  79. data/docs/BulkRecipientsUpdateResponse.md +0 -8
  80. data/docs/CaptiveRecipient.md +0 -11
  81. data/docs/CaptiveRecipientInformation.md +0 -8
  82. data/docs/CarbonCopy.md +0 -49
  83. data/docs/CertifiedDelivery.md +0 -49
  84. data/docs/Checkbox.md +0 -37
  85. data/docs/ChunkedUploadPart.md +0 -9
  86. data/docs/ChunkedUploadRequest.md +0 -9
  87. data/docs/ChunkedUploadResponse.md +0 -14
  88. data/docs/CloudStorageApi.md +0 -424
  89. data/docs/CloudStorageProvider.md +0 -12
  90. data/docs/CloudStorageProviders.md +0 -8
  91. data/docs/Company.md +0 -46
  92. data/docs/CompositeTemplate.md +0 -12
  93. data/docs/ConnectApi.md +0 -891
  94. data/docs/ConnectConfigResults.md +0 -9
  95. data/docs/ConnectCustomConfiguration.md +0 -28
  96. data/docs/ConnectDebugLog.md +0 -12
  97. data/docs/ConnectFailureFilter.md +0 -9
  98. data/docs/ConnectFailureResult.md +0 -12
  99. data/docs/ConnectFailureResults.md +0 -8
  100. data/docs/ConnectLog.md +0 -25
  101. data/docs/ConnectLogs.md +0 -11
  102. data/docs/ConsoleViewRequest.md +0 -9
  103. data/docs/ConsumerDisclosure.md +0 -37
  104. data/docs/Contact.md +0 -16
  105. data/docs/ContactGetResponse.md +0 -14
  106. data/docs/ContactModRequest.md +0 -8
  107. data/docs/ContactUpdateResponse.md +0 -8
  108. data/docs/CorrectViewRequest.md +0 -9
  109. data/docs/Country.md +0 -11
  110. data/docs/CreditCardInformation.md +0 -13
  111. data/docs/CreditCardTypes.md +0 -8
  112. data/docs/CurrencyFeatureSetPrice.md +0 -12
  113. data/docs/CurrencyPlanPrice.md +0 -13
  114. data/docs/CustomFieldV2.md +0 -14
  115. data/docs/CustomFields.md +0 -9
  116. data/docs/CustomFieldsEnvelope.md +0 -9
  117. data/docs/CustomSettingsInformation.md +0 -8
  118. data/docs/CustomTabsApi.md +0 -268
  119. data/docs/Date.md +0 -52
  120. data/docs/DateSigned.md +0 -39
  121. data/docs/Decline.md +0 -41
  122. data/docs/DiagnosticsApi.md +0 -321
  123. data/docs/DiagnosticsSettingsInformation.md +0 -10
  124. data/docs/DobInformationInput.md +0 -10
  125. data/docs/Document.md +0 -27
  126. data/docs/DocumentFieldsInformation.md +0 -8
  127. data/docs/DocumentTemplate.md +0 -12
  128. data/docs/DocumentTemplateList.md +0 -8
  129. data/docs/DocumentVisibility.md +0 -12
  130. data/docs/DocumentVisibilityList.md +0 -8
  131. data/docs/ENoteConfiguration.md +0 -12
  132. data/docs/Editor.md +0 -48
  133. data/docs/Email.md +0 -52
  134. data/docs/EmailAddress.md +0 -38
  135. data/docs/EmailSettings.md +0 -10
  136. data/docs/Envelope.md +0 -54
  137. data/docs/EnvelopeAttachment.md +0 -13
  138. data/docs/EnvelopeAttachmentsRequest.md +0 -8
  139. data/docs/EnvelopeAttachmentsResult.md +0 -8
  140. data/docs/EnvelopeAuditEvent.md +0 -8
  141. data/docs/EnvelopeAuditEventResponse.md +0 -8
  142. data/docs/EnvelopeDefinition.md +0 -63
  143. data/docs/EnvelopeDocument.md +0 -24
  144. data/docs/EnvelopeDocumentsResult.md +0 -9
  145. data/docs/EnvelopeEvent.md +0 -9
  146. data/docs/EnvelopeFormData.md +0 -13
  147. data/docs/EnvelopeId.md +0 -38
  148. data/docs/EnvelopeIdsRequest.md +0 -9
  149. data/docs/EnvelopeNotificationRequest.md +0 -10
  150. data/docs/EnvelopeSummary.md +0 -11
  151. data/docs/EnvelopeTemplate.md +0 -56
  152. data/docs/EnvelopeTemplateDefinition.md +0 -22
  153. data/docs/EnvelopeTemplateResult.md +0 -68
  154. data/docs/EnvelopeTemplateResults.md +0 -15
  155. data/docs/EnvelopeTransactionStatus.md +0 -11
  156. data/docs/EnvelopeUpdateSummary.md +0 -15
  157. data/docs/EnvelopesApi.md +0 -4306
  158. data/docs/EnvelopesInformation.md +0 -15
  159. data/docs/ErrorDetails.md +0 -9
  160. data/docs/EventNotification.md +0 -22
  161. data/docs/EventResult.md +0 -11
  162. data/docs/Expirations.md +0 -10
  163. data/docs/ExternalDocServiceErrorDetails.md +0 -10
  164. data/docs/ExternalFile.md +0 -15
  165. data/docs/ExternalFolder.md +0 -17
  166. data/docs/FeatureSet.md +0 -16
  167. data/docs/FileType.md +0 -9
  168. data/docs/FileTypeList.md +0 -8
  169. data/docs/Filter.md +0 -18
  170. data/docs/FirstName.md +0 -38
  171. data/docs/Folder.md +0 -19
  172. data/docs/FolderItem.md +0 -28
  173. data/docs/FolderItemResponse.md +0 -14
  174. data/docs/FolderItemV2.md +0 -27
  175. data/docs/FolderItemsResponse.md +0 -14
  176. data/docs/FoldersApi.md +0 -261
  177. data/docs/FoldersRequest.md +0 -9
  178. data/docs/FoldersResponse.md +0 -8
  179. data/docs/ForgottenPasswordInformation.md +0 -15
  180. data/docs/FormulaTab.md +0 -56
  181. data/docs/FullName.md +0 -38
  182. data/docs/Group.md +0 -13
  183. data/docs/GroupInformation.md +0 -14
  184. data/docs/GroupsApi.md +0 -552
  185. data/docs/IdCheckInformationInput.md +0 -11
  186. data/docs/InPersonSigner.md +0 -62
  187. data/docs/InitialHere.md +0 -34
  188. data/docs/InlineTemplate.md +0 -12
  189. data/docs/IntegratedUserInfoList.md +0 -15
  190. data/docs/Intermediary.md +0 -49
  191. data/docs/LastName.md +0 -38
  192. data/docs/List.md +0 -46
  193. data/docs/ListCustomField.md +0 -15
  194. data/docs/ListItem.md +0 -10
  195. data/docs/LockInformation.md +0 -15
  196. data/docs/LockRequest.md +0 -12
  197. data/docs/LoginAccount.md +0 -18
  198. data/docs/LoginInformation.md +0 -9
  199. data/docs/MatchBox.md +0 -12
  200. data/docs/MemberGroupSharedItem.md +0 -10
  201. data/docs/MemberSharedItems.md +0 -11
  202. data/docs/MergeField.md +0 -12
  203. data/docs/MobileNotifierConfiguration.md +0 -10
  204. data/docs/MobileNotifierConfigurationInformation.md +0 -8
  205. data/docs/Money.md +0 -10
  206. data/docs/NameValue.md +0 -11
  207. data/docs/NewAccountDefinition.md +0 -17
  208. data/docs/NewAccountSummary.md +0 -14
  209. data/docs/NewUser.md +0 -17
  210. data/docs/NewUsersDefinition.md +0 -8
  211. data/docs/NewUsersSummary.md +0 -8
  212. data/docs/NotaryHost.md +0 -47
  213. data/docs/Note.md +0 -42
  214. data/docs/Notification.md +0 -10
  215. data/docs/Number.md +0 -54
  216. data/docs/OauthAccess.md +0 -13
  217. data/docs/OfflineAttributes.md +0 -13
  218. data/docs/Page.md +0 -15
  219. data/docs/PageImages.md +0 -14
  220. data/docs/PageRequest.md +0 -9
  221. data/docs/PaymentDetails.md +0 -12
  222. data/docs/PaymentLineItem.md +0 -11
  223. data/docs/PermissionProfile.md +0 -14
  224. data/docs/PermissionProfileInformation.md +0 -8
  225. data/docs/PlanInformation.md +0 -13
  226. data/docs/PostTransactionsRequest.md +0 -11
  227. data/docs/PostTransactionsResponse.md +0 -9
  228. data/docs/PowerForm.md +0 -31
  229. data/docs/PowerFormFormDataEnvelope.md +0 -9
  230. data/docs/PowerFormFormDataRecipient.md +0 -11
  231. data/docs/PowerFormRecipient.md +0 -20
  232. data/docs/PowerFormSendersResponse.md +0 -14
  233. data/docs/PowerFormsApi.md +0 -419
  234. data/docs/PowerFormsFormDataResponse.md +0 -8
  235. data/docs/PowerFormsRequest.md +0 -8
  236. data/docs/PowerFormsResponse.md +0 -14
  237. data/docs/PropertyMetadata.md +0 -9
  238. data/docs/Province.md +0 -9
  239. data/docs/ProvisioningInformation.md +0 -14
  240. data/docs/PurchasedEnvelopesInformation.md +0 -16
  241. data/docs/Radio.md +0 -25
  242. data/docs/RadioGroup.md +0 -16
  243. data/docs/RecipientAttachment.md +0 -13
  244. data/docs/RecipientDomain.md +0 -11
  245. data/docs/RecipientEmailNotification.md +0 -10
  246. data/docs/RecipientEvent.md +0 -9
  247. data/docs/RecipientFormData.md +0 -15
  248. data/docs/RecipientNamesResponse.md +0 -10
  249. data/docs/RecipientPhoneAuthentication.md +0 -11
  250. data/docs/RecipientSAMLAuthentication.md +0 -8
  251. data/docs/RecipientSMSAuthentication.md +0 -8
  252. data/docs/RecipientSignatureInformation.md +0 -10
  253. data/docs/RecipientSignatureProvider.md +0 -9
  254. data/docs/RecipientSignatureProviderOptions.md +0 -11
  255. data/docs/RecipientUpdateResponse.md +0 -10
  256. data/docs/RecipientViewRequest.md +0 -21
  257. data/docs/Recipients.md +0 -17
  258. data/docs/RecipientsUpdateSummary.md +0 -8
  259. data/docs/ReferralInformation.md +0 -25
  260. data/docs/Reminders.md +0 -10
  261. data/docs/ResourceInformation.md +0 -8
  262. data/docs/ReturnUrlRequest.md +0 -8
  263. data/docs/SamlAssertionAttribute.md +0 -11
  264. data/docs/SeatDiscount.md +0 -10
  265. data/docs/SenderEmailNotifications.md +0 -14
  266. data/docs/ServerTemplate.md +0 -9
  267. data/docs/ServiceInformation.md +0 -13
  268. data/docs/ServiceVersion.md +0 -9
  269. data/docs/SettingsMetadata.md +0 -13
  270. data/docs/SharedItem.md +0 -10
  271. data/docs/SignHere.md +0 -34
  272. data/docs/SignatureProviderRequiredOption.md +0 -9
  273. data/docs/SignatureType.md +0 -9
  274. data/docs/Signer.md +0 -63
  275. data/docs/SignerAttachment.md +0 -34
  276. data/docs/SignerEmailNotifications.md +0 -21
  277. data/docs/SigningGroup.md +0 -17
  278. data/docs/SigningGroupInformation.md +0 -8
  279. data/docs/SigningGroupUser.md +0 -10
  280. data/docs/SigningGroupUsers.md +0 -8
  281. data/docs/SigningGroupsApi.md +0 -485
  282. data/docs/SocialAccountInformation.md +0 -12
  283. data/docs/SocialAuthentication.md +0 -8
  284. data/docs/Ssn.md +0 -52
  285. data/docs/Ssn4InformationInput.md +0 -10
  286. data/docs/Ssn9InformationInput.md +0 -9
  287. data/docs/TabAccountSettings.md +0 -45
  288. data/docs/TabMetadata.md +0 -46
  289. data/docs/TabMetadataList.md +0 -8
  290. data/docs/Tabs.md +0 -32
  291. data/docs/TemplateCustomFields.md +0 -9
  292. data/docs/TemplateDocumentVisibilityList.md +0 -8
  293. data/docs/TemplateDocumentsResult.md +0 -9
  294. data/docs/TemplateInformation.md +0 -8
  295. data/docs/TemplateMatch.md +0 -10
  296. data/docs/TemplateNotificationRequest.md +0 -11
  297. data/docs/TemplateRecipients.md +0 -17
  298. data/docs/TemplateRole.md +0 -19
  299. data/docs/TemplateSharedItem.md +0 -14
  300. data/docs/TemplateSummary.md +0 -14
  301. data/docs/TemplateTabs.md +0 -32
  302. data/docs/TemplateUpdateSummary.md +0 -15
  303. data/docs/TemplatesApi.md +0 -2349
  304. data/docs/Text.md +0 -55
  305. data/docs/TextCustomField.md +0 -14
  306. data/docs/Title.md +0 -46
  307. data/docs/UsageHistory.md +0 -11
  308. data/docs/UserAccountManagementGranularInformation.md +0 -15
  309. data/docs/UserInfo.md +0 -17
  310. data/docs/UserInfoList.md +0 -8
  311. data/docs/UserInformation.md +0 -41
  312. data/docs/UserInformationList.md +0 -14
  313. data/docs/UserPasswordInformation.md +0 -11
  314. data/docs/UserProfile.md +0 -19
  315. data/docs/UserSettingsInformation.md +0 -11
  316. data/docs/UserSharedItem.md +0 -10
  317. data/docs/UserSignature.md +0 -20
  318. data/docs/UserSignatureDefinition.md +0 -11
  319. data/docs/UserSignaturesInformation.md +0 -8
  320. data/docs/UserSocialIdResult.md +0 -9
  321. data/docs/UsersApi.md +0 -1566
  322. data/docs/UsersResponse.md +0 -14
  323. data/docs/View.md +0 -42
  324. data/docs/ViewLinkRequest.md +0 -9
  325. data/docs/ViewUrl.md +0 -8
  326. data/docs/Workspace.md +0 -18
  327. data/docs/WorkspaceFolderContents.md +0 -15
  328. data/docs/WorkspaceItem.md +0 -26
  329. data/docs/WorkspaceItemList.md +0 -8
  330. data/docs/WorkspaceList.md +0 -12
  331. data/docs/WorkspaceUser.md +0 -23
  332. data/docs/WorkspaceUserAuthorization.md +0 -18
  333. data/docs/WorkspacesApi.md +0 -630
  334. data/docs/Zip.md +0 -53
  335. data/tests/rsa_keys/public.pem +0 -9
@@ -1,14 +0,0 @@
1
- # DocuSign_eSign::UsersResponse
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **end_position** | **String** | The last position in the result set. | [optional]
7
- **next_uri** | **String** | The URI to the next chunk of records based on the search request. If the endPosition is the entire results of the search, this is null. | [optional]
8
- **previous_uri** | **String** | The postal code for the billing address. | [optional]
9
- **result_set_size** | **String** | The number of results returned in this response. | [optional]
10
- **start_position** | **String** | Starting position of the current result set. | [optional]
11
- **total_set_size** | **String** | The total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response. | [optional]
12
- **users** | [**Array<UserInfo>**](UserInfo.md) | | [optional]
13
-
14
-
@@ -1,42 +0,0 @@
1
- # DocuSign_eSign::View
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **anchor_case_sensitive** | **String** | When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**. | [optional]
7
- **anchor_horizontal_alignment** | **String** | Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**. | [optional]
8
- **anchor_ignore_if_not_present** | **String** | When set to **true**, this tab is ignored if anchorString is not found in the document. | [optional]
9
- **anchor_match_whole_word** | **String** | When set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**. | [optional]
10
- **anchor_string** | **String** | Anchor text information for a radio button. | [optional]
11
- **anchor_units** | **String** | Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches. | [optional]
12
- **anchor_x_offset** | **String** | Specifies the X axis location of the tab, in achorUnits, relative to the anchorString. | [optional]
13
- **anchor_y_offset** | **String** | Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString. | [optional]
14
- **bold** | **String** | When set to **true**, the information in the tab is bold. | [optional]
15
- **button_text** | **String** | | [optional]
16
- **conditional_parent_label** | **String** | For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. | [optional]
17
- **conditional_parent_value** | **String** | For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active. | [optional]
18
- **custom_tab_id** | **String** | The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. | [optional]
19
- **document_id** | **String** | Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. | [optional]
20
- **error_details** | [**ErrorDetails**](ErrorDetails.md) | | [optional]
21
- **font** | **String** | The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default. | [optional]
22
- **font_color** | **String** | The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White. | [optional]
23
- **font_size** | **String** | The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72. | [optional]
24
- **height** | **Integer** | Height of the tab in pixels. | [optional]
25
- **italic** | **String** | When set to **true**, the information in the tab is italic. | [optional]
26
- **merge_field** | [**MergeField**](MergeField.md) | | [optional]
27
- **page_number** | **String** | Specifies the page number on which the tab is located. | [optional]
28
- **recipient_id** | **String** | Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. | [optional]
29
- **required** | **String** | When set to **true**, the signer is required to fill out this tab | [optional]
30
- **required_read** | **String** | | [optional]
31
- **status** | **String** | Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. | [optional]
32
- **tab_id** | **String** | The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. | [optional]
33
- **tab_label** | **String** | The label string associated with the tab. | [optional]
34
- **tab_order** | **String** | | [optional]
35
- **template_locked** | **String** | When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. | [optional]
36
- **template_required** | **String** | When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. | [optional]
37
- **underline** | **String** | When set to **true**, the information in the tab is underlined. | [optional]
38
- **width** | **Integer** | Width of the tab in pixels. | [optional]
39
- **x_position** | **String** | This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. | [optional]
40
- **y_position** | **String** | This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. | [optional]
41
-
42
-
@@ -1,9 +0,0 @@
1
- # DocuSign_eSign::ViewLinkRequest
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **email** | **String** | | [optional]
7
- **return_url** | **String** | | [optional]
8
-
9
-
@@ -1,8 +0,0 @@
1
- # DocuSign_eSign::ViewUrl
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **url** | **String** | The view URL to be navigated to. | [optional]
7
-
8
-
@@ -1,18 +0,0 @@
1
- # DocuSign_eSign::Workspace
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **billable_account_id** | **String** | | [optional]
7
- **created** | **String** | | [optional]
8
- **created_by_information** | [**WorkspaceUser**](WorkspaceUser.md) | | [optional]
9
- **last_modified** | **String** | Utc date and time the comment was last updated (can only be done by creator.) | [optional]
10
- **last_modified_by_information** | [**WorkspaceUser**](WorkspaceUser.md) | | [optional]
11
- **status** | **String** | Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. | [optional]
12
- **workspace_base_url** | **String** | The relative URL that may be used to access the workspace. | [optional]
13
- **workspace_description** | **String** | Text describing the purpose of the workspace. | [optional]
14
- **workspace_id** | **String** | The id of the workspace, always populated. | [optional]
15
- **workspace_name** | **String** | The name of the workspace. | [optional]
16
- **workspace_uri** | **String** | The relative URI that may be used to access the workspace. | [optional]
17
-
18
-
@@ -1,15 +0,0 @@
1
- # DocuSign_eSign::WorkspaceFolderContents
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **end_position** | **String** | The last position in the result set. | [optional]
7
- **folder** | [**WorkspaceItem**](WorkspaceItem.md) | | [optional]
8
- **items** | [**Array<WorkspaceItem>**](WorkspaceItem.md) | | [optional]
9
- **parent_folders** | [**Array<WorkspaceItem>**](WorkspaceItem.md) | | [optional]
10
- **result_set_size** | **String** | The number of results returned in this response. | [optional]
11
- **start_position** | **String** | Starting position of the current result set. | [optional]
12
- **total_set_size** | **String** | The total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response. | [optional]
13
- **workspace_id** | **String** | The id of the workspace, always populated. | [optional]
14
-
15
-
@@ -1,26 +0,0 @@
1
- # DocuSign_eSign::WorkspaceItem
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **caller_authorization** | [**WorkspaceUserAuthorization**](WorkspaceUserAuthorization.md) | | [optional]
7
- **content_type** | **String** | | [optional]
8
- **created** | **String** | The UTC DateTime when the workspace item was created. | [optional]
9
- **created_by_id** | **String** | | [optional]
10
- **created_by_information** | [**WorkspaceUser**](WorkspaceUser.md) | | [optional]
11
- **extension** | **String** | | [optional]
12
- **file_size** | **String** | | [optional]
13
- **file_uri** | **String** | | [optional]
14
- **id** | **String** | | [optional]
15
- **is_public** | **String** | If true, this supersedes need for bit mask permission with workspaceUserAuthorization | [optional]
16
- **last_modified** | **String** | | [optional]
17
- **last_modified_by_id** | **String** | Utc date and time the comment was last updated (can only be done by creator) | [optional]
18
- **last_modified_by_information** | [**WorkspaceUser**](WorkspaceUser.md) | | [optional]
19
- **name** | **String** | A simple string description of the item, such as a file name or a folder name. | [optional]
20
- **page_count** | **String** | | [optional]
21
- **parent_folder_id** | **String** | The ID of the parent folder. This is the GUID of the parent folder, or the special value 'root' for the root folder. | [optional]
22
- **parent_folder_uri** | **String** | | [optional]
23
- **type** | **String** | The type of the workspace item. Valid values are file, folder. | [optional]
24
- **uri** | **String** | | [optional]
25
-
26
-
@@ -1,8 +0,0 @@
1
- # DocuSign_eSign::WorkspaceItemList
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **items** | [**Array<WorkspaceItem>**](WorkspaceItem.md) | | [optional]
7
-
8
-
@@ -1,12 +0,0 @@
1
- # DocuSign_eSign::WorkspaceList
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **end_position** | **String** | The last position in the result set. | [optional]
7
- **result_set_size** | **String** | The number of results returned in this response. | [optional]
8
- **start_position** | **String** | Starting position of the current result set. | [optional]
9
- **total_set_size** | **String** | The total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response. | [optional]
10
- **workspaces** | [**Array<Workspace>**](Workspace.md) | A list of workspaces. | [optional]
11
-
12
-
@@ -1,23 +0,0 @@
1
- # DocuSign_eSign::WorkspaceUser
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **account_id** | **String** | The account ID associated with the envelope. | [optional]
7
- **account_name** | **String** | The name of the account that the workspace user belongs to. | [optional]
8
- **active_since** | **String** | | [optional]
9
- **created** | **String** | The UTC DateTime when the workspace user was created. | [optional]
10
- **created_by_id** | **String** | | [optional]
11
- **email** | **String** | | [optional]
12
- **error_details** | [**ErrorDetails**](ErrorDetails.md) | | [optional]
13
- **last_modified** | **String** | Utc date and time the comment was last updated (can only be done by creator.) | [optional]
14
- **last_modified_by_id** | **String** | | [optional]
15
- **status** | **String** | Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. | [optional]
16
- **type** | **String** | Type of the user. Valid values: type_owner, type_participant. | [optional]
17
- **user_id** | **String** | | [optional]
18
- **user_name** | **String** | | [optional]
19
- **workspace_id** | **String** | | [optional]
20
- **workspace_user_base_url** | **String** | The relative URI that may be used to access a workspace user. | [optional]
21
- **workspace_user_id** | **String** | | [optional]
22
-
23
-
@@ -1,18 +0,0 @@
1
- # DocuSign_eSign::WorkspaceUserAuthorization
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **can_delete** | **String** | | [optional]
7
- **can_move** | **String** | | [optional]
8
- **can_transact** | **String** | | [optional]
9
- **can_view** | **String** | | [optional]
10
- **created** | **String** | The UTC DateTime when the workspace user authorization was created. | [optional]
11
- **created_by_id** | **String** | | [optional]
12
- **error_details** | [**ErrorDetails**](ErrorDetails.md) | | [optional]
13
- **modified** | **String** | | [optional]
14
- **modified_by_id** | **String** | | [optional]
15
- **workspace_user_id** | **String** | | [optional]
16
- **workspace_user_information** | [**WorkspaceUser**](WorkspaceUser.md) | | [optional]
17
-
18
-
@@ -1,630 +0,0 @@
1
- # DocuSign_eSign::WorkspacesApi
2
-
3
- All URIs are relative to *https://www.docusign.net/restapi*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**create_workspace**](WorkspacesApi.md#create_workspace) | **POST** /v2/accounts/{accountId}/workspaces | Create a Workspace
8
- [**create_workspace_file**](WorkspacesApi.md#create_workspace_file) | **POST** /v2/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files | Creates a workspace file.
9
- [**delete_workspace**](WorkspacesApi.md#delete_workspace) | **DELETE** /v2/accounts/{accountId}/workspaces/{workspaceId} | Delete Workspace
10
- [**delete_workspace_folder_items**](WorkspacesApi.md#delete_workspace_folder_items) | **DELETE** /v2/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId} | Deletes workspace one or more specific files/folders from the given folder or root.
11
- [**get_workspace**](WorkspacesApi.md#get_workspace) | **GET** /v2/accounts/{accountId}/workspaces/{workspaceId} | Get Workspace
12
- [**get_workspace_file**](WorkspacesApi.md#get_workspace_file) | **GET** /v2/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId} | Get Workspace File
13
- [**list_workspace_file_pages**](WorkspacesApi.md#list_workspace_file_pages) | **GET** /v2/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}/pages | List File Pages
14
- [**list_workspace_folder_items**](WorkspacesApi.md#list_workspace_folder_items) | **GET** /v2/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId} | List Workspace Folder Contents
15
- [**list_workspaces**](WorkspacesApi.md#list_workspaces) | **GET** /v2/accounts/{accountId}/workspaces | List Workspaces
16
- [**update_workspace**](WorkspacesApi.md#update_workspace) | **PUT** /v2/accounts/{accountId}/workspaces/{workspaceId} | Update Workspace
17
- [**update_workspace_file**](WorkspacesApi.md#update_workspace_file) | **PUT** /v2/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId} | Update Workspace File Metadata
18
-
19
-
20
- # **create_workspace**
21
- > Workspace create_workspace(account_id, opts)
22
-
23
- Create a Workspace
24
-
25
- Creates a new workspace.
26
-
27
- ### Example
28
- ```ruby
29
- # load the gem
30
- require 'docusign_esign'
31
-
32
- api_instance = DocuSign_eSign::WorkspacesApi.new
33
-
34
- account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
35
-
36
- opts = {
37
- workspace: DocuSign_eSign::Workspace.new # Workspace |
38
- }
39
-
40
- begin
41
- #Create a Workspace
42
- result = api_instance.create_workspace(account_id, opts)
43
- p result
44
- rescue DocuSign_eSign::ApiError => e
45
- puts "Exception when calling WorkspacesApi->create_workspace: #{e}"
46
- end
47
- ```
48
-
49
- ### Parameters
50
-
51
- Name | Type | Description | Notes
52
- ------------- | ------------- | ------------- | -------------
53
- **account_id** | **String**| The external account number (int) or account ID Guid. |
54
- **workspace** | [**Workspace**](Workspace.md)| | [optional]
55
-
56
- ### Return type
57
-
58
- [**Workspace**](Workspace.md)
59
-
60
- ### Authorization
61
-
62
- No authorization required
63
-
64
- ### HTTP request headers
65
-
66
- - **Content-Type**: Not defined
67
- - **Accept**: application/json
68
-
69
-
70
-
71
- # **create_workspace_file**
72
- > WorkspaceItem create_workspace_file(account_id, folder_id, workspace_id)
73
-
74
- Creates a workspace file.
75
-
76
- ### Example
77
- ```ruby
78
- # load the gem
79
- require 'docusign_esign'
80
-
81
- api_instance = DocuSign_eSign::WorkspacesApi.new
82
-
83
- account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
84
-
85
- folder_id = "folder_id_example" # String | The ID of the folder being accessed.
86
-
87
- workspace_id = "workspace_id_example" # String | Specifies the workspace ID GUID.
88
-
89
-
90
- begin
91
- #Creates a workspace file.
92
- result = api_instance.create_workspace_file(account_id, folder_id, workspace_id)
93
- p result
94
- rescue DocuSign_eSign::ApiError => e
95
- puts "Exception when calling WorkspacesApi->create_workspace_file: #{e}"
96
- end
97
- ```
98
-
99
- ### Parameters
100
-
101
- Name | Type | Description | Notes
102
- ------------- | ------------- | ------------- | -------------
103
- **account_id** | **String**| The external account number (int) or account ID Guid. |
104
- **folder_id** | **String**| The ID of the folder being accessed. |
105
- **workspace_id** | **String**| Specifies the workspace ID GUID. |
106
-
107
- ### Return type
108
-
109
- [**WorkspaceItem**](WorkspaceItem.md)
110
-
111
- ### Authorization
112
-
113
- No authorization required
114
-
115
- ### HTTP request headers
116
-
117
- - **Content-Type**: Not defined
118
- - **Accept**: application/json
119
-
120
-
121
-
122
- # **delete_workspace**
123
- > Workspace delete_workspace(account_id, workspace_id)
124
-
125
- Delete Workspace
126
-
127
- Deletes an existing workspace (logically).
128
-
129
- ### Example
130
- ```ruby
131
- # load the gem
132
- require 'docusign_esign'
133
-
134
- api_instance = DocuSign_eSign::WorkspacesApi.new
135
-
136
- account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
137
-
138
- workspace_id = "workspace_id_example" # String | Specifies the workspace ID GUID.
139
-
140
-
141
- begin
142
- #Delete Workspace
143
- result = api_instance.delete_workspace(account_id, workspace_id)
144
- p result
145
- rescue DocuSign_eSign::ApiError => e
146
- puts "Exception when calling WorkspacesApi->delete_workspace: #{e}"
147
- end
148
- ```
149
-
150
- ### Parameters
151
-
152
- Name | Type | Description | Notes
153
- ------------- | ------------- | ------------- | -------------
154
- **account_id** | **String**| The external account number (int) or account ID Guid. |
155
- **workspace_id** | **String**| Specifies the workspace ID GUID. |
156
-
157
- ### Return type
158
-
159
- [**Workspace**](Workspace.md)
160
-
161
- ### Authorization
162
-
163
- No authorization required
164
-
165
- ### HTTP request headers
166
-
167
- - **Content-Type**: Not defined
168
- - **Accept**: application/json
169
-
170
-
171
-
172
- # **delete_workspace_folder_items**
173
- > delete_workspace_folder_items(account_id, folder_id, workspace_id, opts)
174
-
175
- Deletes workspace one or more specific files/folders from the given folder or root.
176
-
177
- ### Example
178
- ```ruby
179
- # load the gem
180
- require 'docusign_esign'
181
-
182
- api_instance = DocuSign_eSign::WorkspacesApi.new
183
-
184
- account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
185
-
186
- folder_id = "folder_id_example" # String | The ID of the folder being accessed.
187
-
188
- workspace_id = "workspace_id_example" # String | Specifies the workspace ID GUID.
189
-
190
- opts = {
191
- workspace_item_list: DocuSign_eSign::WorkspaceItemList.new # WorkspaceItemList |
192
- }
193
-
194
- begin
195
- #Deletes workspace one or more specific files/folders from the given folder or root.
196
- api_instance.delete_workspace_folder_items(account_id, folder_id, workspace_id, opts)
197
- rescue DocuSign_eSign::ApiError => e
198
- puts "Exception when calling WorkspacesApi->delete_workspace_folder_items: #{e}"
199
- end
200
- ```
201
-
202
- ### Parameters
203
-
204
- Name | Type | Description | Notes
205
- ------------- | ------------- | ------------- | -------------
206
- **account_id** | **String**| The external account number (int) or account ID Guid. |
207
- **folder_id** | **String**| The ID of the folder being accessed. |
208
- **workspace_id** | **String**| Specifies the workspace ID GUID. |
209
- **workspace_item_list** | [**WorkspaceItemList**](WorkspaceItemList.md)| | [optional]
210
-
211
- ### Return type
212
-
213
- nil (empty response body)
214
-
215
- ### Authorization
216
-
217
- No authorization required
218
-
219
- ### HTTP request headers
220
-
221
- - **Content-Type**: Not defined
222
- - **Accept**: application/json
223
-
224
-
225
-
226
- # **get_workspace**
227
- > Workspace get_workspace(account_id, workspace_id)
228
-
229
- Get Workspace
230
-
231
- Retrives properties about a workspace given a unique workspaceId.
232
-
233
- ### Example
234
- ```ruby
235
- # load the gem
236
- require 'docusign_esign'
237
-
238
- api_instance = DocuSign_eSign::WorkspacesApi.new
239
-
240
- account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
241
-
242
- workspace_id = "workspace_id_example" # String | Specifies the workspace ID GUID.
243
-
244
-
245
- begin
246
- #Get Workspace
247
- result = api_instance.get_workspace(account_id, workspace_id)
248
- p result
249
- rescue DocuSign_eSign::ApiError => e
250
- puts "Exception when calling WorkspacesApi->get_workspace: #{e}"
251
- end
252
- ```
253
-
254
- ### Parameters
255
-
256
- Name | Type | Description | Notes
257
- ------------- | ------------- | ------------- | -------------
258
- **account_id** | **String**| The external account number (int) or account ID Guid. |
259
- **workspace_id** | **String**| Specifies the workspace ID GUID. |
260
-
261
- ### Return type
262
-
263
- [**Workspace**](Workspace.md)
264
-
265
- ### Authorization
266
-
267
- No authorization required
268
-
269
- ### HTTP request headers
270
-
271
- - **Content-Type**: Not defined
272
- - **Accept**: application/json
273
-
274
-
275
-
276
- # **get_workspace_file**
277
- > get_workspace_file(account_id, file_id, folder_id, workspace_id, opts)
278
-
279
- Get Workspace File
280
-
281
- Retrieves a workspace file (the binary).
282
-
283
- ### Example
284
- ```ruby
285
- # load the gem
286
- require 'docusign_esign'
287
-
288
- api_instance = DocuSign_eSign::WorkspacesApi.new
289
-
290
- account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
291
-
292
- file_id = "file_id_example" # String | Specifies the room file ID GUID.
293
-
294
- folder_id = "folder_id_example" # String | The ID of the folder being accessed.
295
-
296
- workspace_id = "workspace_id_example" # String | Specifies the workspace ID GUID.
297
-
298
- opts = {
299
- is_download: "is_download_example", # String | 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**.
300
- pdf_version: "pdf_version_example" # String | When set to **true** the file returned as a PDF.
301
- }
302
-
303
- begin
304
- #Get Workspace File
305
- api_instance.get_workspace_file(account_id, file_id, folder_id, workspace_id, opts)
306
- rescue DocuSign_eSign::ApiError => e
307
- puts "Exception when calling WorkspacesApi->get_workspace_file: #{e}"
308
- end
309
- ```
310
-
311
- ### Parameters
312
-
313
- Name | Type | Description | Notes
314
- ------------- | ------------- | ------------- | -------------
315
- **account_id** | **String**| The external account number (int) or account ID Guid. |
316
- **file_id** | **String**| Specifies the room file ID GUID. |
317
- **folder_id** | **String**| The ID of the folder being accessed. |
318
- **workspace_id** | **String**| Specifies the workspace ID GUID. |
319
- **is_download** | **String**| 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**. | [optional]
320
- **pdf_version** | **String**| When set to **true** the file returned as a PDF. | [optional]
321
-
322
- ### Return type
323
-
324
- nil (empty response body)
325
-
326
- ### Authorization
327
-
328
- No authorization required
329
-
330
- ### HTTP request headers
331
-
332
- - **Content-Type**: Not defined
333
- - **Accept**: application/json
334
-
335
-
336
-
337
- # **list_workspace_file_pages**
338
- > PageImages list_workspace_file_pages(account_id, file_id, folder_id, workspace_id, opts)
339
-
340
- List File Pages
341
-
342
- Retrieves a workspace file as rasterized pages.
343
-
344
- ### Example
345
- ```ruby
346
- # load the gem
347
- require 'docusign_esign'
348
-
349
- api_instance = DocuSign_eSign::WorkspacesApi.new
350
-
351
- account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
352
-
353
- file_id = "file_id_example" # String | Specifies the room file ID GUID.
354
-
355
- folder_id = "folder_id_example" # String | The ID of the folder being accessed.
356
-
357
- workspace_id = "workspace_id_example" # String | Specifies the workspace ID GUID.
358
-
359
- opts = {
360
- count: "count_example", # String | The maximum number of results to be returned by this request.
361
- dpi: "dpi_example", # String | Number of dots per inch for the resulting image. The default if not used is 94. The range is 1-310.
362
- max_height: "max_height_example", # String | Sets the maximum height (in pixels) of the returned image.
363
- max_width: "max_width_example", # String | Sets the maximum width (in pixels) of the returned image.
364
- start_position: "start_position_example" # String | The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.
365
- }
366
-
367
- begin
368
- #List File Pages
369
- result = api_instance.list_workspace_file_pages(account_id, file_id, folder_id, workspace_id, opts)
370
- p result
371
- rescue DocuSign_eSign::ApiError => e
372
- puts "Exception when calling WorkspacesApi->list_workspace_file_pages: #{e}"
373
- end
374
- ```
375
-
376
- ### Parameters
377
-
378
- Name | Type | Description | Notes
379
- ------------- | ------------- | ------------- | -------------
380
- **account_id** | **String**| The external account number (int) or account ID Guid. |
381
- **file_id** | **String**| Specifies the room file ID GUID. |
382
- **folder_id** | **String**| The ID of the folder being accessed. |
383
- **workspace_id** | **String**| Specifies the workspace ID GUID. |
384
- **count** | **String**| The maximum number of results to be returned by this request. | [optional]
385
- **dpi** | **String**| Number of dots per inch for the resulting image. The default if not used is 94. The range is 1-310. | [optional]
386
- **max_height** | **String**| Sets the maximum height (in pixels) of the returned image. | [optional]
387
- **max_width** | **String**| Sets the maximum width (in pixels) of the returned image. | [optional]
388
- **start_position** | **String**| The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image. | [optional]
389
-
390
- ### Return type
391
-
392
- [**PageImages**](PageImages.md)
393
-
394
- ### Authorization
395
-
396
- No authorization required
397
-
398
- ### HTTP request headers
399
-
400
- - **Content-Type**: Not defined
401
- - **Accept**: application/json
402
-
403
-
404
-
405
- # **list_workspace_folder_items**
406
- > WorkspaceFolderContents list_workspace_folder_items(account_id, folder_id, workspace_id, opts)
407
-
408
- List Workspace Folder Contents
409
-
410
- Retrieves workspace folder contents, which can include sub folders and files.
411
-
412
- ### Example
413
- ```ruby
414
- # load the gem
415
- require 'docusign_esign'
416
-
417
- api_instance = DocuSign_eSign::WorkspacesApi.new
418
-
419
- account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
420
-
421
- folder_id = "folder_id_example" # String | The ID of the folder being accessed.
422
-
423
- workspace_id = "workspace_id_example" # String | Specifies the workspace ID GUID.
424
-
425
- opts = {
426
- count: "count_example", # String | The maximum number of results to be returned by this request.
427
- include_files: "include_files_example", # String | When set to **true**, file information is returned in the response along with folder information. The default is **false**.
428
- include_sub_folders: "include_sub_folders_example", # String | When set to **true**, information about the sub-folders of the current folder is returned. The default is **false**.
429
- include_thumbnails: "include_thumbnails_example", # String | When set to **true**, thumbnails are returned as part of the response. The default is **false**.
430
- include_user_detail: "include_user_detail_example", # String | Set to **true** to return extended details about the user. The default is **false**.
431
- start_position: "start_position_example", # String | The position within the total result set from which to start returning values.
432
- workspace_user_id: "workspace_user_id_example" # String | If set, then the results are filtered to those associated with the specified userId.
433
- }
434
-
435
- begin
436
- #List Workspace Folder Contents
437
- result = api_instance.list_workspace_folder_items(account_id, folder_id, workspace_id, opts)
438
- p result
439
- rescue DocuSign_eSign::ApiError => e
440
- puts "Exception when calling WorkspacesApi->list_workspace_folder_items: #{e}"
441
- end
442
- ```
443
-
444
- ### Parameters
445
-
446
- Name | Type | Description | Notes
447
- ------------- | ------------- | ------------- | -------------
448
- **account_id** | **String**| The external account number (int) or account ID Guid. |
449
- **folder_id** | **String**| The ID of the folder being accessed. |
450
- **workspace_id** | **String**| Specifies the workspace ID GUID. |
451
- **count** | **String**| The maximum number of results to be returned by this request. | [optional]
452
- **include_files** | **String**| When set to **true**, file information is returned in the response along with folder information. The default is **false**. | [optional]
453
- **include_sub_folders** | **String**| When set to **true**, information about the sub-folders of the current folder is returned. The default is **false**. | [optional]
454
- **include_thumbnails** | **String**| When set to **true**, thumbnails are returned as part of the response. The default is **false**. | [optional]
455
- **include_user_detail** | **String**| Set to **true** to return extended details about the user. The default is **false**. | [optional]
456
- **start_position** | **String**| The position within the total result set from which to start returning values. | [optional]
457
- **workspace_user_id** | **String**| If set, then the results are filtered to those associated with the specified userId. | [optional]
458
-
459
- ### Return type
460
-
461
- [**WorkspaceFolderContents**](WorkspaceFolderContents.md)
462
-
463
- ### Authorization
464
-
465
- No authorization required
466
-
467
- ### HTTP request headers
468
-
469
- - **Content-Type**: Not defined
470
- - **Accept**: application/json
471
-
472
-
473
-
474
- # **list_workspaces**
475
- > WorkspaceList list_workspaces(account_id)
476
-
477
- List Workspaces
478
-
479
- Gets information about the Workspaces that have been created.
480
-
481
- ### Example
482
- ```ruby
483
- # load the gem
484
- require 'docusign_esign'
485
-
486
- api_instance = DocuSign_eSign::WorkspacesApi.new
487
-
488
- account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
489
-
490
-
491
- begin
492
- #List Workspaces
493
- result = api_instance.list_workspaces(account_id)
494
- p result
495
- rescue DocuSign_eSign::ApiError => e
496
- puts "Exception when calling WorkspacesApi->list_workspaces: #{e}"
497
- end
498
- ```
499
-
500
- ### Parameters
501
-
502
- Name | Type | Description | Notes
503
- ------------- | ------------- | ------------- | -------------
504
- **account_id** | **String**| The external account number (int) or account ID Guid. |
505
-
506
- ### Return type
507
-
508
- [**WorkspaceList**](WorkspaceList.md)
509
-
510
- ### Authorization
511
-
512
- No authorization required
513
-
514
- ### HTTP request headers
515
-
516
- - **Content-Type**: Not defined
517
- - **Accept**: application/json
518
-
519
-
520
-
521
- # **update_workspace**
522
- > Workspace update_workspace(account_id, workspace_id, opts)
523
-
524
- Update Workspace
525
-
526
- Updates information about a specific workspace.
527
-
528
- ### Example
529
- ```ruby
530
- # load the gem
531
- require 'docusign_esign'
532
-
533
- api_instance = DocuSign_eSign::WorkspacesApi.new
534
-
535
- account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
536
-
537
- workspace_id = "workspace_id_example" # String | Specifies the workspace ID GUID.
538
-
539
- opts = {
540
- workspace: DocuSign_eSign::Workspace.new # Workspace |
541
- }
542
-
543
- begin
544
- #Update Workspace
545
- result = api_instance.update_workspace(account_id, workspace_id, opts)
546
- p result
547
- rescue DocuSign_eSign::ApiError => e
548
- puts "Exception when calling WorkspacesApi->update_workspace: #{e}"
549
- end
550
- ```
551
-
552
- ### Parameters
553
-
554
- Name | Type | Description | Notes
555
- ------------- | ------------- | ------------- | -------------
556
- **account_id** | **String**| The external account number (int) or account ID Guid. |
557
- **workspace_id** | **String**| Specifies the workspace ID GUID. |
558
- **workspace** | [**Workspace**](Workspace.md)| | [optional]
559
-
560
- ### Return type
561
-
562
- [**Workspace**](Workspace.md)
563
-
564
- ### Authorization
565
-
566
- No authorization required
567
-
568
- ### HTTP request headers
569
-
570
- - **Content-Type**: Not defined
571
- - **Accept**: application/json
572
-
573
-
574
-
575
- # **update_workspace_file**
576
- > WorkspaceItem update_workspace_file(account_id, file_id, folder_id, workspace_id)
577
-
578
- Update Workspace File Metadata
579
-
580
- Updates workspace item metadata for one or more specific files/folders.
581
-
582
- ### Example
583
- ```ruby
584
- # load the gem
585
- require 'docusign_esign'
586
-
587
- api_instance = DocuSign_eSign::WorkspacesApi.new
588
-
589
- account_id = "account_id_example" # String | The external account number (int) or account ID Guid.
590
-
591
- file_id = "file_id_example" # String | Specifies the room file ID GUID.
592
-
593
- folder_id = "folder_id_example" # String | The ID of the folder being accessed.
594
-
595
- workspace_id = "workspace_id_example" # String | Specifies the workspace ID GUID.
596
-
597
-
598
- begin
599
- #Update Workspace File Metadata
600
- result = api_instance.update_workspace_file(account_id, file_id, folder_id, workspace_id)
601
- p result
602
- rescue DocuSign_eSign::ApiError => e
603
- puts "Exception when calling WorkspacesApi->update_workspace_file: #{e}"
604
- end
605
- ```
606
-
607
- ### Parameters
608
-
609
- Name | Type | Description | Notes
610
- ------------- | ------------- | ------------- | -------------
611
- **account_id** | **String**| The external account number (int) or account ID Guid. |
612
- **file_id** | **String**| Specifies the room file ID GUID. |
613
- **folder_id** | **String**| The ID of the folder being accessed. |
614
- **workspace_id** | **String**| Specifies the workspace ID GUID. |
615
-
616
- ### Return type
617
-
618
- [**WorkspaceItem**](WorkspaceItem.md)
619
-
620
- ### Authorization
621
-
622
- No authorization required
623
-
624
- ### HTTP request headers
625
-
626
- - **Content-Type**: Not defined
627
- - **Accept**: application/json
628
-
629
-
630
-