├── .github
└── workflows
│ ├── publish.yml
│ ├── sync.yml
│ └── test.yml
├── .gitignore
├── .prettierrc.json
├── LICENSE
├── README.md
├── package.json
├── src
├── Apideck.ts
├── gen
│ ├── .openapi-generator-ignore
│ ├── .openapi-generator
│ │ ├── FILES
│ │ └── VERSION
│ ├── apis
│ │ ├── AccountingApi.ts
│ │ ├── AtsApi.ts
│ │ ├── ConnectorApi.ts
│ │ ├── CrmApi.ts
│ │ ├── EcommerceApi.ts
│ │ ├── FileStorageApi.ts
│ │ ├── HrisApi.ts
│ │ ├── IssueTrackingApi.ts
│ │ ├── LeadApi.ts
│ │ ├── PosApi.ts
│ │ ├── SmsApi.ts
│ │ ├── VaultApi.ts
│ │ ├── WebhookApi.ts
│ │ └── index.ts
│ ├── docs
│ │ ├── apis
│ │ │ ├── AccountingApi.md
│ │ │ ├── Api.md
│ │ │ ├── AtsApi.md
│ │ │ ├── ConnectorApi.md
│ │ │ ├── CrmApi.md
│ │ │ ├── EcommerceApi.md
│ │ │ ├── FileStorageApi.md
│ │ │ ├── HrisApi.md
│ │ │ ├── IssueTrackingApi.md
│ │ │ ├── LeadApi.md
│ │ │ ├── PosApi.md
│ │ │ ├── SmsApi.md
│ │ │ ├── VaultApi.md
│ │ │ └── WebhookApi.md
│ │ └── models
│ │ │ ├── AccountingDepartment.md
│ │ │ ├── AccountingDepartmentsFilter.md
│ │ │ ├── AccountingEventType.md
│ │ │ ├── AccountingLocation.md
│ │ │ ├── AccountingLocationsFilter.md
│ │ │ ├── ActivitiesFilter.md
│ │ │ ├── ActivitiesSort.md
│ │ │ ├── Activity.md
│ │ │ ├── ActivityAttendee.md
│ │ │ ├── Address.md
│ │ │ ├── AgedCreditors.md
│ │ │ ├── AgedDebtors.md
│ │ │ ├── AgedReportFilter.md
│ │ │ ├── Allocation.md
│ │ │ ├── ApiResource.md
│ │ │ ├── ApiResourceCoverage.md
│ │ │ ├── ApiResourceCoverageCoverage.md
│ │ │ ├── ApiResourceLinkedResources.md
│ │ │ ├── ApiResources.md
│ │ │ ├── ApiStatus.md
│ │ │ ├── ApisFilter.md
│ │ │ ├── Applicant.md
│ │ │ ├── ApplicantSocialLinks.md
│ │ │ ├── ApplicantWebsites.md
│ │ │ ├── ApplicantsFilter.md
│ │ │ ├── Application.md
│ │ │ ├── ApplicationStage.md
│ │ │ ├── Assignee.md
│ │ │ ├── AtsActivity.md
│ │ │ ├── AtsEventType.md
│ │ │ ├── Attachment.md
│ │ │ ├── AttachmentReference.md
│ │ │ ├── AttachmentReferenceType.md
│ │ │ ├── AuthType.md
│ │ │ ├── BadRequestResponse.md
│ │ │ ├── BalanceByPeriod.md
│ │ │ ├── BalanceByTransaction.md
│ │ │ ├── BalanceSheet.md
│ │ │ ├── BalanceSheetAccount.md
│ │ │ ├── BalanceSheetAccountRecord.md
│ │ │ ├── BalanceSheetAccounts.md
│ │ │ ├── BalanceSheetAssetsAccount.md
│ │ │ ├── BalanceSheetEquityAccount.md
│ │ │ ├── BalanceSheetFilter.md
│ │ │ ├── BalanceSheetLiabilitiesAccount.md
│ │ │ ├── BalanceSheetReports.md
│ │ │ ├── BalanceSheetUncategorizedItemsAccount.md
│ │ │ ├── BankAccount.md
│ │ │ ├── Benefit.md
│ │ │ ├── Bill.md
│ │ │ ├── BillLineItem.md
│ │ │ ├── BillPayment.md
│ │ │ ├── BillPaymentAllocations.md
│ │ │ ├── BillsFilter.md
│ │ │ ├── BillsSort.md
│ │ │ ├── Branch.md
│ │ │ ├── CashDetails.md
│ │ │ ├── Collection.md
│ │ │ ├── CollectionTag.md
│ │ │ ├── CollectionTicketComment.md
│ │ │ ├── CollectionUser.md
│ │ │ ├── CollectionsSort.md
│ │ │ ├── CommentsSort.md
│ │ │ ├── CompaniesFilter.md
│ │ │ ├── CompaniesSort.md
│ │ │ ├── Company.md
│ │ │ ├── CompanyInfo.md
│ │ │ ├── CompanyRowType.md
│ │ │ ├── Compensation.md
│ │ │ ├── Connection.md
│ │ │ ├── ConnectionConfiguration.md
│ │ │ ├── ConnectionDefaults.md
│ │ │ ├── ConnectionImportData.md
│ │ │ ├── ConnectionImportDataCredentials.md
│ │ │ ├── ConnectionMetadata.md
│ │ │ ├── ConnectionState.md
│ │ │ ├── ConnectionWebhook.md
│ │ │ ├── Connector.md
│ │ │ ├── ConnectorDoc.md
│ │ │ ├── ConnectorEvent.md
│ │ │ ├── ConnectorOauthScopes.md
│ │ │ ├── ConnectorOauthScopes1.md
│ │ │ ├── ConnectorResource.md
│ │ │ ├── ConnectorSetting.md
│ │ │ ├── ConnectorStatus.md
│ │ │ ├── ConnectorTlsSupport.md
│ │ │ ├── ConnectorUnifiedApis.md
│ │ │ ├── ConnectorsFilter.md
│ │ │ ├── Consumer.md
│ │ │ ├── ConsumerConnection.md
│ │ │ ├── ConsumerMetadata.md
│ │ │ ├── ConsumerRequestCountsInDateRangeResponse.md
│ │ │ ├── ConsumerRequestCountsInDateRangeResponseData.md
│ │ │ ├── Contact.md
│ │ │ ├── ContactsFilter.md
│ │ │ ├── ContactsSort.md
│ │ │ ├── CopyFolderRequest.md
│ │ │ ├── CostOfGoodsSold.md
│ │ │ ├── CreateAccountingDepartmentResponse.md
│ │ │ ├── CreateAccountingLocationResponse.md
│ │ │ ├── CreateActivityResponse.md
│ │ │ ├── CreateApplicantResponse.md
│ │ │ ├── CreateApplicationResponse.md
│ │ │ ├── CreateAttachmentRequest.md
│ │ │ ├── CreateAttachmentResponse.md
│ │ │ ├── CreateBillPaymentResponse.md
│ │ │ ├── CreateBillResponse.md
│ │ │ ├── CreateCallbackState.md
│ │ │ ├── CreateCallbackStateResponse.md
│ │ │ ├── CreateCallbackStateResponseData.md
│ │ │ ├── CreateCommentResponse.md
│ │ │ ├── CreateCompanyResponse.md
│ │ │ ├── CreateConnectionResponse.md
│ │ │ ├── CreateConsumerResponse.md
│ │ │ ├── CreateContactResponse.md
│ │ │ ├── CreateCreditNoteResponse.md
│ │ │ ├── CreateCustomMappingRequest.md
│ │ │ ├── CreateCustomMappingResponse.md
│ │ │ ├── CreateCustomerResponse.md
│ │ │ ├── CreateDepartmentResponse.md
│ │ │ ├── CreateDriveGroupResponse.md
│ │ │ ├── CreateDriveResponse.md
│ │ │ ├── CreateEcommerceCustomerResponse.md
│ │ │ ├── CreateEcommerceOrderResponse.md
│ │ │ ├── CreateEmployeeResponse.md
│ │ │ ├── CreateExpenseResponse.md
│ │ │ ├── CreateFileRequest.md
│ │ │ ├── CreateFileResponse.md
│ │ │ ├── CreateFolderRequest.md
│ │ │ ├── CreateFolderResponse.md
│ │ │ ├── CreateHrisCompanyResponse.md
│ │ │ ├── CreateInvoiceItemResponse.md
│ │ │ ├── CreateInvoiceResponse.md
│ │ │ ├── CreateItemResponse.md
│ │ │ ├── CreateJobResponse.md
│ │ │ ├── CreateJournalEntryResponse.md
│ │ │ ├── CreateLeadResponse.md
│ │ │ ├── CreateLedgerAccountResponse.md
│ │ │ ├── CreateLocationResponse.md
│ │ │ ├── CreateMerchantResponse.md
│ │ │ ├── CreateMessageResponse.md
│ │ │ ├── CreateModifierGroupResponse.md
│ │ │ ├── CreateModifierResponse.md
│ │ │ ├── CreateNoteResponse.md
│ │ │ ├── CreateOpportunityResponse.md
│ │ │ ├── CreateOrderResponse.md
│ │ │ ├── CreateOrderTypeResponse.md
│ │ │ ├── CreatePaymentResponse.md
│ │ │ ├── CreatePipelineResponse.md
│ │ │ ├── CreatePosPaymentResponse.md
│ │ │ ├── CreateProductResponse.md
│ │ │ ├── CreatePurchaseOrderResponse.md
│ │ │ ├── CreateSessionResponse.md
│ │ │ ├── CreateSessionResponseData.md
│ │ │ ├── CreateSharedLinkResponse.md
│ │ │ ├── CreateSubsidiaryResponse.md
│ │ │ ├── CreateSupplierResponse.md
│ │ │ ├── CreateTaxRateResponse.md
│ │ │ ├── CreateTenderResponse.md
│ │ │ ├── CreateTicketResponse.md
│ │ │ ├── CreateTimeOffRequestResponse.md
│ │ │ ├── CreateTrackingCategoryResponse.md
│ │ │ ├── CreateUploadSessionRequest.md
│ │ │ ├── CreateUploadSessionResponse.md
│ │ │ ├── CreateUserResponse.md
│ │ │ ├── CreateWebhookRequest.md
│ │ │ ├── CreateWebhookResponse.md
│ │ │ ├── CreditNote.md
│ │ │ ├── CreditNotesFilter.md
│ │ │ ├── CreditNotesSort.md
│ │ │ ├── CrmEventType.md
│ │ │ ├── Currency.md
│ │ │ ├── CustomField.md
│ │ │ ├── CustomFieldFinder.md
│ │ │ ├── CustomMapping.md
│ │ │ ├── Customer.md
│ │ │ ├── CustomersFilter.md
│ │ │ ├── CustomersSort.md
│ │ │ ├── Deduction.md
│ │ │ ├── DeleteAccountingDepartmentResponse.md
│ │ │ ├── DeleteAccountingLocationResponse.md
│ │ │ ├── DeleteActivityResponse.md
│ │ │ ├── DeleteApplicantResponse.md
│ │ │ ├── DeleteApplicationResponse.md
│ │ │ ├── DeleteAttachmentResponse.md
│ │ │ ├── DeleteBillPaymentResponse.md
│ │ │ ├── DeleteBillResponse.md
│ │ │ ├── DeleteCommentResponse.md
│ │ │ ├── DeleteCompanyResponse.md
│ │ │ ├── DeleteConsumerResponse.md
│ │ │ ├── DeleteContactResponse.md
│ │ │ ├── DeleteCreditNoteResponse.md
│ │ │ ├── DeleteCustomerResponse.md
│ │ │ ├── DeleteDepartmentResponse.md
│ │ │ ├── DeleteDriveGroupResponse.md
│ │ │ ├── DeleteDriveResponse.md
│ │ │ ├── DeleteEcommerceCustomerResponse.md
│ │ │ ├── DeleteEcommerceOrderResponse.md
│ │ │ ├── DeleteEmployeeResponse.md
│ │ │ ├── DeleteExpenseResponse.md
│ │ │ ├── DeleteFileResponse.md
│ │ │ ├── DeleteFolderResponse.md
│ │ │ ├── DeleteHrisCompanyResponse.md
│ │ │ ├── DeleteInvoiceResponse.md
│ │ │ ├── DeleteItemResponse.md
│ │ │ ├── DeleteJobResponse.md
│ │ │ ├── DeleteJournalEntryResponse.md
│ │ │ ├── DeleteLeadResponse.md
│ │ │ ├── DeleteLedgerAccountResponse.md
│ │ │ ├── DeleteLocationResponse.md
│ │ │ ├── DeleteMerchantResponse.md
│ │ │ ├── DeleteMessageResponse.md
│ │ │ ├── DeleteModifierGroupResponse.md
│ │ │ ├── DeleteModifierResponse.md
│ │ │ ├── DeleteNoteResponse.md
│ │ │ ├── DeleteOpportunityResponse.md
│ │ │ ├── DeleteOrderResponse.md
│ │ │ ├── DeleteOrderTypeResponse.md
│ │ │ ├── DeletePaymentResponse.md
│ │ │ ├── DeletePipelineResponse.md
│ │ │ ├── DeletePosPaymentResponse.md
│ │ │ ├── DeleteProductResponse.md
│ │ │ ├── DeletePurchaseOrderResponse.md
│ │ │ ├── DeleteSharedLinkResponse.md
│ │ │ ├── DeleteSubsidiaryResponse.md
│ │ │ ├── DeleteSupplierResponse.md
│ │ │ ├── DeleteTaxRateResponse.md
│ │ │ ├── DeleteTenderResponse.md
│ │ │ ├── DeleteTicketResponse.md
│ │ │ ├── DeleteTimeOffRequestResponse.md
│ │ │ ├── DeleteTrackingCategoryResponse.md
│ │ │ ├── DeleteUploadSessionResponse.md
│ │ │ ├── DeleteUserResponse.md
│ │ │ ├── DeleteWebhookResponse.md
│ │ │ ├── Department.md
│ │ │ ├── DeprecatedLinkedSupplier.md
│ │ │ ├── DeprecatedLinkedTrackingCategory.md
│ │ │ ├── Drive.md
│ │ │ ├── DriveGroup.md
│ │ │ ├── DriveGroupsFilter.md
│ │ │ ├── DrivesFilter.md
│ │ │ ├── EcommerceAddress.md
│ │ │ ├── EcommerceCustomer.md
│ │ │ ├── EcommerceCustomerAddresses.md
│ │ │ ├── EcommerceCustomersFilter.md
│ │ │ ├── EcommerceDiscount.md
│ │ │ ├── EcommerceEventType.md
│ │ │ ├── EcommerceOrder.md
│ │ │ ├── EcommerceOrderLineItem.md
│ │ │ ├── EcommerceOrderStatus.md
│ │ │ ├── EcommerceOrdersFilter.md
│ │ │ ├── EcommerceProduct.md
│ │ │ ├── EcommerceProductCategories.md
│ │ │ ├── EcommerceProductImages.md
│ │ │ ├── EcommerceProductImages1.md
│ │ │ ├── EcommerceProductOptions.md
│ │ │ ├── EcommerceProductOptions1.md
│ │ │ ├── EcommerceProductVariants.md
│ │ │ ├── EcommerceStore.md
│ │ │ ├── Email.md
│ │ │ ├── Employee.md
│ │ │ ├── EmployeeCompensation.md
│ │ │ ├── EmployeeEmploymentRole.md
│ │ │ ├── EmployeeJob.md
│ │ │ ├── EmployeeList.md
│ │ │ ├── EmployeeManager.md
│ │ │ ├── EmployeePayroll.md
│ │ │ ├── EmployeeSchedules.md
│ │ │ ├── EmployeesFilter.md
│ │ │ ├── EmployeesOneFilter.md
│ │ │ ├── EmployeesSort.md
│ │ │ ├── EmploymentStatus.md
│ │ │ ├── Error.md
│ │ │ ├── ExecuteWebhookEventRequest.md
│ │ │ ├── ExecuteWebhookEventsRequest.md
│ │ │ ├── ExecuteWebhookResponse.md
│ │ │ ├── Expense.md
│ │ │ ├── ExpenseLineItem.md
│ │ │ ├── Expenses.md
│ │ │ ├── FileStorageEventType.md
│ │ │ ├── FileType.md
│ │ │ ├── FilesFilter.md
│ │ │ ├── FilesSearch.md
│ │ │ ├── FilesSort.md
│ │ │ ├── Folder.md
│ │ │ ├── FormField.md
│ │ │ ├── FormFieldOption.md
│ │ │ ├── FormFieldOptionGroup.md
│ │ │ ├── Gender.md
│ │ │ ├── GetAccountingDepartmentResponse.md
│ │ │ ├── GetAccountingDepartmentsResponse.md
│ │ │ ├── GetAccountingLocationResponse.md
│ │ │ ├── GetAccountingLocationsResponse.md
│ │ │ ├── GetActivitiesResponse.md
│ │ │ ├── GetActivityResponse.md
│ │ │ ├── GetAgedCreditorsResponse.md
│ │ │ ├── GetAgedDebtorsResponse.md
│ │ │ ├── GetApiResourceCoverageResponse.md
│ │ │ ├── GetApiResourceResponse.md
│ │ │ ├── GetApiResponse.md
│ │ │ ├── GetApisResponse.md
│ │ │ ├── GetApplicantResponse.md
│ │ │ ├── GetApplicantsResponse.md
│ │ │ ├── GetApplicationResponse.md
│ │ │ ├── GetApplicationsResponse.md
│ │ │ ├── GetAttachmentResponse.md
│ │ │ ├── GetAttachmentsResponse.md
│ │ │ ├── GetBalanceSheetResponse.md
│ │ │ ├── GetBillPaymentResponse.md
│ │ │ ├── GetBillPaymentsResponse.md
│ │ │ ├── GetBillResponse.md
│ │ │ ├── GetBillsResponse.md
│ │ │ ├── GetCollectionResponse.md
│ │ │ ├── GetCollectionTagsResponse.md
│ │ │ ├── GetCollectionUserResponse.md
│ │ │ ├── GetCollectionUsersResponse.md
│ │ │ ├── GetCollectionsResponse.md
│ │ │ ├── GetCommentResponse.md
│ │ │ ├── GetCommentsResponse.md
│ │ │ ├── GetCompaniesResponse.md
│ │ │ ├── GetCompanyInfoResponse.md
│ │ │ ├── GetCompanyResponse.md
│ │ │ ├── GetConnectionResponse.md
│ │ │ ├── GetConnectionsResponse.md
│ │ │ ├── GetConnectorResourceExampleResponse.md
│ │ │ ├── GetConnectorResourceExampleResponseData.md
│ │ │ ├── GetConnectorResourceResponse.md
│ │ │ ├── GetConnectorResourceSchemaResponse.md
│ │ │ ├── GetConnectorResponse.md
│ │ │ ├── GetConnectorsResponse.md
│ │ │ ├── GetConsumerResponse.md
│ │ │ ├── GetConsumersResponse.md
│ │ │ ├── GetConsumersResponseData.md
│ │ │ ├── GetContactResponse.md
│ │ │ ├── GetContactsResponse.md
│ │ │ ├── GetCreditNoteResponse.md
│ │ │ ├── GetCreditNotesResponse.md
│ │ │ ├── GetCustomFieldsResponse.md
│ │ │ ├── GetCustomMappingResponse.md
│ │ │ ├── GetCustomMappingsResponse.md
│ │ │ ├── GetCustomerResponse.md
│ │ │ ├── GetCustomersResponse.md
│ │ │ ├── GetDepartmentResponse.md
│ │ │ ├── GetDepartmentsResponse.md
│ │ │ ├── GetDriveGroupResponse.md
│ │ │ ├── GetDriveGroupsResponse.md
│ │ │ ├── GetDriveResponse.md
│ │ │ ├── GetDrivesResponse.md
│ │ │ ├── GetEcommerceCustomerResponse.md
│ │ │ ├── GetEcommerceCustomersResponse.md
│ │ │ ├── GetEcommerceOrderResponse.md
│ │ │ ├── GetEcommerceOrdersResponse.md
│ │ │ ├── GetEmployeePayrollResponse.md
│ │ │ ├── GetEmployeePayrollsResponse.md
│ │ │ ├── GetEmployeeResponse.md
│ │ │ ├── GetEmployeeSchedulesResponse.md
│ │ │ ├── GetEmployeesResponse.md
│ │ │ ├── GetExpenseResponse.md
│ │ │ ├── GetExpensesResponse.md
│ │ │ ├── GetFileResponse.md
│ │ │ ├── GetFilesResponse.md
│ │ │ ├── GetFolderResponse.md
│ │ │ ├── GetFoldersResponse.md
│ │ │ ├── GetHrisCompaniesResponse.md
│ │ │ ├── GetHrisCompanyResponse.md
│ │ │ ├── GetHrisJobResponse.md
│ │ │ ├── GetHrisJobsResponse.md
│ │ │ ├── GetInvoiceItemResponse.md
│ │ │ ├── GetInvoiceItemsResponse.md
│ │ │ ├── GetInvoiceResponse.md
│ │ │ ├── GetInvoicesResponse.md
│ │ │ ├── GetItemResponse.md
│ │ │ ├── GetItemsResponse.md
│ │ │ ├── GetJobResponse.md
│ │ │ ├── GetJobsResponse.md
│ │ │ ├── GetJournalEntriesResponse.md
│ │ │ ├── GetJournalEntryResponse.md
│ │ │ ├── GetLeadResponse.md
│ │ │ ├── GetLeadsResponse.md
│ │ │ ├── GetLedgerAccountResponse.md
│ │ │ ├── GetLedgerAccountsResponse.md
│ │ │ ├── GetLocationResponse.md
│ │ │ ├── GetLocationsResponse.md
│ │ │ ├── GetLogsResponse.md
│ │ │ ├── GetMerchantResponse.md
│ │ │ ├── GetMerchantsResponse.md
│ │ │ ├── GetMessageResponse.md
│ │ │ ├── GetMessagesResponse.md
│ │ │ ├── GetModifierGroupResponse.md
│ │ │ ├── GetModifierGroupsResponse.md
│ │ │ ├── GetModifierResponse.md
│ │ │ ├── GetModifiersResponse.md
│ │ │ ├── GetNoteResponse.md
│ │ │ ├── GetNotesResponse.md
│ │ │ ├── GetOpportunitiesResponse.md
│ │ │ ├── GetOpportunityResponse.md
│ │ │ ├── GetOrderResponse.md
│ │ │ ├── GetOrderTypeResponse.md
│ │ │ ├── GetOrderTypesResponse.md
│ │ │ ├── GetOrdersResponse.md
│ │ │ ├── GetPaymentResponse.md
│ │ │ ├── GetPaymentsResponse.md
│ │ │ ├── GetPayrollResponse.md
│ │ │ ├── GetPayrollsResponse.md
│ │ │ ├── GetPipelineResponse.md
│ │ │ ├── GetPipelinesResponse.md
│ │ │ ├── GetPosPaymentResponse.md
│ │ │ ├── GetPosPaymentsResponse.md
│ │ │ ├── GetProductResponse.md
│ │ │ ├── GetProductsResponse.md
│ │ │ ├── GetProfitAndLossResponse.md
│ │ │ ├── GetPurchaseOrderResponse.md
│ │ │ ├── GetPurchaseOrdersResponse.md
│ │ │ ├── GetResourceExampleResponse.md
│ │ │ ├── GetResourceSchemaResponse.md
│ │ │ ├── GetSharedLinkResponse.md
│ │ │ ├── GetSharedLinksResponse.md
│ │ │ ├── GetStoreResponse.md
│ │ │ ├── GetStoresResponse.md
│ │ │ ├── GetSubsidiariesResponse.md
│ │ │ ├── GetSubsidiaryResponse.md
│ │ │ ├── GetSupplierResponse.md
│ │ │ ├── GetSuppliersResponse.md
│ │ │ ├── GetTaxRateResponse.md
│ │ │ ├── GetTaxRatesResponse.md
│ │ │ ├── GetTenderResponse.md
│ │ │ ├── GetTendersResponse.md
│ │ │ ├── GetTicketResponse.md
│ │ │ ├── GetTicketsResponse.md
│ │ │ ├── GetTimeOffRequestResponse.md
│ │ │ ├── GetTimeOffRequestsResponse.md
│ │ │ ├── GetTrackingCategoriesResponse.md
│ │ │ ├── GetTrackingCategoryResponse.md
│ │ │ ├── GetUploadSessionResponse.md
│ │ │ ├── GetUserResponse.md
│ │ │ ├── GetUsersResponse.md
│ │ │ ├── GetWebhookEventLogsResponse.md
│ │ │ ├── GetWebhookResponse.md
│ │ │ ├── GetWebhooksResponse.md
│ │ │ ├── HrisCompany.md
│ │ │ ├── HrisEventType.md
│ │ │ ├── HrisJob.md
│ │ │ ├── HrisJobLocation.md
│ │ │ ├── HrisJobs.md
│ │ │ ├── Income.md
│ │ │ ├── IntegrationState.md
│ │ │ ├── Invoice.md
│ │ │ ├── InvoiceItem.md
│ │ │ ├── InvoiceItemFilter.md
│ │ │ ├── InvoiceItemSalesDetails.md
│ │ │ ├── InvoiceItemsFilter.md
│ │ │ ├── InvoiceItemsSort.md
│ │ │ ├── InvoiceLineItem.md
│ │ │ ├── InvoiceResponse.md
│ │ │ ├── InvoicesFilter.md
│ │ │ ├── InvoicesSort.md
│ │ │ ├── IssueTrackingEventType.md
│ │ │ ├── IssuesFilter.md
│ │ │ ├── Item.md
│ │ │ ├── Job.md
│ │ │ ├── JobLinks.md
│ │ │ ├── JobSalary.md
│ │ │ ├── JobStatus.md
│ │ │ ├── JournalEntriesFilter.md
│ │ │ ├── JournalEntriesSort.md
│ │ │ ├── JournalEntry.md
│ │ │ ├── JournalEntryLineItem.md
│ │ │ ├── Lead.md
│ │ │ ├── LeadEventType.md
│ │ │ ├── LeadsFilter.md
│ │ │ ├── LeadsSort.md
│ │ │ ├── LedgerAccount.md
│ │ │ ├── LedgerAccountCategories.md
│ │ │ ├── LedgerAccountParentAccount.md
│ │ │ ├── LedgerAccounts.md
│ │ │ ├── LedgerAccountsFilter.md
│ │ │ ├── LedgerAccountsSort.md
│ │ │ ├── LinkedConnectorResource.md
│ │ │ ├── LinkedCustomer.md
│ │ │ ├── LinkedEcommerceCustomer.md
│ │ │ ├── LinkedEcommerceOrder.md
│ │ │ ├── LinkedFolder.md
│ │ │ ├── LinkedInvoiceItem.md
│ │ │ ├── LinkedLedgerAccount.md
│ │ │ ├── LinkedParentCustomer.md
│ │ │ ├── LinkedSupplier.md
│ │ │ ├── LinkedTaxRate.md
│ │ │ ├── LinkedTrackingCategories.md
│ │ │ ├── LinkedTrackingCategory.md
│ │ │ ├── Links.md
│ │ │ ├── Location.md
│ │ │ ├── Log.md
│ │ │ ├── LogOperation.md
│ │ │ ├── LogService.md
│ │ │ ├── LogsFilter.md
│ │ │ ├── Merchant.md
│ │ │ ├── Message.md
│ │ │ ├── Meta.md
│ │ │ ├── MetaCursors.md
│ │ │ ├── Modifier.md
│ │ │ ├── ModifierGroup.md
│ │ │ ├── ModifierGroupFilter.md
│ │ │ ├── NotFoundResponse.md
│ │ │ ├── NotImplementedResponse.md
│ │ │ ├── Note.md
│ │ │ ├── OAuthGrantType.md
│ │ │ ├── Offer.md
│ │ │ ├── OpportunitiesFilter.md
│ │ │ ├── OpportunitiesSort.md
│ │ │ ├── Opportunity.md
│ │ │ ├── Order.md
│ │ │ ├── OrderCustomers.md
│ │ │ ├── OrderDiscounts.md
│ │ │ ├── OrderFulfillments.md
│ │ │ ├── OrderLineItems.md
│ │ │ ├── OrderPayments.md
│ │ │ ├── OrderPickupDetails.md
│ │ │ ├── OrderPickupDetailsCurbsidePickupDetails.md
│ │ │ ├── OrderPickupDetailsRecipient.md
│ │ │ ├── OrderRefunds.md
│ │ │ ├── OrderTenders.md
│ │ │ ├── OrderType.md
│ │ │ ├── OrdersSort.md
│ │ │ ├── OtherExpenses.md
│ │ │ ├── OtherIncome.md
│ │ │ ├── OutstandingBalanceByCurrency.md
│ │ │ ├── OutstandingBalanceByCustomer.md
│ │ │ ├── OutstandingBalanceBySupplier.md
│ │ │ ├── Owner.md
│ │ │ ├── PaginationCoverage.md
│ │ │ ├── PassThroughBody.md
│ │ │ ├── PassThroughQuery.md
│ │ │ ├── Payment.md
│ │ │ ├── PaymentCard.md
│ │ │ ├── PaymentFrequency.md
│ │ │ ├── PaymentRequiredResponse.md
│ │ │ ├── PaymentStatus.md
│ │ │ ├── PaymentType.md
│ │ │ ├── PaymentUnit.md
│ │ │ ├── PaymentsFilter.md
│ │ │ ├── PaymentsSort.md
│ │ │ ├── Payroll.md
│ │ │ ├── PayrollTotals.md
│ │ │ ├── PayrollsFilter.md
│ │ │ ├── Person.md
│ │ │ ├── PhoneNumber.md
│ │ │ ├── Pipeline.md
│ │ │ ├── PipelineStages.md
│ │ │ ├── PosBankAccount.md
│ │ │ ├── PosBankAccountAchDetails.md
│ │ │ ├── PosPayment.md
│ │ │ ├── PosPaymentCardDetails.md
│ │ │ ├── PosPaymentExternalDetails.md
│ │ │ ├── Price.md
│ │ │ ├── ProbationPeriod.md
│ │ │ ├── ProfitAndLoss.md
│ │ │ ├── ProfitAndLossFilter.md
│ │ │ ├── ProfitAndLossIndicator.md
│ │ │ ├── ProfitAndLossRecord.md
│ │ │ ├── ProfitAndLossRecords.md
│ │ │ ├── ProfitAndLossSection.md
│ │ │ ├── ProfitAndLossType.md
│ │ │ ├── PurchaseOrder.md
│ │ │ ├── PurchaseOrdersFilter.md
│ │ │ ├── PurchaseOrdersSort.md
│ │ │ ├── Raw.md
│ │ │ ├── RequestCountAllocation.md
│ │ │ ├── RequestRate.md
│ │ │ ├── ResolveWebhookEventRequest.md
│ │ │ ├── ResolveWebhookEventsRequest.md
│ │ │ ├── ResolveWebhookResponse.md
│ │ │ ├── ResourceExample.md
│ │ │ ├── ResourceStatus.md
│ │ │ ├── Schedule.md
│ │ │ ├── ScheduleWorkPattern.md
│ │ │ ├── ScheduleWorkPatternOddWeeks.md
│ │ │ ├── SchemaSupport.md
│ │ │ ├── ServiceCharge.md
│ │ │ ├── ServiceCharges.md
│ │ │ ├── Session.md
│ │ │ ├── SessionSettings.md
│ │ │ ├── SessionTheme.md
│ │ │ ├── SharedLink.md
│ │ │ ├── SharedLinkTarget.md
│ │ │ ├── SimpleFormFieldOption.md
│ │ │ ├── SocialLink.md
│ │ │ ├── SortDirection.md
│ │ │ ├── Status.md
│ │ │ ├── Subsidiary.md
│ │ │ ├── SubsidiaryReference.md
│ │ │ ├── Supplier.md
│ │ │ ├── SuppliersFilter.md
│ │ │ ├── SuppliersSort.md
│ │ │ ├── SupportedProperty.md
│ │ │ ├── Tags.md
│ │ │ ├── Tax.md
│ │ │ ├── TaxRate.md
│ │ │ ├── TaxRatesFilter.md
│ │ │ ├── Team.md
│ │ │ ├── Tender.md
│ │ │ ├── Ticket.md
│ │ │ ├── TicketsSort.md
│ │ │ ├── TimeOffRequest.md
│ │ │ ├── TimeOffRequestNotes.md
│ │ │ ├── TimeOffRequestsFilter.md
│ │ │ ├── TooManyRequestsResponse.md
│ │ │ ├── TooManyRequestsResponseDetail.md
│ │ │ ├── TrackingCategory.md
│ │ │ ├── TrackingItem.md
│ │ │ ├── UnauthorizedResponse.md
│ │ │ ├── UncategorizedAccounts.md
│ │ │ ├── UnexpectedErrorResponse.md
│ │ │ ├── UnifiedApiId.md
│ │ │ ├── UnifiedFile.md
│ │ │ ├── UnifiedFilePermissions.md
│ │ │ ├── UnifiedId.md
│ │ │ ├── UnprocessableResponse.md
│ │ │ ├── UpdateAccountingDepartmentResponse.md
│ │ │ ├── UpdateAccountingLocationResponse.md
│ │ │ ├── UpdateActivityResponse.md
│ │ │ ├── UpdateApplicantResponse.md
│ │ │ ├── UpdateApplicationResponse.md
│ │ │ ├── UpdateBillPaymentResponse.md
│ │ │ ├── UpdateBillResponse.md
│ │ │ ├── UpdateCommentResponse.md
│ │ │ ├── UpdateCompanyResponse.md
│ │ │ ├── UpdateConnectionResponse.md
│ │ │ ├── UpdateConsumerRequest.md
│ │ │ ├── UpdateConsumerResponse.md
│ │ │ ├── UpdateContactResponse.md
│ │ │ ├── UpdateCreditNoteResponse.md
│ │ │ ├── UpdateCustomMappingRequest.md
│ │ │ ├── UpdateCustomMappingResponse.md
│ │ │ ├── UpdateCustomerResponse.md
│ │ │ ├── UpdateDepartmentResponse.md
│ │ │ ├── UpdateDriveGroupResponse.md
│ │ │ ├── UpdateDriveResponse.md
│ │ │ ├── UpdateEcommerceCustomerResponse.md
│ │ │ ├── UpdateEcommerceOrderResponse.md
│ │ │ ├── UpdateEmployeeResponse.md
│ │ │ ├── UpdateExpenseResponse.md
│ │ │ ├── UpdateFileRequest.md
│ │ │ ├── UpdateFileResponse.md
│ │ │ ├── UpdateFolderRequest.md
│ │ │ ├── UpdateFolderResponse.md
│ │ │ ├── UpdateHrisCompanyResponse.md
│ │ │ ├── UpdateInvoiceItemsResponse.md
│ │ │ ├── UpdateInvoiceResponse.md
│ │ │ ├── UpdateItemResponse.md
│ │ │ ├── UpdateJobResponse.md
│ │ │ ├── UpdateJournalEntryResponse.md
│ │ │ ├── UpdateLeadResponse.md
│ │ │ ├── UpdateLedgerAccountResponse.md
│ │ │ ├── UpdateLocationResponse.md
│ │ │ ├── UpdateMerchantResponse.md
│ │ │ ├── UpdateMessageResponse.md
│ │ │ ├── UpdateModifierGroupResponse.md
│ │ │ ├── UpdateModifierResponse.md
│ │ │ ├── UpdateNoteResponse.md
│ │ │ ├── UpdateOpportunityResponse.md
│ │ │ ├── UpdateOrderResponse.md
│ │ │ ├── UpdateOrderTypeResponse.md
│ │ │ ├── UpdatePaymentResponse.md
│ │ │ ├── UpdatePipelineResponse.md
│ │ │ ├── UpdatePosPaymentResponse.md
│ │ │ ├── UpdateProductResponse.md
│ │ │ ├── UpdatePurchaseOrderResponse.md
│ │ │ ├── UpdateSharedLinkResponse.md
│ │ │ ├── UpdateSubsidiaryResponse.md
│ │ │ ├── UpdateSupplierResponse.md
│ │ │ ├── UpdateTaxRateResponse.md
│ │ │ ├── UpdateTenderResponse.md
│ │ │ ├── UpdateTicketResponse.md
│ │ │ ├── UpdateTimeOffRequestResponse.md
│ │ │ ├── UpdateTrackingCategoryResponse.md
│ │ │ ├── UpdateUploadSessionResponse.md
│ │ │ ├── UpdateUserResponse.md
│ │ │ ├── UpdateWebhookRequest.md
│ │ │ ├── UpdateWebhookResponse.md
│ │ │ ├── UploadSession.md
│ │ │ ├── User.md
│ │ │ ├── ValidateConnectionStateResponse.md
│ │ │ ├── ValidateConnectionStateResponseData.md
│ │ │ ├── VaultEventType.md
│ │ │ ├── VirtualWebhooks.md
│ │ │ ├── VirtualWebhooksResources.md
│ │ │ ├── WalletDetails.md
│ │ │ ├── Webhook.md
│ │ │ ├── WebhookEvent.md
│ │ │ ├── WebhookEventLog.md
│ │ │ ├── WebhookEventLogAttempts.md
│ │ │ ├── WebhookEventLogService.md
│ │ │ ├── WebhookEventLogsFilter.md
│ │ │ ├── WebhookEventLogsFilterService.md
│ │ │ ├── WebhookEventType.md
│ │ │ ├── WebhookSubscription.md
│ │ │ ├── WebhookSupport.md
│ │ │ └── Website.md
│ ├── index.ts
│ ├── models
│ │ ├── AccountingDepartment.ts
│ │ ├── AccountingDepartmentsFilter.ts
│ │ ├── AccountingEventType.ts
│ │ ├── AccountingLocation.ts
│ │ ├── AccountingLocationsFilter.ts
│ │ ├── ActivitiesFilter.ts
│ │ ├── ActivitiesSort.ts
│ │ ├── Activity.ts
│ │ ├── ActivityAttendee.ts
│ │ ├── Address.ts
│ │ ├── AgedCreditors.ts
│ │ ├── AgedDebtors.ts
│ │ ├── AgedReportFilter.ts
│ │ ├── Allocation.ts
│ │ ├── Api.ts
│ │ ├── ApiResource.ts
│ │ ├── ApiResourceCoverage.ts
│ │ ├── ApiResourceCoverageCoverage.ts
│ │ ├── ApiResourceLinkedResources.ts
│ │ ├── ApiResources.ts
│ │ ├── ApiStatus.ts
│ │ ├── ApisFilter.ts
│ │ ├── Applicant.ts
│ │ ├── ApplicantSocialLinks.ts
│ │ ├── ApplicantWebsites.ts
│ │ ├── ApplicantsFilter.ts
│ │ ├── Application.ts
│ │ ├── ApplicationStage.ts
│ │ ├── Assignee.ts
│ │ ├── AtsActivity.ts
│ │ ├── AtsEventType.ts
│ │ ├── Attachment.ts
│ │ ├── AttachmentReference.ts
│ │ ├── AttachmentReferenceType.ts
│ │ ├── AuthType.ts
│ │ ├── BadRequestResponse.ts
│ │ ├── BalanceByPeriod.ts
│ │ ├── BalanceByTransaction.ts
│ │ ├── BalanceSheet.ts
│ │ ├── BalanceSheetAccount.ts
│ │ ├── BalanceSheetAccountRecord.ts
│ │ ├── BalanceSheetAccounts.ts
│ │ ├── BalanceSheetAssetsAccount.ts
│ │ ├── BalanceSheetEquityAccount.ts
│ │ ├── BalanceSheetFilter.ts
│ │ ├── BalanceSheetLiabilitiesAccount.ts
│ │ ├── BalanceSheetReports.ts
│ │ ├── BalanceSheetUncategorizedItemsAccount.ts
│ │ ├── BankAccount.ts
│ │ ├── Benefit.ts
│ │ ├── Bill.ts
│ │ ├── BillLineItem.ts
│ │ ├── BillPayment.ts
│ │ ├── BillPaymentAllocations.ts
│ │ ├── BillsFilter.ts
│ │ ├── BillsSort.ts
│ │ ├── Branch.ts
│ │ ├── CashDetails.ts
│ │ ├── Collection.ts
│ │ ├── CollectionTag.ts
│ │ ├── CollectionTicketComment.ts
│ │ ├── CollectionUser.ts
│ │ ├── CollectionsSort.ts
│ │ ├── CommentsSort.ts
│ │ ├── CompaniesFilter.ts
│ │ ├── CompaniesSort.ts
│ │ ├── Company.ts
│ │ ├── CompanyInfo.ts
│ │ ├── CompanyRowType.ts
│ │ ├── Compensation.ts
│ │ ├── Connection.ts
│ │ ├── ConnectionConfiguration.ts
│ │ ├── ConnectionDefaults.ts
│ │ ├── ConnectionImportData.ts
│ │ ├── ConnectionImportDataCredentials.ts
│ │ ├── ConnectionMetadata.ts
│ │ ├── ConnectionState.ts
│ │ ├── ConnectionWebhook.ts
│ │ ├── Connector.ts
│ │ ├── ConnectorDoc.ts
│ │ ├── ConnectorEvent.ts
│ │ ├── ConnectorOauthScopes.ts
│ │ ├── ConnectorOauthScopes1.ts
│ │ ├── ConnectorResource.ts
│ │ ├── ConnectorSetting.ts
│ │ ├── ConnectorStatus.ts
│ │ ├── ConnectorTlsSupport.ts
│ │ ├── ConnectorUnifiedApis.ts
│ │ ├── ConnectorsFilter.ts
│ │ ├── Consumer.ts
│ │ ├── ConsumerConnection.ts
│ │ ├── ConsumerMetadata.ts
│ │ ├── ConsumerRequestCountsInDateRangeResponse.ts
│ │ ├── ConsumerRequestCountsInDateRangeResponseData.ts
│ │ ├── Contact.ts
│ │ ├── ContactsFilter.ts
│ │ ├── ContactsSort.ts
│ │ ├── CopyFolderRequest.ts
│ │ ├── CostOfGoodsSold.ts
│ │ ├── CreateAccountingDepartmentResponse.ts
│ │ ├── CreateAccountingLocationResponse.ts
│ │ ├── CreateActivityResponse.ts
│ │ ├── CreateApplicantResponse.ts
│ │ ├── CreateApplicationResponse.ts
│ │ ├── CreateAttachmentRequest.ts
│ │ ├── CreateAttachmentResponse.ts
│ │ ├── CreateBillPaymentResponse.ts
│ │ ├── CreateBillResponse.ts
│ │ ├── CreateCallbackState.ts
│ │ ├── CreateCallbackStateResponse.ts
│ │ ├── CreateCallbackStateResponseData.ts
│ │ ├── CreateCommentResponse.ts
│ │ ├── CreateCompanyResponse.ts
│ │ ├── CreateConnectionResponse.ts
│ │ ├── CreateConsumerResponse.ts
│ │ ├── CreateContactResponse.ts
│ │ ├── CreateCreditNoteResponse.ts
│ │ ├── CreateCustomMappingRequest.ts
│ │ ├── CreateCustomMappingResponse.ts
│ │ ├── CreateCustomerResponse.ts
│ │ ├── CreateDepartmentResponse.ts
│ │ ├── CreateDriveGroupResponse.ts
│ │ ├── CreateDriveResponse.ts
│ │ ├── CreateEcommerceCustomerResponse.ts
│ │ ├── CreateEcommerceOrderResponse.ts
│ │ ├── CreateEmployeeResponse.ts
│ │ ├── CreateExpenseResponse.ts
│ │ ├── CreateFileRequest.ts
│ │ ├── CreateFileResponse.ts
│ │ ├── CreateFolderRequest.ts
│ │ ├── CreateFolderResponse.ts
│ │ ├── CreateHrisCompanyResponse.ts
│ │ ├── CreateInvoiceItemResponse.ts
│ │ ├── CreateInvoiceResponse.ts
│ │ ├── CreateItemResponse.ts
│ │ ├── CreateJobResponse.ts
│ │ ├── CreateJournalEntryResponse.ts
│ │ ├── CreateLeadResponse.ts
│ │ ├── CreateLedgerAccountResponse.ts
│ │ ├── CreateLocationResponse.ts
│ │ ├── CreateMerchantResponse.ts
│ │ ├── CreateMessageResponse.ts
│ │ ├── CreateModifierGroupResponse.ts
│ │ ├── CreateModifierResponse.ts
│ │ ├── CreateNoteResponse.ts
│ │ ├── CreateOpportunityResponse.ts
│ │ ├── CreateOrderResponse.ts
│ │ ├── CreateOrderTypeResponse.ts
│ │ ├── CreatePaymentResponse.ts
│ │ ├── CreatePipelineResponse.ts
│ │ ├── CreatePosPaymentResponse.ts
│ │ ├── CreateProductResponse.ts
│ │ ├── CreatePurchaseOrderResponse.ts
│ │ ├── CreateSessionResponse.ts
│ │ ├── CreateSessionResponseData.ts
│ │ ├── CreateSharedLinkResponse.ts
│ │ ├── CreateSubsidiaryResponse.ts
│ │ ├── CreateSupplierResponse.ts
│ │ ├── CreateTaxRateResponse.ts
│ │ ├── CreateTenderResponse.ts
│ │ ├── CreateTicketResponse.ts
│ │ ├── CreateTimeOffRequestResponse.ts
│ │ ├── CreateTrackingCategoryResponse.ts
│ │ ├── CreateUploadSessionRequest.ts
│ │ ├── CreateUploadSessionResponse.ts
│ │ ├── CreateUserResponse.ts
│ │ ├── CreateWebhookRequest.ts
│ │ ├── CreateWebhookResponse.ts
│ │ ├── CreditNote.ts
│ │ ├── CreditNotesFilter.ts
│ │ ├── CreditNotesSort.ts
│ │ ├── CrmEventType.ts
│ │ ├── Currency.ts
│ │ ├── CustomField.ts
│ │ ├── CustomFieldFinder.ts
│ │ ├── CustomMapping.ts
│ │ ├── Customer.ts
│ │ ├── CustomersFilter.ts
│ │ ├── CustomersSort.ts
│ │ ├── Deduction.ts
│ │ ├── DeleteAccountingDepartmentResponse.ts
│ │ ├── DeleteAccountingLocationResponse.ts
│ │ ├── DeleteActivityResponse.ts
│ │ ├── DeleteApplicantResponse.ts
│ │ ├── DeleteApplicationResponse.ts
│ │ ├── DeleteAttachmentResponse.ts
│ │ ├── DeleteBillPaymentResponse.ts
│ │ ├── DeleteBillResponse.ts
│ │ ├── DeleteCommentResponse.ts
│ │ ├── DeleteCompanyResponse.ts
│ │ ├── DeleteConsumerResponse.ts
│ │ ├── DeleteContactResponse.ts
│ │ ├── DeleteCreditNoteResponse.ts
│ │ ├── DeleteCustomerResponse.ts
│ │ ├── DeleteDepartmentResponse.ts
│ │ ├── DeleteDriveGroupResponse.ts
│ │ ├── DeleteDriveResponse.ts
│ │ ├── DeleteEcommerceCustomerResponse.ts
│ │ ├── DeleteEcommerceOrderResponse.ts
│ │ ├── DeleteEmployeeResponse.ts
│ │ ├── DeleteExpenseResponse.ts
│ │ ├── DeleteFileResponse.ts
│ │ ├── DeleteFolderResponse.ts
│ │ ├── DeleteHrisCompanyResponse.ts
│ │ ├── DeleteInvoiceResponse.ts
│ │ ├── DeleteItemResponse.ts
│ │ ├── DeleteJobResponse.ts
│ │ ├── DeleteJournalEntryResponse.ts
│ │ ├── DeleteLeadResponse.ts
│ │ ├── DeleteLedgerAccountResponse.ts
│ │ ├── DeleteLocationResponse.ts
│ │ ├── DeleteMerchantResponse.ts
│ │ ├── DeleteMessageResponse.ts
│ │ ├── DeleteModifierGroupResponse.ts
│ │ ├── DeleteModifierResponse.ts
│ │ ├── DeleteNoteResponse.ts
│ │ ├── DeleteOpportunityResponse.ts
│ │ ├── DeleteOrderResponse.ts
│ │ ├── DeleteOrderTypeResponse.ts
│ │ ├── DeletePaymentResponse.ts
│ │ ├── DeletePipelineResponse.ts
│ │ ├── DeletePosPaymentResponse.ts
│ │ ├── DeleteProductResponse.ts
│ │ ├── DeletePurchaseOrderResponse.ts
│ │ ├── DeleteSharedLinkResponse.ts
│ │ ├── DeleteSubsidiaryResponse.ts
│ │ ├── DeleteSupplierResponse.ts
│ │ ├── DeleteTaxRateResponse.ts
│ │ ├── DeleteTenderResponse.ts
│ │ ├── DeleteTicketResponse.ts
│ │ ├── DeleteTimeOffRequestResponse.ts
│ │ ├── DeleteTrackingCategoryResponse.ts
│ │ ├── DeleteUploadSessionResponse.ts
│ │ ├── DeleteUserResponse.ts
│ │ ├── DeleteWebhookResponse.ts
│ │ ├── Department.ts
│ │ ├── DeprecatedLinkedSupplier.ts
│ │ ├── DeprecatedLinkedTrackingCategory.ts
│ │ ├── Drive.ts
│ │ ├── DriveGroup.ts
│ │ ├── DriveGroupsFilter.ts
│ │ ├── DrivesFilter.ts
│ │ ├── EcommerceAddress.ts
│ │ ├── EcommerceCustomer.ts
│ │ ├── EcommerceCustomerAddresses.ts
│ │ ├── EcommerceCustomersFilter.ts
│ │ ├── EcommerceDiscount.ts
│ │ ├── EcommerceEventType.ts
│ │ ├── EcommerceOrder.ts
│ │ ├── EcommerceOrderLineItem.ts
│ │ ├── EcommerceOrderStatus.ts
│ │ ├── EcommerceOrdersFilter.ts
│ │ ├── EcommerceProduct.ts
│ │ ├── EcommerceProductCategories.ts
│ │ ├── EcommerceProductImages.ts
│ │ ├── EcommerceProductImages1.ts
│ │ ├── EcommerceProductOptions.ts
│ │ ├── EcommerceProductOptions1.ts
│ │ ├── EcommerceProductVariants.ts
│ │ ├── EcommerceStore.ts
│ │ ├── Email.ts
│ │ ├── Employee.ts
│ │ ├── EmployeeCompensation.ts
│ │ ├── EmployeeEmploymentRole.ts
│ │ ├── EmployeeJob.ts
│ │ ├── EmployeeList.ts
│ │ ├── EmployeeManager.ts
│ │ ├── EmployeePayroll.ts
│ │ ├── EmployeeSchedules.ts
│ │ ├── EmployeesFilter.ts
│ │ ├── EmployeesOneFilter.ts
│ │ ├── EmployeesSort.ts
│ │ ├── EmploymentStatus.ts
│ │ ├── ExecuteWebhookEventRequest.ts
│ │ ├── ExecuteWebhookEventsRequest.ts
│ │ ├── ExecuteWebhookResponse.ts
│ │ ├── Expense.ts
│ │ ├── ExpenseLineItem.ts
│ │ ├── Expenses.ts
│ │ ├── FileStorageEventType.ts
│ │ ├── FileType.ts
│ │ ├── FilesFilter.ts
│ │ ├── FilesSearch.ts
│ │ ├── FilesSort.ts
│ │ ├── Folder.ts
│ │ ├── FormField.ts
│ │ ├── FormFieldOption.ts
│ │ ├── FormFieldOptionGroup.ts
│ │ ├── Gender.ts
│ │ ├── GetAccountingDepartmentResponse.ts
│ │ ├── GetAccountingDepartmentsResponse.ts
│ │ ├── GetAccountingLocationResponse.ts
│ │ ├── GetAccountingLocationsResponse.ts
│ │ ├── GetActivitiesResponse.ts
│ │ ├── GetActivityResponse.ts
│ │ ├── GetAgedCreditorsResponse.ts
│ │ ├── GetAgedDebtorsResponse.ts
│ │ ├── GetApiResourceCoverageResponse.ts
│ │ ├── GetApiResourceResponse.ts
│ │ ├── GetApiResponse.ts
│ │ ├── GetApisResponse.ts
│ │ ├── GetApplicantResponse.ts
│ │ ├── GetApplicantsResponse.ts
│ │ ├── GetApplicationResponse.ts
│ │ ├── GetApplicationsResponse.ts
│ │ ├── GetAttachmentResponse.ts
│ │ ├── GetAttachmentsResponse.ts
│ │ ├── GetBalanceSheetResponse.ts
│ │ ├── GetBillPaymentResponse.ts
│ │ ├── GetBillPaymentsResponse.ts
│ │ ├── GetBillResponse.ts
│ │ ├── GetBillsResponse.ts
│ │ ├── GetCollectionResponse.ts
│ │ ├── GetCollectionTagsResponse.ts
│ │ ├── GetCollectionUserResponse.ts
│ │ ├── GetCollectionUsersResponse.ts
│ │ ├── GetCollectionsResponse.ts
│ │ ├── GetCommentResponse.ts
│ │ ├── GetCommentsResponse.ts
│ │ ├── GetCompaniesResponse.ts
│ │ ├── GetCompanyInfoResponse.ts
│ │ ├── GetCompanyResponse.ts
│ │ ├── GetConnectionResponse.ts
│ │ ├── GetConnectionsResponse.ts
│ │ ├── GetConnectorResourceExampleResponse.ts
│ │ ├── GetConnectorResourceExampleResponseData.ts
│ │ ├── GetConnectorResourceResponse.ts
│ │ ├── GetConnectorResourceSchemaResponse.ts
│ │ ├── GetConnectorResponse.ts
│ │ ├── GetConnectorsResponse.ts
│ │ ├── GetConsumerResponse.ts
│ │ ├── GetConsumersResponse.ts
│ │ ├── GetConsumersResponseData.ts
│ │ ├── GetContactResponse.ts
│ │ ├── GetContactsResponse.ts
│ │ ├── GetCreditNoteResponse.ts
│ │ ├── GetCreditNotesResponse.ts
│ │ ├── GetCustomFieldsResponse.ts
│ │ ├── GetCustomMappingResponse.ts
│ │ ├── GetCustomMappingsResponse.ts
│ │ ├── GetCustomerResponse.ts
│ │ ├── GetCustomersResponse.ts
│ │ ├── GetDepartmentResponse.ts
│ │ ├── GetDepartmentsResponse.ts
│ │ ├── GetDriveGroupResponse.ts
│ │ ├── GetDriveGroupsResponse.ts
│ │ ├── GetDriveResponse.ts
│ │ ├── GetDrivesResponse.ts
│ │ ├── GetEcommerceCustomerResponse.ts
│ │ ├── GetEcommerceCustomersResponse.ts
│ │ ├── GetEcommerceOrderResponse.ts
│ │ ├── GetEcommerceOrdersResponse.ts
│ │ ├── GetEmployeePayrollResponse.ts
│ │ ├── GetEmployeePayrollsResponse.ts
│ │ ├── GetEmployeeResponse.ts
│ │ ├── GetEmployeeSchedulesResponse.ts
│ │ ├── GetEmployeesResponse.ts
│ │ ├── GetExpenseResponse.ts
│ │ ├── GetExpensesResponse.ts
│ │ ├── GetFileResponse.ts
│ │ ├── GetFilesResponse.ts
│ │ ├── GetFolderResponse.ts
│ │ ├── GetFoldersResponse.ts
│ │ ├── GetHrisCompaniesResponse.ts
│ │ ├── GetHrisCompanyResponse.ts
│ │ ├── GetHrisJobResponse.ts
│ │ ├── GetHrisJobsResponse.ts
│ │ ├── GetInvoiceItemResponse.ts
│ │ ├── GetInvoiceItemsResponse.ts
│ │ ├── GetInvoiceResponse.ts
│ │ ├── GetInvoicesResponse.ts
│ │ ├── GetItemResponse.ts
│ │ ├── GetItemsResponse.ts
│ │ ├── GetJobResponse.ts
│ │ ├── GetJobsResponse.ts
│ │ ├── GetJournalEntriesResponse.ts
│ │ ├── GetJournalEntryResponse.ts
│ │ ├── GetLeadResponse.ts
│ │ ├── GetLeadsResponse.ts
│ │ ├── GetLedgerAccountResponse.ts
│ │ ├── GetLedgerAccountsResponse.ts
│ │ ├── GetLocationResponse.ts
│ │ ├── GetLocationsResponse.ts
│ │ ├── GetLogsResponse.ts
│ │ ├── GetMerchantResponse.ts
│ │ ├── GetMerchantsResponse.ts
│ │ ├── GetMessageResponse.ts
│ │ ├── GetMessagesResponse.ts
│ │ ├── GetModifierGroupResponse.ts
│ │ ├── GetModifierGroupsResponse.ts
│ │ ├── GetModifierResponse.ts
│ │ ├── GetModifiersResponse.ts
│ │ ├── GetNoteResponse.ts
│ │ ├── GetNotesResponse.ts
│ │ ├── GetOpportunitiesResponse.ts
│ │ ├── GetOpportunityResponse.ts
│ │ ├── GetOrderResponse.ts
│ │ ├── GetOrderTypeResponse.ts
│ │ ├── GetOrderTypesResponse.ts
│ │ ├── GetOrdersResponse.ts
│ │ ├── GetPaymentResponse.ts
│ │ ├── GetPaymentsResponse.ts
│ │ ├── GetPayrollResponse.ts
│ │ ├── GetPayrollsResponse.ts
│ │ ├── GetPipelineResponse.ts
│ │ ├── GetPipelinesResponse.ts
│ │ ├── GetPosPaymentResponse.ts
│ │ ├── GetPosPaymentsResponse.ts
│ │ ├── GetProductResponse.ts
│ │ ├── GetProductsResponse.ts
│ │ ├── GetProfitAndLossResponse.ts
│ │ ├── GetPurchaseOrderResponse.ts
│ │ ├── GetPurchaseOrdersResponse.ts
│ │ ├── GetResourceExampleResponse.ts
│ │ ├── GetResourceSchemaResponse.ts
│ │ ├── GetSharedLinkResponse.ts
│ │ ├── GetSharedLinksResponse.ts
│ │ ├── GetStoreResponse.ts
│ │ ├── GetStoresResponse.ts
│ │ ├── GetSubsidiariesResponse.ts
│ │ ├── GetSubsidiaryResponse.ts
│ │ ├── GetSupplierResponse.ts
│ │ ├── GetSuppliersResponse.ts
│ │ ├── GetTaxRateResponse.ts
│ │ ├── GetTaxRatesResponse.ts
│ │ ├── GetTenderResponse.ts
│ │ ├── GetTendersResponse.ts
│ │ ├── GetTicketResponse.ts
│ │ ├── GetTicketsResponse.ts
│ │ ├── GetTimeOffRequestResponse.ts
│ │ ├── GetTimeOffRequestsResponse.ts
│ │ ├── GetTrackingCategoriesResponse.ts
│ │ ├── GetTrackingCategoryResponse.ts
│ │ ├── GetUploadSessionResponse.ts
│ │ ├── GetUserResponse.ts
│ │ ├── GetUsersResponse.ts
│ │ ├── GetWebhookEventLogsResponse.ts
│ │ ├── GetWebhookResponse.ts
│ │ ├── GetWebhooksResponse.ts
│ │ ├── HrisCompany.ts
│ │ ├── HrisEventType.ts
│ │ ├── HrisJob.ts
│ │ ├── HrisJobLocation.ts
│ │ ├── HrisJobs.ts
│ │ ├── Income.ts
│ │ ├── IntegrationState.ts
│ │ ├── Invoice.ts
│ │ ├── InvoiceItem.ts
│ │ ├── InvoiceItemFilter.ts
│ │ ├── InvoiceItemSalesDetails.ts
│ │ ├── InvoiceItemsFilter.ts
│ │ ├── InvoiceItemsSort.ts
│ │ ├── InvoiceLineItem.ts
│ │ ├── InvoiceResponse.ts
│ │ ├── InvoicesFilter.ts
│ │ ├── InvoicesSort.ts
│ │ ├── IssueTrackingEventType.ts
│ │ ├── IssuesFilter.ts
│ │ ├── Item.ts
│ │ ├── Job.ts
│ │ ├── JobLinks.ts
│ │ ├── JobSalary.ts
│ │ ├── JobStatus.ts
│ │ ├── JournalEntriesFilter.ts
│ │ ├── JournalEntriesSort.ts
│ │ ├── JournalEntry.ts
│ │ ├── JournalEntryLineItem.ts
│ │ ├── Lead.ts
│ │ ├── LeadEventType.ts
│ │ ├── LeadsFilter.ts
│ │ ├── LeadsSort.ts
│ │ ├── LedgerAccount.ts
│ │ ├── LedgerAccountCategories.ts
│ │ ├── LedgerAccountParentAccount.ts
│ │ ├── LedgerAccounts.ts
│ │ ├── LedgerAccountsFilter.ts
│ │ ├── LedgerAccountsSort.ts
│ │ ├── LinkedConnectorResource.ts
│ │ ├── LinkedCustomer.ts
│ │ ├── LinkedEcommerceCustomer.ts
│ │ ├── LinkedEcommerceOrder.ts
│ │ ├── LinkedFolder.ts
│ │ ├── LinkedInvoiceItem.ts
│ │ ├── LinkedLedgerAccount.ts
│ │ ├── LinkedParentCustomer.ts
│ │ ├── LinkedSupplier.ts
│ │ ├── LinkedTaxRate.ts
│ │ ├── LinkedTrackingCategories.ts
│ │ ├── LinkedTrackingCategory.ts
│ │ ├── Links.ts
│ │ ├── Location.ts
│ │ ├── Log.ts
│ │ ├── LogOperation.ts
│ │ ├── LogService.ts
│ │ ├── LogsFilter.ts
│ │ ├── Merchant.ts
│ │ ├── Message.ts
│ │ ├── Meta.ts
│ │ ├── MetaCursors.ts
│ │ ├── ModelError.ts
│ │ ├── Modifier.ts
│ │ ├── ModifierGroup.ts
│ │ ├── ModifierGroupFilter.ts
│ │ ├── NotFoundResponse.ts
│ │ ├── NotImplementedResponse.ts
│ │ ├── Note.ts
│ │ ├── OAuthGrantType.ts
│ │ ├── Offer.ts
│ │ ├── OpportunitiesFilter.ts
│ │ ├── OpportunitiesSort.ts
│ │ ├── Opportunity.ts
│ │ ├── Order.ts
│ │ ├── OrderCustomers.ts
│ │ ├── OrderDiscounts.ts
│ │ ├── OrderFulfillments.ts
│ │ ├── OrderLineItems.ts
│ │ ├── OrderPayments.ts
│ │ ├── OrderPickupDetails.ts
│ │ ├── OrderPickupDetailsCurbsidePickupDetails.ts
│ │ ├── OrderPickupDetailsRecipient.ts
│ │ ├── OrderRefunds.ts
│ │ ├── OrderTenders.ts
│ │ ├── OrderType.ts
│ │ ├── OrdersSort.ts
│ │ ├── OtherExpenses.ts
│ │ ├── OtherIncome.ts
│ │ ├── OutstandingBalanceByCurrency.ts
│ │ ├── OutstandingBalanceByCustomer.ts
│ │ ├── OutstandingBalanceBySupplier.ts
│ │ ├── Owner.ts
│ │ ├── PaginationCoverage.ts
│ │ ├── PassThroughBody.ts
│ │ ├── PassThroughQuery.ts
│ │ ├── Payment.ts
│ │ ├── PaymentCard.ts
│ │ ├── PaymentFrequency.ts
│ │ ├── PaymentRequiredResponse.ts
│ │ ├── PaymentStatus.ts
│ │ ├── PaymentType.ts
│ │ ├── PaymentUnit.ts
│ │ ├── PaymentsFilter.ts
│ │ ├── PaymentsSort.ts
│ │ ├── Payroll.ts
│ │ ├── PayrollTotals.ts
│ │ ├── PayrollsFilter.ts
│ │ ├── Person.ts
│ │ ├── PhoneNumber.ts
│ │ ├── Pipeline.ts
│ │ ├── PipelineStages.ts
│ │ ├── PosBankAccount.ts
│ │ ├── PosBankAccountAchDetails.ts
│ │ ├── PosPayment.ts
│ │ ├── PosPaymentCardDetails.ts
│ │ ├── PosPaymentExternalDetails.ts
│ │ ├── Price.ts
│ │ ├── ProbationPeriod.ts
│ │ ├── ProfitAndLoss.ts
│ │ ├── ProfitAndLossFilter.ts
│ │ ├── ProfitAndLossIndicator.ts
│ │ ├── ProfitAndLossRecord.ts
│ │ ├── ProfitAndLossRecords.ts
│ │ ├── ProfitAndLossSection.ts
│ │ ├── ProfitAndLossType.ts
│ │ ├── PurchaseOrder.ts
│ │ ├── PurchaseOrdersFilter.ts
│ │ ├── PurchaseOrdersSort.ts
│ │ ├── Raw.ts
│ │ ├── RequestCountAllocation.ts
│ │ ├── RequestRate.ts
│ │ ├── ResolveWebhookEventRequest.ts
│ │ ├── ResolveWebhookEventsRequest.ts
│ │ ├── ResolveWebhookResponse.ts
│ │ ├── ResourceExample.ts
│ │ ├── ResourceStatus.ts
│ │ ├── Schedule.ts
│ │ ├── ScheduleWorkPattern.ts
│ │ ├── ScheduleWorkPatternOddWeeks.ts
│ │ ├── SchemaSupport.ts
│ │ ├── ServiceCharge.ts
│ │ ├── ServiceCharges.ts
│ │ ├── Session.ts
│ │ ├── SessionSettings.ts
│ │ ├── SessionTheme.ts
│ │ ├── SharedLink.ts
│ │ ├── SharedLinkTarget.ts
│ │ ├── SimpleFormFieldOption.ts
│ │ ├── SocialLink.ts
│ │ ├── SortDirection.ts
│ │ ├── Status.ts
│ │ ├── Subsidiary.ts
│ │ ├── SubsidiaryReference.ts
│ │ ├── Supplier.ts
│ │ ├── SuppliersFilter.ts
│ │ ├── SuppliersSort.ts
│ │ ├── SupportedProperty.ts
│ │ ├── Tags.ts
│ │ ├── Tax.ts
│ │ ├── TaxRate.ts
│ │ ├── TaxRatesFilter.ts
│ │ ├── Team.ts
│ │ ├── Tender.ts
│ │ ├── Ticket.ts
│ │ ├── TicketsSort.ts
│ │ ├── TimeOffRequest.ts
│ │ ├── TimeOffRequestNotes.ts
│ │ ├── TimeOffRequestsFilter.ts
│ │ ├── TooManyRequestsResponse.ts
│ │ ├── TooManyRequestsResponseDetail.ts
│ │ ├── TrackingCategory.ts
│ │ ├── TrackingItem.ts
│ │ ├── UnauthorizedResponse.ts
│ │ ├── UncategorizedAccounts.ts
│ │ ├── UnexpectedErrorResponse.ts
│ │ ├── UnifiedApiId.ts
│ │ ├── UnifiedFile.ts
│ │ ├── UnifiedFilePermissions.ts
│ │ ├── UnifiedId.ts
│ │ ├── UnprocessableResponse.ts
│ │ ├── UpdateAccountingDepartmentResponse.ts
│ │ ├── UpdateAccountingLocationResponse.ts
│ │ ├── UpdateActivityResponse.ts
│ │ ├── UpdateApplicantResponse.ts
│ │ ├── UpdateApplicationResponse.ts
│ │ ├── UpdateBillPaymentResponse.ts
│ │ ├── UpdateBillResponse.ts
│ │ ├── UpdateCommentResponse.ts
│ │ ├── UpdateCompanyResponse.ts
│ │ ├── UpdateConnectionResponse.ts
│ │ ├── UpdateConsumerRequest.ts
│ │ ├── UpdateConsumerResponse.ts
│ │ ├── UpdateContactResponse.ts
│ │ ├── UpdateCreditNoteResponse.ts
│ │ ├── UpdateCustomMappingRequest.ts
│ │ ├── UpdateCustomMappingResponse.ts
│ │ ├── UpdateCustomerResponse.ts
│ │ ├── UpdateDepartmentResponse.ts
│ │ ├── UpdateDriveGroupResponse.ts
│ │ ├── UpdateDriveResponse.ts
│ │ ├── UpdateEcommerceCustomerResponse.ts
│ │ ├── UpdateEcommerceOrderResponse.ts
│ │ ├── UpdateEmployeeResponse.ts
│ │ ├── UpdateExpenseResponse.ts
│ │ ├── UpdateFileRequest.ts
│ │ ├── UpdateFileResponse.ts
│ │ ├── UpdateFolderRequest.ts
│ │ ├── UpdateFolderResponse.ts
│ │ ├── UpdateHrisCompanyResponse.ts
│ │ ├── UpdateInvoiceItemsResponse.ts
│ │ ├── UpdateInvoiceResponse.ts
│ │ ├── UpdateItemResponse.ts
│ │ ├── UpdateJobResponse.ts
│ │ ├── UpdateJournalEntryResponse.ts
│ │ ├── UpdateLeadResponse.ts
│ │ ├── UpdateLedgerAccountResponse.ts
│ │ ├── UpdateLocationResponse.ts
│ │ ├── UpdateMerchantResponse.ts
│ │ ├── UpdateMessageResponse.ts
│ │ ├── UpdateModifierGroupResponse.ts
│ │ ├── UpdateModifierResponse.ts
│ │ ├── UpdateNoteResponse.ts
│ │ ├── UpdateOpportunityResponse.ts
│ │ ├── UpdateOrderResponse.ts
│ │ ├── UpdateOrderTypeResponse.ts
│ │ ├── UpdatePaymentResponse.ts
│ │ ├── UpdatePipelineResponse.ts
│ │ ├── UpdatePosPaymentResponse.ts
│ │ ├── UpdateProductResponse.ts
│ │ ├── UpdatePurchaseOrderResponse.ts
│ │ ├── UpdateSharedLinkResponse.ts
│ │ ├── UpdateSubsidiaryResponse.ts
│ │ ├── UpdateSupplierResponse.ts
│ │ ├── UpdateTaxRateResponse.ts
│ │ ├── UpdateTenderResponse.ts
│ │ ├── UpdateTicketResponse.ts
│ │ ├── UpdateTimeOffRequestResponse.ts
│ │ ├── UpdateTrackingCategoryResponse.ts
│ │ ├── UpdateUploadSessionResponse.ts
│ │ ├── UpdateUserResponse.ts
│ │ ├── UpdateWebhookRequest.ts
│ │ ├── UpdateWebhookResponse.ts
│ │ ├── UploadSession.ts
│ │ ├── User.ts
│ │ ├── ValidateConnectionStateResponse.ts
│ │ ├── ValidateConnectionStateResponseData.ts
│ │ ├── VaultEventType.ts
│ │ ├── VirtualWebhooks.ts
│ │ ├── VirtualWebhooksResources.ts
│ │ ├── WalletDetails.ts
│ │ ├── Webhook.ts
│ │ ├── WebhookEvent.ts
│ │ ├── WebhookEventLog.ts
│ │ ├── WebhookEventLogAttempts.ts
│ │ ├── WebhookEventLogService.ts
│ │ ├── WebhookEventLogsFilter.ts
│ │ ├── WebhookEventLogsFilterService.ts
│ │ ├── WebhookEventType.ts
│ │ ├── WebhookSubscription.ts
│ │ ├── WebhookSupport.ts
│ │ ├── Website.ts
│ │ └── index.ts
│ ├── runtime.ts
│ └── tests
│ │ └── apis
│ │ ├── AccountingApiTest.api.test.ts
│ │ ├── AtsApiTest.api.test.ts
│ │ ├── ConnectorApiTest.api.test.ts
│ │ ├── CrmApiTest.api.test.ts
│ │ ├── EcommerceApiTest.api.test.ts
│ │ ├── FileStorageApiTest.api.test.ts
│ │ ├── HrisApiTest.api.test.ts
│ │ ├── IssueTrackingApiTest.api.test.ts
│ │ ├── LeadApiTest.api.test.ts
│ │ ├── PosApiTest.api.test.ts
│ │ ├── SmsApiTest.api.test.ts
│ │ ├── VaultApiTest.api.test.ts
│ │ └── WebhookApiTest.api.test.ts
├── index.ts
└── utils.ts
├── test
└── setupJest.js
├── tsconfig.json
└── yarn.lock
/.github/workflows/publish.yml:
--------------------------------------------------------------------------------
1 | name: Publish to NPM
2 |
3 | on:
4 | push:
5 | branches:
6 | - main
7 |
8 | jobs:
9 | publish:
10 | runs-on: ubuntu-latest
11 | steps:
12 | - uses: actions/checkout@v2
13 |
14 | - name: 'Setup Node.js'
15 | uses: actions/setup-node@v2
16 | with:
17 | node-version: '16.x'
18 | cache: yarn
19 |
20 | - name: Install dependencies
21 | run: yarn
22 |
23 | - name: Unit Test
24 | run: yarn test
25 |
26 | - name: Prepare for Publish
27 | run: yarn prepare
28 |
29 | - name: Publish
30 | uses: JS-DevTools/npm-publish@v1
31 | with:
32 | token: ${{ secrets.NPM_TOKEN }}
33 |
--------------------------------------------------------------------------------
/.github/workflows/sync.yml:
--------------------------------------------------------------------------------
1 | name: Sync branch
2 |
3 | on:
4 | push:
5 | branches:
6 | - main
7 |
8 | permissions:
9 | id-token: write
10 | contents: write
11 |
12 | jobs:
13 | sync-branch:
14 | name: Update generator-update branch
15 | runs-on: ubuntu-latest
16 | steps:
17 | - name: Checkout
18 | uses: actions/checkout@v3
19 | - uses: connor-baer/action-sync-branch@main
20 | with:
21 | branch: generator-update
22 | token: ${{ secrets.GITHUB_TOKEN }}
23 | force: false
24 |
--------------------------------------------------------------------------------
/.github/workflows/test.yml:
--------------------------------------------------------------------------------
1 | name: Unit Test
2 |
3 | on:
4 | pull_request:
5 |
6 | jobs:
7 | publish:
8 | runs-on: ubuntu-latest
9 | steps:
10 | - uses: actions/checkout@v2
11 |
12 | - name: 'Setup Node.js'
13 | uses: actions/setup-node@v2
14 | with:
15 | node-version: '16.x'
16 | cache: yarn
17 |
18 | - name: Install dependencies
19 | run: yarn
20 |
21 | - name: Unit Test
22 | run: yarn test
23 |
24 | - name: Automerge
25 | uses: pascalgn/automerge-action@v0.15.3
26 | env:
27 | GITHUB_TOKEN: '${{ secrets.GH_API_TOKEN }}'
28 | MERGE_LABELS: ''
29 | MERGE_METHOD: squash
30 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | node_modules
2 | dist
3 |
--------------------------------------------------------------------------------
/.prettierrc.json:
--------------------------------------------------------------------------------
1 | {
2 | "printWidth": 100,
3 | "singleQuote": true,
4 | "bracketSpacing": true,
5 | "semi": false,
6 | "tabWidth": 2,
7 | "useTabs": false,
8 | "trailingComma": "none",
9 | "arrowParens": "avoid"
10 | }
11 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Copyright 2021 Apideck (https://apideck.com)
2 |
3 | Licensed under the Apache License, Version 2.0 (the "License");
4 | you may not use this file except in compliance with the License.
5 | You may obtain a copy of the License at
6 |
7 | http://www.apache.org/licenses/LICENSE-2.0
8 |
9 | Unless required by applicable law or agreed to in writing, software
10 | distributed under the License is distributed on an "AS IS" BASIS,
11 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | See the License for the specific language governing permissions and
13 | limitations under the License.
14 |
--------------------------------------------------------------------------------
/src/gen/.openapi-generator/VERSION:
--------------------------------------------------------------------------------
1 | 5.4.0
--------------------------------------------------------------------------------
/src/gen/apis/index.ts:
--------------------------------------------------------------------------------
1 | /* tslint:disable */
2 | /* eslint-disable */
3 | export * from './AccountingApi'
4 | export * from './AtsApi'
5 | export * from './ConnectorApi'
6 | export * from './CrmApi'
7 | export * from './EcommerceApi'
8 | export * from './FileStorageApi'
9 | export * from './HrisApi'
10 | export * from './IssueTrackingApi'
11 | export * from './LeadApi'
12 | export * from './PosApi'
13 | export * from './SmsApi'
14 | export * from './VaultApi'
15 | export * from './WebhookApi'
16 |
--------------------------------------------------------------------------------
/src/gen/docs/models/AccountingDepartmentsFilter.md:
--------------------------------------------------------------------------------
1 | # Apideck.AccountingDepartmentsFilter
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `subsidiary` | **string** | Id of the subsidiary to search for | [optional]
9 |
10 |
11 |
12 |
13 |
14 | ---
15 |
16 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
17 |
18 |
19 |
--------------------------------------------------------------------------------
/src/gen/docs/models/AccountingLocationsFilter.md:
--------------------------------------------------------------------------------
1 | # Apideck.AccountingLocationsFilter
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `subsidiary` | **string** | Id of the subsidiary to search for | [optional]
9 |
10 |
11 |
12 |
13 |
14 | ---
15 |
16 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
17 |
18 |
19 |
--------------------------------------------------------------------------------
/src/gen/docs/models/ActivitiesFilter.md:
--------------------------------------------------------------------------------
1 | # Apideck.ActivitiesFilter
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `company_id` | **string** | Company ID to filter on | [optional]
9 | `owner_id` | **string** | Owner ID to filter on | [optional]
10 | `contact_id` | **string** | Primary contact ID to filter on | [optional]
11 | `updated_since` | **Date** | | [optional]
12 | `type` | **string** | Type to filter on | [optional]
13 |
14 |
15 |
16 |
17 |
18 | ---
19 |
20 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
21 |
22 |
23 |
--------------------------------------------------------------------------------
/src/gen/docs/models/ActivitiesSort.md:
--------------------------------------------------------------------------------
1 | # Apideck.ActivitiesSort
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `by` | **string** | The field on which to sort the Activities | [optional]
9 | `direction` | [**SortDirection**](SortDirection.md) | | [optional]
10 |
11 |
12 |
13 |
14 |
15 |
16 | ## Enum: ActivitiesSort.by
17 |
18 |
19 | * `created_at` (value: `'created_at'`)
20 |
21 | * `updated_at` (value: `'updated_at'`)
22 |
23 |
24 |
25 |
26 | ## Referenced Types:
27 |
28 | * [`SortDirection`](SortDirection.md)
29 |
30 | ---
31 |
32 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
33 |
34 |
35 |
--------------------------------------------------------------------------------
/src/gen/docs/models/AgedReportFilter.md:
--------------------------------------------------------------------------------
1 | # Apideck.AgedReportFilter
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `customer_id` | **string** | Filter by customer id | [optional]
9 | `supplier_id` | **string** | Filter by supplier id | [optional]
10 | `report_as_of_date` | **string** | The cutoff date for considering transactions | [optional]
11 | `period_count` | **number** | Number of periods to split the aged creditors report into | [optional]
12 | `period_length` | **number** | Length of each period in days | [optional]
13 |
14 |
15 |
16 |
17 |
18 | ---
19 |
20 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
21 |
22 |
23 |
--------------------------------------------------------------------------------
/src/gen/docs/models/ApiResourceLinkedResources.md:
--------------------------------------------------------------------------------
1 | # Apideck.ApiResourceLinkedResources
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `id` | **string** | ID of the resource, typically a lowercased version of name. | [optional]
9 | `unified_property` | **string** | Name of the property in our Unified API. | [optional]
10 |
11 |
12 |
13 |
14 |
15 | ---
16 |
17 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
18 |
19 |
20 |
--------------------------------------------------------------------------------
/src/gen/docs/models/ApiResources.md:
--------------------------------------------------------------------------------
1 | # Apideck.ApiResources
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `id` | **string** | ID of the resource, typically a lowercased version of its name. | [optional]
9 | `name` | **string** | Name of the resource (plural) | [optional]
10 | `status` | [**ResourceStatus**](ResourceStatus.md) | | [optional]
11 | `excluded_from_coverage` | **boolean** | Exclude from mapping coverage | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ## Referenced Types:
18 |
19 |
20 | * [`ResourceStatus`](ResourceStatus.md)
21 |
22 |
23 | ---
24 |
25 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
26 |
27 |
28 |
--------------------------------------------------------------------------------
/src/gen/docs/models/ApiStatus.md:
--------------------------------------------------------------------------------
1 | # Apideck.ApiStatus
2 |
3 | ## Enum
4 |
5 |
6 | * `live` (value: `'live'`)
7 |
8 | * `beta` (value: `'beta'`)
9 |
10 | * `development` (value: `'development'`)
11 |
12 | * `considering` (value: `'considering'`)
13 |
14 |
15 | ---
16 |
17 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
18 |
19 |
20 |
--------------------------------------------------------------------------------
/src/gen/docs/models/ApisFilter.md:
--------------------------------------------------------------------------------
1 | # Apideck.ApisFilter
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status` | [**ApiStatus**](ApiStatus.md) | | [optional]
9 |
10 |
11 |
12 |
13 |
14 | ## Referenced Types:
15 | * [`ApiStatus`](ApiStatus.md)
16 |
17 | ---
18 |
19 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
20 |
21 |
22 |
--------------------------------------------------------------------------------
/src/gen/docs/models/ApplicantSocialLinks.md:
--------------------------------------------------------------------------------
1 | # Apideck.ApplicantSocialLinks
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `url` | **string** | URL of the social link, e.g. https://www.twitter.com/apideck |
9 | `id` | **string** | Unique identifier of the social link | [optional]
10 | `type` | **string** | Type of the social link, e.g. twitter | [optional]
11 |
12 |
13 |
14 |
15 |
16 | ---
17 |
18 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
19 |
20 |
21 |
--------------------------------------------------------------------------------
/src/gen/docs/models/ApplicantWebsites.md:
--------------------------------------------------------------------------------
1 | # Apideck.ApplicantWebsites
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `url` | **string** | The website URL |
9 | `id` | **string** | Unique identifier for the website | [optional]
10 | `type` | **string** | The type of website | [optional]
11 |
12 |
13 |
14 |
15 |
16 |
17 | ## Enum: ApplicantWebsites.type
18 |
19 |
20 | * `primary` (value: `'primary'`)
21 |
22 | * `secondary` (value: `'secondary'`)
23 |
24 | * `work` (value: `'work'`)
25 |
26 | * `personal` (value: `'personal'`)
27 |
28 | * `other` (value: `'other'`)
29 |
30 |
31 |
32 |
33 | ---
34 |
35 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
36 |
37 |
38 |
--------------------------------------------------------------------------------
/src/gen/docs/models/ApplicantsFilter.md:
--------------------------------------------------------------------------------
1 | # Apideck.ApplicantsFilter
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `job_id` | **string** | Id of the job to filter on | [optional]
9 |
10 |
11 |
12 |
13 |
14 | ---
15 |
16 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
17 |
18 |
19 |
--------------------------------------------------------------------------------
/src/gen/docs/models/ApplicationStage.md:
--------------------------------------------------------------------------------
1 | # Apideck.ApplicationStage
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `id` | **string** | Stage the candidate should be in. If omitted, the default stage for this job will be used. | [optional]
9 | `name` | **string** | | [optional]
10 |
11 |
12 |
13 |
14 |
15 | ---
16 |
17 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
18 |
19 |
20 |
--------------------------------------------------------------------------------
/src/gen/docs/models/Assignee.md:
--------------------------------------------------------------------------------
1 | # Apideck.Assignee
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `id` | **string** | A unique identifier for an object. |
9 | `username` | **string** | | [optional]
10 |
11 |
12 |
13 |
14 |
15 | ---
16 |
17 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
18 |
19 |
20 |
--------------------------------------------------------------------------------
/src/gen/docs/models/AtsEventType.md:
--------------------------------------------------------------------------------
1 | # Apideck.AtsEventType
2 |
3 | ## Enum
4 |
5 |
6 | * `Star` (value: `'*'`)
7 |
8 | * `ats_job_created` (value: `'ats.job.created'`)
9 |
10 | * `ats_job_updated` (value: `'ats.job.updated'`)
11 |
12 | * `ats_job_deleted` (value: `'ats.job.deleted'`)
13 |
14 | * `ats_applicant_created` (value: `'ats.applicant.created'`)
15 |
16 | * `ats_applicant_updated` (value: `'ats.applicant.updated'`)
17 |
18 | * `ats_applicant_deleted` (value: `'ats.applicant.deleted'`)
19 |
20 | * `ats_application_created` (value: `'ats.application.created'`)
21 |
22 | * `ats_application_updated` (value: `'ats.application.updated'`)
23 |
24 | * `ats_application_deleted` (value: `'ats.application.deleted'`)
25 |
26 |
27 | ---
28 |
29 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
30 |
31 |
32 |
--------------------------------------------------------------------------------
/src/gen/docs/models/AttachmentReference.md:
--------------------------------------------------------------------------------
1 | # Apideck.AttachmentReference
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `type` | [**AttachmentReferenceType**](AttachmentReferenceType.md) | | [optional]
9 | `id` | **string** | A unique identifier for an object. | [optional]
10 |
11 |
12 |
13 |
14 |
15 | ## Referenced Types:
16 | * [`AttachmentReferenceType`](AttachmentReferenceType.md)
17 |
18 |
19 | ---
20 |
21 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
22 |
23 |
24 |
--------------------------------------------------------------------------------
/src/gen/docs/models/AttachmentReferenceType.md:
--------------------------------------------------------------------------------
1 | # Apideck.AttachmentReferenceType
2 |
3 | ## Enum
4 |
5 |
6 | * `invoice` (value: `'invoice'`)
7 |
8 | * `bill` (value: `'bill'`)
9 |
10 | * `expense` (value: `'expense'`)
11 |
12 |
13 | ---
14 |
15 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
16 |
17 |
18 |
--------------------------------------------------------------------------------
/src/gen/docs/models/AuthType.md:
--------------------------------------------------------------------------------
1 | # Apideck.AuthType
2 |
3 | ## Enum
4 |
5 |
6 | * `oauth2` (value: `'oauth2'`)
7 |
8 | * `apiKey` (value: `'apiKey'`)
9 |
10 | * `basic` (value: `'basic'`)
11 |
12 | * `custom` (value: `'custom'`)
13 |
14 | * `none` (value: `'none'`)
15 |
16 |
17 | ---
18 |
19 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
20 |
21 |
22 |
--------------------------------------------------------------------------------
/src/gen/docs/models/BalanceSheet.md:
--------------------------------------------------------------------------------
1 | # Apideck.BalanceSheet
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `reports` | [**Array<BalanceSheetReports>**](BalanceSheetReports.md) | |
9 |
10 |
11 |
12 |
13 |
14 | ## Referenced Types:
15 | * [`BalanceSheetReports`](BalanceSheetReports.md)
16 |
17 | ---
18 |
19 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
20 |
21 |
22 |
--------------------------------------------------------------------------------
/src/gen/docs/models/BalanceSheetAccountRecord.md:
--------------------------------------------------------------------------------
1 | # Apideck.BalanceSheetAccountRecord
2 |
3 | ### Description
4 |
5 | A record of a balance sheet account.
6 |
7 | ## Properties
8 | Name | Type | Description | Notes
9 | ------------ | ------------- | ------------- | -------------
10 | `account_id` | **string** | The unique identifier for the account. | [optional]
11 | `code` | **string** | The account code of the account | [optional]
12 | `name` | **string** | The name of the account. | [optional]
13 | `value` | **number** | The amount or value of the item | [optional]
14 |
15 |
16 |
17 |
18 |
19 | ---
20 |
21 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
22 |
23 |
24 |
--------------------------------------------------------------------------------
/src/gen/docs/models/BalanceSheetAccounts.md:
--------------------------------------------------------------------------------
1 | # Apideck.BalanceSheetAccounts
2 |
3 | ### Description
4 |
5 | A list of balance sheet accounts
6 |
7 | ## Properties
8 | Name | Type | Description | Notes
9 | ------------ | ------------- | ------------- | -------------
10 |
11 |
12 |
13 |
14 |
15 | ---
16 |
17 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
18 |
19 |
20 |
--------------------------------------------------------------------------------
/src/gen/docs/models/Benefit.md:
--------------------------------------------------------------------------------
1 | # Apideck.Benefit
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `name` | **string** | The name of the benefit. | [optional]
9 | `employee_deduction` | **number** | The amount deducted for benefit. | [optional]
10 | `employer_contribution` | **number** | The amount of employer contribution. | [optional]
11 |
12 |
13 |
14 |
15 |
16 | ---
17 |
18 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
19 |
20 |
21 |
--------------------------------------------------------------------------------
/src/gen/docs/models/BillsFilter.md:
--------------------------------------------------------------------------------
1 | # Apideck.BillsFilter
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `updated_since` | **Date** | | [optional]
9 |
10 |
11 |
12 |
13 |
14 | ---
15 |
16 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
17 |
18 |
19 |
--------------------------------------------------------------------------------
/src/gen/docs/models/BillsSort.md:
--------------------------------------------------------------------------------
1 | # Apideck.BillsSort
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `by` | **string** | The field on which to sort the Bills | [optional]
9 | `direction` | [**SortDirection**](SortDirection.md) | | [optional]
10 |
11 |
12 |
13 |
14 |
15 |
16 | ## Enum: BillsSort.by
17 |
18 |
19 | * `updated_at` (value: `'updated_at'`)
20 |
21 | * `created_at` (value: `'created_at'`)
22 |
23 |
24 |
25 |
26 | ## Referenced Types:
27 |
28 | * [`SortDirection`](SortDirection.md)
29 |
30 | ---
31 |
32 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
33 |
34 |
35 |
--------------------------------------------------------------------------------
/src/gen/docs/models/Branch.md:
--------------------------------------------------------------------------------
1 | # Apideck.Branch
2 |
3 | ### Description
4 |
5 | Details of the branch for which the job is created.
6 |
7 | ## Properties
8 | Name | Type | Description | Notes
9 | ------------ | ------------- | ------------- | -------------
10 | `id` | **string** | A unique identifier for an object. | [optional]
11 | `name` | **string** | Name of the branch. | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ---
18 |
19 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
20 |
21 |
22 |
--------------------------------------------------------------------------------
/src/gen/docs/models/CashDetails.md:
--------------------------------------------------------------------------------
1 | # Apideck.CashDetails
2 |
3 | ### Description
4 |
5 | Cash details for this payment
6 |
7 | ## Properties
8 | Name | Type | Description | Notes
9 | ------------ | ------------- | ------------- | -------------
10 | `amount` | **any** | The amount of cash given by the customer. | [optional]
11 | `charge_back_amount` | **any** | The amount of change due back to the buyer. For Square: this read-only field is calculated from the amount_money and buyer_supplied_money fields. | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ---
18 |
19 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
20 |
21 |
22 |
--------------------------------------------------------------------------------
/src/gen/docs/models/CollectionTag.md:
--------------------------------------------------------------------------------
1 | # Apideck.CollectionTag
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `id` | **string** | A unique identifier for an object. |
9 | `name` | **string** | The name of the tag. | [optional]
10 | `custom_mappings` | **object** | When custom mappings are configured on the resource, the result is included here. | [optional]
11 |
12 |
13 |
14 |
15 |
16 | ---
17 |
18 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
19 |
20 |
21 |
--------------------------------------------------------------------------------
/src/gen/docs/models/CollectionsSort.md:
--------------------------------------------------------------------------------
1 | # Apideck.CollectionsSort
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `by` | **string** | The field on which to sort the Collections | [optional]
9 | `direction` | [**SortDirection**](SortDirection.md) | | [optional]
10 |
11 |
12 |
13 |
14 |
15 |
16 | ## Enum: CollectionsSort.by
17 |
18 |
19 | * `name` (value: `'name'`)
20 |
21 | * `created_at` (value: `'created_at'`)
22 |
23 | * `updated_at` (value: `'updated_at'`)
24 |
25 |
26 |
27 |
28 | ## Referenced Types:
29 |
30 | * [`SortDirection`](SortDirection.md)
31 |
32 | ---
33 |
34 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
35 |
36 |
37 |
--------------------------------------------------------------------------------
/src/gen/docs/models/CommentsSort.md:
--------------------------------------------------------------------------------
1 | # Apideck.CommentsSort
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `by` | **string** | The field on which to sort the Comments | [optional]
9 | `direction` | [**SortDirection**](SortDirection.md) | | [optional]
10 |
11 |
12 |
13 |
14 |
15 |
16 | ## Enum: CommentsSort.by
17 |
18 |
19 | * `created_at` (value: `'created_at'`)
20 |
21 | * `updated_at` (value: `'updated_at'`)
22 |
23 |
24 |
25 |
26 | ## Referenced Types:
27 |
28 | * [`SortDirection`](SortDirection.md)
29 |
30 | ---
31 |
32 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
33 |
34 |
35 |
--------------------------------------------------------------------------------
/src/gen/docs/models/CompaniesFilter.md:
--------------------------------------------------------------------------------
1 | # Apideck.CompaniesFilter
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `name` | **string** | Name of the company to filter on | [optional]
9 |
10 |
11 |
12 |
13 |
14 | ---
15 |
16 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
17 |
18 |
19 |
--------------------------------------------------------------------------------
/src/gen/docs/models/CompaniesSort.md:
--------------------------------------------------------------------------------
1 | # Apideck.CompaniesSort
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `by` | **string** | The field on which to sort the Companies | [optional]
9 | `direction` | [**SortDirection**](SortDirection.md) | | [optional]
10 |
11 |
12 |
13 |
14 |
15 |
16 | ## Enum: CompaniesSort.by
17 |
18 |
19 | * `created_at` (value: `'created_at'`)
20 |
21 | * `updated_at` (value: `'updated_at'`)
22 |
23 | * `name` (value: `'name'`)
24 |
25 |
26 |
27 |
28 | ## Referenced Types:
29 |
30 | * [`SortDirection`](SortDirection.md)
31 |
32 | ---
33 |
34 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
35 |
36 |
37 |
--------------------------------------------------------------------------------
/src/gen/docs/models/CompanyRowType.md:
--------------------------------------------------------------------------------
1 | # Apideck.CompanyRowType
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `id` | **string** | | [optional]
9 | `name` | **string** | | [optional]
10 |
11 |
12 |
13 |
14 |
15 | ---
16 |
17 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
18 |
19 |
20 |
--------------------------------------------------------------------------------
/src/gen/docs/models/ConnectionConfiguration.md:
--------------------------------------------------------------------------------
1 | # Apideck.ConnectionConfiguration
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `resource` | **string** | | [optional]
9 | `defaults` | [**Array<ConnectionDefaults>**](ConnectionDefaults.md) | | [optional]
10 |
11 |
12 |
13 |
14 |
15 | ## Referenced Types:
16 |
17 | * [`ConnectionDefaults`](ConnectionDefaults.md)
18 |
19 | ---
20 |
21 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
22 |
23 |
24 |
--------------------------------------------------------------------------------
/src/gen/docs/models/ConnectionImportData.md:
--------------------------------------------------------------------------------
1 | # Apideck.ConnectionImportData
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `credentials` | [**ConnectionImportDataCredentials**](ConnectionImportDataCredentials.md) | | [optional]
9 | `settings` | **object** | Connection settings. Values will persist to `form_fields` with corresponding id | [optional]
10 | `metadata` | **{ [key: string]: object; }** | Attach your own consumer specific metadata | [optional]
11 |
12 |
13 |
14 |
15 |
16 | ## Referenced Types:
17 | * [`ConnectionImportDataCredentials`](ConnectionImportDataCredentials.md)
18 |
19 |
20 |
21 | ---
22 |
23 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
24 |
25 |
26 |
--------------------------------------------------------------------------------
/src/gen/docs/models/ConnectionImportDataCredentials.md:
--------------------------------------------------------------------------------
1 | # Apideck.ConnectionImportDataCredentials
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `refresh_token` | **string** | The refresh token can be used to obtain a new access token. | [optional]
9 | `access_token` | **string** | Access token | [optional]
10 | `issued_at` | **Date** | The datetime at which the token was issued. If omitted the token will be queued for refresh. | [optional]
11 | `expires_in` | **number** | The number of seconds until the token expires. If omitted the token will be queued for refresh. | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ---
18 |
19 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
20 |
21 |
22 |
--------------------------------------------------------------------------------
/src/gen/docs/models/ConnectionMetadata.md:
--------------------------------------------------------------------------------
1 | # Apideck.ConnectionMetadata
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `id` | **string** | | [optional]
9 | `name` | **string** | | [optional]
10 |
11 |
12 |
13 |
14 |
15 | ---
16 |
17 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
18 |
19 |
20 |
--------------------------------------------------------------------------------
/src/gen/docs/models/ConnectionState.md:
--------------------------------------------------------------------------------
1 | # Apideck.ConnectionState
2 |
3 | ## Enum
4 |
5 |
6 | * `available` (value: `'available'`)
7 |
8 | * `callable` (value: `'callable'`)
9 |
10 | * `added` (value: `'added'`)
11 |
12 | * `authorized` (value: `'authorized'`)
13 |
14 | * `invalid` (value: `'invalid'`)
15 |
16 |
17 | ---
18 |
19 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
20 |
21 |
22 |
--------------------------------------------------------------------------------
/src/gen/docs/models/ConnectorOauthScopes.md:
--------------------------------------------------------------------------------
1 | # Apideck.ConnectorOauthScopes
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `id` | **string** | ID of the OAuth scope. | [optional]
9 | `label` | **string** | Label of the OAuth scope. | [optional]
10 | `default_apis` | **Array<string>** | List of Unified APIs that request this OAuth Scope by default. Application owners can customize the requested scopes. | [optional]
11 |
12 |
13 |
14 |
15 |
16 | ---
17 |
18 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
19 |
20 |
21 |
--------------------------------------------------------------------------------
/src/gen/docs/models/ConnectorOauthScopes1.md:
--------------------------------------------------------------------------------
1 | # Apideck.ConnectorOauthScopes1
2 |
3 | ### Description
4 |
5 | OAuth scopes required for the connector. Add these scopes to your OAuth app.
6 |
7 | ## Properties
8 | Name | Type | Description | Notes
9 | ------------ | ------------- | ------------- | -------------
10 | `id` | **string** | ID of the OAuth scope. | [optional]
11 | `label` | **string** | Label of the OAuth scope. | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ---
18 |
19 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
20 |
21 |
22 |
--------------------------------------------------------------------------------
/src/gen/docs/models/ConnectorStatus.md:
--------------------------------------------------------------------------------
1 | # Apideck.ConnectorStatus
2 |
3 | ## Enum
4 |
5 |
6 | * `live` (value: `'live'`)
7 |
8 | * `beta` (value: `'beta'`)
9 |
10 | * `development` (value: `'development'`)
11 |
12 | * `considering` (value: `'considering'`)
13 |
14 |
15 | ---
16 |
17 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
18 |
19 |
20 |
--------------------------------------------------------------------------------
/src/gen/docs/models/ConnectorTlsSupport.md:
--------------------------------------------------------------------------------
1 | # Apideck.ConnectorTlsSupport
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `type` | **string** | | [optional]
9 | `description` | **string** | Description of the TLS support | [optional]
10 |
11 |
12 |
13 |
14 |
15 | ---
16 |
17 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
18 |
19 |
20 |
--------------------------------------------------------------------------------
/src/gen/docs/models/ConnectorsFilter.md:
--------------------------------------------------------------------------------
1 | # Apideck.ConnectorsFilter
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `unified_api` | [**UnifiedApiId**](UnifiedApiId.md) | | [optional]
9 | `status` | [**ConnectorStatus**](ConnectorStatus.md) | | [optional]
10 |
11 |
12 |
13 |
14 |
15 | ## Referenced Types:
16 | * [`UnifiedApiId`](UnifiedApiId.md)
17 | * [`ConnectorStatus`](ConnectorStatus.md)
18 |
19 | ---
20 |
21 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
22 |
23 |
24 |
--------------------------------------------------------------------------------
/src/gen/docs/models/ConsumerMetadata.md:
--------------------------------------------------------------------------------
1 | # Apideck.ConsumerMetadata
2 |
3 | ### Description
4 |
5 | The metadata of the consumer. This is used to display the consumer in the sidebar. This is optional, but recommended.
6 |
7 | ## Properties
8 | Name | Type | Description | Notes
9 | ------------ | ------------- | ------------- | -------------
10 | `account_name` | **string** | The name of the account as shown in the sidebar. | [optional]
11 | `user_name` | **string** | The name of the user as shown in the sidebar. | [optional]
12 | `email` | **string** | The email of the user as shown in the sidebar. | [optional]
13 | `image` | **string** | The avatar of the user in the sidebar. Must be a valid URL | [optional]
14 |
15 |
16 |
17 |
18 |
19 | ---
20 |
21 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
22 |
23 |
24 |
--------------------------------------------------------------------------------
/src/gen/docs/models/ConsumerRequestCountsInDateRangeResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.ConsumerRequestCountsInDateRangeResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `data` | [**ConsumerRequestCountsInDateRangeResponseData**](ConsumerRequestCountsInDateRangeResponseData.md) | |
11 | `_raw` | [**Raw**](Raw.md) | | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ## Referenced Types:
18 |
19 |
20 | * [`ConsumerRequestCountsInDateRangeResponseData`](ConsumerRequestCountsInDateRangeResponseData.md)
21 | * [`Raw`](Raw.md)
22 |
23 | ---
24 |
25 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
26 |
27 |
28 |
--------------------------------------------------------------------------------
/src/gen/docs/models/CreateAttachmentRequest.md:
--------------------------------------------------------------------------------
1 | # Apideck.CreateAttachmentRequest
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `name` | **string** | The name of the file |
9 | `description` | **string** | Optional description of the file. | [optional]
10 | `parent_folder_id` | **string** | The folder id where this attachment belong to | [optional]
11 | `pass_through` | [**PassThroughBody**](PassThroughBody.md) | | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ## Referenced Types:
18 |
19 |
20 |
21 | * [`PassThroughBody`](PassThroughBody.md)
22 |
23 | ---
24 |
25 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
26 |
27 |
28 |
--------------------------------------------------------------------------------
/src/gen/docs/models/CreateBillResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.CreateBillResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `service` | **string** | Apideck ID of service provider |
11 | `resource` | **string** | Unified API resource name |
12 | `operation` | **string** | Operation performed |
13 | `data` | [**UnifiedId**](UnifiedId.md) | |
14 | `_raw` | [**Raw**](Raw.md) | | [optional]
15 |
16 |
17 |
18 |
19 |
20 | ## Referenced Types:
21 |
22 |
23 |
24 |
25 |
26 | * [`UnifiedId`](UnifiedId.md)
27 | * [`Raw`](Raw.md)
28 |
29 | ---
30 |
31 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
32 |
33 |
34 |
--------------------------------------------------------------------------------
/src/gen/docs/models/CreateCallbackState.md:
--------------------------------------------------------------------------------
1 | # Apideck.CreateCallbackState
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `redirect_uri` | **string** | The redirect URI to be used after the connection is created. | [optional]
9 |
10 |
11 |
12 |
13 |
14 | ---
15 |
16 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
17 |
18 |
19 |
--------------------------------------------------------------------------------
/src/gen/docs/models/CreateCallbackStateResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.CreateCallbackStateResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `data` | [**CreateCallbackStateResponseData**](CreateCallbackStateResponseData.md) | |
11 | `_raw` | [**Raw**](Raw.md) | | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ## Referenced Types:
18 |
19 |
20 | * [`CreateCallbackStateResponseData`](CreateCallbackStateResponseData.md)
21 | * [`Raw`](Raw.md)
22 |
23 | ---
24 |
25 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
26 |
27 |
28 |
--------------------------------------------------------------------------------
/src/gen/docs/models/CreateCallbackStateResponseData.md:
--------------------------------------------------------------------------------
1 | # Apideck.CreateCallbackStateResponseData
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `state` | **string** | Callback state | [optional]
9 |
10 |
11 |
12 |
13 |
14 | ---
15 |
16 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
17 |
18 |
19 |
--------------------------------------------------------------------------------
/src/gen/docs/models/CreateConnectionResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.CreateConnectionResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `data` | [**Connection**](Connection.md) | |
11 | `_raw` | [**Raw**](Raw.md) | | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ## Referenced Types:
18 |
19 |
20 | * [`Connection`](Connection.md)
21 | * [`Raw`](Raw.md)
22 |
23 | ---
24 |
25 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
26 |
27 |
28 |
--------------------------------------------------------------------------------
/src/gen/docs/models/CreateConsumerResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.CreateConsumerResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `data` | [**Consumer**](Consumer.md) | |
11 | `_raw` | [**Raw**](Raw.md) | | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ## Referenced Types:
18 |
19 |
20 | * [`Consumer`](Consumer.md)
21 | * [`Raw`](Raw.md)
22 |
23 | ---
24 |
25 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
26 |
27 |
28 |
--------------------------------------------------------------------------------
/src/gen/docs/models/CreateCustomMappingRequest.md:
--------------------------------------------------------------------------------
1 | # Apideck.CreateCustomMappingRequest
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `value` | **string** | Target Field Mapping value |
9 |
10 |
11 |
12 |
13 |
14 | ---
15 |
16 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
17 |
18 |
19 |
--------------------------------------------------------------------------------
/src/gen/docs/models/CreateCustomMappingResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.CreateCustomMappingResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `data` | [**CustomMapping**](CustomMapping.md) | |
11 | `_raw` | [**Raw**](Raw.md) | | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ## Referenced Types:
18 |
19 |
20 | * [`CustomMapping`](CustomMapping.md)
21 | * [`Raw`](Raw.md)
22 |
23 | ---
24 |
25 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
26 |
27 |
28 |
--------------------------------------------------------------------------------
/src/gen/docs/models/CreateDriveResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.CreateDriveResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `service` | **string** | Apideck ID of service provider |
11 | `resource` | **string** | Unified API resource name |
12 | `operation` | **string** | Operation performed |
13 | `data` | [**UnifiedId**](UnifiedId.md) | |
14 | `_raw` | [**Raw**](Raw.md) | | [optional]
15 |
16 |
17 |
18 |
19 |
20 | ## Referenced Types:
21 |
22 |
23 |
24 |
25 |
26 | * [`UnifiedId`](UnifiedId.md)
27 | * [`Raw`](Raw.md)
28 |
29 | ---
30 |
31 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
32 |
33 |
34 |
--------------------------------------------------------------------------------
/src/gen/docs/models/CreateFileResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.CreateFileResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `service` | **string** | Apideck ID of service provider |
11 | `resource` | **string** | Unified API resource name |
12 | `operation` | **string** | Operation performed |
13 | `data` | [**UnifiedId**](UnifiedId.md) | |
14 | `_raw` | [**Raw**](Raw.md) | | [optional]
15 |
16 |
17 |
18 |
19 |
20 | ## Referenced Types:
21 |
22 |
23 |
24 |
25 |
26 | * [`UnifiedId`](UnifiedId.md)
27 | * [`Raw`](Raw.md)
28 |
29 | ---
30 |
31 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
32 |
33 |
34 |
--------------------------------------------------------------------------------
/src/gen/docs/models/CreateItemResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.CreateItemResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `service` | **string** | Apideck ID of service provider |
11 | `resource` | **string** | Unified API resource name |
12 | `operation` | **string** | Operation performed |
13 | `data` | [**UnifiedId**](UnifiedId.md) | |
14 | `_raw` | [**Raw**](Raw.md) | | [optional]
15 |
16 |
17 |
18 |
19 |
20 | ## Referenced Types:
21 |
22 |
23 |
24 |
25 |
26 | * [`UnifiedId`](UnifiedId.md)
27 | * [`Raw`](Raw.md)
28 |
29 | ---
30 |
31 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
32 |
33 |
34 |
--------------------------------------------------------------------------------
/src/gen/docs/models/CreateJobResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.CreateJobResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `service` | **string** | Apideck ID of service provider |
11 | `resource` | **string** | Unified API resource name |
12 | `operation` | **string** | Operation performed |
13 | `data` | [**UnifiedId**](UnifiedId.md) | |
14 | `_raw` | [**Raw**](Raw.md) | | [optional]
15 |
16 |
17 |
18 |
19 |
20 | ## Referenced Types:
21 |
22 |
23 |
24 |
25 |
26 | * [`UnifiedId`](UnifiedId.md)
27 | * [`Raw`](Raw.md)
28 |
29 | ---
30 |
31 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
32 |
33 |
34 |
--------------------------------------------------------------------------------
/src/gen/docs/models/CreateLeadResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.CreateLeadResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `service` | **string** | Apideck ID of service provider |
11 | `resource` | **string** | Unified API resource name |
12 | `operation` | **string** | Operation performed |
13 | `data` | [**UnifiedId**](UnifiedId.md) | |
14 | `_raw` | [**Raw**](Raw.md) | | [optional]
15 |
16 |
17 |
18 |
19 |
20 | ## Referenced Types:
21 |
22 |
23 |
24 |
25 |
26 | * [`UnifiedId`](UnifiedId.md)
27 | * [`Raw`](Raw.md)
28 |
29 | ---
30 |
31 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
32 |
33 |
34 |
--------------------------------------------------------------------------------
/src/gen/docs/models/CreateNoteResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.CreateNoteResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `service` | **string** | Apideck ID of service provider |
11 | `resource` | **string** | Unified API resource name |
12 | `operation` | **string** | Operation performed |
13 | `data` | [**UnifiedId**](UnifiedId.md) | |
14 | `_raw` | [**Raw**](Raw.md) | | [optional]
15 |
16 |
17 |
18 |
19 |
20 | ## Referenced Types:
21 |
22 |
23 |
24 |
25 |
26 | * [`UnifiedId`](UnifiedId.md)
27 | * [`Raw`](Raw.md)
28 |
29 | ---
30 |
31 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
32 |
33 |
34 |
--------------------------------------------------------------------------------
/src/gen/docs/models/CreateOrderResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.CreateOrderResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `service` | **string** | Apideck ID of service provider |
11 | `resource` | **string** | Unified API resource name |
12 | `operation` | **string** | Operation performed |
13 | `data` | [**UnifiedId**](UnifiedId.md) | |
14 | `_raw` | [**Raw**](Raw.md) | | [optional]
15 |
16 |
17 |
18 |
19 |
20 | ## Referenced Types:
21 |
22 |
23 |
24 |
25 |
26 | * [`UnifiedId`](UnifiedId.md)
27 | * [`Raw`](Raw.md)
28 |
29 | ---
30 |
31 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
32 |
33 |
34 |
--------------------------------------------------------------------------------
/src/gen/docs/models/CreateSessionResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.CreateSessionResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `data` | [**CreateSessionResponseData**](CreateSessionResponseData.md) | |
11 | `_raw` | [**Raw**](Raw.md) | | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ## Referenced Types:
18 |
19 |
20 | * [`CreateSessionResponseData`](CreateSessionResponseData.md)
21 | * [`Raw`](Raw.md)
22 |
23 | ---
24 |
25 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
26 |
27 |
28 |
--------------------------------------------------------------------------------
/src/gen/docs/models/CreateSessionResponseData.md:
--------------------------------------------------------------------------------
1 | # Apideck.CreateSessionResponseData
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `session_uri` | **string** | |
9 | `session_token` | **string** | |
10 |
11 |
12 |
13 |
14 |
15 | ---
16 |
17 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
18 |
19 |
20 |
--------------------------------------------------------------------------------
/src/gen/docs/models/CreateUserResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.CreateUserResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `service` | **string** | Apideck ID of service provider |
11 | `resource` | **string** | Unified API resource name |
12 | `operation` | **string** | Operation performed |
13 | `data` | [**UnifiedId**](UnifiedId.md) | |
14 | `_raw` | [**Raw**](Raw.md) | | [optional]
15 |
16 |
17 |
18 |
19 |
20 | ## Referenced Types:
21 |
22 |
23 |
24 |
25 |
26 | * [`UnifiedId`](UnifiedId.md)
27 | * [`Raw`](Raw.md)
28 |
29 | ---
30 |
31 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
32 |
33 |
34 |
--------------------------------------------------------------------------------
/src/gen/docs/models/CreateWebhookResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.CreateWebhookResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `data` | [**Webhook**](Webhook.md) | |
11 | `_raw` | [**Raw**](Raw.md) | | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ## Referenced Types:
18 |
19 |
20 | * [`Webhook`](Webhook.md)
21 | * [`Raw`](Raw.md)
22 |
23 | ---
24 |
25 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
26 |
27 |
28 |
--------------------------------------------------------------------------------
/src/gen/docs/models/CreditNotesFilter.md:
--------------------------------------------------------------------------------
1 | # Apideck.CreditNotesFilter
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `updated_since` | **Date** | | [optional]
9 |
10 |
11 |
12 |
13 |
14 | ---
15 |
16 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
17 |
18 |
19 |
--------------------------------------------------------------------------------
/src/gen/docs/models/CreditNotesSort.md:
--------------------------------------------------------------------------------
1 | # Apideck.CreditNotesSort
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `by` | **string** | The field on which to sort the Customers | [optional]
9 | `direction` | [**SortDirection**](SortDirection.md) | | [optional]
10 |
11 |
12 |
13 |
14 |
15 |
16 | ## Enum: CreditNotesSort.by
17 |
18 |
19 | * `created_at` (value: `'created_at'`)
20 |
21 | * `updated_at` (value: `'updated_at'`)
22 |
23 |
24 |
25 |
26 | ## Referenced Types:
27 |
28 | * [`SortDirection`](SortDirection.md)
29 |
30 | ---
31 |
32 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
33 |
34 |
35 |
--------------------------------------------------------------------------------
/src/gen/docs/models/CustomField.md:
--------------------------------------------------------------------------------
1 | # Apideck.CustomField
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `id` | **string** | Unique identifier for the custom field. |
9 | `name` | **string** | Name of the custom field. | [optional]
10 | `description` | **string** | More information about the custom field | [optional]
11 | `value` | **string \| number \| boolean \| object \| Array<string> \| Array<object>** | | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ---
18 |
19 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
20 |
21 |
22 |
--------------------------------------------------------------------------------
/src/gen/docs/models/CustomFieldFinder.md:
--------------------------------------------------------------------------------
1 | # Apideck.CustomFieldFinder
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `id` | **string** | Custom Field ID | [optional]
9 | `name` | **string** | Custom Field name to use as a label if provided | [optional]
10 | `description` | **string** | More information about the custom field | [optional]
11 | `value` | **any** | Custom Field value | [optional]
12 | `finder` | **string** | JSONPath finder for retrieving this value when mapping a response payload from downstream | [optional]
13 |
14 |
15 |
16 |
17 |
18 | ---
19 |
20 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
21 |
22 |
23 |
--------------------------------------------------------------------------------
/src/gen/docs/models/CustomersSort.md:
--------------------------------------------------------------------------------
1 | # Apideck.CustomersSort
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `by` | **string** | The field on which to sort the Customers | [optional]
9 | `direction` | [**SortDirection**](SortDirection.md) | | [optional]
10 |
11 |
12 |
13 |
14 |
15 |
16 | ## Enum: CustomersSort.by
17 |
18 |
19 | * `created_at` (value: `'created_at'`)
20 |
21 | * `updated_at` (value: `'updated_at'`)
22 |
23 |
24 |
25 |
26 | ## Referenced Types:
27 |
28 | * [`SortDirection`](SortDirection.md)
29 |
30 | ---
31 |
32 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
33 |
34 |
35 |
--------------------------------------------------------------------------------
/src/gen/docs/models/Deduction.md:
--------------------------------------------------------------------------------
1 | # Apideck.Deduction
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `name` | **string** | The name of the deduction. | [optional]
9 | `amount` | **number** | The amount deducted. | [optional]
10 |
11 |
12 |
13 |
14 |
15 | ---
16 |
17 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
18 |
19 |
20 |
--------------------------------------------------------------------------------
/src/gen/docs/models/DeleteBillResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.DeleteBillResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `service` | **string** | Apideck ID of service provider |
11 | `resource` | **string** | Unified API resource name |
12 | `operation` | **string** | Operation performed |
13 | `data` | [**UnifiedId**](UnifiedId.md) | |
14 | `_raw` | [**Raw**](Raw.md) | | [optional]
15 |
16 |
17 |
18 |
19 |
20 | ## Referenced Types:
21 |
22 |
23 |
24 |
25 |
26 | * [`UnifiedId`](UnifiedId.md)
27 | * [`Raw`](Raw.md)
28 |
29 | ---
30 |
31 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
32 |
33 |
34 |
--------------------------------------------------------------------------------
/src/gen/docs/models/DeleteConsumerResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.DeleteConsumerResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `data` | **object** | |
11 | `_raw` | [**Raw**](Raw.md) | | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ## Referenced Types:
18 |
19 |
20 |
21 | * [`Raw`](Raw.md)
22 |
23 | ---
24 |
25 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
26 |
27 |
28 |
--------------------------------------------------------------------------------
/src/gen/docs/models/DeleteDriveResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.DeleteDriveResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `service` | **string** | Apideck ID of service provider |
11 | `resource` | **string** | Unified API resource name |
12 | `operation` | **string** | Operation performed |
13 | `data` | [**UnifiedId**](UnifiedId.md) | |
14 | `_raw` | [**Raw**](Raw.md) | | [optional]
15 |
16 |
17 |
18 |
19 |
20 | ## Referenced Types:
21 |
22 |
23 |
24 |
25 |
26 | * [`UnifiedId`](UnifiedId.md)
27 | * [`Raw`](Raw.md)
28 |
29 | ---
30 |
31 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
32 |
33 |
34 |
--------------------------------------------------------------------------------
/src/gen/docs/models/DeleteFileResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.DeleteFileResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `service` | **string** | Apideck ID of service provider |
11 | `resource` | **string** | Unified API resource name |
12 | `operation` | **string** | Operation performed |
13 | `data` | [**UnifiedId**](UnifiedId.md) | |
14 | `_raw` | [**Raw**](Raw.md) | | [optional]
15 |
16 |
17 |
18 |
19 |
20 | ## Referenced Types:
21 |
22 |
23 |
24 |
25 |
26 | * [`UnifiedId`](UnifiedId.md)
27 | * [`Raw`](Raw.md)
28 |
29 | ---
30 |
31 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
32 |
33 |
34 |
--------------------------------------------------------------------------------
/src/gen/docs/models/DeleteItemResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.DeleteItemResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `service` | **string** | Apideck ID of service provider |
11 | `resource` | **string** | Unified API resource name |
12 | `operation` | **string** | Operation performed |
13 | `data` | [**UnifiedId**](UnifiedId.md) | |
14 | `_raw` | [**Raw**](Raw.md) | | [optional]
15 |
16 |
17 |
18 |
19 |
20 | ## Referenced Types:
21 |
22 |
23 |
24 |
25 |
26 | * [`UnifiedId`](UnifiedId.md)
27 | * [`Raw`](Raw.md)
28 |
29 | ---
30 |
31 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
32 |
33 |
34 |
--------------------------------------------------------------------------------
/src/gen/docs/models/DeleteJobResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.DeleteJobResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `service` | **string** | Apideck ID of service provider |
11 | `resource` | **string** | Unified API resource name |
12 | `operation` | **string** | Operation performed |
13 | `data` | [**UnifiedId**](UnifiedId.md) | |
14 | `_raw` | [**Raw**](Raw.md) | | [optional]
15 |
16 |
17 |
18 |
19 |
20 | ## Referenced Types:
21 |
22 |
23 |
24 |
25 |
26 | * [`UnifiedId`](UnifiedId.md)
27 | * [`Raw`](Raw.md)
28 |
29 | ---
30 |
31 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
32 |
33 |
34 |
--------------------------------------------------------------------------------
/src/gen/docs/models/DeleteLeadResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.DeleteLeadResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `service` | **string** | Apideck ID of service provider |
11 | `resource` | **string** | Unified API resource name |
12 | `operation` | **string** | Operation performed |
13 | `data` | [**UnifiedId**](UnifiedId.md) | |
14 | `_raw` | [**Raw**](Raw.md) | | [optional]
15 |
16 |
17 |
18 |
19 |
20 | ## Referenced Types:
21 |
22 |
23 |
24 |
25 |
26 | * [`UnifiedId`](UnifiedId.md)
27 | * [`Raw`](Raw.md)
28 |
29 | ---
30 |
31 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
32 |
33 |
34 |
--------------------------------------------------------------------------------
/src/gen/docs/models/DeleteNoteResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.DeleteNoteResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `service` | **string** | Apideck ID of service provider |
11 | `resource` | **string** | Unified API resource name |
12 | `operation` | **string** | Operation performed |
13 | `data` | [**UnifiedId**](UnifiedId.md) | |
14 | `_raw` | [**Raw**](Raw.md) | | [optional]
15 |
16 |
17 |
18 |
19 |
20 | ## Referenced Types:
21 |
22 |
23 |
24 |
25 |
26 | * [`UnifiedId`](UnifiedId.md)
27 | * [`Raw`](Raw.md)
28 |
29 | ---
30 |
31 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
32 |
33 |
34 |
--------------------------------------------------------------------------------
/src/gen/docs/models/DeleteOrderResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.DeleteOrderResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `service` | **string** | Apideck ID of service provider |
11 | `resource` | **string** | Unified API resource name |
12 | `operation` | **string** | Operation performed |
13 | `data` | [**UnifiedId**](UnifiedId.md) | |
14 | `_raw` | [**Raw**](Raw.md) | | [optional]
15 |
16 |
17 |
18 |
19 |
20 | ## Referenced Types:
21 |
22 |
23 |
24 |
25 |
26 | * [`UnifiedId`](UnifiedId.md)
27 | * [`Raw`](Raw.md)
28 |
29 | ---
30 |
31 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
32 |
33 |
34 |
--------------------------------------------------------------------------------
/src/gen/docs/models/DeleteUserResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.DeleteUserResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `service` | **string** | Apideck ID of service provider |
11 | `resource` | **string** | Unified API resource name |
12 | `operation` | **string** | Operation performed |
13 | `data` | [**UnifiedId**](UnifiedId.md) | |
14 | `_raw` | [**Raw**](Raw.md) | | [optional]
15 |
16 |
17 |
18 |
19 |
20 | ## Referenced Types:
21 |
22 |
23 |
24 |
25 |
26 | * [`UnifiedId`](UnifiedId.md)
27 | * [`Raw`](Raw.md)
28 |
29 | ---
30 |
31 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
32 |
33 |
34 |
--------------------------------------------------------------------------------
/src/gen/docs/models/DeleteWebhookResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.DeleteWebhookResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `data` | [**Webhook**](Webhook.md) | |
11 | `_raw` | [**Raw**](Raw.md) | | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ## Referenced Types:
18 |
19 |
20 | * [`Webhook`](Webhook.md)
21 | * [`Raw`](Raw.md)
22 |
23 | ---
24 |
25 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
26 |
27 |
28 |
--------------------------------------------------------------------------------
/src/gen/docs/models/DeprecatedLinkedTrackingCategory.md:
--------------------------------------------------------------------------------
1 | # Apideck.DeprecatedLinkedTrackingCategory
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `id` | **string** | The unique identifier for the tracking category. | [optional]
9 | `name` | **string** | The name of the tracking category. | [optional]
10 |
11 |
12 |
13 |
14 |
15 | ---
16 |
17 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
18 |
19 |
20 |
--------------------------------------------------------------------------------
/src/gen/docs/models/DriveGroupsFilter.md:
--------------------------------------------------------------------------------
1 | # Apideck.DriveGroupsFilter
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `parent_group_id` | **string** | ID of the drive group to filter on | [optional]
9 |
10 |
11 |
12 |
13 |
14 | ---
15 |
16 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
17 |
18 |
19 |
--------------------------------------------------------------------------------
/src/gen/docs/models/DrivesFilter.md:
--------------------------------------------------------------------------------
1 | # Apideck.DrivesFilter
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `group_id` | **string** | ID of the drive group to filter on | [optional]
9 |
10 |
11 |
12 |
13 |
14 | ---
15 |
16 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
17 |
18 |
19 |
--------------------------------------------------------------------------------
/src/gen/docs/models/EcommerceCustomersFilter.md:
--------------------------------------------------------------------------------
1 | # Apideck.EcommerceCustomersFilter
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `email` | **string** | Customer email address to filter on | [optional]
9 | `phone_number` | **string** | Customer phone number to filter on | [optional]
10 |
11 |
12 |
13 |
14 |
15 | ---
16 |
17 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
18 |
19 |
20 |
--------------------------------------------------------------------------------
/src/gen/docs/models/EcommerceDiscount.md:
--------------------------------------------------------------------------------
1 | # Apideck.EcommerceDiscount
2 |
3 | ### Description
4 |
5 | An object representing a discount applied to an ecommerce order or product.
6 |
7 | ## Properties
8 | Name | Type | Description | Notes
9 | ------------ | ------------- | ------------- | -------------
10 | `code` | **string** | The code used to apply the discount. | [optional]
11 | `amount` | **string** | The fixed amount of the discount. | [optional]
12 | `percentage` | **string** | The percentage of the discount. | [optional]
13 |
14 |
15 |
16 |
17 |
18 | ---
19 |
20 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
21 |
22 |
23 |
--------------------------------------------------------------------------------
/src/gen/docs/models/EcommerceOrderStatus.md:
--------------------------------------------------------------------------------
1 | # Apideck.EcommerceOrderStatus
2 |
3 | ## Enum
4 |
5 |
6 | * `active` (value: `'active'`)
7 |
8 | * `completed` (value: `'completed'`)
9 |
10 | * `cancelled` (value: `'cancelled'`)
11 |
12 | * `archived` (value: `'archived'`)
13 |
14 | * `unknown` (value: `'unknown'`)
15 |
16 | * `other` (value: `'other'`)
17 |
18 |
19 | ---
20 |
21 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
22 |
23 |
24 |
--------------------------------------------------------------------------------
/src/gen/docs/models/EcommerceOrdersFilter.md:
--------------------------------------------------------------------------------
1 | # Apideck.EcommerceOrdersFilter
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `email` | **string** | Customer email address to filter on | [optional]
9 | `customer_id` | **string** | Customer id to filter on | [optional]
10 | `updated_since` | **string** | Minimum date the order was last modified | [optional]
11 | `created_since` | **string** | Minimum date the order was created | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ---
18 |
19 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
20 |
21 |
22 |
--------------------------------------------------------------------------------
/src/gen/docs/models/EcommerceProductCategories.md:
--------------------------------------------------------------------------------
1 | # Apideck.EcommerceProductCategories
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `id` | **string** | A unique identifier for an object. | [optional]
9 | `name` | **string** | The name of the category. | [optional]
10 |
11 |
12 |
13 |
14 |
15 | ---
16 |
17 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
18 |
19 |
20 |
--------------------------------------------------------------------------------
/src/gen/docs/models/EcommerceProductImages.md:
--------------------------------------------------------------------------------
1 | # Apideck.EcommerceProductImages
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `id` | **string** | A unique identifier for an object. | [optional]
9 | `url` | **string** | The URL of an image of the product. | [optional]
10 |
11 |
12 |
13 |
14 |
15 | ---
16 |
17 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
18 |
19 |
20 |
--------------------------------------------------------------------------------
/src/gen/docs/models/EcommerceProductImages1.md:
--------------------------------------------------------------------------------
1 | # Apideck.EcommerceProductImages1
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `id` | **string** | A unique identifier for an object. | [optional]
9 | `url` | **string** | The URL of an image of the variant. | [optional]
10 |
11 |
12 |
13 |
14 |
15 | ---
16 |
17 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
18 |
19 |
20 |
--------------------------------------------------------------------------------
/src/gen/docs/models/EcommerceProductOptions.md:
--------------------------------------------------------------------------------
1 | # Apideck.EcommerceProductOptions
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `id` | **string** | A unique identifier for the option of the product. | [optional]
9 | `name` | **string** | The name of the option for the product. | [optional]
10 | `values` | **Array<string>** | | [optional]
11 |
12 |
13 |
14 |
15 |
16 | ---
17 |
18 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
19 |
20 |
21 |
--------------------------------------------------------------------------------
/src/gen/docs/models/EcommerceProductOptions1.md:
--------------------------------------------------------------------------------
1 | # Apideck.EcommerceProductOptions1
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `id` | **string** | A unique identifier for the option of the variant. | [optional]
9 | `name` | **string** | The name of the option for the variant. | [optional]
10 | `value` | **string** | The value of the option for the variant. | [optional]
11 |
12 |
13 |
14 |
15 |
16 | ---
17 |
18 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
19 |
20 |
21 |
--------------------------------------------------------------------------------
/src/gen/docs/models/Email.md:
--------------------------------------------------------------------------------
1 | # Apideck.Email
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `email` | **string** | Email address |
9 | `id` | **string** | Unique identifier for the email address | [optional]
10 | `type` | **string** | Email type | [optional]
11 |
12 |
13 |
14 |
15 |
16 |
17 | ## Enum: Email.type
18 |
19 |
20 | * `primary` (value: `'primary'`)
21 |
22 | * `secondary` (value: `'secondary'`)
23 |
24 | * `work` (value: `'work'`)
25 |
26 | * `personal` (value: `'personal'`)
27 |
28 | * `billing` (value: `'billing'`)
29 |
30 | * `other` (value: `'other'`)
31 |
32 |
33 |
34 |
35 | ---
36 |
37 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
38 |
39 |
40 |
--------------------------------------------------------------------------------
/src/gen/docs/models/EmployeeList.md:
--------------------------------------------------------------------------------
1 | # Apideck.EmployeeList
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `id` | **string** | A unique identifier for an object. | [optional]
9 | `first_name` | **string** | The first name of the person. | [optional]
10 | `last_name` | **string** | The last name of the person. | [optional]
11 | `updated_at` | **Date** | The date and time when the object was last updated. | [optional]
12 | `created_at` | **Date** | The date and time when the object was created. | [optional]
13 |
14 |
15 |
16 |
17 |
18 | ---
19 |
20 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
21 |
22 |
23 |
--------------------------------------------------------------------------------
/src/gen/docs/models/EmployeeSchedules.md:
--------------------------------------------------------------------------------
1 | # Apideck.EmployeeSchedules
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `employee` | [**Employee**](Employee.md) | | [optional]
9 | `schedules` | [**Array<Schedule>**](Schedule.md) | | [optional]
10 |
11 |
12 |
13 |
14 |
15 | ## Referenced Types:
16 | * [`Employee`](Employee.md)
17 | * [`Schedule`](Schedule.md)
18 |
19 | ---
20 |
21 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
22 |
23 |
24 |
--------------------------------------------------------------------------------
/src/gen/docs/models/EmployeesOneFilter.md:
--------------------------------------------------------------------------------
1 | # Apideck.EmployeesOneFilter
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `company_id` | **string** | Company ID to filter on | [optional]
9 |
10 |
11 |
12 |
13 |
14 | ---
15 |
16 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
17 |
18 |
19 |
--------------------------------------------------------------------------------
/src/gen/docs/models/EmploymentStatus.md:
--------------------------------------------------------------------------------
1 | # Apideck.EmploymentStatus
2 |
3 | ## Enum
4 |
5 |
6 | * `active` (value: `'active'`)
7 |
8 | * `inactive` (value: `'inactive'`)
9 |
10 | * `terminated` (value: `'terminated'`)
11 |
12 | * `other` (value: `'other'`)
13 |
14 |
15 | ---
16 |
17 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
18 |
19 |
20 |
--------------------------------------------------------------------------------
/src/gen/docs/models/Error.md:
--------------------------------------------------------------------------------
1 | # Apideck.ModelError
2 |
3 | ### Description
4 |
5 | The error returned if your message status is failed or undelivered.
6 |
7 | ## Properties
8 | Name | Type | Description | Notes
9 | ------------ | ------------- | ------------- | -------------
10 | `code` | **string** | The error_code provides more information about the failure. If the message was successful, this value is null | [optional]
11 | `message` | **string** | | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ---
18 |
19 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
20 |
21 |
22 |
--------------------------------------------------------------------------------
/src/gen/docs/models/ExecuteWebhookEventRequest.md:
--------------------------------------------------------------------------------
1 | # Apideck.ExecuteWebhookEventRequest
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 |
9 |
10 |
11 |
12 |
13 | ---
14 |
15 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
16 |
17 |
18 |
--------------------------------------------------------------------------------
/src/gen/docs/models/ExecuteWebhookEventsRequest.md:
--------------------------------------------------------------------------------
1 | # Apideck.ExecuteWebhookEventsRequest
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 |
9 |
10 |
11 |
12 |
13 | ---
14 |
15 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
16 |
17 |
18 |
--------------------------------------------------------------------------------
/src/gen/docs/models/ExecuteWebhookResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.ExecuteWebhookResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `request_id` | **string** | UUID of the request received | [optional]
11 | `timestamp` | **string** | ISO Datetime webhook event was received | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ---
18 |
19 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
20 |
21 |
22 |
--------------------------------------------------------------------------------
/src/gen/docs/models/FileStorageEventType.md:
--------------------------------------------------------------------------------
1 | # Apideck.FileStorageEventType
2 |
3 | ## Enum
4 |
5 |
6 | * `Star` (value: `'*'`)
7 |
8 | * `file_storage_file_created` (value: `'file-storage.file.created'`)
9 |
10 | * `file_storage_file_updated` (value: `'file-storage.file.updated'`)
11 |
12 | * `file_storage_file_deleted` (value: `'file-storage.file.deleted'`)
13 |
14 |
15 | ---
16 |
17 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
18 |
19 |
20 |
--------------------------------------------------------------------------------
/src/gen/docs/models/FileType.md:
--------------------------------------------------------------------------------
1 | # Apideck.FileType
2 |
3 | ## Enum
4 |
5 |
6 | * `file` (value: `'file'`)
7 |
8 | * `folder` (value: `'folder'`)
9 |
10 | * `url` (value: `'url'`)
11 |
12 |
13 | ---
14 |
15 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
16 |
17 |
18 |
--------------------------------------------------------------------------------
/src/gen/docs/models/FilesFilter.md:
--------------------------------------------------------------------------------
1 | # Apideck.FilesFilter
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `drive_id` | **string** | ID of the drive to filter on | [optional]
9 | `folder_id` | **string** | ID of the folder to filter on. The root folder has an alias \"root\" | [optional]
10 | `shared` | **boolean** | Only return files and folders that are shared | [optional]
11 |
12 |
13 |
14 |
15 |
16 | ---
17 |
18 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
19 |
20 |
21 |
--------------------------------------------------------------------------------
/src/gen/docs/models/FilesSearch.md:
--------------------------------------------------------------------------------
1 | # Apideck.FilesSearch
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `query` | **string** | The query to search for. May match across multiple fields. |
9 | `drive_id` | **string** | ID of the drive to filter on | [optional]
10 | `pass_through` | [**PassThroughBody**](PassThroughBody.md) | | [optional]
11 |
12 |
13 |
14 |
15 |
16 | ## Referenced Types:
17 |
18 |
19 | * [`PassThroughBody`](PassThroughBody.md)
20 |
21 | ---
22 |
23 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
24 |
25 |
26 |
--------------------------------------------------------------------------------
/src/gen/docs/models/FilesSort.md:
--------------------------------------------------------------------------------
1 | # Apideck.FilesSort
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `by` | **string** | The field on which to sort the Files | [optional]
9 | `direction` | [**SortDirection**](SortDirection.md) | | [optional]
10 |
11 |
12 |
13 |
14 |
15 |
16 | ## Enum: FilesSort.by
17 |
18 |
19 | * `updated_at` (value: `'updated_at'`)
20 |
21 | * `name` (value: `'name'`)
22 |
23 |
24 |
25 |
26 | ## Referenced Types:
27 |
28 | * [`SortDirection`](SortDirection.md)
29 |
30 | ---
31 |
32 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
33 |
34 |
35 |
--------------------------------------------------------------------------------
/src/gen/docs/models/FormFieldOption.md:
--------------------------------------------------------------------------------
1 | # Apideck.FormFieldOption
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `label` | **string** | | [optional]
9 | `value` | **string \| number \| boolean \| Array<string \| number>** | | [optional]
10 | `id` | **string** | | [optional]
11 | `options` | [**Array<SimpleFormFieldOption>**](SimpleFormFieldOption.md) | | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ## Referenced Types:
18 |
19 | * [`SimpleFormFieldOption`](SimpleFormFieldOption.md)
20 |
21 | ---
22 |
23 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
24 |
25 |
26 |
--------------------------------------------------------------------------------
/src/gen/docs/models/FormFieldOptionGroup.md:
--------------------------------------------------------------------------------
1 | # Apideck.FormFieldOptionGroup
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `id` | **string** | | [optional]
9 | `label` | **string** | | [optional]
10 | `options` | [**Array<SimpleFormFieldOption>**](SimpleFormFieldOption.md) | | [optional]
11 |
12 |
13 |
14 |
15 |
16 | ## Referenced Types:
17 |
18 |
19 | * [`SimpleFormFieldOption`](SimpleFormFieldOption.md)
20 |
21 | ---
22 |
23 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
24 |
25 |
26 |
--------------------------------------------------------------------------------
/src/gen/docs/models/Gender.md:
--------------------------------------------------------------------------------
1 | # Apideck.Gender
2 |
3 | ## Enum
4 |
5 |
6 | * `male` (value: `'male'`)
7 |
8 | * `female` (value: `'female'`)
9 |
10 | * `unisex` (value: `'unisex'`)
11 |
12 | * `other` (value: `'other'`)
13 |
14 | * `not_specified` (value: `'not_specified'`)
15 |
16 |
17 | ---
18 |
19 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
20 |
21 |
22 |
--------------------------------------------------------------------------------
/src/gen/docs/models/GetActivityResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.GetActivityResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `service` | **string** | Apideck ID of service provider |
11 | `resource` | **string** | Unified API resource name |
12 | `operation` | **string** | Operation performed |
13 | `data` | [**Activity**](Activity.md) | |
14 | `_raw` | [**Raw**](Raw.md) | | [optional]
15 |
16 |
17 |
18 |
19 |
20 | ## Referenced Types:
21 |
22 |
23 |
24 |
25 |
26 | * [`Activity`](Activity.md)
27 | * [`Raw`](Raw.md)
28 |
29 | ---
30 |
31 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
32 |
33 |
34 |
--------------------------------------------------------------------------------
/src/gen/docs/models/GetApiResourceResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.GetApiResourceResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `data` | [**ApiResource**](ApiResource.md) | |
11 | `_raw` | [**Raw**](Raw.md) | | [optional]
12 | `meta` | [**Meta**](Meta.md) | | [optional]
13 | `links` | [**Links**](Links.md) | | [optional]
14 |
15 |
16 |
17 |
18 |
19 | ## Referenced Types:
20 |
21 |
22 | * [`ApiResource`](ApiResource.md)
23 | * [`Raw`](Raw.md)
24 | * [`Meta`](Meta.md)
25 | * [`Links`](Links.md)
26 |
27 | ---
28 |
29 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
30 |
31 |
32 |
--------------------------------------------------------------------------------
/src/gen/docs/models/GetApiResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.GetApiResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `data` | [**Api**](Api.md) | |
11 | `_raw` | [**Raw**](Raw.md) | | [optional]
12 | `meta` | [**Meta**](Meta.md) | | [optional]
13 | `links` | [**Links**](Links.md) | | [optional]
14 |
15 |
16 |
17 |
18 |
19 | ## Referenced Types:
20 |
21 |
22 | * [`Api`](Api.md)
23 | * [`Raw`](Raw.md)
24 | * [`Meta`](Meta.md)
25 | * [`Links`](Links.md)
26 |
27 | ---
28 |
29 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
30 |
31 |
32 |
--------------------------------------------------------------------------------
/src/gen/docs/models/GetApisResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.GetApisResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `data` | [**Array<Api>**](Api.md) | |
11 | `_raw` | [**Raw**](Raw.md) | | [optional]
12 | `meta` | [**Meta**](Meta.md) | | [optional]
13 | `links` | [**Links**](Links.md) | | [optional]
14 |
15 |
16 |
17 |
18 |
19 | ## Referenced Types:
20 |
21 |
22 | * [`Api`](Api.md)
23 | * [`Raw`](Raw.md)
24 | * [`Meta`](Meta.md)
25 | * [`Links`](Links.md)
26 |
27 | ---
28 |
29 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
30 |
31 |
32 |
--------------------------------------------------------------------------------
/src/gen/docs/models/GetBillResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.GetBillResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `service` | **string** | Apideck ID of service provider |
11 | `resource` | **string** | Unified API resource name |
12 | `operation` | **string** | Operation performed |
13 | `data` | [**Bill**](Bill.md) | |
14 | `_raw` | [**Raw**](Raw.md) | | [optional]
15 |
16 |
17 |
18 |
19 |
20 | ## Referenced Types:
21 |
22 |
23 |
24 |
25 |
26 | * [`Bill`](Bill.md)
27 | * [`Raw`](Raw.md)
28 |
29 | ---
30 |
31 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
32 |
33 |
34 |
--------------------------------------------------------------------------------
/src/gen/docs/models/GetCompanyResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.GetCompanyResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `service` | **string** | Apideck ID of service provider |
11 | `resource` | **string** | Unified API resource name |
12 | `operation` | **string** | Operation performed |
13 | `data` | [**Company**](Company.md) | |
14 | `_raw` | [**Raw**](Raw.md) | | [optional]
15 |
16 |
17 |
18 |
19 |
20 | ## Referenced Types:
21 |
22 |
23 |
24 |
25 |
26 | * [`Company`](Company.md)
27 | * [`Raw`](Raw.md)
28 |
29 | ---
30 |
31 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
32 |
33 |
34 |
--------------------------------------------------------------------------------
/src/gen/docs/models/GetConnectionResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.GetConnectionResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `data` | [**Connection**](Connection.md) | |
11 | `_raw` | [**Raw**](Raw.md) | | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ## Referenced Types:
18 |
19 |
20 | * [`Connection`](Connection.md)
21 | * [`Raw`](Raw.md)
22 |
23 | ---
24 |
25 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
26 |
27 |
28 |
--------------------------------------------------------------------------------
/src/gen/docs/models/GetConnectionsResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.GetConnectionsResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `data` | [**Array<Connection>**](Connection.md) | |
11 | `_raw` | [**Raw**](Raw.md) | | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ## Referenced Types:
18 |
19 |
20 | * [`Connection`](Connection.md)
21 | * [`Raw`](Raw.md)
22 |
23 | ---
24 |
25 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
26 |
27 |
28 |
--------------------------------------------------------------------------------
/src/gen/docs/models/GetConnectorResourceExampleResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.GetConnectorResourceExampleResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `data` | [**GetConnectorResourceExampleResponseData**](GetConnectorResourceExampleResponseData.md) | |
11 | `_raw` | [**Raw**](Raw.md) | | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ## Referenced Types:
18 |
19 |
20 | * [`GetConnectorResourceExampleResponseData`](GetConnectorResourceExampleResponseData.md)
21 | * [`Raw`](Raw.md)
22 |
23 | ---
24 |
25 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
26 |
27 |
28 |
--------------------------------------------------------------------------------
/src/gen/docs/models/GetConnectorResourceSchemaResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.GetConnectorResourceSchemaResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `data` | **object** | |
11 | `_raw` | [**Raw**](Raw.md) | | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ## Referenced Types:
18 |
19 |
20 |
21 | * [`Raw`](Raw.md)
22 |
23 | ---
24 |
25 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
26 |
27 |
28 |
--------------------------------------------------------------------------------
/src/gen/docs/models/GetConnectorResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.GetConnectorResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `data` | [**Connector**](Connector.md) | |
11 | `_raw` | [**Raw**](Raw.md) | | [optional]
12 | `meta` | [**Meta**](Meta.md) | | [optional]
13 | `links` | [**Links**](Links.md) | | [optional]
14 |
15 |
16 |
17 |
18 |
19 | ## Referenced Types:
20 |
21 |
22 | * [`Connector`](Connector.md)
23 | * [`Raw`](Raw.md)
24 | * [`Meta`](Meta.md)
25 | * [`Links`](Links.md)
26 |
27 | ---
28 |
29 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
30 |
31 |
32 |
--------------------------------------------------------------------------------
/src/gen/docs/models/GetConnectorsResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.GetConnectorsResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `data` | [**Array<Connector>**](Connector.md) | |
11 | `_raw` | [**Raw**](Raw.md) | | [optional]
12 | `meta` | [**Meta**](Meta.md) | | [optional]
13 | `links` | [**Links**](Links.md) | | [optional]
14 |
15 |
16 |
17 |
18 |
19 | ## Referenced Types:
20 |
21 |
22 | * [`Connector`](Connector.md)
23 | * [`Raw`](Raw.md)
24 | * [`Meta`](Meta.md)
25 | * [`Links`](Links.md)
26 |
27 | ---
28 |
29 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
30 |
31 |
32 |
--------------------------------------------------------------------------------
/src/gen/docs/models/GetConsumerResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.GetConsumerResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `data` | [**Consumer**](Consumer.md) | |
11 | `_raw` | [**Raw**](Raw.md) | | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ## Referenced Types:
18 |
19 |
20 | * [`Consumer`](Consumer.md)
21 | * [`Raw`](Raw.md)
22 |
23 | ---
24 |
25 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
26 |
27 |
28 |
--------------------------------------------------------------------------------
/src/gen/docs/models/GetContactResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.GetContactResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `service` | **string** | Apideck ID of service provider |
11 | `resource` | **string** | Unified API resource name |
12 | `operation` | **string** | Operation performed |
13 | `data` | [**Contact**](Contact.md) | |
14 | `_raw` | [**Raw**](Raw.md) | | [optional]
15 |
16 |
17 |
18 |
19 |
20 | ## Referenced Types:
21 |
22 |
23 |
24 |
25 |
26 | * [`Contact`](Contact.md)
27 | * [`Raw`](Raw.md)
28 |
29 | ---
30 |
31 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
32 |
33 |
34 |
--------------------------------------------------------------------------------
/src/gen/docs/models/GetCustomFieldsResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.GetCustomFieldsResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `data` | [**Array<CustomFieldFinder>**](CustomFieldFinder.md) | |
11 | `_raw` | [**Raw**](Raw.md) | | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ## Referenced Types:
18 |
19 |
20 | * [`CustomFieldFinder`](CustomFieldFinder.md)
21 | * [`Raw`](Raw.md)
22 |
23 | ---
24 |
25 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
26 |
27 |
28 |
--------------------------------------------------------------------------------
/src/gen/docs/models/GetCustomMappingResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.GetCustomMappingResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `data` | [**CustomMapping**](CustomMapping.md) | |
11 | `_raw` | [**Raw**](Raw.md) | | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ## Referenced Types:
18 |
19 |
20 | * [`CustomMapping`](CustomMapping.md)
21 | * [`Raw`](Raw.md)
22 |
23 | ---
24 |
25 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
26 |
27 |
28 |
--------------------------------------------------------------------------------
/src/gen/docs/models/GetCustomMappingsResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.GetCustomMappingsResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `data` | [**Array<CustomMapping>**](CustomMapping.md) | |
11 | `_raw` | [**Raw**](Raw.md) | | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ## Referenced Types:
18 |
19 |
20 | * [`CustomMapping`](CustomMapping.md)
21 | * [`Raw`](Raw.md)
22 |
23 | ---
24 |
25 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
26 |
27 |
28 |
--------------------------------------------------------------------------------
/src/gen/docs/models/GetDriveResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.GetDriveResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `service` | **string** | Apideck ID of service provider |
11 | `resource` | **string** | Unified API resource name |
12 | `operation` | **string** | Operation performed |
13 | `data` | [**Drive**](Drive.md) | |
14 | `_raw` | [**Raw**](Raw.md) | | [optional]
15 |
16 |
17 |
18 |
19 |
20 | ## Referenced Types:
21 |
22 |
23 |
24 |
25 |
26 | * [`Drive`](Drive.md)
27 | * [`Raw`](Raw.md)
28 |
29 | ---
30 |
31 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
32 |
33 |
34 |
--------------------------------------------------------------------------------
/src/gen/docs/models/GetExpenseResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.GetExpenseResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `service` | **string** | Apideck ID of service provider |
11 | `resource` | **string** | Unified API resource name |
12 | `operation` | **string** | Operation performed |
13 | `data` | [**Expense**](Expense.md) | |
14 | `_raw` | [**Raw**](Raw.md) | | [optional]
15 |
16 |
17 |
18 |
19 |
20 | ## Referenced Types:
21 |
22 |
23 |
24 |
25 |
26 | * [`Expense`](Expense.md)
27 | * [`Raw`](Raw.md)
28 |
29 | ---
30 |
31 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
32 |
33 |
34 |
--------------------------------------------------------------------------------
/src/gen/docs/models/GetFolderResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.GetFolderResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `service` | **string** | Apideck ID of service provider |
11 | `resource` | **string** | Unified API resource name |
12 | `operation` | **string** | Operation performed |
13 | `data` | [**Folder**](Folder.md) | |
14 | `_raw` | [**Raw**](Raw.md) | | [optional]
15 |
16 |
17 |
18 |
19 |
20 | ## Referenced Types:
21 |
22 |
23 |
24 |
25 |
26 | * [`Folder`](Folder.md)
27 | * [`Raw`](Raw.md)
28 |
29 | ---
30 |
31 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
32 |
33 |
34 |
--------------------------------------------------------------------------------
/src/gen/docs/models/GetHrisJobResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.GetHrisJobResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `service` | **string** | Apideck ID of service provider |
11 | `resource` | **string** | Unified API resource name |
12 | `operation` | **string** | Operation performed |
13 | `data` | [**HrisJob**](HrisJob.md) | |
14 | `_raw` | [**Raw**](Raw.md) | | [optional]
15 |
16 |
17 |
18 |
19 |
20 | ## Referenced Types:
21 |
22 |
23 |
24 |
25 |
26 | * [`HrisJob`](HrisJob.md)
27 | * [`Raw`](Raw.md)
28 |
29 | ---
30 |
31 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
32 |
33 |
34 |
--------------------------------------------------------------------------------
/src/gen/docs/models/GetInvoiceResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.GetInvoiceResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `service` | **string** | Apideck ID of service provider |
11 | `resource` | **string** | Unified API resource name |
12 | `operation` | **string** | Operation performed |
13 | `data` | [**Invoice**](Invoice.md) | |
14 | `_raw` | [**Raw**](Raw.md) | | [optional]
15 |
16 |
17 |
18 |
19 |
20 | ## Referenced Types:
21 |
22 |
23 |
24 |
25 |
26 | * [`Invoice`](Invoice.md)
27 | * [`Raw`](Raw.md)
28 |
29 | ---
30 |
31 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
32 |
33 |
34 |
--------------------------------------------------------------------------------
/src/gen/docs/models/GetItemResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.GetItemResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `service` | **string** | Apideck ID of service provider |
11 | `resource` | **string** | Unified API resource name |
12 | `operation` | **string** | Operation performed |
13 | `data` | [**Item**](Item.md) | |
14 | `_raw` | [**Raw**](Raw.md) | | [optional]
15 |
16 |
17 |
18 |
19 |
20 | ## Referenced Types:
21 |
22 |
23 |
24 |
25 |
26 | * [`Item`](Item.md)
27 | * [`Raw`](Raw.md)
28 |
29 | ---
30 |
31 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
32 |
33 |
34 |
--------------------------------------------------------------------------------
/src/gen/docs/models/GetJobResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.GetJobResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `service` | **string** | Apideck ID of service provider |
11 | `resource` | **string** | Unified API resource name |
12 | `operation` | **string** | Operation performed |
13 | `data` | [**Job**](Job.md) | |
14 | `_raw` | [**Raw**](Raw.md) | | [optional]
15 |
16 |
17 |
18 |
19 |
20 | ## Referenced Types:
21 |
22 |
23 |
24 |
25 |
26 | * [`Job`](Job.md)
27 | * [`Raw`](Raw.md)
28 |
29 | ---
30 |
31 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
32 |
33 |
34 |
--------------------------------------------------------------------------------
/src/gen/docs/models/GetLeadResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.GetLeadResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `service` | **string** | Apideck ID of service provider |
11 | `resource` | **string** | Unified API resource name |
12 | `operation` | **string** | Operation performed |
13 | `data` | [**Lead**](Lead.md) | |
14 | `_raw` | [**Raw**](Raw.md) | | [optional]
15 |
16 |
17 |
18 |
19 |
20 | ## Referenced Types:
21 |
22 |
23 |
24 |
25 |
26 | * [`Lead`](Lead.md)
27 | * [`Raw`](Raw.md)
28 |
29 | ---
30 |
31 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
32 |
33 |
34 |
--------------------------------------------------------------------------------
/src/gen/docs/models/GetLogsResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.GetLogsResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `data` | [**Array<Log>**](Log.md) | |
11 | `meta` | [**Meta**](Meta.md) | | [optional]
12 | `links` | [**Links**](Links.md) | | [optional]
13 | `_raw` | [**Raw**](Raw.md) | | [optional]
14 |
15 |
16 |
17 |
18 |
19 | ## Referenced Types:
20 |
21 |
22 | * [`Log`](Log.md)
23 | * [`Meta`](Meta.md)
24 | * [`Links`](Links.md)
25 | * [`Raw`](Raw.md)
26 |
27 | ---
28 |
29 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
30 |
31 |
32 |
--------------------------------------------------------------------------------
/src/gen/docs/models/GetMessageResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.GetMessageResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `service` | **string** | Apideck ID of service provider |
11 | `resource` | **string** | Unified API resource name |
12 | `operation` | **string** | Operation performed |
13 | `data` | [**Message**](Message.md) | |
14 | `_raw` | [**Raw**](Raw.md) | | [optional]
15 |
16 |
17 |
18 |
19 |
20 | ## Referenced Types:
21 |
22 |
23 |
24 |
25 |
26 | * [`Message`](Message.md)
27 | * [`Raw`](Raw.md)
28 |
29 | ---
30 |
31 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
32 |
33 |
34 |
--------------------------------------------------------------------------------
/src/gen/docs/models/GetNoteResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.GetNoteResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `service` | **string** | Apideck ID of service provider |
11 | `resource` | **string** | Unified API resource name |
12 | `operation` | **string** | Operation performed |
13 | `data` | [**Note**](Note.md) | |
14 | `_raw` | [**Raw**](Raw.md) | | [optional]
15 |
16 |
17 |
18 |
19 |
20 | ## Referenced Types:
21 |
22 |
23 |
24 |
25 |
26 | * [`Note`](Note.md)
27 | * [`Raw`](Raw.md)
28 |
29 | ---
30 |
31 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
32 |
33 |
34 |
--------------------------------------------------------------------------------
/src/gen/docs/models/GetOrderResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.GetOrderResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `service` | **string** | Apideck ID of service provider |
11 | `resource` | **string** | Unified API resource name |
12 | `operation` | **string** | Operation performed |
13 | `data` | [**Order**](Order.md) | |
14 | `_raw` | [**Raw**](Raw.md) | | [optional]
15 |
16 |
17 |
18 |
19 |
20 | ## Referenced Types:
21 |
22 |
23 |
24 |
25 |
26 | * [`Order`](Order.md)
27 | * [`Raw`](Raw.md)
28 |
29 | ---
30 |
31 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
32 |
33 |
34 |
--------------------------------------------------------------------------------
/src/gen/docs/models/GetPaymentResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.GetPaymentResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `service` | **string** | Apideck ID of service provider |
11 | `resource` | **string** | Unified API resource name |
12 | `operation` | **string** | Operation performed |
13 | `data` | [**Payment**](Payment.md) | |
14 | `_raw` | [**Raw**](Raw.md) | | [optional]
15 |
16 |
17 |
18 |
19 |
20 | ## Referenced Types:
21 |
22 |
23 |
24 |
25 |
26 | * [`Payment`](Payment.md)
27 | * [`Raw`](Raw.md)
28 |
29 | ---
30 |
31 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
32 |
33 |
34 |
--------------------------------------------------------------------------------
/src/gen/docs/models/GetPayrollResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.GetPayrollResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `service` | **string** | Apideck ID of service provider |
11 | `resource` | **string** | Unified API resource name |
12 | `operation` | **string** | Operation performed |
13 | `data` | [**Payroll**](Payroll.md) | |
14 | `_raw` | [**Raw**](Raw.md) | | [optional]
15 |
16 |
17 |
18 |
19 |
20 | ## Referenced Types:
21 |
22 |
23 |
24 |
25 |
26 | * [`Payroll`](Payroll.md)
27 | * [`Raw`](Raw.md)
28 |
29 | ---
30 |
31 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
32 |
33 |
34 |
--------------------------------------------------------------------------------
/src/gen/docs/models/GetResourceExampleResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.GetResourceExampleResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `data` | [**ResourceExample**](ResourceExample.md) | |
11 | `_raw` | [**Raw**](Raw.md) | | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ## Referenced Types:
18 |
19 |
20 | * [`ResourceExample`](ResourceExample.md)
21 | * [`Raw`](Raw.md)
22 |
23 | ---
24 |
25 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
26 |
27 |
28 |
--------------------------------------------------------------------------------
/src/gen/docs/models/GetResourceSchemaResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.GetResourceSchemaResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `data` | **object** | |
11 | `_raw` | [**Raw**](Raw.md) | | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ## Referenced Types:
18 |
19 |
20 |
21 | * [`Raw`](Raw.md)
22 |
23 | ---
24 |
25 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
26 |
27 |
28 |
--------------------------------------------------------------------------------
/src/gen/docs/models/GetTaxRateResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.GetTaxRateResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `service` | **string** | Apideck ID of service provider |
11 | `resource` | **string** | Unified API resource name |
12 | `operation` | **string** | Operation performed |
13 | `data` | [**TaxRate**](TaxRate.md) | |
14 | `_raw` | [**Raw**](Raw.md) | | [optional]
15 |
16 |
17 |
18 |
19 |
20 | ## Referenced Types:
21 |
22 |
23 |
24 |
25 |
26 | * [`TaxRate`](TaxRate.md)
27 | * [`Raw`](Raw.md)
28 |
29 | ---
30 |
31 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
32 |
33 |
34 |
--------------------------------------------------------------------------------
/src/gen/docs/models/GetTenderResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.GetTenderResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `service` | **string** | Apideck ID of service provider |
11 | `resource` | **string** | Unified API resource name |
12 | `operation` | **string** | Operation performed |
13 | `data` | [**Tender**](Tender.md) | |
14 | `_raw` | [**Raw**](Raw.md) | | [optional]
15 |
16 |
17 |
18 |
19 |
20 | ## Referenced Types:
21 |
22 |
23 |
24 |
25 |
26 | * [`Tender`](Tender.md)
27 | * [`Raw`](Raw.md)
28 |
29 | ---
30 |
31 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
32 |
33 |
34 |
--------------------------------------------------------------------------------
/src/gen/docs/models/GetTicketResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.GetTicketResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `service` | **string** | Apideck ID of service provider |
11 | `resource` | **string** | Unified API resource name |
12 | `operation` | **string** | Operation performed |
13 | `data` | [**Ticket**](Ticket.md) | |
14 | `_raw` | [**Raw**](Raw.md) | | [optional]
15 |
16 |
17 |
18 |
19 |
20 | ## Referenced Types:
21 |
22 |
23 |
24 |
25 |
26 | * [`Ticket`](Ticket.md)
27 | * [`Raw`](Raw.md)
28 |
29 | ---
30 |
31 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
32 |
33 |
34 |
--------------------------------------------------------------------------------
/src/gen/docs/models/GetUserResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.GetUserResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `service` | **string** | Apideck ID of service provider |
11 | `resource` | **string** | Unified API resource name |
12 | `operation` | **string** | Operation performed |
13 | `data` | [**User**](User.md) | |
14 | `_raw` | [**Raw**](Raw.md) | | [optional]
15 |
16 |
17 |
18 |
19 |
20 | ## Referenced Types:
21 |
22 |
23 |
24 |
25 |
26 | * [`User`](User.md)
27 | * [`Raw`](Raw.md)
28 |
29 | ---
30 |
31 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
32 |
33 |
34 |
--------------------------------------------------------------------------------
/src/gen/docs/models/GetWebhookResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.GetWebhookResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `data` | [**Webhook**](Webhook.md) | |
11 | `_raw` | [**Raw**](Raw.md) | | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ## Referenced Types:
18 |
19 |
20 | * [`Webhook`](Webhook.md)
21 | * [`Raw`](Raw.md)
22 |
23 | ---
24 |
25 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
26 |
27 |
28 |
--------------------------------------------------------------------------------
/src/gen/docs/models/GetWebhooksResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.GetWebhooksResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `data` | [**Array<Webhook>**](Webhook.md) | |
11 | `meta` | [**Meta**](Meta.md) | | [optional]
12 | `links` | [**Links**](Links.md) | | [optional]
13 | `_raw` | [**Raw**](Raw.md) | | [optional]
14 |
15 |
16 |
17 |
18 |
19 | ## Referenced Types:
20 |
21 |
22 | * [`Webhook`](Webhook.md)
23 | * [`Meta`](Meta.md)
24 | * [`Links`](Links.md)
25 | * [`Raw`](Raw.md)
26 |
27 | ---
28 |
29 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
30 |
31 |
32 |
--------------------------------------------------------------------------------
/src/gen/docs/models/HrisEventType.md:
--------------------------------------------------------------------------------
1 | # Apideck.HrisEventType
2 |
3 | ## Enum
4 |
5 |
6 | * `Star` (value: `'*'`)
7 |
8 | * `hris_employee_created` (value: `'hris.employee.created'`)
9 |
10 | * `hris_employee_updated` (value: `'hris.employee.updated'`)
11 |
12 | * `hris_employee_terminated` (value: `'hris.employee.terminated'`)
13 |
14 | * `hris_employee_deleted` (value: `'hris.employee.deleted'`)
15 |
16 | * `hris_company_created` (value: `'hris.company.created'`)
17 |
18 | * `hris_company_updated` (value: `'hris.company.updated'`)
19 |
20 | * `hris_company_deleted` (value: `'hris.company.deleted'`)
21 |
22 |
23 | ---
24 |
25 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
26 |
27 |
28 |
--------------------------------------------------------------------------------
/src/gen/docs/models/HrisJobLocation.md:
--------------------------------------------------------------------------------
1 | # Apideck.HrisJobLocation
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `name` | **string** | | [optional]
9 |
10 |
11 |
12 |
13 |
14 | ---
15 |
16 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
17 |
18 |
19 |
--------------------------------------------------------------------------------
/src/gen/docs/models/HrisJobs.md:
--------------------------------------------------------------------------------
1 | # Apideck.HrisJobs
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `employee` | [**Employee**](Employee.md) | | [optional]
9 | `jobs` | [**Array<HrisJob>**](HrisJob.md) | | [optional]
10 |
11 |
12 |
13 |
14 |
15 | ## Referenced Types:
16 | * [`Employee`](Employee.md)
17 | * [`HrisJob`](HrisJob.md)
18 |
19 | ---
20 |
21 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
22 |
23 |
24 |
--------------------------------------------------------------------------------
/src/gen/docs/models/IntegrationState.md:
--------------------------------------------------------------------------------
1 | # Apideck.IntegrationState
2 |
3 | ## Enum
4 |
5 |
6 | * `disabled` (value: `'disabled'`)
7 |
8 | * `needs_configuration` (value: `'needs_configuration'`)
9 |
10 | * `configured` (value: `'configured'`)
11 |
12 |
13 | ---
14 |
15 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
16 |
17 |
18 |
--------------------------------------------------------------------------------
/src/gen/docs/models/InvoiceItemFilter.md:
--------------------------------------------------------------------------------
1 | # Apideck.InvoiceItemFilter
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `type` | **string** | The type of invoice item, indicating whether it is an inventory item, a service, or another type. | [optional]
9 |
10 |
11 |
12 |
13 |
14 |
15 | ## Enum: InvoiceItemFilter.type
16 |
17 |
18 | * `inventory` (value: `'inventory'`)
19 |
20 | * `service` (value: `'service'`)
21 |
22 | * `other` (value: `'other'`)
23 |
24 |
25 |
26 |
27 | ---
28 |
29 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
30 |
31 |
32 |
--------------------------------------------------------------------------------
/src/gen/docs/models/InvoiceItemSalesDetails.md:
--------------------------------------------------------------------------------
1 | # Apideck.InvoiceItemSalesDetails
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `unit_price` | **number** | | [optional]
9 | `unit_of_measure` | **string** | Description of the unit type the item is sold as, ie: kg, hour. | [optional]
10 | `tax_inclusive` | **boolean** | Amounts are including tax | [optional]
11 | `tax_rate` | [**LinkedTaxRate**](LinkedTaxRate.md) | | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ## Referenced Types:
18 |
19 |
20 |
21 | * [`LinkedTaxRate`](LinkedTaxRate.md)
22 |
23 | ---
24 |
25 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
26 |
27 |
28 |
--------------------------------------------------------------------------------
/src/gen/docs/models/InvoiceItemsFilter.md:
--------------------------------------------------------------------------------
1 | # Apideck.InvoiceItemsFilter
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `name` | **string** | Name of Invoice Items to search for | [optional]
9 | `type` | **string** | The type of invoice item, indicating whether it is an inventory item, a service, or another type. | [optional]
10 |
11 |
12 |
13 |
14 |
15 |
16 | ## Enum: InvoiceItemsFilter.type
17 |
18 |
19 | * `inventory` (value: `'inventory'`)
20 |
21 | * `service` (value: `'service'`)
22 |
23 | * `other` (value: `'other'`)
24 |
25 |
26 |
27 |
28 | ---
29 |
30 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
31 |
32 |
33 |
--------------------------------------------------------------------------------
/src/gen/docs/models/InvoiceItemsSort.md:
--------------------------------------------------------------------------------
1 | # Apideck.InvoiceItemsSort
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `by` | **string** | The field on which to sort the Invoice Items | [optional]
9 | `direction` | [**SortDirection**](SortDirection.md) | | [optional]
10 |
11 |
12 |
13 |
14 |
15 |
16 | ## Enum: InvoiceItemsSort.by
17 |
18 |
19 | * `created_at` (value: `'created_at'`)
20 |
21 | * `updated_at` (value: `'updated_at'`)
22 |
23 |
24 |
25 |
26 | ## Referenced Types:
27 |
28 | * [`SortDirection`](SortDirection.md)
29 |
30 | ---
31 |
32 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
33 |
34 |
35 |
--------------------------------------------------------------------------------
/src/gen/docs/models/InvoiceResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.InvoiceResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `id` | **string** | A unique identifier for an object. | [optional]
9 | `downstream_id` | **string** | The third-party API ID of original entity | [optional]
10 |
11 |
12 |
13 |
14 |
15 | ---
16 |
17 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
18 |
19 |
20 |
--------------------------------------------------------------------------------
/src/gen/docs/models/InvoicesFilter.md:
--------------------------------------------------------------------------------
1 | # Apideck.InvoicesFilter
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `updated_since` | **Date** | | [optional]
9 | `created_since` | **Date** | | [optional]
10 | `number` | **string** | Invoice number to search for | [optional]
11 |
12 |
13 |
14 |
15 |
16 | ---
17 |
18 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
19 |
20 |
21 |
--------------------------------------------------------------------------------
/src/gen/docs/models/InvoicesSort.md:
--------------------------------------------------------------------------------
1 | # Apideck.InvoicesSort
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `by` | **string** | The field on which to sort the Invoices | [optional]
9 | `direction` | [**SortDirection**](SortDirection.md) | | [optional]
10 |
11 |
12 |
13 |
14 |
15 |
16 | ## Enum: InvoicesSort.by
17 |
18 |
19 | * `created_at` (value: `'created_at'`)
20 |
21 | * `updated_at` (value: `'updated_at'`)
22 |
23 |
24 |
25 |
26 | ## Referenced Types:
27 |
28 | * [`SortDirection`](SortDirection.md)
29 |
30 | ---
31 |
32 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
33 |
34 |
35 |
--------------------------------------------------------------------------------
/src/gen/docs/models/IssueTrackingEventType.md:
--------------------------------------------------------------------------------
1 | # Apideck.IssueTrackingEventType
2 |
3 | ## Enum
4 |
5 |
6 | * `Star` (value: `'*'`)
7 |
8 | * `issue_tracking_ticket_created` (value: `'issue-tracking.ticket.created'`)
9 |
10 | * `issue_tracking_ticket_updated` (value: `'issue-tracking.ticket.updated'`)
11 |
12 | * `issue_tracking_ticket_deleted` (value: `'issue-tracking.ticket.deleted'`)
13 |
14 |
15 | ---
16 |
17 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
18 |
19 |
20 |
--------------------------------------------------------------------------------
/src/gen/docs/models/IssuesFilter.md:
--------------------------------------------------------------------------------
1 | # Apideck.IssuesFilter
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status` | **Set<string>** | Filter by ticket status, can be `open`, `closed` or `all`. Will passthrough if none of the above match | [optional]
9 | `since` | **Date** | Only return tickets since a specific date | [optional]
10 | `assignee_id` | **string** | Only return tickets assigned to a specific user | [optional]
11 |
12 |
13 |
14 |
15 |
16 | ---
17 |
18 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
19 |
20 |
21 |
--------------------------------------------------------------------------------
/src/gen/docs/models/JobLinks.md:
--------------------------------------------------------------------------------
1 | # Apideck.JobLinks
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `type` | **string** | | [optional]
9 | `url` | **string** | | [optional]
10 |
11 |
12 |
13 |
14 |
15 |
16 | ## Enum: JobLinks.type
17 |
18 |
19 | * `portal` (value: `'job_portal'`)
20 |
21 | * `description` (value: `'job_description'`)
22 |
23 |
24 |
25 |
26 | ---
27 |
28 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
29 |
30 |
31 |
--------------------------------------------------------------------------------
/src/gen/docs/models/JobSalary.md:
--------------------------------------------------------------------------------
1 | # Apideck.JobSalary
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `min` | **number** | Minimum salary payable for the job role. | [optional]
9 | `max` | **number** | Maximum salary payable for the job role. | [optional]
10 | `currency` | [**Currency**](Currency.md) | | [optional]
11 | `interval` | **string** | | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ## Referenced Types:
18 |
19 |
20 | * [`Currency`](Currency.md)
21 |
22 |
23 | ---
24 |
25 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
26 |
27 |
28 |
--------------------------------------------------------------------------------
/src/gen/docs/models/JobStatus.md:
--------------------------------------------------------------------------------
1 | # Apideck.JobStatus
2 |
3 | ## Enum
4 |
5 |
6 | * `draft` (value: `'draft'`)
7 |
8 | * `internal` (value: `'internal'`)
9 |
10 | * `published` (value: `'published'`)
11 |
12 | * `completed` (value: `'completed'`)
13 |
14 | * `on_hold` (value: `'on-hold'`)
15 |
16 | * `private` (value: `'private'`)
17 |
18 |
19 | ---
20 |
21 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
22 |
23 |
24 |
--------------------------------------------------------------------------------
/src/gen/docs/models/JournalEntriesFilter.md:
--------------------------------------------------------------------------------
1 | # Apideck.JournalEntriesFilter
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `updated_since` | **Date** | | [optional]
9 |
10 |
11 |
12 |
13 |
14 | ---
15 |
16 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
17 |
18 |
19 |
--------------------------------------------------------------------------------
/src/gen/docs/models/JournalEntriesSort.md:
--------------------------------------------------------------------------------
1 | # Apideck.JournalEntriesSort
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `by` | **string** | The field on which to sort the Journal Entries. | [optional]
9 | `direction` | [**SortDirection**](SortDirection.md) | | [optional]
10 |
11 |
12 |
13 |
14 |
15 |
16 | ## Enum: JournalEntriesSort.by
17 |
18 |
19 | * `created_at` (value: `'created_at'`)
20 |
21 | * `updated_at` (value: `'updated_at'`)
22 |
23 |
24 |
25 |
26 | ## Referenced Types:
27 |
28 | * [`SortDirection`](SortDirection.md)
29 |
30 | ---
31 |
32 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
33 |
34 |
35 |
--------------------------------------------------------------------------------
/src/gen/docs/models/LeadEventType.md:
--------------------------------------------------------------------------------
1 | # Apideck.LeadEventType
2 |
3 | ## Enum
4 |
5 |
6 | * `Star` (value: `'*'`)
7 |
8 | * `lead_lead_created` (value: `'lead.lead.created'`)
9 |
10 | * `lead_lead_updated` (value: `'lead.lead.updated'`)
11 |
12 | * `lead_lead_deleted` (value: `'lead.lead.deleted'`)
13 |
14 |
15 | ---
16 |
17 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
18 |
19 |
20 |
--------------------------------------------------------------------------------
/src/gen/docs/models/LeadsFilter.md:
--------------------------------------------------------------------------------
1 | # Apideck.LeadsFilter
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `name` | **string** | Name of the lead to filter on | [optional]
9 | `first_name` | **string** | First name of the lead to filter on | [optional]
10 | `last_name` | **string** | Last name of the lead to filter on | [optional]
11 | `email` | **string** | E-mail of the lead to filter on | [optional]
12 | `phone_number` | **string** | Phone number of the lead to filter on | [optional]
13 |
14 |
15 |
16 |
17 |
18 | ---
19 |
20 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
21 |
22 |
23 |
--------------------------------------------------------------------------------
/src/gen/docs/models/LedgerAccountCategories.md:
--------------------------------------------------------------------------------
1 | # Apideck.LedgerAccountCategories
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `id` | **string** | | [optional]
9 | `name` | **string** | The name of the category. | [optional]
10 |
11 |
12 |
13 |
14 |
15 | ---
16 |
17 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
18 |
19 |
20 |
--------------------------------------------------------------------------------
/src/gen/docs/models/LedgerAccountParentAccount.md:
--------------------------------------------------------------------------------
1 | # Apideck.LedgerAccountParentAccount
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `id` | **string** | The ID of the parent account. | [optional]
9 | `name` | **string** | The name of the parent account. | [optional]
10 | `display_id` | **string** | The human readable display ID used when displaying the parent account | [optional]
11 |
12 |
13 |
14 |
15 |
16 | ---
17 |
18 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
19 |
20 |
21 |
--------------------------------------------------------------------------------
/src/gen/docs/models/LedgerAccounts.md:
--------------------------------------------------------------------------------
1 | # Apideck.LedgerAccounts
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 |
9 |
10 |
11 |
12 |
13 | ---
14 |
15 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
16 |
17 |
18 |
--------------------------------------------------------------------------------
/src/gen/docs/models/LedgerAccountsFilter.md:
--------------------------------------------------------------------------------
1 | # Apideck.LedgerAccountsFilter
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `updated_since` | **Date** | | [optional]
9 |
10 |
11 |
12 |
13 |
14 | ---
15 |
16 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
17 |
18 |
19 |
--------------------------------------------------------------------------------
/src/gen/docs/models/LedgerAccountsSort.md:
--------------------------------------------------------------------------------
1 | # Apideck.LedgerAccountsSort
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `by` | **string** | The field on which to sort the Ledger Accounts | [optional]
9 | `direction` | [**SortDirection**](SortDirection.md) | | [optional]
10 |
11 |
12 |
13 |
14 |
15 |
16 | ## Enum: LedgerAccountsSort.by
17 |
18 |
19 | * `created_at` (value: `'created_at'`)
20 |
21 | * `updated_at` (value: `'updated_at'`)
22 |
23 |
24 |
25 |
26 | ## Referenced Types:
27 |
28 | * [`SortDirection`](SortDirection.md)
29 |
30 | ---
31 |
32 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
33 |
34 |
35 |
--------------------------------------------------------------------------------
/src/gen/docs/models/LinkedEcommerceOrder.md:
--------------------------------------------------------------------------------
1 | # Apideck.LinkedEcommerceOrder
2 |
3 | ### Description
4 |
5 | The order this entity is linked to.
6 |
7 | ## Properties
8 | Name | Type | Description | Notes
9 | ------------ | ------------- | ------------- | -------------
10 | `id` | **string** | A unique identifier for an object. | [optional]
11 | `total` | **string** | The total amount of the order. | [optional]
12 | `status` | [**EcommerceOrderStatus**](EcommerceOrderStatus.md) | | [optional]
13 |
14 |
15 |
16 |
17 |
18 | ## Referenced Types:
19 |
20 |
21 | * [`EcommerceOrderStatus`](EcommerceOrderStatus.md)
22 |
23 | ---
24 |
25 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
26 |
27 |
28 |
--------------------------------------------------------------------------------
/src/gen/docs/models/LinkedFolder.md:
--------------------------------------------------------------------------------
1 | # Apideck.LinkedFolder
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `id` | **string** | A unique identifier for an object. |
9 | `name` | **string** | The name of the folder | [optional]
10 |
11 |
12 |
13 |
14 |
15 | ---
16 |
17 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
18 |
19 |
20 |
--------------------------------------------------------------------------------
/src/gen/docs/models/LinkedInvoiceItem.md:
--------------------------------------------------------------------------------
1 | # Apideck.LinkedInvoiceItem
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `id` | **string** | ID of the linked item. A reference to the [invoice item](https://developers.apideck.com/apis/accounting/reference#tag/Invoice-Items) that was used to create this line item | [optional]
9 | `code` | **string** | User defined item code | [optional]
10 | `name` | **string** | User defined item name | [optional]
11 |
12 |
13 |
14 |
15 |
16 | ---
17 |
18 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
19 |
20 |
21 |
--------------------------------------------------------------------------------
/src/gen/docs/models/LinkedLedgerAccount.md:
--------------------------------------------------------------------------------
1 | # Apideck.LinkedLedgerAccount
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `id` | **string** | The unique identifier for the account. | [optional]
9 | `name` | **string** | The name of the account. | [optional]
10 | `nominal_code` | **string** | The nominal code of the account. | [optional]
11 | `code` | **string** | The code assigned to the account. | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ---
18 |
19 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
20 |
21 |
22 |
--------------------------------------------------------------------------------
/src/gen/docs/models/LinkedParentCustomer.md:
--------------------------------------------------------------------------------
1 | # Apideck.LinkedParentCustomer
2 |
3 | ### Description
4 |
5 | The parent customer this entity is linked to.
6 |
7 | ## Properties
8 | Name | Type | Description | Notes
9 | ------------ | ------------- | ------------- | -------------
10 | `id` | **string** | The parent ID of the customer this entity is linked to. |
11 | `name` | **string** | The name of the parent customer. | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ---
18 |
19 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
20 |
21 |
22 |
--------------------------------------------------------------------------------
/src/gen/docs/models/LinkedTaxRate.md:
--------------------------------------------------------------------------------
1 | # Apideck.LinkedTaxRate
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `id` | **string** | The ID of the object. | [optional]
9 | `code` | **string** | Tax rate code | [optional]
10 | `name` | **string** | Name of the tax rate | [optional]
11 | `rate` | **number** | Rate of the tax rate | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ---
18 |
19 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
20 |
21 |
22 |
--------------------------------------------------------------------------------
/src/gen/docs/models/LinkedTrackingCategories.md:
--------------------------------------------------------------------------------
1 | # Apideck.LinkedTrackingCategories
2 |
3 | ### Description
4 |
5 | A list of linked tracking categories.
6 |
7 | ## Properties
8 | Name | Type | Description | Notes
9 | ------------ | ------------- | ------------- | -------------
10 |
11 |
12 |
13 |
14 |
15 | ---
16 |
17 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
18 |
19 |
20 |
--------------------------------------------------------------------------------
/src/gen/docs/models/LinkedTrackingCategory.md:
--------------------------------------------------------------------------------
1 | # Apideck.LinkedTrackingCategory
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `id` | **string** | The unique identifier for the tracking category. | [optional]
9 | `name` | **string** | The name of the tracking category. | [optional]
10 |
11 |
12 |
13 |
14 |
15 | ---
16 |
17 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
18 |
19 |
20 |
--------------------------------------------------------------------------------
/src/gen/docs/models/Links.md:
--------------------------------------------------------------------------------
1 | # Apideck.Links
2 |
3 | ### Description
4 |
5 | Links to navigate to previous or next pages through the API
6 |
7 | ## Properties
8 | Name | Type | Description | Notes
9 | ------------ | ------------- | ------------- | -------------
10 | `previous` | **string** | Link to navigate to the previous page through the API | [optional]
11 | `current` | **string** | Link to navigate to the current page through the API | [optional]
12 | `next` | **string** | Link to navigate to the previous page through the API | [optional]
13 |
14 |
15 |
16 |
17 |
18 | ---
19 |
20 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
21 |
22 |
23 |
--------------------------------------------------------------------------------
/src/gen/docs/models/LogOperation.md:
--------------------------------------------------------------------------------
1 | # Apideck.LogOperation
2 |
3 | ### Description
4 |
5 | The request as defined in OpenApi Spec.
6 |
7 | ## Properties
8 | Name | Type | Description | Notes
9 | ------------ | ------------- | ------------- | -------------
10 | `id` | **string** | The OpenApi Operation Id associated with the request |
11 | `name` | **string** | The OpenApi Operation name associated with the request |
12 |
13 |
14 |
15 |
16 |
17 | ---
18 |
19 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
20 |
21 |
22 |
--------------------------------------------------------------------------------
/src/gen/docs/models/LogService.md:
--------------------------------------------------------------------------------
1 | # Apideck.LogService
2 |
3 | ### Description
4 |
5 | Apideck service provider associated with request.
6 |
7 | ## Properties
8 | Name | Type | Description | Notes
9 | ------------ | ------------- | ------------- | -------------
10 | `id` | **string** | Apideck service provider id. |
11 | `name` | **string** | Apideck service provider name. |
12 |
13 |
14 |
15 |
16 |
17 | ---
18 |
19 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
20 |
21 |
22 |
--------------------------------------------------------------------------------
/src/gen/docs/models/LogsFilter.md:
--------------------------------------------------------------------------------
1 | # Apideck.LogsFilter
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `connector_id` | **string** | | [optional]
9 | `status_code` | **number** | | [optional]
10 | `exclude_unified_apis` | **string** | | [optional]
11 |
12 |
13 |
14 |
15 |
16 | ---
17 |
18 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
19 |
20 |
21 |
--------------------------------------------------------------------------------
/src/gen/docs/models/Meta.md:
--------------------------------------------------------------------------------
1 | # Apideck.Meta
2 |
3 | ### Description
4 |
5 | Response metadata
6 |
7 | ## Properties
8 | Name | Type | Description | Notes
9 | ------------ | ------------- | ------------- | -------------
10 | `items_on_page` | **number** | Number of items returned in the data property of the response | [optional]
11 | `cursors` | [**MetaCursors**](MetaCursors.md) | | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ## Referenced Types:
18 |
19 | * [`MetaCursors`](MetaCursors.md)
20 |
21 | ---
22 |
23 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
24 |
25 |
26 |
--------------------------------------------------------------------------------
/src/gen/docs/models/MetaCursors.md:
--------------------------------------------------------------------------------
1 | # Apideck.MetaCursors
2 |
3 | ### Description
4 |
5 | Cursors to navigate to previous or next pages through the API
6 |
7 | ## Properties
8 | Name | Type | Description | Notes
9 | ------------ | ------------- | ------------- | -------------
10 | `previous` | **string** | Cursor to navigate to the previous page of results through the API | [optional]
11 | `current` | **string** | Cursor to navigate to the current page of results through the API | [optional]
12 | `next` | **string** | Cursor to navigate to the next page of results through the API | [optional]
13 |
14 |
15 |
16 |
17 |
18 | ---
19 |
20 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
21 |
22 |
23 |
--------------------------------------------------------------------------------
/src/gen/docs/models/ModifierGroupFilter.md:
--------------------------------------------------------------------------------
1 | # Apideck.ModifierGroupFilter
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `modifier_group_id` | **string** | Id of the job to filter on | [optional]
9 |
10 |
11 |
12 |
13 |
14 | ---
15 |
16 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
17 |
18 |
19 |
--------------------------------------------------------------------------------
/src/gen/docs/models/OAuthGrantType.md:
--------------------------------------------------------------------------------
1 | # Apideck.OAuthGrantType
2 |
3 | ## Enum
4 |
5 |
6 | * `authorization_code` (value: `'authorization_code'`)
7 |
8 | * `client_credentials` (value: `'client_credentials'`)
9 |
10 | * `password` (value: `'password'`)
11 |
12 |
13 | ---
14 |
15 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
16 |
17 |
18 |
--------------------------------------------------------------------------------
/src/gen/docs/models/OrderCustomers.md:
--------------------------------------------------------------------------------
1 | # Apideck.OrderCustomers
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `id` | **string** | | [optional]
9 | `first_name` | **string** | | [optional]
10 | `middle_name` | **string** | | [optional]
11 | `last_name` | **string** | | [optional]
12 | `phone_numbers` | [**Array<PhoneNumber>**](PhoneNumber.md) | | [optional]
13 | `emails` | [**Array<Email>**](Email.md) | | [optional]
14 |
15 |
16 |
17 |
18 |
19 | ## Referenced Types:
20 |
21 |
22 |
23 |
24 | * [`PhoneNumber`](PhoneNumber.md)
25 | * [`Email`](Email.md)
26 |
27 | ---
28 |
29 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
30 |
31 |
32 |
--------------------------------------------------------------------------------
/src/gen/docs/models/OrderPayments.md:
--------------------------------------------------------------------------------
1 | # Apideck.OrderPayments
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `id` | **string** | A unique identifier for an object. | [optional]
9 | `amount` | **number** | | [optional]
10 | `currency` | [**Currency**](Currency.md) | | [optional]
11 |
12 |
13 |
14 |
15 |
16 | ## Referenced Types:
17 |
18 |
19 | * [`Currency`](Currency.md)
20 |
21 | ---
22 |
23 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
24 |
25 |
26 |
--------------------------------------------------------------------------------
/src/gen/docs/models/OrderPickupDetailsCurbsidePickupDetails.md:
--------------------------------------------------------------------------------
1 | # Apideck.OrderPickupDetailsCurbsidePickupDetails
2 |
3 | ### Description
4 |
5 | Specific details for curbside pickup.
6 |
7 | ## Properties
8 | Name | Type | Description | Notes
9 | ------------ | ------------- | ------------- | -------------
10 | `curbside_details` | **string** | Specific details for curbside pickup, such as parking number and vehicle model. | [optional]
11 | `buyer_arrived_at` | **Date** | Indicating when the buyer arrived and is waiting for pickup. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\"). | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ---
18 |
19 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
20 |
21 |
22 |
--------------------------------------------------------------------------------
/src/gen/docs/models/OrderPickupDetailsRecipient.md:
--------------------------------------------------------------------------------
1 | # Apideck.OrderPickupDetailsRecipient
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `customer_id` | **string** | | [optional]
9 | `display_name` | **string** | | [optional]
10 | `address` | [**Address**](Address.md) | | [optional]
11 | `phone_number` | [**PhoneNumber**](PhoneNumber.md) | | [optional]
12 | `email` | [**Email**](Email.md) | | [optional]
13 |
14 |
15 |
16 |
17 |
18 | ## Referenced Types:
19 |
20 |
21 | * [`Address`](Address.md)
22 | * [`PhoneNumber`](PhoneNumber.md)
23 | * [`Email`](Email.md)
24 |
25 | ---
26 |
27 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
28 |
29 |
30 |
--------------------------------------------------------------------------------
/src/gen/docs/models/OrdersSort.md:
--------------------------------------------------------------------------------
1 | # Apideck.OrdersSort
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `by` | **string** | The field on which to sort the Orders | [optional]
9 | `direction` | [**SortDirection**](SortDirection.md) | | [optional]
10 |
11 |
12 |
13 |
14 |
15 |
16 | ## Enum: OrdersSort.by
17 |
18 |
19 | * `created_at` (value: `'created_at'`)
20 |
21 | * `updated_at` (value: `'updated_at'`)
22 |
23 | * `name` (value: `'name'`)
24 |
25 |
26 |
27 |
28 | ## Referenced Types:
29 |
30 | * [`SortDirection`](SortDirection.md)
31 |
32 | ---
33 |
34 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
35 |
36 |
37 |
--------------------------------------------------------------------------------
/src/gen/docs/models/OutstandingBalanceByCurrency.md:
--------------------------------------------------------------------------------
1 | # Apideck.OutstandingBalanceByCurrency
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `currency` | [**Currency**](Currency.md) | | [optional]
9 | `total_amount` | **number** | Total amount of the outstanding balance. | [optional]
10 | `balances_by_period` | [**Array<BalanceByPeriod>**](BalanceByPeriod.md) | | [optional]
11 |
12 |
13 |
14 |
15 |
16 | ## Referenced Types:
17 | * [`Currency`](Currency.md)
18 |
19 | * [`BalanceByPeriod`](BalanceByPeriod.md)
20 |
21 | ---
22 |
23 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
24 |
25 |
26 |
--------------------------------------------------------------------------------
/src/gen/docs/models/OutstandingBalanceByCustomer.md:
--------------------------------------------------------------------------------
1 | # Apideck.OutstandingBalanceByCustomer
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `customer_id` | **string** | Unique identifier for the customer. | [optional]
9 | `customer_name` | **string** | Full name of the customer. | [optional]
10 | `outstanding_balances_by_currency` | [**Array<OutstandingBalanceByCurrency>**](OutstandingBalanceByCurrency.md) | | [optional]
11 |
12 |
13 |
14 |
15 |
16 | ## Referenced Types:
17 |
18 |
19 | * [`OutstandingBalanceByCurrency`](OutstandingBalanceByCurrency.md)
20 |
21 | ---
22 |
23 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
24 |
25 |
26 |
--------------------------------------------------------------------------------
/src/gen/docs/models/OutstandingBalanceBySupplier.md:
--------------------------------------------------------------------------------
1 | # Apideck.OutstandingBalanceBySupplier
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `supplier_id` | **string** | Unique identifier for the supplier. | [optional]
9 | `supplier_name` | **string** | Full name of the supplier. | [optional]
10 | `outstanding_balances_by_currency` | [**Array<OutstandingBalanceByCurrency>**](OutstandingBalanceByCurrency.md) | | [optional]
11 |
12 |
13 |
14 |
15 |
16 | ## Referenced Types:
17 |
18 |
19 | * [`OutstandingBalanceByCurrency`](OutstandingBalanceByCurrency.md)
20 |
21 | ---
22 |
23 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
24 |
25 |
26 |
--------------------------------------------------------------------------------
/src/gen/docs/models/Owner.md:
--------------------------------------------------------------------------------
1 | # Apideck.Owner
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `id` | **string** | ID of the owner | [optional]
9 | `email` | **string** | Email of the owner | [optional]
10 | `name` | **string** | Name of the owner | [optional]
11 |
12 |
13 |
14 |
15 |
16 | ---
17 |
18 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
19 |
20 |
21 |
--------------------------------------------------------------------------------
/src/gen/docs/models/PassThroughBody.md:
--------------------------------------------------------------------------------
1 | # Apideck.PassThroughBody
2 |
3 | ### Description
4 |
5 | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
6 |
7 | ## Properties
8 | Name | Type | Description | Notes
9 | ------------ | ------------- | ------------- | -------------
10 |
11 |
12 |
13 |
14 |
15 | ---
16 |
17 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
18 |
19 |
20 |
--------------------------------------------------------------------------------
/src/gen/docs/models/PassThroughQuery.md:
--------------------------------------------------------------------------------
1 | # Apideck.PassThroughQuery
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `example_downstream_property` | **string** | All passthrough query parameters are passed along to the connector as is (?pass_through[search]=leads becomes ?search=leads) | [optional]
9 |
10 |
11 |
12 |
13 |
14 | ---
15 |
16 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
17 |
18 |
19 |
--------------------------------------------------------------------------------
/src/gen/docs/models/PaymentFrequency.md:
--------------------------------------------------------------------------------
1 | # Apideck.PaymentFrequency
2 |
3 | ## Enum
4 |
5 |
6 | * `weekly` (value: `'weekly'`)
7 |
8 | * `biweekly` (value: `'biweekly'`)
9 |
10 | * `monthly` (value: `'monthly'`)
11 |
12 | * `pro_rata` (value: `'pro-rata'`)
13 |
14 | * `other` (value: `'other'`)
15 |
16 |
17 | ---
18 |
19 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
20 |
21 |
22 |
--------------------------------------------------------------------------------
/src/gen/docs/models/PaymentStatus.md:
--------------------------------------------------------------------------------
1 | # Apideck.PaymentStatus
2 |
3 | ## Enum
4 |
5 |
6 | * `draft` (value: `'draft'`)
7 |
8 | * `authorised` (value: `'authorised'`)
9 |
10 | * `rejected` (value: `'rejected'`)
11 |
12 | * `paid` (value: `'paid'`)
13 |
14 | * `voided` (value: `'voided'`)
15 |
16 | * `deleted` (value: `'deleted'`)
17 |
18 |
19 | ---
20 |
21 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
22 |
23 |
24 |
--------------------------------------------------------------------------------
/src/gen/docs/models/PaymentType.md:
--------------------------------------------------------------------------------
1 | # Apideck.PaymentType
2 |
3 | ## Enum
4 |
5 |
6 | * `receivable` (value: `'accounts_receivable'`)
7 |
8 | * `payable` (value: `'accounts_payable'`)
9 |
10 | * `receivable_credit` (value: `'accounts_receivable_credit'`)
11 |
12 | * `payable_credit` (value: `'accounts_payable_credit'`)
13 |
14 | * `receivable_overpayment` (value: `'accounts_receivable_overpayment'`)
15 |
16 | * `payable_overpayment` (value: `'accounts_payable_overpayment'`)
17 |
18 | * `receivable_prepayment` (value: `'accounts_receivable_prepayment'`)
19 |
20 | * `payable_prepayment` (value: `'accounts_payable_prepayment'`)
21 |
22 |
23 | ---
24 |
25 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
26 |
27 |
28 |
--------------------------------------------------------------------------------
/src/gen/docs/models/PaymentUnit.md:
--------------------------------------------------------------------------------
1 | # Apideck.PaymentUnit
2 |
3 | ## Enum
4 |
5 |
6 | * `hour` (value: `'hour'`)
7 |
8 | * `week` (value: `'week'`)
9 |
10 | * `month` (value: `'month'`)
11 |
12 | * `year` (value: `'year'`)
13 |
14 | * `paycheck` (value: `'paycheck'`)
15 |
16 | * `other` (value: `'other'`)
17 |
18 |
19 | ---
20 |
21 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
22 |
23 |
24 |
--------------------------------------------------------------------------------
/src/gen/docs/models/PaymentsFilter.md:
--------------------------------------------------------------------------------
1 | # Apideck.PaymentsFilter
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `updated_since` | **Date** | | [optional]
9 |
10 |
11 |
12 |
13 |
14 | ---
15 |
16 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
17 |
18 |
19 |
--------------------------------------------------------------------------------
/src/gen/docs/models/PaymentsSort.md:
--------------------------------------------------------------------------------
1 | # Apideck.PaymentsSort
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `by` | **string** | The field on which to sort the Payments | [optional]
9 | `direction` | [**SortDirection**](SortDirection.md) | | [optional]
10 |
11 |
12 |
13 |
14 |
15 |
16 | ## Enum: PaymentsSort.by
17 |
18 |
19 | * `updated_at` (value: `'updated_at'`)
20 |
21 | * `created_at` (value: `'created_at'`)
22 |
23 |
24 |
25 |
26 | ## Referenced Types:
27 |
28 | * [`SortDirection`](SortDirection.md)
29 |
30 | ---
31 |
32 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
33 |
34 |
35 |
--------------------------------------------------------------------------------
/src/gen/docs/models/PayrollsFilter.md:
--------------------------------------------------------------------------------
1 | # Apideck.PayrollsFilter
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `start_date` | **string** | Return payrolls whose pay period is after the start date | [optional]
9 | `end_date` | **string** | Return payrolls whose pay period is before the end date | [optional]
10 |
11 |
12 |
13 |
14 |
15 | ---
16 |
17 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
18 |
19 |
20 |
--------------------------------------------------------------------------------
/src/gen/docs/models/PipelineStages.md:
--------------------------------------------------------------------------------
1 | # Apideck.PipelineStages
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `id` | **string** | The unique identifier of the Pipeline Stage. | [optional]
9 | `name` | **string** | The name of the Pipeline Stage. | [optional]
10 | `value` | **string** | The value of the Pipeline Stage. | [optional]
11 | `win_probability` | **number** | The expected probability of winning an Opportunity in this Pipeline Stage. Valid values are [0-100]. | [optional]
12 | `display_order` | **number** | The order in which the Pipeline Stage is displayed in the UI. | [optional]
13 |
14 |
15 |
16 |
17 |
18 | ---
19 |
20 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
21 |
22 |
23 |
--------------------------------------------------------------------------------
/src/gen/docs/models/PosBankAccountAchDetails.md:
--------------------------------------------------------------------------------
1 | # Apideck.PosBankAccountAchDetails
2 |
3 | ### Description
4 |
5 | ACH-specific details about `BANK_ACCOUNT` type payments with the `transfer_type` of `ACH`.
6 |
7 | ## Properties
8 | Name | Type | Description | Notes
9 | ------------ | ------------- | ------------- | -------------
10 | `routing_number` | **string** | The routing number for the bank account. | [optional]
11 | `account_number_suffix` | **string** | The last few digits of the bank account number. | [optional]
12 | `account_type` | **string** | The type of the bank account performing the transfer. The account type can be `CHECKING`, `SAVINGS`, or `UNKNOWN`. | [optional]
13 |
14 |
15 |
16 |
17 |
18 | ---
19 |
20 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
21 |
22 |
23 |
--------------------------------------------------------------------------------
/src/gen/docs/models/PosPaymentCardDetails.md:
--------------------------------------------------------------------------------
1 | # Apideck.PosPaymentCardDetails
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `card` | [**PaymentCard**](PaymentCard.md) | | [optional]
9 |
10 |
11 |
12 |
13 |
14 | ## Referenced Types:
15 | * [`PaymentCard`](PaymentCard.md)
16 |
17 | ---
18 |
19 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
20 |
21 |
22 |
--------------------------------------------------------------------------------
/src/gen/docs/models/Price.md:
--------------------------------------------------------------------------------
1 | # Apideck.Price
2 |
3 | ### Description
4 |
5 | Price of the message.
6 |
7 | ## Properties
8 | Name | Type | Description | Notes
9 | ------------ | ------------- | ------------- | -------------
10 | `per_unit` | **string** | | [optional]
11 | `total_amount` | **string** | | [optional]
12 | `currency` | [**Currency**](Currency.md) | | [optional]
13 |
14 |
15 |
16 |
17 |
18 | ## Referenced Types:
19 |
20 |
21 | * [`Currency`](Currency.md)
22 |
23 | ---
24 |
25 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
26 |
27 |
28 |
--------------------------------------------------------------------------------
/src/gen/docs/models/ProbationPeriod.md:
--------------------------------------------------------------------------------
1 | # Apideck.ProbationPeriod
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `start_date` | **Date** | The date that the employee started their probation period at the company. | [optional]
9 | `end_date` | **Date** | The date that the employee ended their probation period at the company. | [optional]
10 |
11 |
12 |
13 |
14 |
15 | ---
16 |
17 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
18 |
19 |
20 |
--------------------------------------------------------------------------------
/src/gen/docs/models/ProfitAndLossFilter.md:
--------------------------------------------------------------------------------
1 | # Apideck.ProfitAndLossFilter
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `customer_id` | **string** | Filter by customer id | [optional]
9 | `start_date` | **string** | Filter by start date. If start date is given, end date is required. | [optional]
10 | `end_date` | **string** | Filter by end date. If end date is given, start date is required. | [optional]
11 |
12 |
13 |
14 |
15 |
16 | ---
17 |
18 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
19 |
20 |
21 |
--------------------------------------------------------------------------------
/src/gen/docs/models/ProfitAndLossIndicator.md:
--------------------------------------------------------------------------------
1 | # Apideck.ProfitAndLossIndicator
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `total` | **number** | The total amount of the transaction or record |
9 |
10 |
11 |
12 |
13 |
14 | ---
15 |
16 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
17 |
18 |
19 |
--------------------------------------------------------------------------------
/src/gen/docs/models/ProfitAndLossRecords.md:
--------------------------------------------------------------------------------
1 | # Apideck.ProfitAndLossRecords
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 |
9 |
10 |
11 |
12 |
13 | ---
14 |
15 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
16 |
17 |
18 |
--------------------------------------------------------------------------------
/src/gen/docs/models/ProfitAndLossType.md:
--------------------------------------------------------------------------------
1 | # Apideck.ProfitAndLossType
2 |
3 | ## Enum
4 |
5 |
6 | * `Section` (value: `'Section'`)
7 |
8 | * `Record` (value: `'Record'`)
9 |
10 |
11 | ---
12 |
13 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
14 |
15 |
16 |
--------------------------------------------------------------------------------
/src/gen/docs/models/PurchaseOrdersFilter.md:
--------------------------------------------------------------------------------
1 | # Apideck.PurchaseOrdersFilter
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `updated_since` | **Date** | | [optional]
9 | `supplier_id` | **string** | | [optional]
10 |
11 |
12 |
13 |
14 |
15 | ---
16 |
17 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
18 |
19 |
20 |
--------------------------------------------------------------------------------
/src/gen/docs/models/PurchaseOrdersSort.md:
--------------------------------------------------------------------------------
1 | # Apideck.PurchaseOrdersSort
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `by` | **string** | The field on which to sort the Purchase Orders | [optional]
9 | `direction` | [**SortDirection**](SortDirection.md) | | [optional]
10 |
11 |
12 |
13 |
14 |
15 |
16 | ## Enum: PurchaseOrdersSort.by
17 |
18 |
19 | * `updated_at` (value: `'updated_at'`)
20 |
21 | * `created_at` (value: `'created_at'`)
22 |
23 |
24 |
25 |
26 | ## Referenced Types:
27 |
28 | * [`SortDirection`](SortDirection.md)
29 |
30 | ---
31 |
32 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
33 |
34 |
35 |
--------------------------------------------------------------------------------
/src/gen/docs/models/Raw.md:
--------------------------------------------------------------------------------
1 | # Apideck.Raw
2 |
3 | ### Description
4 |
5 | Raw response from the integration when raw=true query param is provided
6 |
7 | ## Properties
8 | Name | Type | Description | Notes
9 | ------------ | ------------- | ------------- | -------------
10 |
11 |
12 |
13 |
14 |
15 | ---
16 |
17 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
18 |
19 |
20 |
--------------------------------------------------------------------------------
/src/gen/docs/models/RequestCountAllocation.md:
--------------------------------------------------------------------------------
1 | # Apideck.RequestCountAllocation
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `unify` | **number** | | [optional]
9 | `proxy` | **number** | | [optional]
10 | `vault` | **number** | | [optional]
11 |
12 |
13 |
14 |
15 |
16 | ---
17 |
18 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
19 |
20 |
21 |
--------------------------------------------------------------------------------
/src/gen/docs/models/RequestRate.md:
--------------------------------------------------------------------------------
1 | # Apideck.RequestRate
2 |
3 | ### Description
4 |
5 | The rate at which requests for resources will be made to downstream.
6 |
7 | ## Properties
8 | Name | Type | Description | Notes
9 | ------------ | ------------- | ------------- | -------------
10 | `rate` | **number** | The number of requests per window unit. |
11 | `size` | **number** | Size of request window. |
12 | `unit` | **string** | The window unit for the rate. |
13 |
14 |
15 |
16 |
17 |
18 |
19 | ## Enum: RequestRate.unit
20 |
21 |
22 | * `second` (value: `'second'`)
23 |
24 | * `minute` (value: `'minute'`)
25 |
26 | * `hour` (value: `'hour'`)
27 |
28 | * `day` (value: `'day'`)
29 |
30 |
31 |
32 |
33 | ---
34 |
35 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
36 |
37 |
38 |
--------------------------------------------------------------------------------
/src/gen/docs/models/ResolveWebhookEventRequest.md:
--------------------------------------------------------------------------------
1 | # Apideck.ResolveWebhookEventRequest
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 |
9 |
10 |
11 |
12 |
13 | ---
14 |
15 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
16 |
17 |
18 |
--------------------------------------------------------------------------------
/src/gen/docs/models/ResolveWebhookEventsRequest.md:
--------------------------------------------------------------------------------
1 | # Apideck.ResolveWebhookEventsRequest
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 |
9 |
10 |
11 |
12 |
13 | ---
14 |
15 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
16 |
17 |
18 |
--------------------------------------------------------------------------------
/src/gen/docs/models/ResolveWebhookResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.ResolveWebhookResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `request_id` | **string** | UUID of the request received | [optional]
11 | `timestamp` | **string** | ISO Datetime webhook event was received | [optional]
12 | `_raw` | [**Raw**](Raw.md) | | [optional]
13 |
14 |
15 |
16 |
17 |
18 | ## Referenced Types:
19 |
20 |
21 |
22 |
23 | * [`Raw`](Raw.md)
24 |
25 | ---
26 |
27 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
28 |
29 |
30 |
--------------------------------------------------------------------------------
/src/gen/docs/models/ResourceExample.md:
--------------------------------------------------------------------------------
1 | # Apideck.ResourceExample
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `unified_api` | [**UnifiedApiId**](UnifiedApiId.md) | | [optional]
9 | `service_id` | **string** | Service provider identifier | [optional]
10 | `resource` | [**LinkedConnectorResource**](LinkedConnectorResource.md) | | [optional]
11 | `example_response` | **object** | Example response from the downstream API | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ## Referenced Types:
18 | * [`UnifiedApiId`](UnifiedApiId.md)
19 |
20 | * [`LinkedConnectorResource`](LinkedConnectorResource.md)
21 |
22 |
23 | ---
24 |
25 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
26 |
27 |
28 |
--------------------------------------------------------------------------------
/src/gen/docs/models/ResourceStatus.md:
--------------------------------------------------------------------------------
1 | # Apideck.ResourceStatus
2 |
3 | ## Enum
4 |
5 |
6 | * `live` (value: `'live'`)
7 |
8 | * `beta` (value: `'beta'`)
9 |
10 | * `development` (value: `'development'`)
11 |
12 | * `upcoming` (value: `'upcoming'`)
13 |
14 | * `considering` (value: `'considering'`)
15 |
16 |
17 | ---
18 |
19 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
20 |
21 |
22 |
--------------------------------------------------------------------------------
/src/gen/docs/models/Schedule.md:
--------------------------------------------------------------------------------
1 | # Apideck.Schedule
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `id` | **string** | A unique identifier for an object. |
9 | `start_date` | **string** | The start date, inclusive, of the schedule period. |
10 | `end_date` | **string** | The end date, inclusive, of the schedule period. |
11 | `work_pattern` | [**ScheduleWorkPattern**](ScheduleWorkPattern.md) | |
12 |
13 |
14 |
15 |
16 |
17 | ## Referenced Types:
18 |
19 |
20 |
21 | * [`ScheduleWorkPattern`](ScheduleWorkPattern.md)
22 |
23 | ---
24 |
25 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
26 |
27 |
28 |
--------------------------------------------------------------------------------
/src/gen/docs/models/ScheduleWorkPattern.md:
--------------------------------------------------------------------------------
1 | # Apideck.ScheduleWorkPattern
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `odd_weeks` | [**ScheduleWorkPatternOddWeeks**](ScheduleWorkPatternOddWeeks.md) | | [optional]
9 | `even_weeks` | [**ScheduleWorkPatternOddWeeks**](ScheduleWorkPatternOddWeeks.md) | | [optional]
10 |
11 |
12 |
13 |
14 |
15 | ## Referenced Types:
16 | * [`ScheduleWorkPatternOddWeeks`](ScheduleWorkPatternOddWeeks.md)
17 | * [`ScheduleWorkPatternOddWeeks`](ScheduleWorkPatternOddWeeks.md)
18 |
19 | ---
20 |
21 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
22 |
23 |
24 |
--------------------------------------------------------------------------------
/src/gen/docs/models/ScheduleWorkPatternOddWeeks.md:
--------------------------------------------------------------------------------
1 | # Apideck.ScheduleWorkPatternOddWeeks
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `hours_monday` | **number** | | [optional]
9 | `hours_tuesday` | **number** | | [optional]
10 | `hours_wednesday` | **number** | | [optional]
11 | `hours_thursday` | **number** | | [optional]
12 | `hours_friday` | **number** | | [optional]
13 | `hours_saturday` | **number** | | [optional]
14 | `hours_sunday` | **number** | | [optional]
15 |
16 |
17 |
18 |
19 |
20 | ---
21 |
22 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
23 |
24 |
25 |
--------------------------------------------------------------------------------
/src/gen/docs/models/SchemaSupport.md:
--------------------------------------------------------------------------------
1 | # Apideck.SchemaSupport
2 |
3 | ### Description
4 |
5 | When a connector has schema_support, a call can be made to retrieve a json schema that describes a downstream resource.
6 |
7 | ## Properties
8 | Name | Type | Description | Notes
9 | ------------ | ------------- | ------------- | -------------
10 | `supported` | **boolean** | Can a resource schema be retrieved for this connector? | [optional]
11 |
12 |
13 |
14 |
15 |
16 | ---
17 |
18 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
19 |
20 |
21 |
--------------------------------------------------------------------------------
/src/gen/docs/models/ServiceCharges.md:
--------------------------------------------------------------------------------
1 | # Apideck.ServiceCharges
2 |
3 | ### Description
4 |
5 | Optional service charges or gratuity tip applied to the order.
6 |
7 | ## Properties
8 | Name | Type | Description | Notes
9 | ------------ | ------------- | ------------- | -------------
10 |
11 |
12 |
13 |
14 |
15 | ---
16 |
17 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
18 |
19 |
20 |
--------------------------------------------------------------------------------
/src/gen/docs/models/SharedLinkTarget.md:
--------------------------------------------------------------------------------
1 | # Apideck.SharedLinkTarget
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `id` | **string** | A unique identifier for an object. |
9 | `name` | **string** | The name of the file | [optional]
10 | `type` | [**FileType**](FileType.md) | | [optional]
11 |
12 |
13 |
14 |
15 |
16 | ## Referenced Types:
17 |
18 |
19 | * [`FileType`](FileType.md)
20 |
21 | ---
22 |
23 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
24 |
25 |
26 |
--------------------------------------------------------------------------------
/src/gen/docs/models/SimpleFormFieldOption.md:
--------------------------------------------------------------------------------
1 | # Apideck.SimpleFormFieldOption
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `label` | **string** | | [optional]
9 | `value` | **string \| number \| boolean \| Array<string \| number>** | | [optional]
10 |
11 |
12 |
13 |
14 |
15 | ---
16 |
17 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
18 |
19 |
20 |
--------------------------------------------------------------------------------
/src/gen/docs/models/SocialLink.md:
--------------------------------------------------------------------------------
1 | # Apideck.SocialLink
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `url` | **string** | URL of the social link, e.g. https://www.twitter.com/apideck |
9 | `id` | **string** | Unique identifier of the social link | [optional]
10 | `type` | **string** | Type of the social link, e.g. twitter | [optional]
11 |
12 |
13 |
14 |
15 |
16 | ---
17 |
18 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
19 |
20 |
21 |
--------------------------------------------------------------------------------
/src/gen/docs/models/SortDirection.md:
--------------------------------------------------------------------------------
1 | # Apideck.SortDirection
2 |
3 | ## Enum
4 |
5 |
6 | * `asc` (value: `'asc'`)
7 |
8 | * `desc` (value: `'desc'`)
9 |
10 |
11 | ---
12 |
13 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
14 |
15 |
16 |
--------------------------------------------------------------------------------
/src/gen/docs/models/Status.md:
--------------------------------------------------------------------------------
1 | # Apideck.Status
2 |
3 | ## Enum
4 |
5 |
6 | * `enabled` (value: `'enabled'`)
7 |
8 | * `disabled` (value: `'disabled'`)
9 |
10 |
11 | ---
12 |
13 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
14 |
15 |
16 |
--------------------------------------------------------------------------------
/src/gen/docs/models/SubsidiaryReference.md:
--------------------------------------------------------------------------------
1 | # Apideck.SubsidiaryReference
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `id` | **string** | A unique identifier for an object. | [optional]
9 | `name` | **string** | The name of the company. | [optional]
10 |
11 |
12 |
13 |
14 |
15 | ---
16 |
17 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
18 |
19 |
20 |
--------------------------------------------------------------------------------
/src/gen/docs/models/SuppliersFilter.md:
--------------------------------------------------------------------------------
1 | # Apideck.SuppliersFilter
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `company_name` | **string** | Company Name of supplier to search for | [optional]
9 | `display_name` | **string** | Display Name of supplier to search for | [optional]
10 | `first_name` | **string** | First name of supplier to search for | [optional]
11 | `last_name` | **string** | Last name of supplier to search for | [optional]
12 | `email` | **string** | Email of supplier to search for | [optional]
13 | `updated_since` | **Date** | | [optional]
14 |
15 |
16 |
17 |
18 |
19 | ---
20 |
21 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
22 |
23 |
24 |
--------------------------------------------------------------------------------
/src/gen/docs/models/SuppliersSort.md:
--------------------------------------------------------------------------------
1 | # Apideck.SuppliersSort
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `by` | **string** | The field on which to sort the Suppliers | [optional]
9 | `direction` | [**SortDirection**](SortDirection.md) | | [optional]
10 |
11 |
12 |
13 |
14 |
15 |
16 | ## Enum: SuppliersSort.by
17 |
18 |
19 | * `created_at` (value: `'created_at'`)
20 |
21 | * `updated_at` (value: `'updated_at'`)
22 |
23 |
24 |
25 |
26 | ## Referenced Types:
27 |
28 | * [`SortDirection`](SortDirection.md)
29 |
30 | ---
31 |
32 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
33 |
34 |
35 |
--------------------------------------------------------------------------------
/src/gen/docs/models/SupportedProperty.md:
--------------------------------------------------------------------------------
1 | # Apideck.SupportedProperty
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `unified_property` | **string** | Name of the property in our Unified API. | [optional]
9 | `child_properties` | [**Array<SupportedProperty>**](SupportedProperty.md) | List of child properties of the unified property. | [optional]
10 |
11 |
12 |
13 |
14 |
15 | ## Referenced Types:
16 |
17 | * [`SupportedProperty`](SupportedProperty.md)
18 |
19 | ---
20 |
21 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
22 |
23 |
24 |
--------------------------------------------------------------------------------
/src/gen/docs/models/Tags.md:
--------------------------------------------------------------------------------
1 | # Apideck.Tags
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 |
9 |
10 |
11 |
12 |
13 | ---
14 |
15 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
16 |
17 |
18 |
--------------------------------------------------------------------------------
/src/gen/docs/models/Tax.md:
--------------------------------------------------------------------------------
1 | # Apideck.Tax
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `name` | **string** | The name of the tax. | [optional]
9 | `employer` | **boolean** | Paid by employer. | [optional]
10 | `amount` | **number** | The amount of the tax. | [optional]
11 |
12 |
13 |
14 |
15 |
16 | ---
17 |
18 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
19 |
20 |
21 |
--------------------------------------------------------------------------------
/src/gen/docs/models/Team.md:
--------------------------------------------------------------------------------
1 | # Apideck.Team
2 |
3 | ### Description
4 |
5 | The team the person is currently in.
6 |
7 | ## Properties
8 | Name | Type | Description | Notes
9 | ------------ | ------------- | ------------- | -------------
10 | `id` | **string** | The unique identifier of the team. | [optional]
11 | `name` | **string** | The name of the team. | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ---
18 |
19 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
20 |
21 |
22 |
--------------------------------------------------------------------------------
/src/gen/docs/models/TicketsSort.md:
--------------------------------------------------------------------------------
1 | # Apideck.TicketsSort
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `by` | **string** | The field on which to sort the Tickets | [optional]
9 | `direction` | [**SortDirection**](SortDirection.md) | | [optional]
10 |
11 |
12 |
13 |
14 |
15 |
16 | ## Enum: TicketsSort.by
17 |
18 |
19 | * `created_at` (value: `'created_at'`)
20 |
21 | * `updated_at` (value: `'updated_at'`)
22 |
23 |
24 |
25 |
26 | ## Referenced Types:
27 |
28 | * [`SortDirection`](SortDirection.md)
29 |
30 | ---
31 |
32 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
33 |
34 |
35 |
--------------------------------------------------------------------------------
/src/gen/docs/models/TimeOffRequestNotes.md:
--------------------------------------------------------------------------------
1 | # Apideck.TimeOffRequestNotes
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `employee` | **string** | | [optional]
9 | `manager` | **string** | | [optional]
10 |
11 |
12 |
13 |
14 |
15 | ---
16 |
17 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
18 |
19 |
20 |
--------------------------------------------------------------------------------
/src/gen/docs/models/TooManyRequestsResponseDetail.md:
--------------------------------------------------------------------------------
1 | # Apideck.TooManyRequestsResponseDetail
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `context` | **string** | | [optional]
9 | `error` | **object** | | [optional]
10 |
11 |
12 |
13 |
14 |
15 | ---
16 |
17 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
18 |
19 |
20 |
--------------------------------------------------------------------------------
/src/gen/docs/models/UnifiedFilePermissions.md:
--------------------------------------------------------------------------------
1 | # Apideck.UnifiedFilePermissions
2 |
3 | ### Description
4 |
5 | Permissions the current user has on this file.
6 |
7 | ## Properties
8 | Name | Type | Description | Notes
9 | ------------ | ------------- | ------------- | -------------
10 | `download` | **boolean** | Whether the current user can download this file. | [optional]
11 |
12 |
13 |
14 |
15 |
16 | ---
17 |
18 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
19 |
20 |
21 |
--------------------------------------------------------------------------------
/src/gen/docs/models/UnifiedId.md:
--------------------------------------------------------------------------------
1 | # Apideck.UnifiedId
2 |
3 | ### Description
4 |
5 | A object containing a unique identifier for the resource that was created, updated, or deleted.
6 |
7 | ## Properties
8 | Name | Type | Description | Notes
9 | ------------ | ------------- | ------------- | -------------
10 | `id` | **string** | The unique identifier of the resource |
11 |
12 |
13 |
14 |
15 |
16 | ---
17 |
18 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
19 |
20 |
21 |
--------------------------------------------------------------------------------
/src/gen/docs/models/UpdateConnectionResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.UpdateConnectionResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `data` | [**Connection**](Connection.md) | |
11 | `_raw` | [**Raw**](Raw.md) | | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ## Referenced Types:
18 |
19 |
20 | * [`Connection`](Connection.md)
21 | * [`Raw`](Raw.md)
22 |
23 | ---
24 |
25 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
26 |
27 |
28 |
--------------------------------------------------------------------------------
/src/gen/docs/models/UpdateConsumerRequest.md:
--------------------------------------------------------------------------------
1 | # Apideck.UpdateConsumerRequest
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `metadata` | [**ConsumerMetadata**](ConsumerMetadata.md) | | [optional]
9 |
10 |
11 |
12 |
13 |
14 | ## Referenced Types:
15 | * [`ConsumerMetadata`](ConsumerMetadata.md)
16 |
17 | ---
18 |
19 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
20 |
21 |
22 |
--------------------------------------------------------------------------------
/src/gen/docs/models/UpdateConsumerResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.UpdateConsumerResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `data` | [**Consumer**](Consumer.md) | |
11 | `_raw` | [**Raw**](Raw.md) | | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ## Referenced Types:
18 |
19 |
20 | * [`Consumer`](Consumer.md)
21 | * [`Raw`](Raw.md)
22 |
23 | ---
24 |
25 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
26 |
27 |
28 |
--------------------------------------------------------------------------------
/src/gen/docs/models/UpdateCustomMappingRequest.md:
--------------------------------------------------------------------------------
1 | # Apideck.UpdateCustomMappingRequest
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `value` | **string** | Target Field Mapping value |
9 |
10 |
11 |
12 |
13 |
14 | ---
15 |
16 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
17 |
18 |
19 |
--------------------------------------------------------------------------------
/src/gen/docs/models/UpdateCustomMappingResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.UpdateCustomMappingResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `data` | [**CustomMapping**](CustomMapping.md) | |
11 | `_raw` | [**Raw**](Raw.md) | | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ## Referenced Types:
18 |
19 |
20 | * [`CustomMapping`](CustomMapping.md)
21 | * [`Raw`](Raw.md)
22 |
23 | ---
24 |
25 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
26 |
27 |
28 |
--------------------------------------------------------------------------------
/src/gen/docs/models/UpdateWebhookResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.UpdateWebhookResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `data` | [**Webhook**](Webhook.md) | |
11 | `_raw` | [**Raw**](Raw.md) | | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ## Referenced Types:
18 |
19 |
20 | * [`Webhook`](Webhook.md)
21 | * [`Raw`](Raw.md)
22 |
23 | ---
24 |
25 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
26 |
27 |
28 |
--------------------------------------------------------------------------------
/src/gen/docs/models/ValidateConnectionStateResponse.md:
--------------------------------------------------------------------------------
1 | # Apideck.ValidateConnectionStateResponse
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `status_code` | **number** | HTTP Response Status Code |
9 | `status` | **string** | HTTP Response Status |
10 | `data` | [**ValidateConnectionStateResponseData**](ValidateConnectionStateResponseData.md) | |
11 | `_raw` | [**Raw**](Raw.md) | | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ## Referenced Types:
18 |
19 |
20 | * [`ValidateConnectionStateResponseData`](ValidateConnectionStateResponseData.md)
21 | * [`Raw`](Raw.md)
22 |
23 | ---
24 |
25 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
26 |
27 |
28 |
--------------------------------------------------------------------------------
/src/gen/docs/models/ValidateConnectionStateResponseData.md:
--------------------------------------------------------------------------------
1 | # Apideck.ValidateConnectionStateResponseData
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `id` | **string** | The unique identifier of the connection. | [optional]
9 | `state` | [**ConnectionState**](ConnectionState.md) | | [optional]
10 |
11 |
12 |
13 |
14 |
15 | ## Referenced Types:
16 |
17 | * [`ConnectionState`](ConnectionState.md)
18 |
19 | ---
20 |
21 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
22 |
23 |
24 |
--------------------------------------------------------------------------------
/src/gen/docs/models/VaultEventType.md:
--------------------------------------------------------------------------------
1 | # Apideck.VaultEventType
2 |
3 | ## Enum
4 |
5 |
6 | * `Star` (value: `'*'`)
7 |
8 | * `vault_connection_created` (value: `'vault.connection.created'`)
9 |
10 | * `vault_connection_updated` (value: `'vault.connection.updated'`)
11 |
12 | * `vault_connection_disabled` (value: `'vault.connection.disabled'`)
13 |
14 | * `vault_connection_deleted` (value: `'vault.connection.deleted'`)
15 |
16 | * `vault_connection_callable` (value: `'vault.connection.callable'`)
17 |
18 | * `vault_connection_revoked` (value: `'vault.connection.revoked'`)
19 |
20 | * `vault_connection_token_refresh_failed` (value: `'vault.connection.token_refresh.failed'`)
21 |
22 |
23 | ---
24 |
25 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
26 |
27 |
28 |
--------------------------------------------------------------------------------
/src/gen/docs/models/VirtualWebhooks.md:
--------------------------------------------------------------------------------
1 | # Apideck.VirtualWebhooks
2 |
3 | ### Description
4 |
5 | Virtual webhook config for the connector.
6 |
7 | ## Properties
8 | Name | Type | Description | Notes
9 | ------------ | ------------- | ------------- | -------------
10 | `request_rate` | [**RequestRate**](RequestRate.md) | |
11 | `resources` | [**{ [key: string]: VirtualWebhooksResources; }**](VirtualWebhooksResources.md) | The resources that will be requested from downstream. | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ## Referenced Types:
18 | * [`RequestRate`](RequestRate.md)
19 | * [`VirtualWebhooksResources`](VirtualWebhooksResources.md)
20 |
21 | ---
22 |
23 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
24 |
25 |
26 |
--------------------------------------------------------------------------------
/src/gen/docs/models/VirtualWebhooksResources.md:
--------------------------------------------------------------------------------
1 | # Apideck.VirtualWebhooksResources
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `events` | **Array<string>** | | [optional]
9 |
10 |
11 |
12 |
13 |
14 | ---
15 |
16 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
17 |
18 |
19 |
--------------------------------------------------------------------------------
/src/gen/docs/models/WebhookEventLogAttempts.md:
--------------------------------------------------------------------------------
1 | # Apideck.WebhookEventLogAttempts
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `timestamp` | **string** | ISO Date and time when the request was made. | [optional]
9 | `execution_attempt` | **number** | Number of attempts webhook endpoint was called before a success was returned or eventually failed | [optional]
10 | `status_code` | **number** | HTTP Status code that was returned. | [optional]
11 | `success` | **boolean** | Whether or not the request was successful. | [optional]
12 |
13 |
14 |
15 |
16 |
17 | ---
18 |
19 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
20 |
21 |
22 |
--------------------------------------------------------------------------------
/src/gen/docs/models/WebhookEventLogService.md:
--------------------------------------------------------------------------------
1 | # Apideck.WebhookEventLogService
2 |
3 | ### Description
4 |
5 | Apideck service provider associated with event.
6 |
7 | ## Properties
8 | Name | Type | Description | Notes
9 | ------------ | ------------- | ------------- | -------------
10 | `id` | **string** | Apideck service provider id. |
11 | `name` | **string** | Apideck service provider name. |
12 |
13 |
14 |
15 |
16 |
17 | ---
18 |
19 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
20 |
21 |
22 |
--------------------------------------------------------------------------------
/src/gen/docs/models/WebhookEventLogsFilter.md:
--------------------------------------------------------------------------------
1 | # Apideck.WebhookEventLogsFilter
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `exclude_apis` | **string** | | [optional]
9 | `service` | [**WebhookEventLogsFilterService**](WebhookEventLogsFilterService.md) | | [optional]
10 | `consumer_id` | **string** | | [optional]
11 | `entity_type` | **string** | | [optional]
12 | `event_type` | **string** | | [optional]
13 |
14 |
15 |
16 |
17 |
18 | ## Referenced Types:
19 |
20 | * [`WebhookEventLogsFilterService`](WebhookEventLogsFilterService.md)
21 |
22 |
23 |
24 |
25 | ---
26 |
27 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
28 |
29 |
30 |
--------------------------------------------------------------------------------
/src/gen/docs/models/WebhookEventLogsFilterService.md:
--------------------------------------------------------------------------------
1 | # Apideck.WebhookEventLogsFilterService
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `id` | **string** | | [optional]
9 |
10 |
11 |
12 |
13 |
14 | ---
15 |
16 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
17 |
18 |
19 |
--------------------------------------------------------------------------------
/src/gen/docs/models/Website.md:
--------------------------------------------------------------------------------
1 | # Apideck.Website
2 |
3 | ### Description
4 |
5 | ## Properties
6 | Name | Type | Description | Notes
7 | ------------ | ------------- | ------------- | -------------
8 | `url` | **string** | The website URL |
9 | `id` | **string** | Unique identifier for the website | [optional]
10 | `type` | **string** | The type of website | [optional]
11 |
12 |
13 |
14 |
15 |
16 |
17 | ## Enum: Website.type
18 |
19 |
20 | * `primary` (value: `'primary'`)
21 |
22 | * `secondary` (value: `'secondary'`)
23 |
24 | * `work` (value: `'work'`)
25 |
26 | * `personal` (value: `'personal'`)
27 |
28 | * `other` (value: `'other'`)
29 |
30 |
31 |
32 |
33 | ---
34 |
35 | [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to README]](../../../../README.md)
36 |
37 |
38 |
--------------------------------------------------------------------------------
/src/gen/index.ts:
--------------------------------------------------------------------------------
1 | /* tslint:disable */
2 | /* eslint-disable */
3 | export * from './apis'
4 | export * from './models'
5 | export * from './runtime'
6 |
--------------------------------------------------------------------------------
/src/gen/models/ExecuteWebhookEventRequest.ts:
--------------------------------------------------------------------------------
1 | /* tslint:disable */
2 | /**
3 | *
4 | * @export
5 | * @interface ExecuteWebhookEventRequest
6 | */
7 | export interface ExecuteWebhookEventRequest {
8 | [key: string]: unknown
9 | }
10 |
11 | export function ExecuteWebhookEventRequestFromJSON(json: any): ExecuteWebhookEventRequest {
12 | return ExecuteWebhookEventRequestFromJSONTyped(json, false)
13 | }
14 |
15 | export function ExecuteWebhookEventRequestFromJSONTyped(
16 | json: any,
17 | ignoreDiscriminator: boolean
18 | ): ExecuteWebhookEventRequest {
19 | return json
20 | }
21 |
22 | export function ExecuteWebhookEventRequestToJSON(value?: ExecuteWebhookEventRequest | null): any {
23 | return value
24 | }
25 |
--------------------------------------------------------------------------------
/src/gen/models/ExecuteWebhookEventsRequest.ts:
--------------------------------------------------------------------------------
1 | /* tslint:disable */
2 | /**
3 | *
4 | * @export
5 | * @interface ExecuteWebhookEventsRequest
6 | */
7 | export interface ExecuteWebhookEventsRequest extends Array {}
8 |
9 | export function ExecuteWebhookEventsRequestFromJSON(json: any): ExecuteWebhookEventsRequest {
10 | return ExecuteWebhookEventsRequestFromJSONTyped(json, false)
11 | }
12 |
13 | export function ExecuteWebhookEventsRequestFromJSONTyped(
14 | json: any,
15 | ignoreDiscriminator: boolean
16 | ): ExecuteWebhookEventsRequest {
17 | return json
18 | }
19 |
20 | export function ExecuteWebhookEventsRequestToJSON(value?: ExecuteWebhookEventsRequest | null): any {
21 | return value
22 | }
23 |
--------------------------------------------------------------------------------
/src/gen/models/PassThroughBody.ts:
--------------------------------------------------------------------------------
1 | /* tslint:disable */
2 | /**
3 | * The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
4 | * @export
5 | * @interface PassThroughBody
6 | */
7 | export interface PassThroughBody extends Array