├── .DS_Store ├── docs ├── Model │ ├── DocumentStatusEnum.md │ ├── WebhookEventErrorEnum.md │ ├── UploadSectionStatusEnum.md │ ├── WebhookEventTriggerEnum.md │ ├── DocumentOrderingFieldsEnum.md │ ├── DocumentStatusRequestEnum.md │ ├── WebhookSubscriptionStatusEnum.md │ ├── WebhookSubscriptionPayloadEnum.md │ ├── WebhookSubscriptionTriggerEnum.md │ ├── WebhookEventHttpStatusCodeGroupEnum.md │ ├── CreateWorkspaceRequest.md │ ├── CreateUserResponse.md │ ├── QuoteResponseSettings.md │ ├── AddMemberRequest.md │ ├── DocumentRecipientResponse.md │ ├── RecipientRedirect.md │ ├── QuoteUpdateRequestSettings1.md │ ├── DocumentCreateRequestImages.md │ ├── WebhookSubscriptionSharedKeyResponse.md │ ├── DocumentRecipientCreateRequest.md │ ├── DocumentsFolderRenameRequest.md │ ├── TemplatesFolderRenameRequest.md │ ├── CreateWorkspaceResponse.md │ ├── QuoteResponseAction.md │ ├── QuoteResponseOptions.md │ ├── QuoteUpdateRequestPriceSettingsTiers.md │ ├── RecipientVerificationSettingsPasscodeVerification.md │ ├── RecipientVerificationSettingsPhoneVerification.md │ ├── DocumentCreateByTemplateRequestImages.md │ ├── DocumentCreateByTemplateRequestTokens.md │ ├── QuoteUpdateRequestDiscounts.md │ ├── DocumentCreateLinkResponse.md │ ├── PricingTableResponseDiscount.md │ ├── QuoteResponseSummaryDiscounts.md │ ├── TemplateDetailsResponseTokens.md │ ├── CreateUserRequestWorkspaces.md │ ├── DocumentDetailsResponseTemplate.md │ ├── MemberListResponse.md │ ├── UploadSectionListResponseResults.md │ ├── ContactListResponse.md │ ├── QuoteResponseConditionComparison.md │ ├── APILogListResponse.md │ ├── DocumentDetailsResponseGrandTotal.md │ ├── DocumentTransferOwnershipRequest.md │ ├── DocumentListResponse.md │ ├── QuoteResponseSummaryRecurringSubtotal.md │ ├── RicipientDeliveryMethods.md │ ├── TemplateListResponse.md │ ├── WebhookEventPageResponse.md │ ├── SectionInfoResponse.md │ ├── LinkedObjectListResponse.md │ ├── DocumentCreateResponseLinks.md │ ├── QuoteSectionSettings.md │ ├── UploadSectionListResponse.md │ ├── DocumentsFolderCreateResponse.md │ ├── DocumentsFolderListResponse.md │ ├── DocumentsFolderRenameResponse.md │ ├── QuoteUpdateRequestSettings.md │ ├── TemplateDetailsResponseImages.md │ ├── TemplatesFolderCreateResponse.md │ ├── TemplatesFolderListResponse.md │ ├── TemplatesFolderRenameResponse.md │ ├── WebhookSubscriptionListResponse.md │ ├── FormListResponse.md │ ├── PricingTableRequestRowOptions.md │ ├── ContentLibraryItemListResponse.md │ ├── DocumentSendRequestSelectedApproversGroupAssignees.md │ ├── TemplateDetailsResponseContentPlaceholders.md │ ├── CreateUserRequestUser.md │ ├── PricingTableResponseSummary.md │ ├── QuoteResponseSectionColumn.md │ ├── QuoteUpdateRequestOptions.md │ ├── DocumentSendRequestSelectedApprovers.md │ ├── DocumentSendRequestForwardingSettings.md │ ├── DocumentDetailsResponseLinkedObjects.md │ ├── DocumentSendRequestSelectedApproversSteps.md │ ├── PricingTableResponseOptions.md │ ├── PricingTableRequestRows.md │ ├── QuoteResponseCondition.md │ ├── APILogListResponseResults.md │ ├── FormListResponseResults.md │ ├── TemplateDetailsResponsePreassignedPerson.md │ ├── PricingResponse.md │ ├── OAuth2AccessTokenResponse.md │ ├── TemplatesFolderCreateRequest.md │ ├── ContentLibraryItemResponseCreatedBy.md │ ├── DocumentAttachmentResponseCreatedBy.md │ ├── DocumentsFolderCreateRequest.md │ ├── DocumentsFolderListResponseResults.md │ ├── TemplatesFolderListResponseResults.md │ ├── ContentLibraryItemListResponseResults.md │ ├── DocumentCreateLinkRequest.md │ ├── AddMemberResponse.md │ ├── DocumentCreateByTemplateRequestContentPlaceholders.md │ ├── DocumentCreateRequestContentPlaceholders.md │ ├── PricingTableRequestSections.md │ ├── CreateUserRequest.md │ ├── DocumentAttachmentResponse.md │ ├── DocumentDetailsResponseCreatedBy.md │ ├── DocumentTransferAllOwnershipRequest.md │ ├── TemplateListResponseResults.md │ ├── DocumentSendRequestSelectedApproversGroup.md │ ├── QuoteResponseMergeRules.md │ ├── TemplateDetailsResponseRoles.md │ ├── LinkedObjectCreateRequest.md │ ├── DocumentListResponseResults.md │ ├── DocumentStatusChangeRequest.md │ ├── WebhookSubscriptionCreateRequest.md │ ├── PricingTableRequest.md │ ├── QuoteUpdateRequestPriceSettings.md │ ├── LinkedObjectCreateResponse.md │ ├── DocumentCreateByTemplateRequestContentLibraryItems.md │ ├── DocumentCreateRequestContentLibraryItems.md │ ├── UploadSectionStatusResponse.md │ ├── DocumentStatusResponse.md │ ├── WebhookSubscriptionPatchRequest.md │ ├── RecipientVerificationSettings.md │ ├── QuoteUpdateRequest.md │ ├── ContactCreateRequest.md │ ├── ContactUpdateRequest.md │ ├── PricingTableResponse.md │ ├── DocumentUpdateRequestRecipients.md │ ├── ContactDetailsResponse.md │ ├── DocumentSendResponse.md │ ├── UploadSectionResponse.md │ ├── DocumentSendResponseRecipients.md │ ├── DocumentCreateRequestRecipients.md │ ├── DocumentCreateByTemplateRequestRecipients.md │ ├── DocumentCreateResponse.md │ ├── QuoteResponse.md │ ├── WebhookEventItemResponse.md │ ├── QuoteResponseSections.md │ ├── QuoteResponseSectionSummary.md │ ├── WebhookSubscriptionItemResponse.md │ ├── APILogDetailsResponse.md │ ├── UpdateIntegrationQuoteSection.md │ ├── DocumentRecipientEditRequest.md │ ├── ContentLibraryItemResponse.md │ ├── QuoteResponseSummary.md │ ├── DocumentSendRequest.md │ ├── DocumentDetailsResponseRecipients.md │ ├── WebhookEventDetailsResponse.md │ ├── MemberDetailsResponse.md │ ├── TemplateDetailsResponse.md │ ├── PricingTableResponseItems.md │ ├── QuoteResponseSectionItem.md │ ├── DocumentUpdateRequest.md │ ├── DocumentDetailsResponse.md │ ├── UploadSectionByPdfRequest.md │ ├── DocumentCreateByPdfRequest.md │ ├── UpdateIntegrationQuoteSectionItem.md │ ├── UploadSectionByTemplateRequest.md │ ├── UploadSectionRequest.md │ ├── DocumentCreateByTemplateRequest.md │ └── DocumentCreateRequest.md └── Api │ ├── QuotesApi.md │ ├── FormsApi.md │ ├── OAuth20AuthenticationApi.md │ ├── ContentLibraryItemsApi.md │ ├── WebhookEventsApi.md │ ├── MembersApi.md │ ├── APILogsApi.md │ ├── UserAndWorkspaceManagementApi.md │ └── TemplatesApi.md ├── .gitignore ├── composer.json ├── LICENSE ├── src ├── Model │ ├── WebhookSubscriptionStatusEnum.php │ ├── UploadSectionStatusEnum.php │ ├── WebhookEventErrorEnum.php │ ├── WebhookSubscriptionPayloadEnum.php │ ├── WebhookEventHttpStatusCodeGroupEnum.php │ ├── WebhookEventTriggerEnum.php │ ├── WebhookSubscriptionTriggerEnum.php │ ├── DocumentStatusRequestEnum.php │ ├── ModelInterface.php │ ├── DocumentStatusEnum.php │ └── DocumentOrderingFieldsEnum.php ├── HeaderSelector.php └── ApiException.php └── examples └── CreateDocumentFromPdByUrlAndSend.php /.DS_Store: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PandaDoc/pandadoc-api-php-client/HEAD/.DS_Store -------------------------------------------------------------------------------- /docs/Model/DocumentStatusEnum.md: -------------------------------------------------------------------------------- 1 | # # DocumentStatusEnum 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 9 | -------------------------------------------------------------------------------- /docs/Model/WebhookEventErrorEnum.md: -------------------------------------------------------------------------------- 1 | # # WebhookEventErrorEnum 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 9 | -------------------------------------------------------------------------------- /docs/Model/UploadSectionStatusEnum.md: -------------------------------------------------------------------------------- 1 | # # UploadSectionStatusEnum 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 9 | -------------------------------------------------------------------------------- /docs/Model/WebhookEventTriggerEnum.md: -------------------------------------------------------------------------------- 1 | # # WebhookEventTriggerEnum 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 9 | -------------------------------------------------------------------------------- /docs/Model/DocumentOrderingFieldsEnum.md: -------------------------------------------------------------------------------- 1 | # # DocumentOrderingFieldsEnum 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 9 | -------------------------------------------------------------------------------- /docs/Model/DocumentStatusRequestEnum.md: -------------------------------------------------------------------------------- 1 | # # DocumentStatusRequestEnum 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 9 | -------------------------------------------------------------------------------- /docs/Model/WebhookSubscriptionStatusEnum.md: -------------------------------------------------------------------------------- 1 | # # WebhookSubscriptionStatusEnum 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 9 | -------------------------------------------------------------------------------- /docs/Model/WebhookSubscriptionPayloadEnum.md: -------------------------------------------------------------------------------- 1 | # # WebhookSubscriptionPayloadEnum 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 9 | -------------------------------------------------------------------------------- /docs/Model/WebhookSubscriptionTriggerEnum.md: -------------------------------------------------------------------------------- 1 | # # WebhookSubscriptionTriggerEnum 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 9 | -------------------------------------------------------------------------------- /docs/Model/WebhookEventHttpStatusCodeGroupEnum.md: -------------------------------------------------------------------------------- 1 | # # WebhookEventHttpStatusCodeGroupEnum 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 9 | -------------------------------------------------------------------------------- /docs/Model/CreateWorkspaceRequest.md: -------------------------------------------------------------------------------- 1 | # # CreateWorkspaceRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **string** | | 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/CreateUserResponse.md: -------------------------------------------------------------------------------- 1 | # # CreateUserResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **userId** | **string** | | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/QuoteResponseSettings.md: -------------------------------------------------------------------------------- 1 | # # QuoteResponseSettings 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **selectionType** | **string** | | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/AddMemberRequest.md: -------------------------------------------------------------------------------- 1 | # # AddMemberRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **userId** | **string** | | 8 | **role** | **string** | | 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/DocumentRecipientResponse.md: -------------------------------------------------------------------------------- 1 | # # DocumentRecipientResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **recipientId** | **string** | | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/RecipientRedirect.md: -------------------------------------------------------------------------------- 1 | # # RecipientRedirect 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **isEnabled** | **bool** | | 8 | **url** | **string** | | 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/QuoteUpdateRequestSettings1.md: -------------------------------------------------------------------------------- 1 | # # QuoteUpdateRequestSettings1 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **selectionType** | **string** | | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/DocumentCreateRequestImages.md: -------------------------------------------------------------------------------- 1 | # # DocumentCreateRequestImages 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **urls** | **string[]** | | 8 | **name** | **string** | | 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/WebhookSubscriptionSharedKeyResponse.md: -------------------------------------------------------------------------------- 1 | # # WebhookSubscriptionSharedKeyResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **sharedKey** | **string** | | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/DocumentRecipientCreateRequest.md: -------------------------------------------------------------------------------- 1 | # # DocumentRecipientCreateRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **string** | | 8 | **kind** | **string** | | 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/DocumentsFolderRenameRequest.md: -------------------------------------------------------------------------------- 1 | # # DocumentsFolderRenameRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **string** | Provide a new name for the folder. | 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/TemplatesFolderRenameRequest.md: -------------------------------------------------------------------------------- 1 | # # TemplatesFolderRenameRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **string** | Provide a new name for the folder. | 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/CreateWorkspaceResponse.md: -------------------------------------------------------------------------------- 1 | # # CreateWorkspaceResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **string** | | [optional] 8 | **name** | **string** | | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/QuoteResponseAction.md: -------------------------------------------------------------------------------- 1 | # # QuoteResponseAction 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | **string** | | [optional] 8 | **sectionId** | **string** | | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/QuoteResponseOptions.md: -------------------------------------------------------------------------------- 1 | # # QuoteResponseOptions 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **selected** | **bool** | | [optional] 8 | **qtyEditable** | **bool** | | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/QuoteUpdateRequestPriceSettingsTiers.md: -------------------------------------------------------------------------------- 1 | # # QuoteUpdateRequestPriceSettingsTiers 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **minQty** | **int** | | 8 | **value** | **float** | | 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/RecipientVerificationSettingsPasscodeVerification.md: -------------------------------------------------------------------------------- 1 | # # RecipientVerificationSettingsPasscodeVerification 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **passcode** | **string** | | 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/RecipientVerificationSettingsPhoneVerification.md: -------------------------------------------------------------------------------- 1 | # # RecipientVerificationSettingsPhoneVerification 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **phoneNumber** | **string** | | 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/DocumentCreateByTemplateRequestImages.md: -------------------------------------------------------------------------------- 1 | # # DocumentCreateByTemplateRequestImages 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **urls** | **string[]** | | 8 | **name** | **string** | | 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/DocumentCreateByTemplateRequestTokens.md: -------------------------------------------------------------------------------- 1 | # # DocumentCreateByTemplateRequestTokens 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **string** | | 8 | **value** | **string** | | 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/QuoteUpdateRequestDiscounts.md: -------------------------------------------------------------------------------- 1 | # # QuoteUpdateRequestDiscounts 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | **string** | | [optional] 8 | **value** | **float** | | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/DocumentCreateLinkResponse.md: -------------------------------------------------------------------------------- 1 | # # DocumentCreateLinkResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **string** | | [optional] 8 | **expiresAt** | **string** | | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/PricingTableResponseDiscount.md: -------------------------------------------------------------------------------- 1 | # # PricingTableResponseDiscount 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **value** | **string** | | [optional] 8 | **type** | **string** | | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/QuoteResponseSummaryDiscounts.md: -------------------------------------------------------------------------------- 1 | # # QuoteResponseSummaryDiscounts 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | **string** | | [optional] 8 | **value** | **string** | | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/TemplateDetailsResponseTokens.md: -------------------------------------------------------------------------------- 1 | # # TemplateDetailsResponseTokens 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **string** | | [optional] 8 | **value** | **string** | | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/CreateUserRequestWorkspaces.md: -------------------------------------------------------------------------------- 1 | # # CreateUserRequestWorkspaces 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **workspaceId** | **string** | | [optional] 8 | **role** | **string** | | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/DocumentDetailsResponseTemplate.md: -------------------------------------------------------------------------------- 1 | # # DocumentDetailsResponseTemplate 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **string** | | [optional] 8 | **name** | **string** | | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/MemberListResponse.md: -------------------------------------------------------------------------------- 1 | # # MemberListResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **results** | [**\PandaDoc\Client\Model\MemberDetailsResponse[]**](MemberDetailsResponse.md) | | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/UploadSectionListResponseResults.md: -------------------------------------------------------------------------------- 1 | # # UploadSectionListResponseResults 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **uuid** | **string** | | [optional] 8 | **name** | **string** | | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/ContactListResponse.md: -------------------------------------------------------------------------------- 1 | # # ContactListResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **results** | [**\PandaDoc\Client\Model\ContactDetailsResponse[]**](ContactDetailsResponse.md) | | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/QuoteResponseConditionComparison.md: -------------------------------------------------------------------------------- 1 | # # QuoteResponseConditionComparison 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | **string** | | [optional] 8 | **value** | **string** | | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/APILogListResponse.md: -------------------------------------------------------------------------------- 1 | # # APILogListResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **results** | [**\PandaDoc\Client\Model\APILogListResponseResults[]**](APILogListResponseResults.md) | | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/DocumentDetailsResponseGrandTotal.md: -------------------------------------------------------------------------------- 1 | # # DocumentDetailsResponseGrandTotal 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **amount** | **string** | | [optional] 8 | **currency** | **string** | | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/DocumentTransferOwnershipRequest.md: -------------------------------------------------------------------------------- 1 | # # DocumentTransferOwnershipRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **membershipId** | **string** | A unique identifier of a workspace member. | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/DocumentListResponse.md: -------------------------------------------------------------------------------- 1 | # # DocumentListResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **results** | [**\PandaDoc\Client\Model\DocumentListResponseResults[]**](DocumentListResponseResults.md) | | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/QuoteResponseSummaryRecurringSubtotal.md: -------------------------------------------------------------------------------- 1 | # # QuoteResponseSummaryRecurringSubtotal 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **billingCycle** | **string** | | [optional] 8 | **value** | **string** | | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/RicipientDeliveryMethods.md: -------------------------------------------------------------------------------- 1 | # # RicipientDeliveryMethods 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **email** | **bool** | | [optional] [default to true] 8 | **sms** | **bool** | | [optional] [default to false] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/TemplateListResponse.md: -------------------------------------------------------------------------------- 1 | # # TemplateListResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **results** | [**\PandaDoc\Client\Model\TemplateListResponseResults[]**](TemplateListResponseResults.md) | | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/WebhookEventPageResponse.md: -------------------------------------------------------------------------------- 1 | # # WebhookEventPageResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **items** | [**\PandaDoc\Client\Model\WebhookEventItemResponse[]**](WebhookEventItemResponse.md) | | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/SectionInfoResponse.md: -------------------------------------------------------------------------------- 1 | # # SectionInfoResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **uuid** | **string** | | [optional] 8 | **name** | **string** | | [optional] 9 | **documentUuid** | **string** | | [optional] 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/LinkedObjectListResponse.md: -------------------------------------------------------------------------------- 1 | # # LinkedObjectListResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **linkedObjects** | [**\PandaDoc\Client\Model\LinkedObjectCreateResponse[]**](LinkedObjectCreateResponse.md) | | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/DocumentCreateResponseLinks.md: -------------------------------------------------------------------------------- 1 | # # DocumentCreateResponseLinks 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **rel** | **string** | | [optional] 8 | **href** | **string** | | [optional] 9 | **type** | **string** | | [optional] 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/QuoteSectionSettings.md: -------------------------------------------------------------------------------- 1 | # # QuoteSectionSettings 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **optional** | **bool** | | [optional] 8 | **selected** | **bool** | | [optional] 9 | **selectionType** | **string** | | [optional] 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/UploadSectionListResponse.md: -------------------------------------------------------------------------------- 1 | # # UploadSectionListResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **results** | [**\PandaDoc\Client\Model\UploadSectionListResponseResults[]**](UploadSectionListResponseResults.md) | | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/DocumentsFolderCreateResponse.md: -------------------------------------------------------------------------------- 1 | # # DocumentsFolderCreateResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **uuid** | **string** | | [optional] 8 | **name** | **string** | | [optional] 9 | **dateCreated** | **string** | | [optional] 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/DocumentsFolderListResponse.md: -------------------------------------------------------------------------------- 1 | # # DocumentsFolderListResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **results** | [**\PandaDoc\Client\Model\DocumentsFolderListResponseResults[]**](DocumentsFolderListResponseResults.md) | | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/DocumentsFolderRenameResponse.md: -------------------------------------------------------------------------------- 1 | # # DocumentsFolderRenameResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **uuid** | **string** | | [optional] 8 | **name** | **string** | | [optional] 9 | **dateCreated** | **string** | | [optional] 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/QuoteUpdateRequestSettings.md: -------------------------------------------------------------------------------- 1 | # # QuoteUpdateRequestSettings 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **optional** | **bool** | | [optional] 8 | **selected** | **bool** | | [optional] 9 | **selectionType** | **string** | | [optional] 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/TemplateDetailsResponseImages.md: -------------------------------------------------------------------------------- 1 | # # TemplateDetailsResponseImages 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **string** | | [optional] 8 | **blockUuid** | **string** | | [optional] 9 | **urls** | **string[]** | | [optional] 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/TemplatesFolderCreateResponse.md: -------------------------------------------------------------------------------- 1 | # # TemplatesFolderCreateResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **uuid** | **string** | | [optional] 8 | **name** | **string** | | [optional] 9 | **dateCreated** | **string** | | [optional] 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/TemplatesFolderListResponse.md: -------------------------------------------------------------------------------- 1 | # # TemplatesFolderListResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **results** | [**\PandaDoc\Client\Model\TemplatesFolderListResponseResults[]**](TemplatesFolderListResponseResults.md) | | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/TemplatesFolderRenameResponse.md: -------------------------------------------------------------------------------- 1 | # # TemplatesFolderRenameResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **uuid** | **string** | | [optional] 8 | **name** | **string** | | [optional] 9 | **dateCreated** | **string** | | [optional] 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/WebhookSubscriptionListResponse.md: -------------------------------------------------------------------------------- 1 | # # WebhookSubscriptionListResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **items** | [**\PandaDoc\Client\Model\WebhookSubscriptionItemResponse[]**](WebhookSubscriptionItemResponse.md) | | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/FormListResponse.md: -------------------------------------------------------------------------------- 1 | # # FormListResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **results** | [**\PandaDoc\Client\Model\FormListResponseResults[]**](FormListResponseResults.md) | | [optional] 8 | **hasNextPage** | **bool** | | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/PricingTableRequestRowOptions.md: -------------------------------------------------------------------------------- 1 | # # PricingTableRequestRowOptions 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **qtyEditable** | **bool** | | [optional] 8 | **optionalSelected** | **bool** | | [optional] 9 | **optional** | **bool** | | [optional] 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/ContentLibraryItemListResponse.md: -------------------------------------------------------------------------------- 1 | # # ContentLibraryItemListResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **results** | [**\PandaDoc\Client\Model\ContentLibraryItemListResponseResults[]**](ContentLibraryItemListResponseResults.md) | | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/DocumentSendRequestSelectedApproversGroupAssignees.md: -------------------------------------------------------------------------------- 1 | # # DocumentSendRequestSelectedApproversGroupAssignees 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **user** | **string** | User ID | [optional] 8 | **isSelected** | **bool** | Whether the user is selected | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/TemplateDetailsResponseContentPlaceholders.md: -------------------------------------------------------------------------------- 1 | # # TemplateDetailsResponseContentPlaceholders 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **uuid** | **string** | | [optional] 8 | **blockId** | **string** | | [optional] 9 | **description** | **string** | | [optional] 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/CreateUserRequestUser.md: -------------------------------------------------------------------------------- 1 | # # CreateUserRequestUser 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **email** | **string** | | [optional] 8 | **firstName** | **string** | | [optional] 9 | **lastName** | **string** | | [optional] 10 | **phoneNumber** | **string** | | [optional] 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/PricingTableResponseSummary.md: -------------------------------------------------------------------------------- 1 | # # PricingTableResponseSummary 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **subtotal** | **string** | | [optional] 8 | **total** | **string** | | [optional] 9 | **discount** | **string** | | [optional] 10 | **tax** | **string** | | [optional] 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/QuoteResponseSectionColumn.md: -------------------------------------------------------------------------------- 1 | # # QuoteResponseSectionColumn 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **header** | **string** | | [optional] 8 | **name** | **string** | | [optional] 9 | **mergeName** | **string** | | [optional] 10 | **hidden** | **string** | | [optional] 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/QuoteUpdateRequestOptions.md: -------------------------------------------------------------------------------- 1 | # # QuoteUpdateRequestOptions 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **selected** | **bool** | | [optional] [default to true] 8 | **qtyEditable** | **bool** | | [default to true] 9 | **optional** | **bool** | | [optional] [default to false] 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # ref: https://github.com/github/gitignore/blob/master/Composer.gitignore 2 | 3 | composer.phar 4 | /vendor/ 5 | 6 | # Commit your application's lock file https://getcomposer.org/doc/01-basic-usage.md#commit-your-composer-lock-file-to-version-control 7 | # You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file 8 | # composer.lock 9 | 10 | # php-cs-fixer cache 11 | .php_cs.cache 12 | 13 | # PHPUnit cache 14 | .phpunit.result.cache 15 | 16 | .idea 17 | .vscode 18 | .history -------------------------------------------------------------------------------- /docs/Model/DocumentSendRequestSelectedApprovers.md: -------------------------------------------------------------------------------- 1 | # # DocumentSendRequestSelectedApprovers 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **steps** | [**\PandaDoc\Client\Model\DocumentSendRequestSelectedApproversSteps[]**](DocumentSendRequestSelectedApproversSteps.md) | Approval steps | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/DocumentSendRequestForwardingSettings.md: -------------------------------------------------------------------------------- 1 | # # DocumentSendRequestForwardingSettings 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **forwardingAllowed** | **bool** | Allow forwarding | [optional] 8 | **forwardingWithReassigningAllowed** | **bool** | Allow forwarding with reassigning | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/DocumentDetailsResponseLinkedObjects.md: -------------------------------------------------------------------------------- 1 | # # DocumentDetailsResponseLinkedObjects 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **provider** | **string** | | [optional] 8 | **entityType** | **string** | | [optional] 9 | **entityId** | **string** | | [optional] 10 | **id** | **string** | | [optional] 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/DocumentSendRequestSelectedApproversSteps.md: -------------------------------------------------------------------------------- 1 | # # DocumentSendRequestSelectedApproversSteps 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **string** | Step ID | 8 | **group** | [**\PandaDoc\Client\Model\DocumentSendRequestSelectedApproversGroup**](DocumentSendRequestSelectedApproversGroup.md) | | 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/PricingTableResponseOptions.md: -------------------------------------------------------------------------------- 1 | # # PricingTableResponseOptions 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **optional** | **bool** | | [optional] 8 | **optionalSelected** | **bool** | | [optional] 9 | **multichoiceEnabled** | **bool** | | [optional] 10 | **multichoiceSelected** | **bool** | | [optional] 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/PricingTableRequestRows.md: -------------------------------------------------------------------------------- 1 | # # PricingTableRequestRows 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **options** | [**\PandaDoc\Client\Model\PricingTableRequestRowOptions**](PricingTableRequestRowOptions.md) | | [optional] 8 | **data** | **object** | | [optional] 9 | **customFields** | **object** | | [optional] 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/QuoteResponseCondition.md: -------------------------------------------------------------------------------- 1 | # # QuoteResponseCondition 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **fieldName** | **string** | | [optional] 8 | **type** | **string** | | [optional] 9 | **comparison** | [**\PandaDoc\Client\Model\QuoteResponseConditionComparison[]**](QuoteResponseConditionComparison.md) | | [optional] 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/APILogListResponseResults.md: -------------------------------------------------------------------------------- 1 | # # APILogListResponseResults 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **string** | | [optional] 8 | **url** | **string** | | [optional] 9 | **status** | **int** | | [optional] 10 | **requestTime** | **string** | | [optional] 11 | **responseTime** | **string** | | [optional] 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/FormListResponseResults.md: -------------------------------------------------------------------------------- 1 | # # FormListResponseResults 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **string** | | [optional] 8 | **name** | **string** | | [optional] 9 | **dateCreated** | **string** | | [optional] 10 | **dateModified** | **string** | | [optional] 11 | **status** | **string** | | [optional] 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/TemplateDetailsResponsePreassignedPerson.md: -------------------------------------------------------------------------------- 1 | # # TemplateDetailsResponsePreassignedPerson 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **email** | **string** | | [optional] 8 | **type** | **string** | | [optional] 9 | **placeholderName** | **string** | | [optional] 10 | **placeholderSource** | **string** | | [optional] 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/PricingResponse.md: -------------------------------------------------------------------------------- 1 | # # PricingResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **tables** | [**\PandaDoc\Client\Model\PricingTableResponse[]**](PricingTableResponse.md) | | [optional] 8 | **quotes** | [**\PandaDoc\Client\Model\QuoteResponse[]**](QuoteResponse.md) | | [optional] 9 | **total** | **string** | | [optional] 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/OAuth2AccessTokenResponse.md: -------------------------------------------------------------------------------- 1 | # # OAuth2AccessTokenResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **accessToken** | **string** | | [optional] 8 | **tokenType** | **string** | | [optional] 9 | **expiresIn** | **float** | | [optional] 10 | **scope** | **string** | | [optional] 11 | **refreshToken** | **string** | | [optional] 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/TemplatesFolderCreateRequest.md: -------------------------------------------------------------------------------- 1 | # # TemplatesFolderCreateRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **string** | Name the folder for Templates you are creating. | 8 | **parentUuid** | **string** | ID of the parent folder. To create a new folder in the root folder, remove this parameter in the request. | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/ContentLibraryItemResponseCreatedBy.md: -------------------------------------------------------------------------------- 1 | # # ContentLibraryItemResponseCreatedBy 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **string** | | [optional] 8 | **email** | **string** | | [optional] 9 | **firstName** | **string** | | [optional] 10 | **lastName** | **string** | | [optional] 11 | **avatar** | **string** | | [optional] 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/DocumentAttachmentResponseCreatedBy.md: -------------------------------------------------------------------------------- 1 | # # DocumentAttachmentResponseCreatedBy 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **string** | | [optional] 8 | **email** | **string** | | [optional] 9 | **firstName** | **string** | | [optional] 10 | **lastName** | **string** | | [optional] 11 | **avatar** | **string** | | [optional] 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/DocumentsFolderCreateRequest.md: -------------------------------------------------------------------------------- 1 | # # DocumentsFolderCreateRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **string** | Name the folder for the Documents you are creating. | 8 | **parentUuid** | **string** | ID of the parent folder. To create a new folder in the root folder, remove this parameter in the request. | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/DocumentsFolderListResponseResults.md: -------------------------------------------------------------------------------- 1 | # # DocumentsFolderListResponseResults 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **uuid** | **string** | | [optional] 8 | **name** | **string** | | [optional] 9 | **dateCreated** | **string** | | [optional] 10 | **hasFolders** | **bool** | | [optional] 11 | **hasItems** | **bool** | | [optional] 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/TemplatesFolderListResponseResults.md: -------------------------------------------------------------------------------- 1 | # # TemplatesFolderListResponseResults 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **uuid** | **string** | | [optional] 8 | **name** | **string** | | [optional] 9 | **dateCreated** | **string** | | [optional] 10 | **hasFolders** | **bool** | | [optional] 11 | **hasItems** | **bool** | | [optional] 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/ContentLibraryItemListResponseResults.md: -------------------------------------------------------------------------------- 1 | # # ContentLibraryItemListResponseResults 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **string** | | [optional] 8 | **name** | **string** | | [optional] 9 | **dateCreated** | **string** | | [optional] 10 | **dateModified** | **string** | | [optional] 11 | **version** | **string** | | [optional] 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/DocumentCreateLinkRequest.md: -------------------------------------------------------------------------------- 1 | # # DocumentCreateLinkRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **recipient** | **string** | The email address for the recipient you're creating a document link for. | 8 | **lifetime** | **float** | Provide the number of seconds that a document link should be valid for. Default is 3600 seconds. | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/AddMemberResponse.md: -------------------------------------------------------------------------------- 1 | # # AddMemberResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **memberId** | **string** | | [optional] 8 | **workspaceId** | **string** | | [optional] 9 | **role** | **string** | | [optional] 10 | **email** | **string** | | [optional] 11 | **firstName** | **string** | | [optional] 12 | **lastName** | **string** | | [optional] 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/Model/DocumentCreateByTemplateRequestContentPlaceholders.md: -------------------------------------------------------------------------------- 1 | # # DocumentCreateByTemplateRequestContentPlaceholders 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **contentLibraryItems** | [**\PandaDoc\Client\Model\DocumentCreateByTemplateRequestContentLibraryItems[]**](DocumentCreateByTemplateRequestContentLibraryItems.md) | | [optional] 8 | **blockId** | **string** | | 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/DocumentCreateRequestContentPlaceholders.md: -------------------------------------------------------------------------------- 1 | # # DocumentCreateRequestContentPlaceholders 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **blockId** | **string** | Content placeholder block id | [optional] 8 | **contentLibraryItems** | [**\PandaDoc\Client\Model\DocumentCreateRequestContentLibraryItems[]**](DocumentCreateRequestContentLibraryItems.md) | | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/PricingTableRequestSections.md: -------------------------------------------------------------------------------- 1 | # # PricingTableRequestSections 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **title** | **string** | | 8 | **default** | **bool** | | [optional] 9 | **multichoiceEnabled** | **bool** | | [optional] [default to false] 10 | **rows** | [**\PandaDoc\Client\Model\PricingTableRequestRows[]**](PricingTableRequestRows.md) | | [optional] 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/CreateUserRequest.md: -------------------------------------------------------------------------------- 1 | # # CreateUserRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **user** | [**\PandaDoc\Client\Model\CreateUserRequestUser**](CreateUserRequestUser.md) | | 8 | **workspaces** | [**\PandaDoc\Client\Model\CreateUserRequestWorkspaces[]**](CreateUserRequestWorkspaces.md) | Info for adding a user to a workspace(s) | 9 | **license** | **string** | | 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/DocumentAttachmentResponse.md: -------------------------------------------------------------------------------- 1 | # # DocumentAttachmentResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **uuid** | **string** | | [optional] 8 | **dateCreated** | **string** | | [optional] 9 | **createdBy** | [**\PandaDoc\Client\Model\DocumentAttachmentResponseCreatedBy**](DocumentAttachmentResponseCreatedBy.md) | | [optional] 10 | **name** | **string** | | [optional] 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/DocumentDetailsResponseCreatedBy.md: -------------------------------------------------------------------------------- 1 | # # DocumentDetailsResponseCreatedBy 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **string** | | [optional] 8 | **membershipId** | **string** | | [optional] 9 | **email** | **string** | | [optional] 10 | **firstName** | **string** | | [optional] 11 | **lastName** | **string** | | [optional] 12 | **avatar** | **string** | | [optional] 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/Model/DocumentTransferAllOwnershipRequest.md: -------------------------------------------------------------------------------- 1 | # # DocumentTransferAllOwnershipRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **fromMembershipId** | **string** | A unique identifier of a workspace member from whom you want to transfer ownership. | [optional] 8 | **toMembershipId** | **string** | A unique identifier of a workspace member to whom you want to transfer ownership. | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/TemplateListResponseResults.md: -------------------------------------------------------------------------------- 1 | # # TemplateListResponseResults 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **string** | | [optional] 8 | **name** | **string** | | [optional] 9 | **dateCreated** | **string** | | [optional] 10 | **dateModified** | **string** | | [optional] 11 | **version** | **string** | | [optional] 12 | **contentDateModified** | **string** | | [optional] 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/Model/DocumentSendRequestSelectedApproversGroup.md: -------------------------------------------------------------------------------- 1 | # # DocumentSendRequestSelectedApproversGroup 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **string** | Group ID | 8 | **type** | **string** | Group type | 9 | **assignees** | [**\PandaDoc\Client\Model\DocumentSendRequestSelectedApproversGroupAssignees[]**](DocumentSendRequestSelectedApproversGroupAssignees.md) | Assignees for the group | 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/QuoteResponseMergeRules.md: -------------------------------------------------------------------------------- 1 | # # QuoteResponseMergeRules 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **string** | | [optional] 8 | **enabled** | **bool** | | [optional] 9 | **action** | [**\PandaDoc\Client\Model\QuoteResponseAction**](QuoteResponseAction.md) | | [optional] 10 | **condition** | [**\PandaDoc\Client\Model\QuoteResponseCondition**](QuoteResponseCondition.md) | | [optional] 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/TemplateDetailsResponseRoles.md: -------------------------------------------------------------------------------- 1 | # # TemplateDetailsResponseRoles 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **string** | | [optional] 8 | **name** | **string** | | [optional] 9 | **signingOrder** | **string** | | [optional] 10 | **preassignedPerson** | [**\PandaDoc\Client\Model\TemplateDetailsResponsePreassignedPerson**](TemplateDetailsResponsePreassignedPerson.md) | | [optional] 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/LinkedObjectCreateRequest.md: -------------------------------------------------------------------------------- 1 | # # LinkedObjectCreateRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **provider** | **string** | CRM name (lowercase). See the list above. | 8 | **entityType** | **string** | Entity type. The system validates if the type is supported. See the list for each CRM above. | 9 | **entityId** | **string** | Entity unique identifier. The system validates if the entity exists. | 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/DocumentListResponseResults.md: -------------------------------------------------------------------------------- 1 | # # DocumentListResponseResults 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **string** | | [optional] 8 | **name** | **string** | | [optional] 9 | **status** | **string** | | [optional] 10 | **dateCreated** | **string** | | [optional] 11 | **dateModified** | **string** | | [optional] 12 | **expirationDate** | **string** | | [optional] 13 | **version** | **string** | | [optional] 14 | 15 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/Model/DocumentStatusChangeRequest.md: -------------------------------------------------------------------------------- 1 | # # DocumentStatusChangeRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **status** | [**\PandaDoc\Client\Model\DocumentStatusRequestEnum**](DocumentStatusRequestEnum.md) | | 8 | **note** | **string** | Provide “private notes” regarding the manual status change. | [optional] 9 | **notifyRecipients** | **bool** | Send a notification email about the status change to all recipients. | [optional] 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/WebhookSubscriptionCreateRequest.md: -------------------------------------------------------------------------------- 1 | # # WebhookSubscriptionCreateRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **string** | | 8 | **url** | **string** | | 9 | **payload** | [**\PandaDoc\Client\Model\WebhookSubscriptionPayloadEnum[]**](WebhookSubscriptionPayloadEnum.md) | | [optional] 10 | **triggers** | [**\PandaDoc\Client\Model\WebhookSubscriptionTriggerEnum[]**](WebhookSubscriptionTriggerEnum.md) | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/PricingTableRequest.md: -------------------------------------------------------------------------------- 1 | # # PricingTableRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **string** | | 8 | **dataMerge** | **bool** | When set to true all field names in data rows must be passed as external names defined in the template. | [optional] 9 | **options** | **object** | | [optional] 10 | **sections** | [**\PandaDoc\Client\Model\PricingTableRequestSections[]**](PricingTableRequestSections.md) | | [optional] 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/QuoteUpdateRequestPriceSettings.md: -------------------------------------------------------------------------------- 1 | # # QuoteUpdateRequestPriceSettings 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **baseValue** | **float** | Base value for volume discount pricing. If set, tiers are treated like percentage of discount on this value. If not set, tiers are treated like a flat value discount of chosen currency. | 8 | **tiers** | [**\PandaDoc\Client\Model\QuoteUpdateRequestPriceSettingsTiers[]**](QuoteUpdateRequestPriceSettingsTiers.md) | | 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/LinkedObjectCreateResponse.md: -------------------------------------------------------------------------------- 1 | # # LinkedObjectCreateResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **string** | | [optional] 8 | **provider** | **string** | CRM name (lowercase). See the list above. | [optional] 9 | **entityType** | **string** | Entity type. The system validates if the type is supported. See the list for each CRM above. | [optional] 10 | **entiryId** | **string** | Entity unique identifier. The system validates if the entity exists. | [optional] 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/DocumentCreateByTemplateRequestContentLibraryItems.md: -------------------------------------------------------------------------------- 1 | # # DocumentCreateByTemplateRequestContentLibraryItems 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **string** | | 8 | **fields** | **object** | | [optional] 9 | **pricingTables** | [**\PandaDoc\Client\Model\PricingTableRequest[]**](PricingTableRequest.md) | | [optional] 10 | **recipients** | [**\PandaDoc\Client\Model\DocumentCreateByTemplateRequestRecipients[]**](DocumentCreateByTemplateRequestRecipients.md) | | [optional] 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/DocumentCreateRequestContentLibraryItems.md: -------------------------------------------------------------------------------- 1 | # # DocumentCreateRequestContentLibraryItems 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **string** | Content library item id | 8 | **pricingTables** | [**\PandaDoc\Client\Model\PricingTableRequest[]**](PricingTableRequest.md) | | [optional] 9 | **fields** | **object** | | [optional] 10 | **recipients** | [**\PandaDoc\Client\Model\DocumentCreateByTemplateRequestRecipients[]**](DocumentCreateByTemplateRequestRecipients.md) | | [optional] 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/UploadSectionStatusResponse.md: -------------------------------------------------------------------------------- 1 | # # UploadSectionStatusResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **uuid** | **string** | | [optional] 8 | **documentUuid** | **string** | | [optional] 9 | **status** | [**\PandaDoc\Client\Model\UploadSectionStatusEnum**](UploadSectionStatusEnum.md) | | [optional] 10 | **name** | **string** | | [optional] 11 | **sectionsUuids** | **string[]** | | [optional] 12 | **dateCreated** | **string** | | [optional] 13 | **dateModified** | **string** | | [optional] 14 | 15 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/Model/DocumentStatusResponse.md: -------------------------------------------------------------------------------- 1 | # # DocumentStatusResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **string** | | [optional] 8 | **name** | **string** | | [optional] 9 | **status** | **string** | | [optional] 10 | **dateCreated** | **string** | | [optional] 11 | **dateModified** | **string** | | [optional] 12 | **dateCompleted** | **string** | | [optional] 13 | **expirationDate** | **string** | | [optional] 14 | **version** | **string** | | [optional] 15 | **uuid** | **string** | | [optional] 16 | 17 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/Model/WebhookSubscriptionPatchRequest.md: -------------------------------------------------------------------------------- 1 | # # WebhookSubscriptionPatchRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **string** | | [optional] 8 | **url** | **string** | | [optional] 9 | **active** | **bool** | | [optional] [default to true] 10 | **payload** | [**\PandaDoc\Client\Model\WebhookSubscriptionPayloadEnum[]**](WebhookSubscriptionPayloadEnum.md) | | [optional] 11 | **triggers** | [**\PandaDoc\Client\Model\WebhookSubscriptionTriggerEnum[]**](WebhookSubscriptionTriggerEnum.md) | | [optional] 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/RecipientVerificationSettings.md: -------------------------------------------------------------------------------- 1 | # # RecipientVerificationSettings 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **verificationPlace** | **string** | Verification place | [optional] 8 | **passcodeVerification** | [**\PandaDoc\Client\Model\RecipientVerificationSettingsPasscodeVerification**](RecipientVerificationSettingsPasscodeVerification.md) | | [optional] 9 | **phoneVerification** | [**\PandaDoc\Client\Model\RecipientVerificationSettingsPhoneVerification**](RecipientVerificationSettingsPhoneVerification.md) | | [optional] 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/QuoteUpdateRequest.md: -------------------------------------------------------------------------------- 1 | # # QuoteUpdateRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **sections** | [**\PandaDoc\Client\Model\UpdateIntegrationQuoteSection[]**](UpdateIntegrationQuoteSection.md) | Quote sections - this property overrides existing sections in the specified order. If you want to change only one section, you must still pass other sections IDs. Otherwise these sections will be removed. | [optional] 8 | **settings** | [**\PandaDoc\Client\Model\QuoteUpdateRequestSettings1**](QuoteUpdateRequestSettings1.md) | | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/ContactCreateRequest.md: -------------------------------------------------------------------------------- 1 | # # ContactCreateRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **email** | **string** | | [optional] 8 | **firstName** | **string** | | [optional] 9 | **lastName** | **string** | | [optional] 10 | **company** | **string** | | [optional] 11 | **jobTitle** | **string** | | [optional] 12 | **phone** | **string** | | [optional] 13 | **state** | **string** | | [optional] 14 | **streetAddress** | **string** | | [optional] 15 | **city** | **string** | | [optional] 16 | **postalCode** | **string** | | [optional] 17 | 18 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 19 | -------------------------------------------------------------------------------- /docs/Model/ContactUpdateRequest.md: -------------------------------------------------------------------------------- 1 | # # ContactUpdateRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **email** | **string** | | [optional] 8 | **firstName** | **string** | | [optional] 9 | **lastName** | **string** | | [optional] 10 | **company** | **string** | | [optional] 11 | **jobTitle** | **string** | | [optional] 12 | **phone** | **string** | | [optional] 13 | **state** | **string** | | [optional] 14 | **streetAddress** | **string** | | [optional] 15 | **city** | **string** | | [optional] 16 | **postalCode** | **string** | | [optional] 17 | 18 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 19 | -------------------------------------------------------------------------------- /docs/Model/PricingTableResponse.md: -------------------------------------------------------------------------------- 1 | # # PricingTableResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **string** | | [optional] 8 | **id** | **string** | | [optional] 9 | **total** | **string** | | [optional] 10 | **isIncludedInTotal** | **bool** | | [optional] 11 | **summary** | [**\PandaDoc\Client\Model\PricingTableResponseSummary**](PricingTableResponseSummary.md) | | [optional] 12 | **items** | [**\PandaDoc\Client\Model\PricingTableResponseItems[]**](PricingTableResponseItems.md) | | [optional] 13 | **currency** | **string** | | [optional] 14 | 15 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/Model/DocumentUpdateRequestRecipients.md: -------------------------------------------------------------------------------- 1 | # # DocumentUpdateRequestRecipients 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **string** | | [optional] 8 | **email** | **string** | | [optional] 9 | **phone** | **string** | | [optional] 10 | **firstName** | **string** | | [optional] 11 | **lastName** | **string** | | [optional] 12 | **deliveryMethods** | [**\PandaDoc\Client\Model\RicipientDeliveryMethods**](RicipientDeliveryMethods.md) | | [optional] 13 | **redirect** | [**\PandaDoc\Client\Model\RecipientRedirect**](RecipientRedirect.md) | | [optional] 14 | 15 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/Model/ContactDetailsResponse.md: -------------------------------------------------------------------------------- 1 | # # ContactDetailsResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **string** | | [optional] 8 | **email** | **string** | | [optional] 9 | **firstName** | **string** | | [optional] 10 | **lastName** | **string** | | [optional] 11 | **company** | **string** | | [optional] 12 | **jobTitle** | **string** | | [optional] 13 | **phone** | **string** | | [optional] 14 | **state** | **string** | | [optional] 15 | **streetAddress** | **string** | | [optional] 16 | **city** | **string** | | [optional] 17 | **postalCode** | **string** | | [optional] 18 | 19 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 20 | -------------------------------------------------------------------------------- /docs/Model/DocumentSendResponse.md: -------------------------------------------------------------------------------- 1 | # # DocumentSendResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **string** | | [optional] 8 | **name** | **string** | | [optional] 9 | **status** | **string** | | [optional] 10 | **dateCreated** | **string** | | [optional] 11 | **dateModified** | **string** | | [optional] 12 | **expirationDate** | **string** | | [optional] 13 | **version** | **string** | | [optional] 14 | **uuid** | **string** | | [optional] 15 | **recipients** | [**\PandaDoc\Client\Model\DocumentSendResponseRecipients[]**](DocumentSendResponseRecipients.md) | | [optional] 16 | 17 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/Model/UploadSectionResponse.md: -------------------------------------------------------------------------------- 1 | # # UploadSectionResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **uuid** | **string** | | [optional] 8 | **name** | **string** | | [optional] 9 | **documentUuid** | **string** | | [optional] 10 | **status** | [**\PandaDoc\Client\Model\UploadSectionStatusEnum**](UploadSectionStatusEnum.md) | | [optional] 11 | **sectionsUuids** | **string[]** | | [optional] 12 | **dateCreated** | **string** | | [optional] 13 | **dateModified** | **string** | | [optional] 14 | **dateCompleted** | **string** | | [optional] 15 | **infoMessage** | **string** | | [optional] 16 | 17 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/Model/DocumentSendResponseRecipients.md: -------------------------------------------------------------------------------- 1 | # # DocumentSendResponseRecipients 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **string** | | [optional] 8 | **firstName** | **string** | | [optional] 9 | **lastName** | **string** | | [optional] 10 | **recipientType** | **string** | | [optional] 11 | **email** | **string** | | [optional] 12 | **phone** | **string** | | [optional] 13 | **deliveryMethods** | [**\PandaDoc\Client\Model\RicipientDeliveryMethods**](RicipientDeliveryMethods.md) | | [optional] 14 | **signingOrder** | **mixed** | | [optional] 15 | **sharedLink** | **string** | | [optional] 16 | 17 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/Model/DocumentCreateRequestRecipients.md: -------------------------------------------------------------------------------- 1 | # # DocumentCreateRequestRecipients 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **email** | **string** | | [optional] 8 | **phone** | **string** | | [optional] 9 | **deliveryMethods** | [**\PandaDoc\Client\Model\RicipientDeliveryMethods**](RicipientDeliveryMethods.md) | | [optional] 10 | **firstName** | **string** | | [optional] 11 | **lastName** | **string** | | [optional] 12 | **role** | **string** | | [optional] 13 | **signingOrder** | **int** | | [optional] 14 | **redirect** | [**\PandaDoc\Client\Model\RecipientRedirect**](RecipientRedirect.md) | | [optional] 15 | 16 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "pandadoc/php-client", 3 | "version": "6.2.0", 4 | "description": "The Official PandaDoc PHP client SDK", 5 | "keywords": [ 6 | "openapi", 7 | "php", 8 | "sdk", 9 | "rest", 10 | "api" 11 | ], 12 | "homepage": "https://developers.pandadoc.com", 13 | "license": "MIT", 14 | "authors": [ 15 | { 16 | "name": "PandaDoc", 17 | "homepage": "https://developers.pandadoc.com" 18 | } 19 | ], 20 | "require": { 21 | "php": "^7.3 || ^8.0", 22 | "ext-curl": "*", 23 | "ext-json": "*", 24 | "ext-mbstring": "*", 25 | "guzzlehttp/guzzle": "^7.3", 26 | "guzzlehttp/psr7": "^1.7 || ^2.0" 27 | }, 28 | "autoload": { 29 | "psr-4": { "PandaDoc\\Client\\" : "src/" } 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /docs/Model/DocumentCreateByTemplateRequestRecipients.md: -------------------------------------------------------------------------------- 1 | # # DocumentCreateByTemplateRequestRecipients 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **email** | **string** | | [optional] 8 | **phone** | **string** | | [optional] 9 | **deliveryMethods** | [**\PandaDoc\Client\Model\RicipientDeliveryMethods**](RicipientDeliveryMethods.md) | | [optional] 10 | **firstName** | **string** | | [optional] 11 | **lastName** | **string** | | [optional] 12 | **role** | **string** | | [optional] 13 | **signingOrder** | **int** | | [optional] 14 | **redirect** | [**\PandaDoc\Client\Model\RecipientRedirect**](RecipientRedirect.md) | | [optional] 15 | 16 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Model/DocumentCreateResponse.md: -------------------------------------------------------------------------------- 1 | # # DocumentCreateResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **string** | | [optional] 8 | **name** | **string** | | [optional] 9 | **status** | [**\PandaDoc\Client\Model\DocumentStatusEnum**](DocumentStatusEnum.md) | | [optional] 10 | **dateCreated** | **string** | | [optional] 11 | **dateModified** | **string** | | [optional] 12 | **expirationDate** | **string** | | [optional] 13 | **uuid** | **string** | | [optional] 14 | **links** | [**\PandaDoc\Client\Model\DocumentCreateResponseLinks[]**](DocumentCreateResponseLinks.md) | | [optional] 15 | **infoMessage** | **string** | | [optional] 16 | 17 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/Model/QuoteResponse.md: -------------------------------------------------------------------------------- 1 | # # QuoteResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **string** | | [optional] 8 | **currency** | **string** | | [optional] 9 | **total** | **string** | | [optional] 10 | **summary** | [**\PandaDoc\Client\Model\QuoteResponseSummary**](QuoteResponseSummary.md) | | [optional] 11 | **sections** | [**\PandaDoc\Client\Model\QuoteResponseSections[]**](QuoteResponseSections.md) | | [optional] 12 | **mergeRules** | [**\PandaDoc\Client\Model\QuoteResponseMergeRules[]**](QuoteResponseMergeRules.md) | | [optional] 13 | **settings** | [**\PandaDoc\Client\Model\QuoteResponseSettings**](QuoteResponseSettings.md) | | [optional] 14 | 15 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/Model/WebhookEventItemResponse.md: -------------------------------------------------------------------------------- 1 | # # WebhookEventItemResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **uuid** | **string** | Unique webhook subscription event identifier | [optional] 8 | **name** | **string** | Webhook subscription name | [optional] 9 | **type** | [**\PandaDoc\Client\Model\WebhookEventTriggerEnum**](WebhookEventTriggerEnum.md) | | [optional] 10 | **httpStatusCode** | **int** | Webhook subscription event response http status code | [optional] 11 | **error** | [**\PandaDoc\Client\Model\WebhookEventErrorEnum**](WebhookEventErrorEnum.md) | | [optional] 12 | **deliveryTime** | **\DateTime** | Webhook subscription event delivery time | [optional] 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/Model/QuoteResponseSections.md: -------------------------------------------------------------------------------- 1 | # # QuoteResponseSections 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **string** | | [optional] 8 | **name** | **string** | | [optional] 9 | **summary** | [**\PandaDoc\Client\Model\QuoteResponseSectionSummary**](QuoteResponseSectionSummary.md) | | [optional] 10 | **columns** | [**\PandaDoc\Client\Model\QuoteResponseSectionColumn[]**](QuoteResponseSectionColumn.md) | | [optional] 11 | **items** | [**\PandaDoc\Client\Model\QuoteResponseSectionItem[]**](QuoteResponseSectionItem.md) | | [optional] 12 | **total** | **string** | | [optional] 13 | **settings** | [**\PandaDoc\Client\Model\QuoteSectionSettings**](QuoteSectionSettings.md) | | [optional] 14 | 15 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/Model/QuoteResponseSectionSummary.md: -------------------------------------------------------------------------------- 1 | # # QuoteResponseSectionSummary 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **total** | **string** | | [optional] 8 | **subtotal** | **string** | | [optional] 9 | **oneTimeSubtotal** | **string** | | [optional] 10 | **recurringSubtotal** | [**\PandaDoc\Client\Model\QuoteResponseSummaryRecurringSubtotal[]**](QuoteResponseSummaryRecurringSubtotal.md) | | [optional] 11 | **totalQty** | **string** | | [optional] 12 | **discounts** | **object** | | [optional] 13 | **taxes** | **object** | | [optional] 14 | **fees** | **object** | | [optional] 15 | **customFields** | **array** | | [optional] 16 | **totalSectionValue** | **string** | | [optional] 17 | 18 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 19 | -------------------------------------------------------------------------------- /docs/Model/WebhookSubscriptionItemResponse.md: -------------------------------------------------------------------------------- 1 | # # WebhookSubscriptionItemResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **uuid** | **string** | | [optional] 8 | **name** | **string** | | [optional] 9 | **url** | **string** | | [optional] 10 | **active** | **bool** | | [optional] 11 | **payload** | [**\PandaDoc\Client\Model\WebhookSubscriptionPayloadEnum[]**](WebhookSubscriptionPayloadEnum.md) | | [optional] 12 | **triggers** | [**\PandaDoc\Client\Model\WebhookSubscriptionTriggerEnum[]**](WebhookSubscriptionTriggerEnum.md) | | [optional] 13 | **workspaceId** | **string** | | [optional] 14 | **sharedKey** | **string** | | [optional] 15 | **status** | [**\PandaDoc\Client\Model\WebhookSubscriptionStatusEnum**](WebhookSubscriptionStatusEnum.md) | | [optional] 16 | 17 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/Model/APILogDetailsResponse.md: -------------------------------------------------------------------------------- 1 | # # APILogDetailsResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **string** | | [optional] 8 | **url** | **string** | | [optional] 9 | **method** | **string** | | [optional] 10 | **status** | **int** | | [optional] 11 | **requestTime** | **string** | | [optional] 12 | **responseTime** | **string** | | [optional] 13 | **responseBody** | **object** | | [optional] 14 | **queryParamsString** | **string** | | [optional] 15 | **queryParamsObject** | **object** | | [optional] 16 | **requestBody** | **object** | | [optional] 17 | **tokenType** | **string** | | [optional] 18 | **application** | **string** | | [optional] 19 | **key** | **string** | | [optional] 20 | **requestId** | **string** | | [optional] 21 | **userEmail** | **string** | | [optional] 22 | **userId** | **string** | | [optional] 23 | 24 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 25 | -------------------------------------------------------------------------------- /docs/Model/UpdateIntegrationQuoteSection.md: -------------------------------------------------------------------------------- 1 | # # UpdateIntegrationQuoteSection 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **string** | Section ID to update. Invalid (or missing) ID causes creating a new section. | [optional] 8 | **name** | **string** | Name of the quotes section. If you create a section without providing a value, it will have the default value. | [optional] [default to 'Section name'] 9 | **items** | [**\PandaDoc\Client\Model\UpdateIntegrationQuoteSectionItem[]**](UpdateIntegrationQuoteSectionItem.md) | Section items - this property overrides the existing items in the order specified. If you want to change only one item, you must still pass other items IDs. Otherwise these items will be removed. | [optional] 10 | **settings** | [**\PandaDoc\Client\Model\QuoteUpdateRequestSettings**](QuoteUpdateRequestSettings.md) | | [optional] 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2021 PandaDoc 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /docs/Model/DocumentRecipientEditRequest.md: -------------------------------------------------------------------------------- 1 | # # DocumentRecipientEditRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **email** | **string** | | [optional] 8 | **phone** | **string** | | [optional] 9 | **deliveryMethods** | [**\PandaDoc\Client\Model\RicipientDeliveryMethods**](RicipientDeliveryMethods.md) | | [optional] 10 | **firstName** | **string** | | [optional] 11 | **lastName** | **string** | | [optional] 12 | **company** | **string** | | [optional] 13 | **jobTitle** | **string** | | [optional] 14 | **state** | **string** | | [optional] 15 | **streetAddress** | **string** | | [optional] 16 | **city** | **string** | | [optional] 17 | **postalCode** | **string** | | [optional] 18 | **verificationSettings** | [**\PandaDoc\Client\Model\RecipientVerificationSettings**](RecipientVerificationSettings.md) | | [optional] 19 | **redirect** | [**\PandaDoc\Client\Model\RecipientRedirect**](RecipientRedirect.md) | | [optional] 20 | 21 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 22 | -------------------------------------------------------------------------------- /docs/Model/ContentLibraryItemResponse.md: -------------------------------------------------------------------------------- 1 | # # ContentLibraryItemResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **string** | | [optional] 8 | **name** | **string** | | [optional] 9 | **dateCreated** | **string** | | [optional] 10 | **dateModified** | **string** | | [optional] 11 | **contentDateModified** | **string** | | [optional] 12 | **createdBy** | [**\PandaDoc\Client\Model\ContentLibraryItemResponseCreatedBy**](ContentLibraryItemResponseCreatedBy.md) | | [optional] 13 | **metadata** | **object** | | [optional] 14 | **tokens** | **object[]** | | [optional] 15 | **fields** | **object[]** | | [optional] 16 | **pricing** | [**\PandaDoc\Client\Model\PricingResponse**](PricingResponse.md) | | [optional] 17 | **tags** | **string[]** | | [optional] 18 | **roles** | **object[]** | | [optional] 19 | **version** | **string** | | [optional] 20 | **contentPlaceholders** | **object[]** | | [optional] 21 | **images** | **object[]** | | [optional] 22 | 23 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 24 | -------------------------------------------------------------------------------- /docs/Model/QuoteResponseSummary.md: -------------------------------------------------------------------------------- 1 | # # QuoteResponseSummary 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **total** | **string** | | [optional] 8 | **subtotal** | **string** | | [optional] 9 | **oneTimeSubtotal** | **string** | | [optional] 10 | **recurringSubtotal** | [**\PandaDoc\Client\Model\QuoteResponseSummaryRecurringSubtotal[]**](QuoteResponseSummaryRecurringSubtotal.md) | | [optional] 11 | **totalQty** | **string** | | [optional] 12 | **discounts** | [**array**](QuoteResponseSummaryDiscounts.md) | | [optional] 13 | **taxes** | **object** | | [optional] 14 | **fees** | **object** | | [optional] 15 | **customFields** | **array** | | [optional] 16 | **totalDiscount** | **string** | | [optional] 17 | **totalTax** | **string** | | [optional] 18 | **totalFee** | **string** | | [optional] 19 | **totalSavings** | **string** | | [optional] 20 | **totalContractValue** | **string** | | [optional] 21 | 22 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 23 | -------------------------------------------------------------------------------- /docs/Model/DocumentSendRequest.md: -------------------------------------------------------------------------------- 1 | # # DocumentSendRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **message** | **string** | A message that will be sent by email with a link to a document to sign. | [optional] 8 | **subject** | **string** | Value that will be used as the email subject. | [optional] 9 | **silent** | **bool** | Disables sent, viewed, comment, and completed email notifications for document recipients and the document sender. By default, notifications emails are sent for specific actions. If set as true, it won't affect the \"Approve document\" email notification sent to the Approver. | [optional] 10 | **sender** | **array** | You can set a sender of a document as an `email` or `membership_id` | [optional] 11 | **forwardingSettings** | [**\PandaDoc\Client\Model\DocumentSendRequestForwardingSettings**](DocumentSendRequestForwardingSettings.md) | | [optional] 12 | **selectedApprovers** | [**\PandaDoc\Client\Model\DocumentSendRequestSelectedApprovers**](DocumentSendRequestSelectedApprovers.md) | | [optional] 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/Model/DocumentDetailsResponseRecipients.md: -------------------------------------------------------------------------------- 1 | # # DocumentDetailsResponseRecipients 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **recipientType** | **string** | | [optional] 8 | **role** | **string** | | [optional] 9 | **roles** | **string[]** | | [optional] 10 | **lastName** | **string** | | [optional] 11 | **signingOrder** | **mixed** | | [optional] 12 | **id** | **string** | | [optional] 13 | **contactId** | **string** | | [optional] 14 | **firstName** | **string** | | [optional] 15 | **email** | **string** | | [optional] 16 | **phone** | **string** | | [optional] 17 | **deliveryMethods** | [**\PandaDoc\Client\Model\RicipientDeliveryMethods**](RicipientDeliveryMethods.md) | | [optional] 18 | **hasCompleted** | **bool** | | [optional] 19 | **sharedLink** | **string** | | [optional] 20 | **signatureDate** | **string** | | [optional] 21 | **verificationSettings** | [**\PandaDoc\Client\Model\RecipientVerificationSettings**](RecipientVerificationSettings.md) | | [optional] 22 | **redirect** | [**\PandaDoc\Client\Model\RecipientRedirect**](RecipientRedirect.md) | | [optional] 23 | 24 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 25 | -------------------------------------------------------------------------------- /docs/Model/WebhookEventDetailsResponse.md: -------------------------------------------------------------------------------- 1 | # # WebhookEventDetailsResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **uuid** | **string** | Unique webhook subscription event identifier | [optional] 8 | **name** | **string** | Webhook subscription name | [optional] 9 | **type** | [**\PandaDoc\Client\Model\WebhookEventTriggerEnum**](WebhookEventTriggerEnum.md) | | [optional] 10 | **httpStatusCode** | **int** | Webhook subscription event response http status code | [optional] 11 | **error** | [**\PandaDoc\Client\Model\WebhookEventErrorEnum**](WebhookEventErrorEnum.md) | | [optional] 12 | **deliveryTime** | **\DateTime** | Webhook subscription event delivery time | [optional] 13 | **url** | **string** | Webhook subscription event destination url | [optional] 14 | **signature** | **string** | Webhook subscription event digital signature | [optional] 15 | **requestBody** | **string** | Webhook subscription event request body | [optional] 16 | **responseBody** | **string** | Webhook subscription response body | [optional] 17 | **responseHeaders** | **string** | Webhook subscription response headers | [optional] 18 | **eventTime** | **\DateTime** | Webhook subscription event trigger time | [optional] 19 | 20 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 21 | -------------------------------------------------------------------------------- /docs/Model/MemberDetailsResponse.md: -------------------------------------------------------------------------------- 1 | # # MemberDetailsResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **userId** | **string** | A unique identifier of the user in the organization. | [optional] 8 | **membershipId** | **string** | A unique identifier of the user in the workspace. | [optional] 9 | **email** | **string** | A user's email address. | [optional] 10 | **firstName** | **string** | A user's first name. | [optional] 11 | **lastName** | **string** | A user's last name. | [optional] 12 | **isActive** | **bool** | A boolean value that identifies if a member is active in the workspace. | [optional] 13 | **workspace** | **string** | A name of the user's current active workspace. | [optional] 14 | **workspaceName** | **string** | A unique identifier of the user's current active workspace. | [optional] 15 | **emailsVerified** | **bool** | A boolean value that identifies if the email is verified. | [optional] 16 | **role** | **string** | A member's role in the workspace. | [optional] 17 | **userLicense** | **string** | A user license in the organization. | [optional] 18 | **dateCreated** | **string** | A date when a member was added to the workspace. | [optional] 19 | **dateModified** | **string** | Last modified date of a member. | [optional] 20 | 21 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 22 | -------------------------------------------------------------------------------- /docs/Model/TemplateDetailsResponse.md: -------------------------------------------------------------------------------- 1 | # # TemplateDetailsResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **string** | | [optional] 8 | **name** | **string** | | [optional] 9 | **dateCreated** | **string** | | [optional] 10 | **dateModified** | **string** | | [optional] 11 | **contentDateModified** | **string** | | [optional] 12 | **createdBy** | [**\PandaDoc\Client\Model\ContentLibraryItemResponseCreatedBy**](ContentLibraryItemResponseCreatedBy.md) | | [optional] 13 | **metadata** | **object** | | [optional] 14 | **tokens** | [**\PandaDoc\Client\Model\TemplateDetailsResponseTokens[]**](TemplateDetailsResponseTokens.md) | | [optional] 15 | **fields** | **object[]** | | [optional] 16 | **pricing** | [**\PandaDoc\Client\Model\PricingResponse**](PricingResponse.md) | | [optional] 17 | **tags** | **string[]** | | [optional] 18 | **roles** | [**\PandaDoc\Client\Model\TemplateDetailsResponseRoles[]**](TemplateDetailsResponseRoles.md) | | [optional] 19 | **version** | **string** | | [optional] 20 | **contentPlaceholders** | [**\PandaDoc\Client\Model\TemplateDetailsResponseContentPlaceholders[]**](TemplateDetailsResponseContentPlaceholders.md) | | [optional] 21 | **images** | [**\PandaDoc\Client\Model\TemplateDetailsResponseImages[]**](TemplateDetailsResponseImages.md) | | [optional] 22 | 23 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 24 | -------------------------------------------------------------------------------- /src/Model/WebhookSubscriptionStatusEnum.php: -------------------------------------------------------------------------------- 1 | ** | | [optional] 21 | **discounts** | [**array**](QuoteResponseSummaryDiscounts.md) | | [optional] 22 | **taxes** | [**array**](QuoteResponseSummaryDiscounts.md) | | [optional] 23 | **fees** | [**array**](QuoteResponseSummaryDiscounts.md) | | [optional] 24 | **multipliers** | **array** | | [optional] 25 | **total** | **string** | | [optional] 26 | **overallTotal** | **string** | | [optional] 27 | 28 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 29 | -------------------------------------------------------------------------------- /docs/Model/DocumentUpdateRequest.md: -------------------------------------------------------------------------------- 1 | # # DocumentUpdateRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **string** | The name of the document. | [optional] 8 | **recipients** | [**\PandaDoc\Client\Model\DocumentUpdateRequestRecipients[]**](DocumentUpdateRequestRecipients.md) | The list of recipients you're sending the document to. The ID or email are required. If the ID is passed, an existing recipient will be updated. If the email is passed, a new recipient will be added to CC. | [optional] 9 | **fields** | **object** | You may pass a list of fields/values which exist in a document. Please use `Merge Field` property of the fields like the key. | [optional] 10 | **tokens** | [**\PandaDoc\Client\Model\DocumentCreateByTemplateRequestTokens[]**](DocumentCreateByTemplateRequestTokens.md) | You can pass a list of tokens/values. If a token name exists in a document then the value will be updated. Otherwise, a new token will be added to the document. | [optional] 11 | **metadata** | **object** | You can pass arbitrary data in the key-value format to associate custom information with a document. This information is returned in any API requests for the document details by id. If metadata exists in a document then the value will be updated. Otherwise, metadata will be added to the document. | [optional] 12 | **pricingTables** | [**\PandaDoc\Client\Model\PricingTableRequest[]**](PricingTableRequest.md) | | [optional] 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /src/Model/WebhookEventErrorEnum.php: -------------------------------------------------------------------------------- 1 | ** | | [optional] 20 | **discounts** | [**array**](QuoteUpdateRequestDiscounts.md) | Item discounts. | [optional] 21 | **taxes** | [**array**](QuoteUpdateRequestDiscounts.md) | Item taxes. | [optional] 22 | **fees** | [**array**](QuoteUpdateRequestDiscounts.md) | Item fees. | [optional] 23 | **multipliers** | **array** | Item multipliers. | [optional] 24 | 25 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 26 | -------------------------------------------------------------------------------- /docs/Api/QuotesApi.md: -------------------------------------------------------------------------------- 1 | # PandaDoc\Client\QuotesApi 2 | 3 | All URIs are relative to https://api.pandadoc.com. 4 | 5 | Method | HTTP request | Description 6 | ------------- | ------------- | ------------- 7 | [**quoteUpdate()**](QuotesApi.md#quoteUpdate) | **PUT** /public/v1/documents/{document_id}/quotes/{quote_id} | Quote update 8 | 9 | 10 | ## `quoteUpdate()` 11 | 12 | ```php 13 | quoteUpdate($documentId, $quoteId, $quoteUpdateRequest): \PandaDoc\Client\Model\QuoteResponse 14 | ``` 15 | 16 | Quote update 17 | 18 | ### Example 19 | 20 | ```php 21 | setApiKey('Authorization', 'YOUR_API_KEY'); 27 | // Setup prefix (e.g. Bearer) for API key, if needed 28 | $config = PandaDoc\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'API-Key'); 29 | 30 | // Configure OAuth2 access token for authorization: oauth2 31 | // $config = PandaDoc\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); 32 | 33 | 34 | $apiInstance = new PandaDoc\Client\Api\QuotesApi( 35 | // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. 36 | // This is optional, `GuzzleHttp\Client` will be used as default. 37 | new GuzzleHttp\Client(), 38 | $config 39 | ); 40 | $documentId = BhVzRcxH9Z2LgfPPGXFUBa; // string | Document ID 41 | $quoteId = 99aaa4f9-3250-4f5b-a953-6d7bfc5d8c9e; // string | Quote ID 42 | $quoteUpdateRequest = new \PandaDoc\Client\Model\QuoteUpdateRequest(); // \PandaDoc\Client\Model\QuoteUpdateRequest 43 | 44 | try { 45 | $result = $apiInstance->quoteUpdate($documentId, $quoteId, $quoteUpdateRequest); 46 | print_r($result); 47 | } catch (Exception $e) { 48 | echo 'Exception when calling QuotesApi->quoteUpdate: ', $e->getMessage(), PHP_EOL; 49 | } 50 | ``` 51 | 52 | ### Parameters 53 | 54 | Name | Type | Description | Notes 55 | ------------- | ------------- | ------------- | ------------- 56 | **documentId** | **string**| Document ID | 57 | **quoteId** | **string**| Quote ID | 58 | **quoteUpdateRequest** | [**\PandaDoc\Client\Model\QuoteUpdateRequest**](../Model/QuoteUpdateRequest.md)| | 59 | 60 | ### Return type 61 | 62 | [**\PandaDoc\Client\Model\QuoteResponse**](../Model/QuoteResponse.md) 63 | 64 | ### Authorization 65 | 66 | [apiKey](../../README.md#apiKey), [oauth2](../../README.md#oauth2) 67 | 68 | ### HTTP request headers 69 | 70 | - **Content-Type**: `application/json` 71 | - **Accept**: `application/json` 72 | 73 | [[Back to top]](#) [[Back to API list]](../../README.md#endpoints) 74 | [[Back to README]](../../README.md) 75 | -------------------------------------------------------------------------------- /docs/Model/UploadSectionByTemplateRequest.md: -------------------------------------------------------------------------------- 1 | # # UploadSectionByTemplateRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **templateUuid** | **string** | The ID of a template you want to use. You can copy it from an in app template url such as `https://app.pandadoc.com/a/#/templates/{ID}/content`. A template ID is also obtained by listing templates. | 8 | **recipients** | [**\PandaDoc\Client\Model\DocumentCreateByTemplateRequestRecipients[]**](DocumentCreateByTemplateRequestRecipients.md) | The list of recipients you're sending the document to. Every object must contain the email parameter. The `role`, `first_name` and `last_name` parameters are optional. If the `role` parameter passed, a person is assigned all fields matching their corresponding role. If not passed, a person will receive a read-only link to view the document. If the `first_name` and `last_name` not passed the system 1. creates a new contact, if none exists with the given `email`; or 2. gets the existing contact with the given `email` that already exists. | 9 | **tokens** | [**\PandaDoc\Client\Model\DocumentCreateByTemplateRequestTokens[]**](DocumentCreateByTemplateRequestTokens.md) | You can pass a list of tokens/values to pre-fill tokens used in a template. Name is a token name in a template. Value is a real value you would like to replace a token with. | [optional] 10 | **fields** | **object** | You can pass a list of fields/values to pre-fill fields used in a template. Note that the Signature field can't be pre-filled. | [optional] 11 | **pricingTables** | [**\PandaDoc\Client\Model\PricingTableRequest[]**](PricingTableRequest.md) | Information to construct or populate a pricing table can be passed when creating a document. All product information must be passed when creating a new document. Products stored in PandaDoc cannot be used to populate table rows at this time. Keep in mind that this is an array, so multiple table objects can be passed to a document. Make sure that \"Automatically add products to this table\" is enabled in the PandaDoc template pricing tables you wish to populate via API. | [optional] 12 | **contentPlaceholders** | [**\PandaDoc\Client\Model\DocumentCreateByTemplateRequestContentPlaceholders[]**](DocumentCreateByTemplateRequestContentPlaceholders.md) | You may replace Content Library Item Placeholders with a few content library items each and pre-fill fields/variables values, pricing table items, and assign recipients to roles from there. | [optional] 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/Model/UploadSectionRequest.md: -------------------------------------------------------------------------------- 1 | # # UploadSectionRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **string** | Name the section you are creating. | [optional] 8 | **templateUuid** | **string** | ID of the template you want to use. You can copy it from an in-app template URL such as `https://app.pandadoc.com/a/#/templates/{ID}/content`. A template ID is also obtained by listing templates. | [optional] 9 | **recipients** | [**\PandaDoc\Client\Model\DocumentCreateRequestRecipients[]**](DocumentCreateRequestRecipients.md) | The list of recipients you're sending the document to. Every object must contain the `email` parameter. The `role`, `first_name` and `last_name` parameters are optional. If the `role` parameter is passed, a person is assigned all fields matching their corresponding role. If a role was not passed, a person receives a read-only link to view the document. If the `first_name` and `last_name` are not passed, the system does this 1. Creates a new contact, if none exists with the given `email`; or 2. Gets the existing contact with the given `email` that already exists. | [optional] 10 | **tokens** | [**\PandaDoc\Client\Model\DocumentCreateByTemplateRequestTokens[]**](DocumentCreateByTemplateRequestTokens.md) | You can pass a list of tokens/values to pre-fill tokens used in a template. Name is a token name in a template. Value is a real value you would like to replace a token with. | [optional] 11 | **fields** | **object** | You can pass a list of fields/values to pre-fill fields used in a template. Please note Signature field can't be pre-filled. | [optional] 12 | **tags** | **string[]** | Mark your document with one or several tags. | [optional] 13 | **pricingTables** | [**\PandaDoc\Client\Model\PricingTableRequest[]**](PricingTableRequest.md) | Information to construct or populate a pricing table can be passed when creating a document. All product information must be passed when creating a new document. Products stored in PandaDoc cannot be used to populate table rows at this time. Keep in mind that this is an array, so multiple table objects can be passed to a document. | [optional] 14 | **contentPlaceholders** | [**\PandaDoc\Client\Model\DocumentCreateRequestContentPlaceholders[]**](DocumentCreateRequestContentPlaceholders.md) | You may replace Content Library Item Placeholders with a few content library items each and pre-fill fields/variables values, pricing table items, and assign recipients to roles from there. | [optional] 15 | **url** | **string** | Use a URL to specify the PDF. We support only URLs starting with https. | [optional] 16 | **parseFormFields** | **bool** | Set this parameter as true if you create a document from a PDF with form fields and as false if you upload a PDF with field tags. | [optional] 17 | 18 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 19 | -------------------------------------------------------------------------------- /src/Model/DocumentOrderingFieldsEnum.php: -------------------------------------------------------------------------------- 1 | selectAcceptHeader($accept); 52 | if ($accept !== null) { 53 | $headers['Accept'] = $accept; 54 | } 55 | 56 | $headers['Content-Type'] = $this->selectContentTypeHeader($contentTypes); 57 | return $headers; 58 | } 59 | 60 | /** 61 | * @param string[] $accept 62 | * @return array 63 | */ 64 | #[\ReturnTypeWillChange] 65 | public function selectHeadersForMultipart($accept) 66 | { 67 | $headers = $this->selectHeaders($accept, []); 68 | 69 | unset($headers['Content-Type']); 70 | return $headers; 71 | } 72 | 73 | /** 74 | * Return the header 'Accept' based on an array of Accept provided 75 | * 76 | * @param string[] $accept Array of header 77 | * 78 | * @return null|string Accept (e.g. application/json) 79 | */ 80 | #[\ReturnTypeWillChange] 81 | private function selectAcceptHeader($accept) 82 | { 83 | if (count($accept) === 0 || (count($accept) === 1 && $accept[0] === '')) { 84 | return null; 85 | } elseif ($jsonAccept = preg_grep('~(?i)^(application/json|[^;/ \t]+/[^;/ \t]+[+]json)[ \t]*(;.*)?$~', $accept)) { 86 | return implode(',', $jsonAccept); 87 | } else { 88 | return implode(',', $accept); 89 | } 90 | } 91 | 92 | /** 93 | * Return the content type based on an array of content-type provided 94 | * 95 | * @param string[] $contentType Array fo content-type 96 | * 97 | * @return string Content-Type (e.g. application/json) 98 | */ 99 | #[\ReturnTypeWillChange] 100 | private function selectContentTypeHeader($contentType) 101 | { 102 | if (count($contentType) === 0 || (count($contentType) === 1 && $contentType[0] === '')) { 103 | return 'application/json'; 104 | } elseif (preg_grep("/application\/json/i", $contentType)) { 105 | return 'application/json'; 106 | } else { 107 | return implode(',', $contentType); 108 | } 109 | } 110 | } 111 | -------------------------------------------------------------------------------- /docs/Api/FormsApi.md: -------------------------------------------------------------------------------- 1 | # PandaDoc\Client\FormsApi 2 | 3 | All URIs are relative to https://api.pandadoc.com. 4 | 5 | Method | HTTP request | Description 6 | ------------- | ------------- | ------------- 7 | [**listForm()**](FormsApi.md#listForm) | **GET** /public/v1/forms | Forms 8 | 9 | 10 | ## `listForm()` 11 | 12 | ```php 13 | listForm($count, $page, $status, $orderBy, $asc, $name): \PandaDoc\Client\Model\FormListResponse 14 | ``` 15 | 16 | Forms 17 | 18 | List forms. 19 | 20 | ### Example 21 | 22 | ```php 23 | setApiKey('Authorization', 'YOUR_API_KEY'); 29 | // Setup prefix (e.g. Bearer) for API key, if needed 30 | $config = PandaDoc\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'API-Key'); 31 | 32 | // Configure OAuth2 access token for authorization: oauth2 33 | // $config = PandaDoc\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); 34 | 35 | 36 | $apiInstance = new PandaDoc\Client\Api\FormsApi( 37 | // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. 38 | // This is optional, `GuzzleHttp\Client` will be used as default. 39 | new GuzzleHttp\Client(), 40 | $config 41 | ); 42 | $count = 10; // int | Optionally, specify how many forms to return. Default is 50 forms, maximum is 100 forms. 43 | $page = 56; // int | Optionally, specify which page of the dataset to return. 44 | $status = array('status_example'); // string[] | Optionally, specify which status of the forms dataset to return. 45 | $orderBy = 'orderBy_example'; // string | Optionally, specify the form dataset order to return. 46 | $asc = True; // bool | Optionally, specify sorting the result-set in ascending or descending order. 47 | $name = New Form; // string | Specify the form name. 48 | 49 | try { 50 | $result = $apiInstance->listForm($count, $page, $status, $orderBy, $asc, $name); 51 | print_r($result); 52 | } catch (Exception $e) { 53 | echo 'Exception when calling FormsApi->listForm: ', $e->getMessage(), PHP_EOL; 54 | } 55 | ``` 56 | 57 | ### Parameters 58 | 59 | Name | Type | Description | Notes 60 | ------------- | ------------- | ------------- | ------------- 61 | **count** | **int**| Optionally, specify how many forms to return. Default is 50 forms, maximum is 100 forms. | [optional] 62 | **page** | **int**| Optionally, specify which page of the dataset to return. | [optional] 63 | **status** | [**string[]**](../Model/string.md)| Optionally, specify which status of the forms dataset to return. | [optional] 64 | **orderBy** | **string**| Optionally, specify the form dataset order to return. | [optional] 65 | **asc** | **bool**| Optionally, specify sorting the result-set in ascending or descending order. | [optional] 66 | **name** | **string**| Specify the form name. | [optional] 67 | 68 | ### Return type 69 | 70 | [**\PandaDoc\Client\Model\FormListResponse**](../Model/FormListResponse.md) 71 | 72 | ### Authorization 73 | 74 | [apiKey](../../README.md#apiKey), [oauth2](../../README.md#oauth2) 75 | 76 | ### HTTP request headers 77 | 78 | - **Content-Type**: Not defined 79 | - **Accept**: `application/json` 80 | 81 | [[Back to top]](#) [[Back to API list]](../../README.md#endpoints) 82 | [[Back to README]](../../README.md) 83 | -------------------------------------------------------------------------------- /src/ApiException.php: -------------------------------------------------------------------------------- 1 | responseHeaders = $responseHeaders; 74 | $this->responseBody = $responseBody; 75 | } 76 | 77 | /** 78 | * Gets the HTTP response header 79 | * 80 | * @return string[]|null HTTP response header 81 | */ 82 | #[\ReturnTypeWillChange] 83 | public function getResponseHeaders() 84 | { 85 | return $this->responseHeaders; 86 | } 87 | 88 | /** 89 | * Gets the HTTP body of the server response either as Json or string 90 | * 91 | * @return \stdClass|string|null HTTP body of the server response either as \stdClass or string 92 | */ 93 | #[\ReturnTypeWillChange] 94 | public function getResponseBody() 95 | { 96 | return $this->responseBody; 97 | } 98 | 99 | /** 100 | * Sets the deserialized response object (during deserialization) 101 | * 102 | * @param mixed $obj Deserialized response object 103 | * 104 | * @return void 105 | */ 106 | public function setResponseObject($obj) 107 | { 108 | $this->responseObject = $obj; 109 | } 110 | 111 | /** 112 | * Gets the deserialized response object (during deserialization) 113 | * 114 | * @return mixed the deserialized response object 115 | */ 116 | #[\ReturnTypeWillChange] 117 | public function getResponseObject() 118 | { 119 | return $this->responseObject; 120 | } 121 | } 122 | -------------------------------------------------------------------------------- /docs/Model/DocumentCreateByTemplateRequest.md: -------------------------------------------------------------------------------- 1 | # # DocumentCreateByTemplateRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **string** | Name the document you are creating. If name is not passed, the template name is used. | [optional] 8 | **detectTitleVariables** | **bool** | Set this parameter as true if you want to detect title variables in the document. | [optional] 9 | **templateUuid** | **string** | The ID of a template you want to use. You can copy it from an in app template url such as `https://app.pandadoc.com/a/#/templates/{ID}/content`. A template ID is also obtained by listing templates. | 10 | **folderUuid** | **string** | | [optional] 11 | **recipients** | [**\PandaDoc\Client\Model\DocumentCreateByTemplateRequestRecipients[]**](DocumentCreateByTemplateRequestRecipients.md) | The list of recipients you're sending the document to. Every object must contain the email parameter. The `role`, `first_name` and `last_name` parameters are optional. If the `role` parameter passed, a person is assigned all fields matching their corresponding role. If not passed, a person will receive a read-only link to view the document. If the `first_name` and `last_name` not passed the system 1. creates a new contact, if none exists with the given `email`; or 2. gets the existing contact with the given `email` that already exists. | 12 | **tokens** | [**\PandaDoc\Client\Model\DocumentCreateByTemplateRequestTokens[]**](DocumentCreateByTemplateRequestTokens.md) | You can pass a list of tokens/values to pre-fill tokens used in a template. Name is a token name in a template. Value is a real value you would like to replace a token with. | [optional] 13 | **fields** | **object** | You can pass a list of fields/values to pre-fill fields used in a template. Note that the Signature field can't be pre-filled. | [optional] 14 | **metadata** | **object** | You can pass arbitrary data in the key-value format to associate custom information with a document. This information is returned in any API requests for the document details by id. | [optional] 15 | **tags** | **string[]** | Mark your document with one or several tags. | [optional] 16 | **images** | [**\PandaDoc\Client\Model\DocumentCreateByTemplateRequestImages[]**](DocumentCreateByTemplateRequestImages.md) | You can pass a list of images to image blocks (one image in one block) for replacement. | [optional] 17 | **pricingTables** | [**\PandaDoc\Client\Model\PricingTableRequest[]**](PricingTableRequest.md) | Information to construct or populate a pricing table can be passed when creating a document. All product information must be passed when creating a new document. Products stored in PandaDoc cannot be used to populate table rows at this time. Keep in mind that this is an array, so multiple table objects can be passed to a document. Make sure that \"Automatically add products to this table\" is enabled in the PandaDoc template pricing tables you wish to populate via API. | [optional] 18 | **contentPlaceholders** | [**\PandaDoc\Client\Model\DocumentCreateByTemplateRequestContentPlaceholders[]**](DocumentCreateByTemplateRequestContentPlaceholders.md) | You may replace Content Library Item Placeholders with a few content library items each and pre-fill fields/variables values, pricing table items, and assign recipients to roles from there. | [optional] 19 | 20 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 21 | -------------------------------------------------------------------------------- /docs/Model/DocumentCreateRequest.md: -------------------------------------------------------------------------------- 1 | # # DocumentCreateRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **string** | Name the document you are creating. | [optional] 8 | **detectTitleVariables** | **bool** | Set this parameter as true if you want to detect title variables in the document. | [optional] 9 | **templateUuid** | **string** | ID of the template you want to use. You can copy it from an in-app template URL such as `https://app.pandadoc.com/a/#/templates/{ID}/content`. A template ID is also obtained by listing templates. | [optional] 10 | **folderUuid** | **string** | ID of the folder where the created document should be stored. | [optional] 11 | **owner** | **array** | You can set an owner of a document as an `email` or `membership_id` | [optional] 12 | **recipients** | [**\PandaDoc\Client\Model\DocumentCreateRequestRecipients[]**](DocumentCreateRequestRecipients.md) | The list of recipients you're sending the document to. Every object must contain the `email` parameter. The `role`, `first_name` and `last_name` parameters are optional. If the `role` parameter is passed, a person is assigned all fields matching their corresponding role. If a role was not passed, a person receives a read-only link to view the document. If the `first_name` and `last_name` are not passed, the system does this 1. Creates a new contact, if none exists with the given `email`; or 2. Gets the existing contact with the given `email` that already exists. | [optional] 13 | **tokens** | [**\PandaDoc\Client\Model\DocumentCreateByTemplateRequestTokens[]**](DocumentCreateByTemplateRequestTokens.md) | You can pass a list of tokens/values to pre-fill tokens used in a template. Name is a token name in a template. Value is a real value you would like to replace a token with. | [optional] 14 | **fields** | **object** | You can pass a list of fields/values to pre-fill fields used in a template. Please note Signature field can't be pre-filled. | [optional] 15 | **metadata** | **object** | You can pass arbitrary data in the key-value format to associate custom information with a document. This information is returned in any API requests for the document details by id. | [optional] 16 | **tags** | **string[]** | Mark your document with one or several tags. | [optional] 17 | **images** | [**\PandaDoc\Client\Model\DocumentCreateRequestImages[]**](DocumentCreateRequestImages.md) | You can pass a list of images to image blocks (one image in one block) for replacement. | [optional] 18 | **pricingTables** | [**\PandaDoc\Client\Model\PricingTableRequest[]**](PricingTableRequest.md) | Information to construct or populate a pricing table can be passed when creating a document. All product information must be passed when creating a new document. Products stored in PandaDoc cannot be used to populate table rows at this time. Keep in mind that this is an array, so multiple table objects can be passed to a document. | [optional] 19 | **contentPlaceholders** | [**\PandaDoc\Client\Model\DocumentCreateRequestContentPlaceholders[]**](DocumentCreateRequestContentPlaceholders.md) | You may replace Content Library Item Placeholders with a few content library items each and pre-fill fields/variables values, pricing table items, and assign recipients to roles from there. | [optional] 20 | **url** | **string** | Use a URL to specify the PDF. We support only URLs starting with https. | [optional] 21 | **parseFormFields** | **bool** | Set this parameter as true if you create a document from a PDF with form fields and as false if you upload a PDF with field tags. | [optional] 22 | 23 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 24 | -------------------------------------------------------------------------------- /docs/Api/OAuth20AuthenticationApi.md: -------------------------------------------------------------------------------- 1 | # PandaDoc\Client\OAuth20AuthenticationApi 2 | 3 | All URIs are relative to https://api.pandadoc.com. 4 | 5 | Method | HTTP request | Description 6 | ------------- | ------------- | ------------- 7 | [**accessToken()**](OAuth20AuthenticationApi.md#accessToken) | **POST** /oauth2/access_token | Create/Refresh Access Token 8 | 9 | 10 | ## `accessToken()` 11 | 12 | ```php 13 | accessToken($grantType, $clientId, $clientSecret, $code, $scope, $refreshToken): \PandaDoc\Client\Model\OAuth2AccessTokenResponse 14 | ``` 15 | 16 | Create/Refresh Access Token 17 | 18 | ### Example 19 | 20 | ```php 21 | setApiKey('Authorization', 'YOUR_API_KEY'); 27 | // Setup prefix (e.g. Bearer) for API key, if needed 28 | $config = PandaDoc\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'API-Key'); 29 | 30 | // Configure OAuth2 access token for authorization: oauth2 31 | // $config = PandaDoc\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); 32 | 33 | 34 | $apiInstance = new PandaDoc\Client\Api\OAuth20AuthenticationApi( 35 | // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. 36 | // This is optional, `GuzzleHttp\Client` will be used as default. 37 | new GuzzleHttp\Client(), 38 | $config 39 | ); 40 | $grantType = 'refresh_token'; // string | This value must be set to `refresh_token`. 41 | $clientId = 'clientId_example'; // string | Client ID that is automatically generated after application creation in the Developer Dashboard. 42 | $clientSecret = 'clientSecret_example'; // string | Client secret that is automatically generated after application creation in the Developer Dashboard. 43 | $code = 'code_example'; // string | `auth_code` from the server on the previous step (Authorize a PandaDoc User). 44 | $scope = 'scope_example'; // string | Requested permissions. Use `read+write` as our default value to send documents. 45 | $refreshToken = 'refreshToken_example'; // string | `refresh_token` you received and stored from the server when initially creating an `access_token`. 46 | 47 | try { 48 | $result = $apiInstance->accessToken($grantType, $clientId, $clientSecret, $code, $scope, $refreshToken); 49 | print_r($result); 50 | } catch (Exception $e) { 51 | echo 'Exception when calling OAuth20AuthenticationApi->accessToken: ', $e->getMessage(), PHP_EOL; 52 | } 53 | ``` 54 | 55 | ### Parameters 56 | 57 | Name | Type | Description | Notes 58 | ------------- | ------------- | ------------- | ------------- 59 | **grantType** | **string**| This value must be set to `refresh_token`. | [optional] [default to 'refresh_token'] 60 | **clientId** | **string**| Client ID that is automatically generated after application creation in the Developer Dashboard. | [optional] 61 | **clientSecret** | **string**| Client secret that is automatically generated after application creation in the Developer Dashboard. | [optional] 62 | **code** | **string**| `auth_code` from the server on the previous step (Authorize a PandaDoc User). | [optional] 63 | **scope** | **string**| Requested permissions. Use `read+write` as our default value to send documents. | [optional] 64 | **refreshToken** | **string**| `refresh_token` you received and stored from the server when initially creating an `access_token`. | [optional] 65 | 66 | ### Return type 67 | 68 | [**\PandaDoc\Client\Model\OAuth2AccessTokenResponse**](../Model/OAuth2AccessTokenResponse.md) 69 | 70 | ### Authorization 71 | 72 | [apiKey](../../README.md#apiKey), [oauth2](../../README.md#oauth2) 73 | 74 | ### HTTP request headers 75 | 76 | - **Content-Type**: `application/x-www-form-urlencoded` 77 | - **Accept**: `application/json` 78 | 79 | [[Back to top]](#) [[Back to API list]](../../README.md#endpoints) 80 | [[Back to README]](../../README.md) 81 | -------------------------------------------------------------------------------- /examples/CreateDocumentFromPdByUrlAndSend.php: -------------------------------------------------------------------------------- 1 | setName('Sample Document from PDF with Field Tags') 34 | ->setUrl(self::PDF_URL) 35 | ->setTags(['tag1', 'tag2']) 36 | ->setRecipients([ 37 | (new DocumentCreateRequestRecipients()) 38 | ->setEmail('john@example.com') 39 | ->setFirstName('John') 40 | ->setLastName('Doe') 41 | ->setRole('user') 42 | ->setSigningOrder(1), 43 | (new DocumentCreateRequestRecipients()) 44 | ->setEmail('josh@example.com') 45 | ->setFirstName('Josh') 46 | ->setLastName('Ron') 47 | ->setSigningOrder(2), 48 | ]) 49 | ->setFields([ 50 | 'name' => ['value' => 'John'], 51 | 'like' => ['value' => true], 52 | ]) 53 | ->setMetadata([ 54 | 'salesforce.opportunity_id' => '123456', 55 | 'myFavoritePet' => 'Panda', 56 | ]) 57 | ->setParseFormFields(false); 58 | return $documentApiInstance->createDocument($documentCreateRequest); 59 | } 60 | 61 | /** 62 | * Document creation is non-blocking (asynchronous) operation. 63 | * 64 | * With a successful request, you receive a response with the created 65 | * document's ID and status document.uploaded. 66 | * After processing completes on our servers, usually a few seconds, 67 | * the document moves to the document.draft status. 68 | * Please wait for the webhook call or check this document's 69 | * status before proceeding. 70 | * 71 | * The change of status from document.uploaded to another status signifies 72 | * the document is ready for further processing. 73 | * Attempting to use a newly created document before PandaDoc servers 74 | * process it will result in a '404 document not found' response. 75 | * 76 | * @param DocumentsApi $documentApiInstance 77 | * @param DocumentCreateResponse $document 78 | * @return void 79 | * @throws ApiException|Exception 80 | */ 81 | public static function ensureDocumentCreated(DocumentsApi $documentApiInstance, DocumentCreateResponse $document): void 82 | { 83 | $currentRetries = 0; 84 | 85 | while ($currentRetries < self::MAX_CHECK_RETRIES) { 86 | try { 87 | sleep(2); 88 | } catch (Exception $e) { 89 | print_r($e->getMessage() . PHP_EOL); 90 | throw $e; 91 | } 92 | 93 | $currentRetries++; 94 | $docStatusResponse = $documentApiInstance->statusDocument($document->getId()); 95 | if ($docStatusResponse->getStatus() === 'document.draft') { 96 | return; 97 | } 98 | } 99 | 100 | throw new Exception('Document was not sent'); 101 | } 102 | 103 | /** 104 | * @param DocumentsApi $documentApiInstance 105 | * @param DocumentCreateResponse $document 106 | * @return void 107 | * @throws ApiException 108 | */ 109 | public static function sendDocument(DocumentsApi $documentApiInstance, DocumentCreateResponse $document): void 110 | { 111 | $requestBody = (new DocumentSendRequest()) 112 | ->setSilent(True) 113 | ->setSubject('This doc was send via php SDK'); 114 | 115 | $documentApiInstance->sendDocument($document->getId(), $requestBody); 116 | } 117 | 118 | public static function run() 119 | { 120 | $config = Configuration::getDefaultConfiguration() 121 | ->setApiKey('Authorization', self::API_KEY) 122 | ->setApiKeyPrefix('Authorization', 'API-Key'); 123 | 124 | $documentApiInstance = new DocumentsApi(null, $config); 125 | 126 | try { 127 | $document = self::createDocument($documentApiInstance); 128 | print_r("Document was successfully uploaded: \n" . $document . PHP_EOL); 129 | self::ensureDocumentCreated($documentApiInstance, $document); 130 | self::sendDocument($documentApiInstance, $document); 131 | print_r("Document was successfully created and sent to the recipients!" . PHP_EOL); 132 | } catch (Exception $e) { 133 | print_r("Status code: " . $e->getCode() . PHP_EOL); 134 | print_r("Reason: " . $e->getMessage() . PHP_EOL); 135 | print_r($e->getTraceAsString() . PHP_EOL); 136 | } 137 | } 138 | } 139 | 140 | CreateDocumentFromPdByUrlAndSend::run(); 141 | -------------------------------------------------------------------------------- /docs/Api/ContentLibraryItemsApi.md: -------------------------------------------------------------------------------- 1 | # PandaDoc\Client\ContentLibraryItemsApi 2 | 3 | All URIs are relative to https://api.pandadoc.com. 4 | 5 | Method | HTTP request | Description 6 | ------------- | ------------- | ------------- 7 | [**detailsContentLibraryItem()**](ContentLibraryItemsApi.md#detailsContentLibraryItem) | **GET** /public/v1/content-library-items/{id}/details | Details Content Library Item 8 | [**listContentLibraryItems()**](ContentLibraryItemsApi.md#listContentLibraryItems) | **GET** /public/v1/content-library-items | List Content Library Item 9 | 10 | 11 | ## `detailsContentLibraryItem()` 12 | 13 | ```php 14 | detailsContentLibraryItem($id): \PandaDoc\Client\Model\ContentLibraryItemResponse 15 | ``` 16 | 17 | Details Content Library Item 18 | 19 | Return detailed data about a content library item. 20 | 21 | ### Example 22 | 23 | ```php 24 | setApiKey('Authorization', 'YOUR_API_KEY'); 30 | // Setup prefix (e.g. Bearer) for API key, if needed 31 | $config = PandaDoc\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'API-Key'); 32 | 33 | // Configure OAuth2 access token for authorization: oauth2 34 | // $config = PandaDoc\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); 35 | 36 | 37 | $apiInstance = new PandaDoc\Client\Api\ContentLibraryItemsApi( 38 | // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. 39 | // This is optional, `GuzzleHttp\Client` will be used as default. 40 | new GuzzleHttp\Client(), 41 | $config 42 | ); 43 | $id = UXdP7Lnbvvr4WEb2wzM2hc; // string | Content Library Item ID 44 | 45 | try { 46 | $result = $apiInstance->detailsContentLibraryItem($id); 47 | print_r($result); 48 | } catch (Exception $e) { 49 | echo 'Exception when calling ContentLibraryItemsApi->detailsContentLibraryItem: ', $e->getMessage(), PHP_EOL; 50 | } 51 | ``` 52 | 53 | ### Parameters 54 | 55 | Name | Type | Description | Notes 56 | ------------- | ------------- | ------------- | ------------- 57 | **id** | **string**| Content Library Item ID | 58 | 59 | ### Return type 60 | 61 | [**\PandaDoc\Client\Model\ContentLibraryItemResponse**](../Model/ContentLibraryItemResponse.md) 62 | 63 | ### Authorization 64 | 65 | [apiKey](../../README.md#apiKey), [oauth2](../../README.md#oauth2) 66 | 67 | ### HTTP request headers 68 | 69 | - **Content-Type**: Not defined 70 | - **Accept**: `application/json` 71 | 72 | [[Back to top]](#) [[Back to API list]](../../README.md#endpoints) 73 | [[Back to README]](../../README.md) 74 | 75 | ## `listContentLibraryItems()` 76 | 77 | ```php 78 | listContentLibraryItems($q, $id, $deleted, $folderUuid, $count, $page, $tag): \PandaDoc\Client\Model\ContentLibraryItemListResponse 79 | ``` 80 | 81 | List Content Library Item 82 | 83 | Optionally filter by a search query or tags. 84 | 85 | ### Example 86 | 87 | ```php 88 | setApiKey('Authorization', 'YOUR_API_KEY'); 94 | // Setup prefix (e.g. Bearer) for API key, if needed 95 | $config = PandaDoc\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'API-Key'); 96 | 97 | // Configure OAuth2 access token for authorization: oauth2 98 | // $config = PandaDoc\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); 99 | 100 | 101 | $apiInstance = new PandaDoc\Client\Api\ContentLibraryItemsApi( 102 | // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. 103 | // This is optional, `GuzzleHttp\Client` will be used as default. 104 | new GuzzleHttp\Client(), 105 | $config 106 | ); 107 | $q = Sample Pricing Table; // string | Search query. Filter by content library item name. 108 | $id = UXdP7Lnbvvr4WEb2wzM2hc; // string | Specify content library item ID. 109 | $deleted = True; // bool | Returns only the deleted content library items. 110 | $folderUuid = S6xX7saJfA44mtJxGWd95L; // string | The UUID of the folder where the content library items are stored. 111 | $count = 10; // int | Specify how many content library items to return. Default is 50 content library items, maximum is 100 content library items. 112 | $page = 56; // int | Specify which page of the dataset to return. 113 | $tag = pricing_tables; // string | Search tag. Filter by content library item tag. 114 | 115 | try { 116 | $result = $apiInstance->listContentLibraryItems($q, $id, $deleted, $folderUuid, $count, $page, $tag); 117 | print_r($result); 118 | } catch (Exception $e) { 119 | echo 'Exception when calling ContentLibraryItemsApi->listContentLibraryItems: ', $e->getMessage(), PHP_EOL; 120 | } 121 | ``` 122 | 123 | ### Parameters 124 | 125 | Name | Type | Description | Notes 126 | ------------- | ------------- | ------------- | ------------- 127 | **q** | **string**| Search query. Filter by content library item name. | [optional] 128 | **id** | **string**| Specify content library item ID. | [optional] 129 | **deleted** | **bool**| Returns only the deleted content library items. | [optional] 130 | **folderUuid** | **string**| The UUID of the folder where the content library items are stored. | [optional] 131 | **count** | **int**| Specify how many content library items to return. Default is 50 content library items, maximum is 100 content library items. | [optional] 132 | **page** | **int**| Specify which page of the dataset to return. | [optional] 133 | **tag** | **string**| Search tag. Filter by content library item tag. | [optional] 134 | 135 | ### Return type 136 | 137 | [**\PandaDoc\Client\Model\ContentLibraryItemListResponse**](../Model/ContentLibraryItemListResponse.md) 138 | 139 | ### Authorization 140 | 141 | [apiKey](../../README.md#apiKey), [oauth2](../../README.md#oauth2) 142 | 143 | ### HTTP request headers 144 | 145 | - **Content-Type**: Not defined 146 | - **Accept**: `application/json` 147 | 148 | [[Back to top]](#) [[Back to API list]](../../README.md#endpoints) 149 | [[Back to README]](../../README.md) 150 | -------------------------------------------------------------------------------- /docs/Api/WebhookEventsApi.md: -------------------------------------------------------------------------------- 1 | # PandaDoc\Client\WebhookEventsApi 2 | 3 | All URIs are relative to https://api.pandadoc.com. 4 | 5 | Method | HTTP request | Description 6 | ------------- | ------------- | ------------- 7 | [**detailsWebhookEvent()**](WebhookEventsApi.md#detailsWebhookEvent) | **GET** /public/v1/webhook-events/{id} | Get webhook event by uuid 8 | [**listWebhookEvent()**](WebhookEventsApi.md#listWebhookEvent) | **GET** /public/v1/webhook-events | Get webhook event page 9 | 10 | 11 | ## `detailsWebhookEvent()` 12 | 13 | ```php 14 | detailsWebhookEvent($id): \PandaDoc\Client\Model\WebhookEventDetailsResponse 15 | ``` 16 | 17 | Get webhook event by uuid 18 | 19 | ### Example 20 | 21 | ```php 22 | setApiKey('Authorization', 'YOUR_API_KEY'); 28 | // Setup prefix (e.g. Bearer) for API key, if needed 29 | $config = PandaDoc\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'API-Key'); 30 | 31 | // Configure OAuth2 access token for authorization: oauth2 32 | // $config = PandaDoc\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); 33 | 34 | 35 | $apiInstance = new PandaDoc\Client\Api\WebhookEventsApi( 36 | // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. 37 | // This is optional, `GuzzleHttp\Client` will be used as default. 38 | new GuzzleHttp\Client(), 39 | $config 40 | ); 41 | $id = 'id_example'; // string | Webhook event uuid 42 | 43 | try { 44 | $result = $apiInstance->detailsWebhookEvent($id); 45 | print_r($result); 46 | } catch (Exception $e) { 47 | echo 'Exception when calling WebhookEventsApi->detailsWebhookEvent: ', $e->getMessage(), PHP_EOL; 48 | } 49 | ``` 50 | 51 | ### Parameters 52 | 53 | Name | Type | Description | Notes 54 | ------------- | ------------- | ------------- | ------------- 55 | **id** | **string**| Webhook event uuid | 56 | 57 | ### Return type 58 | 59 | [**\PandaDoc\Client\Model\WebhookEventDetailsResponse**](../Model/WebhookEventDetailsResponse.md) 60 | 61 | ### Authorization 62 | 63 | [apiKey](../../README.md#apiKey), [oauth2](../../README.md#oauth2) 64 | 65 | ### HTTP request headers 66 | 67 | - **Content-Type**: Not defined 68 | - **Accept**: `application/json` 69 | 70 | [[Back to top]](#) [[Back to API list]](../../README.md#endpoints) 71 | [[Back to README]](../../README.md) 72 | 73 | ## `listWebhookEvent()` 74 | 75 | ```php 76 | listWebhookEvent($count, $page, $since, $to, $type, $httpStatusCode, $error): \PandaDoc\Client\Model\WebhookEventPageResponse 77 | ``` 78 | 79 | Get webhook event page 80 | 81 | ### Example 82 | 83 | ```php 84 | setApiKey('Authorization', 'YOUR_API_KEY'); 90 | // Setup prefix (e.g. Bearer) for API key, if needed 91 | $config = PandaDoc\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'API-Key'); 92 | 93 | // Configure OAuth2 access token for authorization: oauth2 94 | // $config = PandaDoc\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); 95 | 96 | 97 | $apiInstance = new PandaDoc\Client\Api\WebhookEventsApi( 98 | // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. 99 | // This is optional, `GuzzleHttp\Client` will be used as default. 100 | new GuzzleHttp\Client(), 101 | $config 102 | ); 103 | $count = 56; // int | Number of element in page 104 | $page = 56; // int | Page number 105 | $since = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Filter option: all events from specified timestamp 106 | $to = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Filter option: all events up to specified timestamp 107 | $type = array(new \PandaDoc\Client\Model\\PandaDoc\Client\Model\WebhookEventTriggerEnum()); // \PandaDoc\Client\Model\WebhookEventTriggerEnum[] | Filter option: all events of type 108 | $httpStatusCode = array(new \PandaDoc\Client\Model\\PandaDoc\Client\Model\WebhookEventHttpStatusCodeGroupEnum()); // \PandaDoc\Client\Model\WebhookEventHttpStatusCodeGroupEnum[] | Filter option: all events of http status code 109 | $error = array(new \PandaDoc\Client\Model\\PandaDoc\Client\Model\WebhookEventErrorEnum()); // \PandaDoc\Client\Model\WebhookEventErrorEnum[] | Filter option: all events with following error 110 | 111 | try { 112 | $result = $apiInstance->listWebhookEvent($count, $page, $since, $to, $type, $httpStatusCode, $error); 113 | print_r($result); 114 | } catch (Exception $e) { 115 | echo 'Exception when calling WebhookEventsApi->listWebhookEvent: ', $e->getMessage(), PHP_EOL; 116 | } 117 | ``` 118 | 119 | ### Parameters 120 | 121 | Name | Type | Description | Notes 122 | ------------- | ------------- | ------------- | ------------- 123 | **count** | **int**| Number of element in page | 124 | **page** | **int**| Page number | 125 | **since** | **\DateTime**| Filter option: all events from specified timestamp | [optional] 126 | **to** | **\DateTime**| Filter option: all events up to specified timestamp | [optional] 127 | **type** | [**\PandaDoc\Client\Model\WebhookEventTriggerEnum[]**](../Model/\PandaDoc\Client\Model\WebhookEventTriggerEnum.md)| Filter option: all events of type | [optional] 128 | **httpStatusCode** | [**\PandaDoc\Client\Model\WebhookEventHttpStatusCodeGroupEnum[]**](../Model/\PandaDoc\Client\Model\WebhookEventHttpStatusCodeGroupEnum.md)| Filter option: all events of http status code | [optional] 129 | **error** | [**\PandaDoc\Client\Model\WebhookEventErrorEnum[]**](../Model/\PandaDoc\Client\Model\WebhookEventErrorEnum.md)| Filter option: all events with following error | [optional] 130 | 131 | ### Return type 132 | 133 | [**\PandaDoc\Client\Model\WebhookEventPageResponse**](../Model/WebhookEventPageResponse.md) 134 | 135 | ### Authorization 136 | 137 | [apiKey](../../README.md#apiKey), [oauth2](../../README.md#oauth2) 138 | 139 | ### HTTP request headers 140 | 141 | - **Content-Type**: Not defined 142 | - **Accept**: `application/json` 143 | 144 | [[Back to top]](#) [[Back to API list]](../../README.md#endpoints) 145 | [[Back to README]](../../README.md) 146 | -------------------------------------------------------------------------------- /docs/Api/MembersApi.md: -------------------------------------------------------------------------------- 1 | # PandaDoc\Client\MembersApi 2 | 3 | All URIs are relative to https://api.pandadoc.com. 4 | 5 | Method | HTTP request | Description 6 | ------------- | ------------- | ------------- 7 | [**detailsCurrentMember()**](MembersApi.md#detailsCurrentMember) | **GET** /public/v1/members/current | Current member details 8 | [**detailsMember()**](MembersApi.md#detailsMember) | **GET** /public/v1/members/{id} | Member details 9 | [**listMembers()**](MembersApi.md#listMembers) | **GET** /public/v1/members | List members 10 | 11 | 12 | ## `detailsCurrentMember()` 13 | 14 | ```php 15 | detailsCurrentMember(): \PandaDoc\Client\Model\MemberDetailsResponse 16 | ``` 17 | 18 | Current member details 19 | 20 | A method to define to whom credentials belong 21 | 22 | ### Example 23 | 24 | ```php 25 | setApiKey('Authorization', 'YOUR_API_KEY'); 31 | // Setup prefix (e.g. Bearer) for API key, if needed 32 | $config = PandaDoc\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'API-Key'); 33 | 34 | // Configure OAuth2 access token for authorization: oauth2 35 | // $config = PandaDoc\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); 36 | 37 | 38 | $apiInstance = new PandaDoc\Client\Api\MembersApi( 39 | // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. 40 | // This is optional, `GuzzleHttp\Client` will be used as default. 41 | new GuzzleHttp\Client(), 42 | $config 43 | ); 44 | 45 | try { 46 | $result = $apiInstance->detailsCurrentMember(); 47 | print_r($result); 48 | } catch (Exception $e) { 49 | echo 'Exception when calling MembersApi->detailsCurrentMember: ', $e->getMessage(), PHP_EOL; 50 | } 51 | ``` 52 | 53 | ### Parameters 54 | 55 | This endpoint does not need any parameter. 56 | 57 | ### Return type 58 | 59 | [**\PandaDoc\Client\Model\MemberDetailsResponse**](../Model/MemberDetailsResponse.md) 60 | 61 | ### Authorization 62 | 63 | [apiKey](../../README.md#apiKey), [oauth2](../../README.md#oauth2) 64 | 65 | ### HTTP request headers 66 | 67 | - **Content-Type**: Not defined 68 | - **Accept**: `application/json` 69 | 70 | [[Back to top]](#) [[Back to API list]](../../README.md#endpoints) 71 | [[Back to README]](../../README.md) 72 | 73 | ## `detailsMember()` 74 | 75 | ```php 76 | detailsMember($id): \PandaDoc\Client\Model\MemberDetailsResponse 77 | ``` 78 | 79 | Member details 80 | 81 | A method to retrieve a member's details by id 82 | 83 | ### Example 84 | 85 | ```php 86 | setApiKey('Authorization', 'YOUR_API_KEY'); 92 | // Setup prefix (e.g. Bearer) for API key, if needed 93 | $config = PandaDoc\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'API-Key'); 94 | 95 | // Configure OAuth2 access token for authorization: oauth2 96 | // $config = PandaDoc\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); 97 | 98 | 99 | $apiInstance = new PandaDoc\Client\Api\MembersApi( 100 | // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. 101 | // This is optional, `GuzzleHttp\Client` will be used as default. 102 | new GuzzleHttp\Client(), 103 | $config 104 | ); 105 | $id = radQBiBkU7MBk59NSgaGf5; // string | Membership id 106 | 107 | try { 108 | $result = $apiInstance->detailsMember($id); 109 | print_r($result); 110 | } catch (Exception $e) { 111 | echo 'Exception when calling MembersApi->detailsMember: ', $e->getMessage(), PHP_EOL; 112 | } 113 | ``` 114 | 115 | ### Parameters 116 | 117 | Name | Type | Description | Notes 118 | ------------- | ------------- | ------------- | ------------- 119 | **id** | **string**| Membership id | 120 | 121 | ### Return type 122 | 123 | [**\PandaDoc\Client\Model\MemberDetailsResponse**](../Model/MemberDetailsResponse.md) 124 | 125 | ### Authorization 126 | 127 | [apiKey](../../README.md#apiKey), [oauth2](../../README.md#oauth2) 128 | 129 | ### HTTP request headers 130 | 131 | - **Content-Type**: Not defined 132 | - **Accept**: `application/json` 133 | 134 | [[Back to top]](#) [[Back to API list]](../../README.md#endpoints) 135 | [[Back to README]](../../README.md) 136 | 137 | ## `listMembers()` 138 | 139 | ```php 140 | listMembers(): \PandaDoc\Client\Model\MemberListResponse 141 | ``` 142 | 143 | List members 144 | 145 | Retrieve all members details of the workspace 146 | 147 | ### Example 148 | 149 | ```php 150 | setApiKey('Authorization', 'YOUR_API_KEY'); 156 | // Setup prefix (e.g. Bearer) for API key, if needed 157 | $config = PandaDoc\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'API-Key'); 158 | 159 | // Configure OAuth2 access token for authorization: oauth2 160 | // $config = PandaDoc\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); 161 | 162 | 163 | $apiInstance = new PandaDoc\Client\Api\MembersApi( 164 | // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. 165 | // This is optional, `GuzzleHttp\Client` will be used as default. 166 | new GuzzleHttp\Client(), 167 | $config 168 | ); 169 | 170 | try { 171 | $result = $apiInstance->listMembers(); 172 | print_r($result); 173 | } catch (Exception $e) { 174 | echo 'Exception when calling MembersApi->listMembers: ', $e->getMessage(), PHP_EOL; 175 | } 176 | ``` 177 | 178 | ### Parameters 179 | 180 | This endpoint does not need any parameter. 181 | 182 | ### Return type 183 | 184 | [**\PandaDoc\Client\Model\MemberListResponse**](../Model/MemberListResponse.md) 185 | 186 | ### Authorization 187 | 188 | [apiKey](../../README.md#apiKey), [oauth2](../../README.md#oauth2) 189 | 190 | ### HTTP request headers 191 | 192 | - **Content-Type**: Not defined 193 | - **Accept**: `application/json` 194 | 195 | [[Back to top]](#) [[Back to API list]](../../README.md#endpoints) 196 | [[Back to README]](../../README.md) 197 | -------------------------------------------------------------------------------- /docs/Api/APILogsApi.md: -------------------------------------------------------------------------------- 1 | # PandaDoc\Client\APILogsApi 2 | 3 | All URIs are relative to https://api.pandadoc.com. 4 | 5 | Method | HTTP request | Description 6 | ------------- | ------------- | ------------- 7 | [**detailsLog()**](APILogsApi.md#detailsLog) | **GET** /public/v1/logs/{id} | Details API Log 8 | [**listLogs()**](APILogsApi.md#listLogs) | **GET** /public/v1/logs | List API Log 9 | 10 | 11 | ## `detailsLog()` 12 | 13 | ```php 14 | detailsLog($id): \PandaDoc\Client\Model\APILogDetailsResponse 15 | ``` 16 | 17 | Details API Log 18 | 19 | Returns details of the specific API log event. 20 | 21 | ### Example 22 | 23 | ```php 24 | setApiKey('Authorization', 'YOUR_API_KEY'); 30 | // Setup prefix (e.g. Bearer) for API key, if needed 31 | $config = PandaDoc\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'API-Key'); 32 | 33 | // Configure OAuth2 access token for authorization: oauth2 34 | // $config = PandaDoc\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); 35 | 36 | 37 | $apiInstance = new PandaDoc\Client\Api\APILogsApi( 38 | // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. 39 | // This is optional, `GuzzleHttp\Client` will be used as default. 40 | new GuzzleHttp\Client(), 41 | $config 42 | ); 43 | $id = AXp2jrHMK2MKv_lRqmQ; // string | Log event id. 44 | 45 | try { 46 | $result = $apiInstance->detailsLog($id); 47 | print_r($result); 48 | } catch (Exception $e) { 49 | echo 'Exception when calling APILogsApi->detailsLog: ', $e->getMessage(), PHP_EOL; 50 | } 51 | ``` 52 | 53 | ### Parameters 54 | 55 | Name | Type | Description | Notes 56 | ------------- | ------------- | ------------- | ------------- 57 | **id** | **string**| Log event id. | 58 | 59 | ### Return type 60 | 61 | [**\PandaDoc\Client\Model\APILogDetailsResponse**](../Model/APILogDetailsResponse.md) 62 | 63 | ### Authorization 64 | 65 | [apiKey](../../README.md#apiKey), [oauth2](../../README.md#oauth2) 66 | 67 | ### HTTP request headers 68 | 69 | - **Content-Type**: Not defined 70 | - **Accept**: `application/json` 71 | 72 | [[Back to top]](#) [[Back to API list]](../../README.md#endpoints) 73 | [[Back to README]](../../README.md) 74 | 75 | ## `listLogs()` 76 | 77 | ```php 78 | listLogs($since, $to, $count, $page, $statuses, $methods, $search, $environmentType): \PandaDoc\Client\Model\APILogListResponse 79 | ``` 80 | 81 | List API Log 82 | 83 | Get the list of all logs within the selected workspace. Optionally filter by date, page, and `#` of items per page. 84 | 85 | ### Example 86 | 87 | ```php 88 | setApiKey('Authorization', 'YOUR_API_KEY'); 94 | // Setup prefix (e.g. Bearer) for API key, if needed 95 | $config = PandaDoc\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'API-Key'); 96 | 97 | // Configure OAuth2 access token for authorization: oauth2 98 | // $config = PandaDoc\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); 99 | 100 | 101 | $apiInstance = new PandaDoc\Client\Api\APILogsApi( 102 | // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. 103 | // This is optional, `GuzzleHttp\Client` will be used as default. 104 | new GuzzleHttp\Client(), 105 | $config 106 | ); 107 | $since = -7d; // string | Determines a point in time from which logs should be fetched. Either a specific ISO 8601 datetime or a relative identifier such as \"-90d\" (for past 90 days). 108 | $to = now; // string | Determines a point in time from which logs should be fetched. Either a specific ISO 8601 datetime or a relative identifier such as \"-10d\" (for past 10 days) or a special \"now\" value. 109 | $count = 10; // int | The amount of items on each page. 110 | $page = 56; // int | Page number of the results returned. 111 | $statuses = [400,500]; // int[] | Returns only the predefined status codes. Allows 1xx, 2xx, 3xx, 4xx, and 5xx. 112 | $methods = ["GET","POST"]; // string[] | Returns only the predefined HTTP methods. Allows GET, POST, PUT, PATCH, and DELETE. 113 | $search = documents/hryJY9mqYZHjQCYQuSjRQg/send; // string | Returns the results containing a string. 114 | $environmentType = 'environmentType_example'; // string | Returns logs for production/sandbox. 115 | 116 | try { 117 | $result = $apiInstance->listLogs($since, $to, $count, $page, $statuses, $methods, $search, $environmentType); 118 | print_r($result); 119 | } catch (Exception $e) { 120 | echo 'Exception when calling APILogsApi->listLogs: ', $e->getMessage(), PHP_EOL; 121 | } 122 | ``` 123 | 124 | ### Parameters 125 | 126 | Name | Type | Description | Notes 127 | ------------- | ------------- | ------------- | ------------- 128 | **since** | **string**| Determines a point in time from which logs should be fetched. Either a specific ISO 8601 datetime or a relative identifier such as \"-90d\" (for past 90 days). | [optional] 129 | **to** | **string**| Determines a point in time from which logs should be fetched. Either a specific ISO 8601 datetime or a relative identifier such as \"-10d\" (for past 10 days) or a special \"now\" value. | [optional] 130 | **count** | **int**| The amount of items on each page. | [optional] 131 | **page** | **int**| Page number of the results returned. | [optional] 132 | **statuses** | [**int[]**](../Model/int.md)| Returns only the predefined status codes. Allows 1xx, 2xx, 3xx, 4xx, and 5xx. | [optional] 133 | **methods** | [**string[]**](../Model/string.md)| Returns only the predefined HTTP methods. Allows GET, POST, PUT, PATCH, and DELETE. | [optional] 134 | **search** | **string**| Returns the results containing a string. | [optional] 135 | **environmentType** | **string**| Returns logs for production/sandbox. | [optional] 136 | 137 | ### Return type 138 | 139 | [**\PandaDoc\Client\Model\APILogListResponse**](../Model/APILogListResponse.md) 140 | 141 | ### Authorization 142 | 143 | [apiKey](../../README.md#apiKey), [oauth2](../../README.md#oauth2) 144 | 145 | ### HTTP request headers 146 | 147 | - **Content-Type**: Not defined 148 | - **Accept**: `application/json` 149 | 150 | [[Back to top]](#) [[Back to API list]](../../README.md#endpoints) 151 | [[Back to README]](../../README.md) 152 | -------------------------------------------------------------------------------- /docs/Api/UserAndWorkspaceManagementApi.md: -------------------------------------------------------------------------------- 1 | # PandaDoc\Client\UserAndWorkspaceManagementApi 2 | 3 | All URIs are relative to https://api.pandadoc.com. 4 | 5 | Method | HTTP request | Description 6 | ------------- | ------------- | ------------- 7 | [**addMember()**](UserAndWorkspaceManagementApi.md#addMember) | **POST** /public/v1/workspaces/{workspace_id}/members | Add member 8 | [**createUser()**](UserAndWorkspaceManagementApi.md#createUser) | **POST** /public/v1/users | Create User 9 | [**createWorkspace()**](UserAndWorkspaceManagementApi.md#createWorkspace) | **POST** /public/v1/workspaces | Create Workspace 10 | 11 | 12 | ## `addMember()` 13 | 14 | ```php 15 | addMember($workspaceId, $addMemberRequest, $notifyUser, $notifyWsAdmins): \PandaDoc\Client\Model\AddMemberResponse 16 | ``` 17 | 18 | Add member 19 | 20 | ### Example 21 | 22 | ```php 23 | setApiKey('Authorization', 'YOUR_API_KEY'); 29 | // Setup prefix (e.g. Bearer) for API key, if needed 30 | $config = PandaDoc\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'API-Key'); 31 | 32 | // Configure OAuth2 access token for authorization: oauth2 33 | // $config = PandaDoc\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); 34 | 35 | 36 | $apiInstance = new PandaDoc\Client\Api\UserAndWorkspaceManagementApi( 37 | // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. 38 | // This is optional, `GuzzleHttp\Client` will be used as default. 39 | new GuzzleHttp\Client(), 40 | $config 41 | ); 42 | $workspaceId = BhVzRcxH9Z2LgfPPGXFUBa; // string 43 | $addMemberRequest = new \PandaDoc\Client\Model\AddMemberRequest(); // \PandaDoc\Client\Model\AddMemberRequest 44 | $notifyUser = True; // bool | Send a confirmation email to the user that was added to workspace(s). 45 | $notifyWsAdmins = True; // bool | Send a confirmation email to all workspace admins indicating that the user has been added to the workspace. 46 | 47 | try { 48 | $result = $apiInstance->addMember($workspaceId, $addMemberRequest, $notifyUser, $notifyWsAdmins); 49 | print_r($result); 50 | } catch (Exception $e) { 51 | echo 'Exception when calling UserAndWorkspaceManagementApi->addMember: ', $e->getMessage(), PHP_EOL; 52 | } 53 | ``` 54 | 55 | ### Parameters 56 | 57 | Name | Type | Description | Notes 58 | ------------- | ------------- | ------------- | ------------- 59 | **workspaceId** | **string**| | 60 | **addMemberRequest** | [**\PandaDoc\Client\Model\AddMemberRequest**](../Model/AddMemberRequest.md)| | 61 | **notifyUser** | **bool**| Send a confirmation email to the user that was added to workspace(s). | [optional] 62 | **notifyWsAdmins** | **bool**| Send a confirmation email to all workspace admins indicating that the user has been added to the workspace. | [optional] 63 | 64 | ### Return type 65 | 66 | [**\PandaDoc\Client\Model\AddMemberResponse**](../Model/AddMemberResponse.md) 67 | 68 | ### Authorization 69 | 70 | [apiKey](../../README.md#apiKey), [oauth2](../../README.md#oauth2) 71 | 72 | ### HTTP request headers 73 | 74 | - **Content-Type**: `application/json` 75 | - **Accept**: `application/json` 76 | 77 | [[Back to top]](#) [[Back to API list]](../../README.md#endpoints) 78 | [[Back to README]](../../README.md) 79 | 80 | ## `createUser()` 81 | 82 | ```php 83 | createUser($createUserRequest, $notifyUser, $notifyWsAdmins): \PandaDoc\Client\Model\CreateUserResponse 84 | ``` 85 | 86 | Create User 87 | 88 | ### Example 89 | 90 | ```php 91 | setApiKey('Authorization', 'YOUR_API_KEY'); 97 | // Setup prefix (e.g. Bearer) for API key, if needed 98 | $config = PandaDoc\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'API-Key'); 99 | 100 | // Configure OAuth2 access token for authorization: oauth2 101 | // $config = PandaDoc\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); 102 | 103 | 104 | $apiInstance = new PandaDoc\Client\Api\UserAndWorkspaceManagementApi( 105 | // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. 106 | // This is optional, `GuzzleHttp\Client` will be used as default. 107 | new GuzzleHttp\Client(), 108 | $config 109 | ); 110 | $createUserRequest = new \PandaDoc\Client\Model\CreateUserRequest(); // \PandaDoc\Client\Model\CreateUserRequest 111 | $notifyUser = True; // bool | Send a confirmation email to the user that was added to workspace(s). 112 | $notifyWsAdmins = True; // bool | Send a confirmation email to all workspace admins indicating that the user has been added to the workspace. 113 | 114 | try { 115 | $result = $apiInstance->createUser($createUserRequest, $notifyUser, $notifyWsAdmins); 116 | print_r($result); 117 | } catch (Exception $e) { 118 | echo 'Exception when calling UserAndWorkspaceManagementApi->createUser: ', $e->getMessage(), PHP_EOL; 119 | } 120 | ``` 121 | 122 | ### Parameters 123 | 124 | Name | Type | Description | Notes 125 | ------------- | ------------- | ------------- | ------------- 126 | **createUserRequest** | [**\PandaDoc\Client\Model\CreateUserRequest**](../Model/CreateUserRequest.md)| | 127 | **notifyUser** | **bool**| Send a confirmation email to the user that was added to workspace(s). | [optional] 128 | **notifyWsAdmins** | **bool**| Send a confirmation email to all workspace admins indicating that the user has been added to the workspace. | [optional] 129 | 130 | ### Return type 131 | 132 | [**\PandaDoc\Client\Model\CreateUserResponse**](../Model/CreateUserResponse.md) 133 | 134 | ### Authorization 135 | 136 | [apiKey](../../README.md#apiKey), [oauth2](../../README.md#oauth2) 137 | 138 | ### HTTP request headers 139 | 140 | - **Content-Type**: `application/json` 141 | - **Accept**: `application/json` 142 | 143 | [[Back to top]](#) [[Back to API list]](../../README.md#endpoints) 144 | [[Back to README]](../../README.md) 145 | 146 | ## `createWorkspace()` 147 | 148 | ```php 149 | createWorkspace($createWorkspaceRequest): \PandaDoc\Client\Model\CreateWorkspaceResponse 150 | ``` 151 | 152 | Create Workspace 153 | 154 | ### Example 155 | 156 | ```php 157 | setApiKey('Authorization', 'YOUR_API_KEY'); 163 | // Setup prefix (e.g. Bearer) for API key, if needed 164 | $config = PandaDoc\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'API-Key'); 165 | 166 | // Configure OAuth2 access token for authorization: oauth2 167 | // $config = PandaDoc\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); 168 | 169 | 170 | $apiInstance = new PandaDoc\Client\Api\UserAndWorkspaceManagementApi( 171 | // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. 172 | // This is optional, `GuzzleHttp\Client` will be used as default. 173 | new GuzzleHttp\Client(), 174 | $config 175 | ); 176 | $createWorkspaceRequest = new \PandaDoc\Client\Model\CreateWorkspaceRequest(); // \PandaDoc\Client\Model\CreateWorkspaceRequest 177 | 178 | try { 179 | $result = $apiInstance->createWorkspace($createWorkspaceRequest); 180 | print_r($result); 181 | } catch (Exception $e) { 182 | echo 'Exception when calling UserAndWorkspaceManagementApi->createWorkspace: ', $e->getMessage(), PHP_EOL; 183 | } 184 | ``` 185 | 186 | ### Parameters 187 | 188 | Name | Type | Description | Notes 189 | ------------- | ------------- | ------------- | ------------- 190 | **createWorkspaceRequest** | [**\PandaDoc\Client\Model\CreateWorkspaceRequest**](../Model/CreateWorkspaceRequest.md)| | 191 | 192 | ### Return type 193 | 194 | [**\PandaDoc\Client\Model\CreateWorkspaceResponse**](../Model/CreateWorkspaceResponse.md) 195 | 196 | ### Authorization 197 | 198 | [apiKey](../../README.md#apiKey), [oauth2](../../README.md#oauth2) 199 | 200 | ### HTTP request headers 201 | 202 | - **Content-Type**: `application/json` 203 | - **Accept**: `application/json` 204 | 205 | [[Back to top]](#) [[Back to API list]](../../README.md#endpoints) 206 | [[Back to README]](../../README.md) 207 | -------------------------------------------------------------------------------- /docs/Api/TemplatesApi.md: -------------------------------------------------------------------------------- 1 | # PandaDoc\Client\TemplatesApi 2 | 3 | All URIs are relative to https://api.pandadoc.com. 4 | 5 | Method | HTTP request | Description 6 | ------------- | ------------- | ------------- 7 | [**deleteTemplate()**](TemplatesApi.md#deleteTemplate) | **DELETE** /public/v1/templates/{id} | Delete Template 8 | [**detailsTemplate()**](TemplatesApi.md#detailsTemplate) | **GET** /public/v1/templates/{id}/details | Details Template 9 | [**listTemplates()**](TemplatesApi.md#listTemplates) | **GET** /public/v1/templates | List Templates 10 | 11 | 12 | ## `deleteTemplate()` 13 | 14 | ```php 15 | deleteTemplate($id) 16 | ``` 17 | 18 | Delete Template 19 | 20 | Delete a template 21 | 22 | ### Example 23 | 24 | ```php 25 | setApiKey('Authorization', 'YOUR_API_KEY'); 31 | // Setup prefix (e.g. Bearer) for API key, if needed 32 | $config = PandaDoc\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'API-Key'); 33 | 34 | // Configure OAuth2 access token for authorization: oauth2 35 | // $config = PandaDoc\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); 36 | 37 | 38 | $apiInstance = new PandaDoc\Client\Api\TemplatesApi( 39 | // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. 40 | // This is optional, `GuzzleHttp\Client` will be used as default. 41 | new GuzzleHttp\Client(), 42 | $config 43 | ); 44 | $id = EE8yUNg5HztqVAuH85He8V; // string | Template ID 45 | 46 | try { 47 | $apiInstance->deleteTemplate($id); 48 | } catch (Exception $e) { 49 | echo 'Exception when calling TemplatesApi->deleteTemplate: ', $e->getMessage(), PHP_EOL; 50 | } 51 | ``` 52 | 53 | ### Parameters 54 | 55 | Name | Type | Description | Notes 56 | ------------- | ------------- | ------------- | ------------- 57 | **id** | **string**| Template ID | 58 | 59 | ### Return type 60 | 61 | void (empty response body) 62 | 63 | ### Authorization 64 | 65 | [apiKey](../../README.md#apiKey), [oauth2](../../README.md#oauth2) 66 | 67 | ### HTTP request headers 68 | 69 | - **Content-Type**: Not defined 70 | - **Accept**: `application/json` 71 | 72 | [[Back to top]](#) [[Back to API list]](../../README.md#endpoints) 73 | [[Back to README]](../../README.md) 74 | 75 | ## `detailsTemplate()` 76 | 77 | ```php 78 | detailsTemplate($id): \PandaDoc\Client\Model\TemplateDetailsResponse 79 | ``` 80 | 81 | Details Template 82 | 83 | Return detailed data about a template. 84 | 85 | ### Example 86 | 87 | ```php 88 | setApiKey('Authorization', 'YOUR_API_KEY'); 94 | // Setup prefix (e.g. Bearer) for API key, if needed 95 | $config = PandaDoc\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'API-Key'); 96 | 97 | // Configure OAuth2 access token for authorization: oauth2 98 | // $config = PandaDoc\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); 99 | 100 | 101 | $apiInstance = new PandaDoc\Client\Api\TemplatesApi( 102 | // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. 103 | // This is optional, `GuzzleHttp\Client` will be used as default. 104 | new GuzzleHttp\Client(), 105 | $config 106 | ); 107 | $id = EE8yUNg5HztqVAuH85He8V; // string | Template ID 108 | 109 | try { 110 | $result = $apiInstance->detailsTemplate($id); 111 | print_r($result); 112 | } catch (Exception $e) { 113 | echo 'Exception when calling TemplatesApi->detailsTemplate: ', $e->getMessage(), PHP_EOL; 114 | } 115 | ``` 116 | 117 | ### Parameters 118 | 119 | Name | Type | Description | Notes 120 | ------------- | ------------- | ------------- | ------------- 121 | **id** | **string**| Template ID | 122 | 123 | ### Return type 124 | 125 | [**\PandaDoc\Client\Model\TemplateDetailsResponse**](../Model/TemplateDetailsResponse.md) 126 | 127 | ### Authorization 128 | 129 | [apiKey](../../README.md#apiKey), [oauth2](../../README.md#oauth2) 130 | 131 | ### HTTP request headers 132 | 133 | - **Content-Type**: Not defined 134 | - **Accept**: `application/json` 135 | 136 | [[Back to top]](#) [[Back to API list]](../../README.md#endpoints) 137 | [[Back to README]](../../README.md) 138 | 139 | ## `listTemplates()` 140 | 141 | ```php 142 | listTemplates($q, $shared, $deleted, $count, $page, $id, $folderUuid, $tag, $fields): \PandaDoc\Client\Model\TemplateListResponse 143 | ``` 144 | 145 | List Templates 146 | 147 | Optionally, filter by a search query or tags. 148 | 149 | ### Example 150 | 151 | ```php 152 | setApiKey('Authorization', 'YOUR_API_KEY'); 158 | // Setup prefix (e.g. Bearer) for API key, if needed 159 | $config = PandaDoc\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'API-Key'); 160 | 161 | // Configure OAuth2 access token for authorization: oauth2 162 | // $config = PandaDoc\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); 163 | 164 | 165 | $apiInstance = new PandaDoc\Client\Api\TemplatesApi( 166 | // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. 167 | // This is optional, `GuzzleHttp\Client` will be used as default. 168 | new GuzzleHttp\Client(), 169 | $config 170 | ); 171 | $q = Sample onboarding template; // string | Optional search query. Filter by template name. 172 | $shared = True; // bool | Returns only the shared templates. 173 | $deleted = True; // bool | Optional. Returns only the deleted templates. 174 | $count = 10; // int | Optionally, specify how many templates to return. Default is 50 templates, maximum is 100 templates. 175 | $page = 56; // int | Optionally, specify which page of the dataset to return. 176 | $id = e9LxBesSL73AeZMzeYdfvV; // string | Optionally, specify template ID. 177 | $folderUuid = xDKHoJ8DkwhiTQSUzNveCJ; // string | UUID of the folder where the templates are stored. 178 | $tag = array('tag_example'); // string[] | Optional search tag. Filter by template tag. 179 | $fields = 'fields_example'; // string | A comma-separated list of additional fields to include in the response. Each field must be a valid template property. Currently, only one additional field, `content_date_modified`, is supported. For example, `GET /templates?fields=content_date_modified`. 180 | 181 | try { 182 | $result = $apiInstance->listTemplates($q, $shared, $deleted, $count, $page, $id, $folderUuid, $tag, $fields); 183 | print_r($result); 184 | } catch (Exception $e) { 185 | echo 'Exception when calling TemplatesApi->listTemplates: ', $e->getMessage(), PHP_EOL; 186 | } 187 | ``` 188 | 189 | ### Parameters 190 | 191 | Name | Type | Description | Notes 192 | ------------- | ------------- | ------------- | ------------- 193 | **q** | **string**| Optional search query. Filter by template name. | [optional] 194 | **shared** | **bool**| Returns only the shared templates. | [optional] 195 | **deleted** | **bool**| Optional. Returns only the deleted templates. | [optional] 196 | **count** | **int**| Optionally, specify how many templates to return. Default is 50 templates, maximum is 100 templates. | [optional] 197 | **page** | **int**| Optionally, specify which page of the dataset to return. | [optional] 198 | **id** | **string**| Optionally, specify template ID. | [optional] 199 | **folderUuid** | **string**| UUID of the folder where the templates are stored. | [optional] 200 | **tag** | [**string[]**](../Model/string.md)| Optional search tag. Filter by template tag. | [optional] 201 | **fields** | **string**| A comma-separated list of additional fields to include in the response. Each field must be a valid template property. Currently, only one additional field, `content_date_modified`, is supported. For example, `GET /templates?fields=content_date_modified`. | [optional] 202 | 203 | ### Return type 204 | 205 | [**\PandaDoc\Client\Model\TemplateListResponse**](../Model/TemplateListResponse.md) 206 | 207 | ### Authorization 208 | 209 | [apiKey](../../README.md#apiKey), [oauth2](../../README.md#oauth2) 210 | 211 | ### HTTP request headers 212 | 213 | - **Content-Type**: Not defined 214 | - **Accept**: `application/json` 215 | 216 | [[Back to top]](#) [[Back to API list]](../../README.md#endpoints) 217 | [[Back to README]](../../README.md) 218 | --------------------------------------------------------------------------------