diff --git a/.devcontainer/README.md b/.devcontainer/README.md
index bd769fa4..1838593b 100644
--- a/.devcontainer/README.md
+++ b/.devcontainer/README.md
@@ -1,4 +1,9 @@
+
+
+
+
> **Remember to shutdown a GitHub Codespace when it is not in use!**
# Dev Containers Quick Start
diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock
index 3c91fdcd..4c6cd7cd 100644
--- a/.speakeasy/gen.lock
+++ b/.speakeasy/gen.lock
@@ -1,19 +1,21 @@
lockVersion: 2.0.0
id: fca0ac3a-5f4e-452c-bbc7-2311afa8da40
management:
- docChecksum: e0a152df239fd8497c0b664a85c58056
- docVersion: 10.8.3
- speakeasyVersion: 1.453.8
- generationVersion: 2.474.15
- releaseVersion: 0.1.7
- configChecksum: cea5b059544e6c210b438ae697b2f2c9
+ docChecksum: 2c1240637436833a37fb51eb9386a22d
+ docVersion: 10.9.0
+ speakeasyVersion: 1.455.7
+ generationVersion: 2.480.1
+ releaseVersion: 0.2.0
+ configChecksum: 7b169bf0238b9fbdb0efd6204f997851
+ repoURL: https://github.com/apideck-libraries/sdk-python.git
+ installationURL: https://github.com/apideck-libraries/sdk-python.git
published: true
features:
python:
acceptHeaders: 3.0.0
additionalDependencies: 1.0.0
constsAndDefaults: 1.0.5
- core: 5.6.11
+ core: 5.7.4
deepObjectParams: 0.1.0
defaultEnabledRetries: 0.2.0
deprecations: 3.0.0
@@ -22,19 +24,21 @@ features:
enumUnions: 0.1.0
envVarSecurityUsage: 0.3.2
errors: 3.2.0
+ flatRequests: 1.0.1
flattening: 3.1.0
globalSecurity: 3.0.2
globalSecurityCallbacks: 1.0.0
globalSecurityFlattening: 1.0.0
- globalServerURLs: 3.0.0
+ globalServerURLs: 3.1.0
globals: 3.0.0
groups: 3.0.0
hiddenGlobals: 1.0.0
inputOutputModels: 3.0.0
methodArguments: 1.0.2
- methodServerURLs: 3.0.0
+ methodServerURLs: 3.1.0
nameOverrides: 3.0.0
nullables: 1.0.0
+ pagination: 3.0.1
responseFormat: 1.0.1
retries: 3.0.2
sdkHooks: 1.0.0
@@ -49,9 +53,16 @@ generatedFiles:
- .vscode/settings.json
- CONTRIBUTING.md
- USAGE.md
+ - docs/models/accountingagedcreditorsoneglobals.md
+ - docs/models/accountingagedcreditorsonerequest.md
+ - docs/models/accountingagedcreditorsoneresponse.md
+ - docs/models/accountingageddebtorsoneglobals.md
+ - docs/models/accountingageddebtorsonerequest.md
+ - docs/models/accountingageddebtorsoneresponse.md
- docs/models/accountingattachmentsallglobals.md
- docs/models/accountingattachmentsallrequest.md
- docs/models/accountingattachmentsallresponse.md
+ - docs/models/accountingattachmentsallresponseresult.md
- docs/models/accountingattachmentsdeleteglobals.md
- docs/models/accountingattachmentsdeleterequest.md
- docs/models/accountingattachmentsdeleteresponse.md
@@ -70,6 +81,7 @@ generatedFiles:
- docs/models/accountingbillpaymentsallglobals.md
- docs/models/accountingbillpaymentsallrequest.md
- docs/models/accountingbillpaymentsallresponse.md
+ - docs/models/accountingbillpaymentsallresponseresult.md
- docs/models/accountingbillpaymentsdeleteglobals.md
- docs/models/accountingbillpaymentsdeleterequest.md
- docs/models/accountingbillpaymentsdeleteresponse.md
@@ -85,6 +97,7 @@ generatedFiles:
- docs/models/accountingbillsallglobals.md
- docs/models/accountingbillsallrequest.md
- docs/models/accountingbillsallresponse.md
+ - docs/models/accountingbillsallresponseresult.md
- docs/models/accountingbillsdeleteglobals.md
- docs/models/accountingbillsdeleterequest.md
- docs/models/accountingbillsdeleteresponse.md
@@ -103,6 +116,7 @@ generatedFiles:
- docs/models/accountingcreditnotesallglobals.md
- docs/models/accountingcreditnotesallrequest.md
- docs/models/accountingcreditnotesallresponse.md
+ - docs/models/accountingcreditnotesallresponseresult.md
- docs/models/accountingcreditnotesdeleteglobals.md
- docs/models/accountingcreditnotesdeleterequest.md
- docs/models/accountingcreditnotesdeleteresponse.md
@@ -118,6 +132,7 @@ generatedFiles:
- docs/models/accountingcustomersallglobals.md
- docs/models/accountingcustomersallrequest.md
- docs/models/accountingcustomersallresponse.md
+ - docs/models/accountingcustomersallresponseresult.md
- docs/models/accountingcustomersdeleteglobals.md
- docs/models/accountingcustomersdeleterequest.md
- docs/models/accountingcustomersdeleteresponse.md
@@ -135,6 +150,7 @@ generatedFiles:
- docs/models/accountingdepartmentsallglobals.md
- docs/models/accountingdepartmentsallrequest.md
- docs/models/accountingdepartmentsallresponse.md
+ - docs/models/accountingdepartmentsallresponseresult.md
- docs/models/accountingdepartmentsdeleteglobals.md
- docs/models/accountingdepartmentsdeleterequest.md
- docs/models/accountingdepartmentsdeleteresponse.md
@@ -151,6 +167,7 @@ generatedFiles:
- docs/models/accountingexpensesallglobals.md
- docs/models/accountingexpensesallrequest.md
- docs/models/accountingexpensesallresponse.md
+ - docs/models/accountingexpensesallresponseresult.md
- docs/models/accountingexpensesdeleteglobals.md
- docs/models/accountingexpensesdeleterequest.md
- docs/models/accountingexpensesdeleteresponse.md
@@ -166,6 +183,7 @@ generatedFiles:
- docs/models/accountinginvoiceitemsallglobals.md
- docs/models/accountinginvoiceitemsallrequest.md
- docs/models/accountinginvoiceitemsallresponse.md
+ - docs/models/accountinginvoiceitemsallresponseresult.md
- docs/models/accountinginvoiceitemsdeleteglobals.md
- docs/models/accountinginvoiceitemsdeleterequest.md
- docs/models/accountinginvoiceitemsdeleteresponse.md
@@ -181,6 +199,7 @@ generatedFiles:
- docs/models/accountinginvoicesallglobals.md
- docs/models/accountinginvoicesallrequest.md
- docs/models/accountinginvoicesallresponse.md
+ - docs/models/accountinginvoicesallresponseresult.md
- docs/models/accountinginvoicesdeleteglobals.md
- docs/models/accountinginvoicesdeleterequest.md
- docs/models/accountinginvoicesdeleteresponse.md
@@ -196,6 +215,7 @@ generatedFiles:
- docs/models/accountingjournalentriesallglobals.md
- docs/models/accountingjournalentriesallrequest.md
- docs/models/accountingjournalentriesallresponse.md
+ - docs/models/accountingjournalentriesallresponseresult.md
- docs/models/accountingjournalentriesdeleteglobals.md
- docs/models/accountingjournalentriesdeleterequest.md
- docs/models/accountingjournalentriesdeleteresponse.md
@@ -211,6 +231,7 @@ generatedFiles:
- docs/models/accountingledgeraccountsallglobals.md
- docs/models/accountingledgeraccountsallrequest.md
- docs/models/accountingledgeraccountsallresponse.md
+ - docs/models/accountingledgeraccountsallresponseresult.md
- docs/models/accountingledgeraccountsdeleteglobals.md
- docs/models/accountingledgeraccountsdeleterequest.md
- docs/models/accountingledgeraccountsdeleteresponse.md
@@ -228,6 +249,7 @@ generatedFiles:
- docs/models/accountinglocationsallglobals.md
- docs/models/accountinglocationsallrequest.md
- docs/models/accountinglocationsallresponse.md
+ - docs/models/accountinglocationsallresponseresult.md
- docs/models/accountinglocationsdeleteglobals.md
- docs/models/accountinglocationsdeleterequest.md
- docs/models/accountinglocationsdeleteresponse.md
@@ -244,6 +266,7 @@ generatedFiles:
- docs/models/accountingpaymentsallglobals.md
- docs/models/accountingpaymentsallrequest.md
- docs/models/accountingpaymentsallresponse.md
+ - docs/models/accountingpaymentsallresponseresult.md
- docs/models/accountingpaymentsdeleteglobals.md
- docs/models/accountingpaymentsdeleterequest.md
- docs/models/accountingpaymentsdeleteresponse.md
@@ -262,6 +285,7 @@ generatedFiles:
- docs/models/accountingpurchaseordersallglobals.md
- docs/models/accountingpurchaseordersallrequest.md
- docs/models/accountingpurchaseordersallresponse.md
+ - docs/models/accountingpurchaseordersallresponseresult.md
- docs/models/accountingpurchaseordersdeleteglobals.md
- docs/models/accountingpurchaseordersdeleterequest.md
- docs/models/accountingpurchaseordersdeleteresponse.md
@@ -277,6 +301,7 @@ generatedFiles:
- docs/models/accountingsubsidiariesallglobals.md
- docs/models/accountingsubsidiariesallrequest.md
- docs/models/accountingsubsidiariesallresponse.md
+ - docs/models/accountingsubsidiariesallresponseresult.md
- docs/models/accountingsubsidiariesdeleteglobals.md
- docs/models/accountingsubsidiariesdeleterequest.md
- docs/models/accountingsubsidiariesdeleteresponse.md
@@ -292,6 +317,7 @@ generatedFiles:
- docs/models/accountingsuppliersallglobals.md
- docs/models/accountingsuppliersallrequest.md
- docs/models/accountingsuppliersallresponse.md
+ - docs/models/accountingsuppliersallresponseresult.md
- docs/models/accountingsuppliersdeleteglobals.md
- docs/models/accountingsuppliersdeleterequest.md
- docs/models/accountingsuppliersdeleteresponse.md
@@ -307,6 +333,7 @@ generatedFiles:
- docs/models/accountingtaxratesallglobals.md
- docs/models/accountingtaxratesallrequest.md
- docs/models/accountingtaxratesallresponse.md
+ - docs/models/accountingtaxratesallresponseresult.md
- docs/models/accountingtaxratesdeleteglobals.md
- docs/models/accountingtaxratesdeleterequest.md
- docs/models/accountingtaxratesdeleteresponse.md
@@ -322,6 +349,7 @@ generatedFiles:
- docs/models/accountingtrackingcategoriesallglobals.md
- docs/models/accountingtrackingcategoriesallrequest.md
- docs/models/accountingtrackingcategoriesallresponse.md
+ - docs/models/accountingtrackingcategoriesallresponseresult.md
- docs/models/accountingtrackingcategoriesdeleteglobals.md
- docs/models/accountingtrackingcategoriesdeleterequest.md
- docs/models/accountingtrackingcategoriesdeleteresponse.md
@@ -344,6 +372,9 @@ generatedFiles:
- docs/models/activitytype.md
- docs/models/address.md
- docs/models/addresses.md
+ - docs/models/agedcreditors.md
+ - docs/models/ageddebtors.md
+ - docs/models/agedreportfilter.md
- docs/models/allocation.md
- docs/models/allocationinput.md
- docs/models/allocations.md
@@ -370,6 +401,7 @@ generatedFiles:
- docs/models/atsapplicantsallglobals.md
- docs/models/atsapplicantsallrequest.md
- docs/models/atsapplicantsallresponse.md
+ - docs/models/atsapplicantsallresponseresult.md
- docs/models/atsapplicantsdeleteglobals.md
- docs/models/atsapplicantsdeleterequest.md
- docs/models/atsapplicantsdeleteresponse.md
@@ -385,6 +417,7 @@ generatedFiles:
- docs/models/atsapplicationsallglobals.md
- docs/models/atsapplicationsallrequest.md
- docs/models/atsapplicationsallresponse.md
+ - docs/models/atsapplicationsallresponseresult.md
- docs/models/atsapplicationsdeleteglobals.md
- docs/models/atsapplicationsdeleterequest.md
- docs/models/atsapplicationsdeleteresponse.md
@@ -397,6 +430,7 @@ generatedFiles:
- docs/models/atsjobsallglobals.md
- docs/models/atsjobsallrequest.md
- docs/models/atsjobsallresponse.md
+ - docs/models/atsjobsallresponseresult.md
- docs/models/atsjobsoneglobals.md
- docs/models/atsjobsonerequest.md
- docs/models/atsjobsoneresponse.md
@@ -408,6 +442,8 @@ generatedFiles:
- docs/models/authtype.md
- docs/models/badrequestresponse.md
- docs/models/badrequestresponsedetail.md
+ - docs/models/balancebyperiod.md
+ - docs/models/balancebytransaction.md
- docs/models/balancesheet.md
- docs/models/balancesheetassetsaccount.md
- docs/models/balancesheetequityaccount.md
@@ -474,6 +510,7 @@ generatedFiles:
- docs/models/connectorapisallglobals.md
- docs/models/connectorapisallrequest.md
- docs/models/connectorapisallresponse.md
+ - docs/models/connectorapisallresponseresult.md
- docs/models/connectorapisoneglobals.md
- docs/models/connectorapisonerequest.md
- docs/models/connectorapisoneresponse.md
@@ -487,6 +524,7 @@ generatedFiles:
- docs/models/connectorconnectorsallglobals.md
- docs/models/connectorconnectorsallrequest.md
- docs/models/connectorconnectorsallresponse.md
+ - docs/models/connectorconnectorsallresponseresult.md
- docs/models/connectorconnectorsoneglobals.md
- docs/models/connectorconnectorsonerequest.md
- docs/models/connectorconnectorsoneresponse.md
@@ -578,6 +616,7 @@ generatedFiles:
- docs/models/crmactivitiesallglobals.md
- docs/models/crmactivitiesallrequest.md
- docs/models/crmactivitiesallresponse.md
+ - docs/models/crmactivitiesallresponseresult.md
- docs/models/crmactivitiesdeleteglobals.md
- docs/models/crmactivitiesdeleterequest.md
- docs/models/crmactivitiesdeleteresponse.md
@@ -593,6 +632,7 @@ generatedFiles:
- docs/models/crmcompaniesallglobals.md
- docs/models/crmcompaniesallrequest.md
- docs/models/crmcompaniesallresponse.md
+ - docs/models/crmcompaniesallresponseresult.md
- docs/models/crmcompaniesdeleteglobals.md
- docs/models/crmcompaniesdeleterequest.md
- docs/models/crmcompaniesdeleteresponse.md
@@ -608,6 +648,7 @@ generatedFiles:
- docs/models/crmcontactsallglobals.md
- docs/models/crmcontactsallrequest.md
- docs/models/crmcontactsallresponse.md
+ - docs/models/crmcontactsallresponseresult.md
- docs/models/crmcontactsdeleteglobals.md
- docs/models/crmcontactsdeleterequest.md
- docs/models/crmcontactsdeleteresponse.md
@@ -623,6 +664,7 @@ generatedFiles:
- docs/models/crmleadsallglobals.md
- docs/models/crmleadsallrequest.md
- docs/models/crmleadsallresponse.md
+ - docs/models/crmleadsallresponseresult.md
- docs/models/crmleadsdeleteglobals.md
- docs/models/crmleadsdeleterequest.md
- docs/models/crmleadsdeleteresponse.md
@@ -638,6 +680,7 @@ generatedFiles:
- docs/models/crmnotesallglobals.md
- docs/models/crmnotesallrequest.md
- docs/models/crmnotesallresponse.md
+ - docs/models/crmnotesallresponseresult.md
- docs/models/crmnotesdeleteglobals.md
- docs/models/crmnotesdeleterequest.md
- docs/models/crmnotesdeleteresponse.md
@@ -653,6 +696,7 @@ generatedFiles:
- docs/models/crmopportunitiesallglobals.md
- docs/models/crmopportunitiesallrequest.md
- docs/models/crmopportunitiesallresponse.md
+ - docs/models/crmopportunitiesallresponseresult.md
- docs/models/crmopportunitiesdeleteglobals.md
- docs/models/crmopportunitiesdeleterequest.md
- docs/models/crmopportunitiesdeleteresponse.md
@@ -668,6 +712,7 @@ generatedFiles:
- docs/models/crmpipelinesallglobals.md
- docs/models/crmpipelinesallrequest.md
- docs/models/crmpipelinesallresponse.md
+ - docs/models/crmpipelinesallresponseresult.md
- docs/models/crmpipelinesdeleteglobals.md
- docs/models/crmpipelinesdeleterequest.md
- docs/models/crmpipelinesdeleteresponse.md
@@ -683,6 +728,7 @@ generatedFiles:
- docs/models/crmusersallglobals.md
- docs/models/crmusersallrequest.md
- docs/models/crmusersallresponse.md
+ - docs/models/crmusersallresponseresult.md
- docs/models/crmusersdeleteglobals.md
- docs/models/crmusersdeleterequest.md
- docs/models/crmusersdeleteresponse.md
@@ -773,6 +819,7 @@ generatedFiles:
- docs/models/ecommercecustomersallglobals.md
- docs/models/ecommercecustomersallrequest.md
- docs/models/ecommercecustomersallresponse.md
+ - docs/models/ecommercecustomersallresponseresult.md
- docs/models/ecommercecustomersfilter.md
- docs/models/ecommercecustomersoneglobals.md
- docs/models/ecommercecustomersonerequest.md
@@ -785,6 +832,7 @@ generatedFiles:
- docs/models/ecommerceordersallglobals.md
- docs/models/ecommerceordersallrequest.md
- docs/models/ecommerceordersallresponse.md
+ - docs/models/ecommerceordersallresponseresult.md
- docs/models/ecommerceordersfilter.md
- docs/models/ecommerceordersoneglobals.md
- docs/models/ecommerceordersonerequest.md
@@ -797,6 +845,7 @@ generatedFiles:
- docs/models/ecommerceproductsallglobals.md
- docs/models/ecommerceproductsallrequest.md
- docs/models/ecommerceproductsallresponse.md
+ - docs/models/ecommerceproductsallresponseresult.md
- docs/models/ecommerceproductsoneglobals.md
- docs/models/ecommerceproductsonerequest.md
- docs/models/ecommerceproductsoneresponse.md
@@ -847,6 +896,7 @@ generatedFiles:
- docs/models/filestoragedrivegroupsallglobals.md
- docs/models/filestoragedrivegroupsallrequest.md
- docs/models/filestoragedrivegroupsallresponse.md
+ - docs/models/filestoragedrivegroupsallresponseresult.md
- docs/models/filestoragedrivegroupsdeleteglobals.md
- docs/models/filestoragedrivegroupsdeleterequest.md
- docs/models/filestoragedrivegroupsdeleteresponse.md
@@ -862,6 +912,7 @@ generatedFiles:
- docs/models/filestoragedrivesallglobals.md
- docs/models/filestoragedrivesallrequest.md
- docs/models/filestoragedrivesallresponse.md
+ - docs/models/filestoragedrivesallresponseresult.md
- docs/models/filestoragedrivesdeleteglobals.md
- docs/models/filestoragedrivesdeleterequest.md
- docs/models/filestoragedrivesdeleteresponse.md
@@ -874,6 +925,7 @@ generatedFiles:
- docs/models/filestoragefilesallglobals.md
- docs/models/filestoragefilesallrequest.md
- docs/models/filestoragefilesallresponse.md
+ - docs/models/filestoragefilesallresponseresult.md
- docs/models/filestoragefilesdeleteglobals.md
- docs/models/filestoragefilesdeleterequest.md
- docs/models/filestoragefilesdeleteresponse.md
@@ -913,6 +965,7 @@ generatedFiles:
- docs/models/filestoragesharedlinksallglobals.md
- docs/models/filestoragesharedlinksallrequest.md
- docs/models/filestoragesharedlinksallresponse.md
+ - docs/models/filestoragesharedlinksallresponseresult.md
- docs/models/filestoragesharedlinksdeleteglobals.md
- docs/models/filestoragesharedlinksdeleterequest.md
- docs/models/filestoragesharedlinksdeleteresponse.md
@@ -953,6 +1006,8 @@ generatedFiles:
- docs/models/getaccountinglocationsresponse.md
- docs/models/getactivitiesresponse.md
- docs/models/getactivityresponse.md
+ - docs/models/getagedcreditorsresponse.md
+ - docs/models/getageddebtorsresponse.md
- docs/models/getapiresourcecoverageresponse.md
- docs/models/getapiresourceresponse.md
- docs/models/getapiresponse.md
@@ -1073,6 +1128,7 @@ generatedFiles:
- docs/models/hriscompaniesallglobals.md
- docs/models/hriscompaniesallrequest.md
- docs/models/hriscompaniesallresponse.md
+ - docs/models/hriscompaniesallresponseresult.md
- docs/models/hriscompaniesdeleteglobals.md
- docs/models/hriscompaniesdeleterequest.md
- docs/models/hriscompaniesdeleteresponse.md
@@ -1091,6 +1147,7 @@ generatedFiles:
- docs/models/hrisdepartmentsallglobals.md
- docs/models/hrisdepartmentsallrequest.md
- docs/models/hrisdepartmentsallresponse.md
+ - docs/models/hrisdepartmentsallresponseresult.md
- docs/models/hrisdepartmentsdeleteglobals.md
- docs/models/hrisdepartmentsdeleterequest.md
- docs/models/hrisdepartmentsdeleteresponse.md
@@ -1112,6 +1169,7 @@ generatedFiles:
- docs/models/hrisemployeesallglobals.md
- docs/models/hrisemployeesallrequest.md
- docs/models/hrisemployeesallresponse.md
+ - docs/models/hrisemployeesallresponseresult.md
- docs/models/hrisemployeeschedulesallglobals.md
- docs/models/hrisemployeeschedulesallrequest.md
- docs/models/hrisemployeeschedulesallresponse.md
@@ -1136,6 +1194,7 @@ generatedFiles:
- docs/models/hristimeoffrequestsallglobals.md
- docs/models/hristimeoffrequestsallrequest.md
- docs/models/hristimeoffrequestsallresponse.md
+ - docs/models/hristimeoffrequestsallresponseresult.md
- docs/models/hristimeoffrequestsdeleteglobals.md
- docs/models/hristimeoffrequestsdeleterequest.md
- docs/models/hristimeoffrequestsdeleteresponse.md
@@ -1173,24 +1232,28 @@ generatedFiles:
- docs/models/issuetrackingcollectionsallglobals.md
- docs/models/issuetrackingcollectionsallrequest.md
- docs/models/issuetrackingcollectionsallresponse.md
+ - docs/models/issuetrackingcollectionsallresponseresult.md
- docs/models/issuetrackingcollectionsoneglobals.md
- docs/models/issuetrackingcollectionsonerequest.md
- docs/models/issuetrackingcollectionsoneresponse.md
- docs/models/issuetrackingcollectiontagsallglobals.md
- docs/models/issuetrackingcollectiontagsallrequest.md
- docs/models/issuetrackingcollectiontagsallresponse.md
+ - docs/models/issuetrackingcollectiontagsallresponseresult.md
- docs/models/issuetrackingcollectionticketcommentsaddglobals.md
- docs/models/issuetrackingcollectionticketcommentsaddrequest.md
- docs/models/issuetrackingcollectionticketcommentsaddresponse.md
- docs/models/issuetrackingcollectionticketcommentsallglobals.md
- docs/models/issuetrackingcollectionticketcommentsallrequest.md
- docs/models/issuetrackingcollectionticketcommentsallresponse.md
+ - docs/models/issuetrackingcollectionticketcommentsallresponseresult.md
- docs/models/issuetrackingcollectionticketcommentsdeleteglobals.md
- docs/models/issuetrackingcollectionticketcommentsdeleterequest.md
- docs/models/issuetrackingcollectionticketcommentsdeleteresponse.md
- docs/models/issuetrackingcollectionticketcommentsoneglobals.md
- docs/models/issuetrackingcollectionticketcommentsonerequest.md
- docs/models/issuetrackingcollectionticketcommentsoneresponse.md
+ - docs/models/issuetrackingcollectionticketcommentsoneresponseresult.md
- docs/models/issuetrackingcollectionticketcommentsupdateglobals.md
- docs/models/issuetrackingcollectionticketcommentsupdaterequest.md
- docs/models/issuetrackingcollectionticketcommentsupdateresponse.md
@@ -1200,6 +1263,7 @@ generatedFiles:
- docs/models/issuetrackingcollectionticketsallglobals.md
- docs/models/issuetrackingcollectionticketsallrequest.md
- docs/models/issuetrackingcollectionticketsallresponse.md
+ - docs/models/issuetrackingcollectionticketsallresponseresult.md
- docs/models/issuetrackingcollectionticketsdeleteglobals.md
- docs/models/issuetrackingcollectionticketsdeleterequest.md
- docs/models/issuetrackingcollectionticketsdeleteresponse.md
@@ -1212,6 +1276,7 @@ generatedFiles:
- docs/models/issuetrackingcollectionusersallglobals.md
- docs/models/issuetrackingcollectionusersallrequest.md
- docs/models/issuetrackingcollectionusersallresponse.md
+ - docs/models/issuetrackingcollectionusersallresponseresult.md
- docs/models/issuetrackingcollectionusersoneglobals.md
- docs/models/issuetrackingcollectionusersonerequest.md
- docs/models/issuetrackingcollectionusersoneresponse.md
@@ -1288,6 +1353,8 @@ generatedFiles:
- docs/models/options.md
- docs/models/orderssort.md
- docs/models/orderssortby.md
+ - docs/models/outstandingbalance.md
+ - docs/models/outstandingbalancebycurrency.md
- docs/models/owner.md
- docs/models/paginationcoverage.md
- docs/models/paginationcoveragemode.md
@@ -1358,6 +1425,7 @@ generatedFiles:
- docs/models/smsmessagesallglobals.md
- docs/models/smsmessagesallrequest.md
- docs/models/smsmessagesallresponse.md
+ - docs/models/smsmessagesallresponseresult.md
- docs/models/smsmessagesdeleteglobals.md
- docs/models/smsmessagesdeleterequest.md
- docs/models/smsmessagesdeleteresponse.md
@@ -1412,6 +1480,7 @@ generatedFiles:
- docs/models/trackingcategorystatus.md
- docs/models/trackingcategorysubsidiaries.md
- docs/models/trackingitem.md
+ - docs/models/transactiontype.md
- docs/models/type.md
- docs/models/unauthorizedresponse.md
- docs/models/unauthorizedresponsedetail.md
@@ -1515,6 +1584,7 @@ generatedFiles:
- docs/models/vaultconsumersallglobals.md
- docs/models/vaultconsumersallrequest.md
- docs/models/vaultconsumersallresponse.md
+ - docs/models/vaultconsumersallresponseresult.md
- docs/models/vaultconsumersdeleteglobals.md
- docs/models/vaultconsumersdeleterequest.md
- docs/models/vaultconsumersdeleteresponse.md
@@ -1536,6 +1606,7 @@ generatedFiles:
- docs/models/vaultlogsallglobals.md
- docs/models/vaultlogsallrequest.md
- docs/models/vaultlogsallresponse.md
+ - docs/models/vaultlogsallresponseresult.md
- docs/models/vaultsessionscreateglobals.md
- docs/models/vaultsessionscreateresponse.md
- docs/models/vaultvalidateconnectionstateglobals.md
@@ -1549,6 +1620,7 @@ generatedFiles:
- docs/models/webhookeventlogsallglobals.md
- docs/models/webhookeventlogsallrequest.md
- docs/models/webhookeventlogsallresponse.md
+ - docs/models/webhookeventlogsallresponseresult.md
- docs/models/webhookeventlogservice.md
- docs/models/webhookeventlogsfilter.md
- docs/models/webhookeventlogsfilterservice.md
@@ -1561,6 +1633,7 @@ generatedFiles:
- docs/models/webhookwebhooksallglobals.md
- docs/models/webhookwebhooksallrequest.md
- docs/models/webhookwebhooksallresponse.md
+ - docs/models/webhookwebhooksallresponseresult.md
- docs/models/webhookwebhooksdeleteglobals.md
- docs/models/webhookwebhooksdeleterequest.md
- docs/models/webhookwebhooksdeleteresponse.md
@@ -1576,6 +1649,8 @@ generatedFiles:
- docs/models/workpattern.md
- docs/sdks/accounting/README.md
- docs/sdks/activities/README.md
+ - docs/sdks/agedcreditorssdk/README.md
+ - docs/sdks/ageddebtorssdk/README.md
- docs/sdks/apideck/README.md
- docs/sdks/apideckcompanies/README.md
- docs/sdks/apideckcustomers/README.md
@@ -1673,6 +1748,8 @@ generatedFiles:
- src/apideck_unify/_version.py
- src/apideck_unify/accounting.py
- src/apideck_unify/activities.py
+ - src/apideck_unify/agedcreditors_sdk.py
+ - src/apideck_unify/ageddebtors_sdk.py
- src/apideck_unify/apideck_companies.py
- src/apideck_unify/apideck_customers.py
- src/apideck_unify/apideck_departments.py
@@ -1735,6 +1812,8 @@ generatedFiles:
- src/apideck_unify/logs.py
- src/apideck_unify/messages.py
- src/apideck_unify/models/__init__.py
+ - src/apideck_unify/models/accounting_agedcreditorsoneop.py
+ - src/apideck_unify/models/accounting_ageddebtorsoneop.py
- src/apideck_unify/models/accounting_attachmentsallop.py
- src/apideck_unify/models/accounting_attachmentsdeleteop.py
- src/apideck_unify/models/accounting_attachmentsdownloadop.py
@@ -1836,6 +1915,9 @@ generatedFiles:
- src/apideck_unify/models/activity.py
- src/apideck_unify/models/activityattendee.py
- src/apideck_unify/models/address.py
+ - src/apideck_unify/models/agedcreditors.py
+ - src/apideck_unify/models/ageddebtors.py
+ - src/apideck_unify/models/agedreportfilter.py
- src/apideck_unify/models/allocation.py
- src/apideck_unify/models/api.py
- src/apideck_unify/models/apierror.py
@@ -1865,6 +1947,8 @@ generatedFiles:
- src/apideck_unify/models/attachmentreferencetype.py
- src/apideck_unify/models/authtype.py
- src/apideck_unify/models/badrequestresponse.py
+ - src/apideck_unify/models/balancebyperiod.py
+ - src/apideck_unify/models/balancebytransaction.py
- src/apideck_unify/models/balancesheet.py
- src/apideck_unify/models/balancesheetfilter.py
- src/apideck_unify/models/bankaccount.py
@@ -2144,6 +2228,8 @@ generatedFiles:
- src/apideck_unify/models/getaccountinglocationsresponse.py
- src/apideck_unify/models/getactivitiesresponse.py
- src/apideck_unify/models/getactivityresponse.py
+ - src/apideck_unify/models/getagedcreditorsresponse.py
+ - src/apideck_unify/models/getageddebtorsresponse.py
- src/apideck_unify/models/getapiresourcecoverageresponse.py
- src/apideck_unify/models/getapiresourceresponse.py
- src/apideck_unify/models/getapiresponse.py
@@ -2353,6 +2439,8 @@ generatedFiles:
- src/apideck_unify/models/opportunity.py
- src/apideck_unify/models/opportunity_input.py
- src/apideck_unify/models/orderssort.py
+ - src/apideck_unify/models/outstandingbalance.py
+ - src/apideck_unify/models/outstandingbalancebycurrency.py
- src/apideck_unify/models/owner.py
- src/apideck_unify/models/paginationcoverage.py
- src/apideck_unify/models/passthroughbody.py
@@ -2593,7 +2681,7 @@ examples:
"402":
application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"}
"404":
- application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": {"not_found": {"entity": "widget", "id": "123"}}, "ref": "https://developers.apideck.com/errors#entitynotfounderror"}
+ application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"}
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
@@ -2675,7 +2763,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
accounting.billsAll:
"":
parameters:
@@ -2723,7 +2811,7 @@ examples:
"402":
application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"}
"404":
- application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": {"not_found": {"entity": "widget", "id": "123"}}, "ref": "https://developers.apideck.com/errors#entitynotfounderror"}
+ application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"}
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
@@ -2805,7 +2893,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
accounting.invoicesAll:
"":
parameters:
@@ -2935,7 +3023,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
accounting.ledgerAccountsAll:
"":
parameters:
@@ -2987,7 +3075,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
accounting.ledgerAccountsOne:
"":
parameters:
@@ -3065,7 +3153,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
accounting.invoiceItemsAll:
"":
parameters:
@@ -3112,7 +3200,7 @@ examples:
"402":
application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"}
"404":
- application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": {"not_found": {"entity": "widget", "id": "123"}}, "ref": "https://developers.apideck.com/errors#entitynotfounderror"}
+ application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"}
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
@@ -3195,7 +3283,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
accounting.creditNotesAll:
"":
parameters:
@@ -3325,7 +3413,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
accounting.customersAll:
"":
parameters:
@@ -3373,7 +3461,7 @@ examples:
"402":
application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"}
"404":
- application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": {"not_found": {"entity": "widget", "id": "123"}}, "ref": "https://developers.apideck.com/errors#entitynotfounderror"}
+ application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"}
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
@@ -3455,7 +3543,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
accounting.suppliersAll:
"":
parameters:
@@ -3503,7 +3591,7 @@ examples:
"402":
application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"}
"404":
- application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": {"not_found": {"entity": "widget", "id": "123"}}, "ref": "https://developers.apideck.com/errors#entitynotfounderror"}
+ application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"}
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
@@ -3585,7 +3673,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
accounting.paymentsAll:
"":
parameters:
@@ -3629,7 +3717,7 @@ examples:
"400":
application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"}
"401":
- application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": {"statusCode": 401, "error": "Unauthorized", "message": "Missing authentication"}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": "Missing authentication", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
"402":
application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"}
"404":
@@ -3715,7 +3803,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
accounting.companyInfoOne:
"":
parameters:
@@ -3838,7 +3926,7 @@ examples:
"402":
application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"}
"404":
- application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": {"not_found": {"entity": "widget", "id": "123"}}, "ref": "https://developers.apideck.com/errors#entitynotfounderror"}
+ application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"}
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
@@ -3920,7 +4008,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
accounting.purchaseOrdersAll:
"":
parameters:
@@ -3967,7 +4055,7 @@ examples:
"402":
application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"}
"404":
- application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": {"not_found": {"entity": "widget", "id": "123"}}, "ref": "https://developers.apideck.com/errors#entitynotfounderror"}
+ application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"}
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
@@ -4048,7 +4136,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
accounting.subsidiariesAll:
"":
parameters:
@@ -4097,7 +4185,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
accounting.subsidiariesOne:
"":
parameters:
@@ -4175,7 +4263,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
accounting.locationsAll:
"":
parameters:
@@ -4221,7 +4309,7 @@ examples:
"402":
application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"}
"404":
- application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": {"not_found": {"entity": "widget", "id": "123"}}, "ref": "https://developers.apideck.com/errors#entitynotfounderror"}
+ application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"}
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
@@ -4303,7 +4391,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
accounting.departmentsAll:
"":
parameters:
@@ -4349,7 +4437,7 @@ examples:
"402":
application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"}
"404":
- application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": {"not_found": {"entity": "widget", "id": "123"}}, "ref": "https://developers.apideck.com/errors#entitynotfounderror"}
+ application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"}
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
@@ -4431,7 +4519,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
accounting.attachmentsAll:
"":
parameters:
@@ -4513,7 +4601,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
accounting.attachmentsDownload:
"":
parameters:
@@ -4590,7 +4678,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
accounting.trackingCategoriesOne:
"":
parameters:
@@ -4668,7 +4756,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
accounting.billPaymentsAll:
"":
parameters:
@@ -4712,7 +4800,7 @@ examples:
"400":
application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"}
"401":
- application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": {"statusCode": 401, "error": "Unauthorized", "message": "Missing authentication"}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": "Missing authentication", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
"402":
application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"}
"404":
@@ -4798,7 +4886,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
accounting.expensesAll:
"":
parameters:
@@ -4838,7 +4926,7 @@ examples:
"400":
application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"}
"401":
- application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": {"statusCode": 401, "error": "Unauthorized", "message": "Missing authentication"}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": "Missing authentication", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
"402":
application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"}
"404":
@@ -4923,7 +5011,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
ats.jobsAll:
"":
parameters:
@@ -5021,7 +5109,7 @@ examples:
"402":
application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"}
"404":
- application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": {"not_found": {"entity": "widget", "id": "123"}}, "ref": "https://developers.apideck.com/errors#entitynotfounderror"}
+ application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"}
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
@@ -5103,7 +5191,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
ats.applicationsAll:
"":
parameters:
@@ -5152,7 +5240,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
ats.applicationsOne:
"":
parameters:
@@ -5229,7 +5317,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
crm.companiesAll:
"":
parameters:
@@ -5359,7 +5447,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
crm.contactsAll:
"":
parameters:
@@ -5490,7 +5578,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
crm.opportunitiesAll:
"":
parameters:
@@ -5538,7 +5626,7 @@ examples:
"402":
application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"}
"404":
- application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": {"not_found": {"entity": "widget", "id": "123"}}, "ref": "https://developers.apideck.com/errors#entitynotfounderror"}
+ application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"}
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
@@ -5620,7 +5708,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
crm.leadsAll:
"":
parameters:
@@ -5750,7 +5838,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
crm.pipelinesAll:
"":
parameters:
@@ -5796,7 +5884,7 @@ examples:
"402":
application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"}
"404":
- application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": {"not_found": {"entity": "widget", "id": "123"}}, "ref": "https://developers.apideck.com/errors#entitynotfounderror"}
+ application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"}
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
@@ -5878,7 +5966,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
crm.notesAll:
"":
parameters:
@@ -5928,7 +6016,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
crm.notesOne:
"":
parameters:
@@ -6006,7 +6094,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
crm.usersAll:
"":
parameters:
@@ -6052,7 +6140,7 @@ examples:
"402":
application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"}
"404":
- application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": {"not_found": {"entity": "widget", "id": "123"}}, "ref": "https://developers.apideck.com/errors#entitynotfounderror"}
+ application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"}
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
@@ -6134,7 +6222,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
crm.activitiesAll:
"":
parameters:
@@ -6182,7 +6270,7 @@ examples:
"402":
application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"}
"404":
- application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": {"not_found": {"entity": "widget", "id": "123"}}, "ref": "https://developers.apideck.com/errors#entitynotfounderror"}
+ application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"}
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
@@ -6264,7 +6352,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
ecommerce.ordersAll:
"":
parameters:
@@ -6577,7 +6665,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
fileStorage.filesDownload:
"":
parameters:
@@ -6655,7 +6743,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
fileStorage.foldersOne:
"":
parameters:
@@ -6733,7 +6821,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
fileStorage.foldersCopy:
"":
parameters:
@@ -6811,7 +6899,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
fileStorage.sharedLinksOne:
"":
parameters:
@@ -6889,7 +6977,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
fileStorage.uploadSessionsAdd:
"":
parameters:
@@ -6914,7 +7002,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
fileStorage.uploadSessionsOne:
"":
parameters:
@@ -6965,7 +7053,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
fileStorage.uploadSessionsFinish:
"":
parameters:
@@ -7041,7 +7129,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
fileStorage.drivesOne:
"":
parameters:
@@ -7119,7 +7207,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
fileStorage.driveGroupsAll:
"":
parameters:
@@ -7170,7 +7258,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
fileStorage.driveGroupsOne:
"":
parameters:
@@ -7248,7 +7336,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
hris.employeesAll:
"":
parameters:
@@ -7298,7 +7386,7 @@ examples:
"404":
application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"}
"422":
- application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"}
+ application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
hris.employeesOne:
@@ -7380,7 +7468,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
hris.companiesAll:
"":
parameters:
@@ -7422,7 +7510,7 @@ examples:
"400":
application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"}
"401":
- application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": {"statusCode": 401, "error": "Unauthorized", "message": "Missing authentication"}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": "Missing authentication", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
"402":
application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"}
"404":
@@ -7508,7 +7596,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
hris.departmentsAll:
"":
parameters:
@@ -7558,7 +7646,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
hris.departmentsOne:
"":
parameters:
@@ -7636,7 +7724,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
hris.payrollsAll:
"":
parameters:
@@ -7821,7 +7909,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
hris.timeOffRequestsOne:
"":
parameters:
@@ -7902,7 +7990,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
sms.messagesAll:
"":
parameters:
@@ -7951,7 +8039,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
sms.messagesOne:
"":
parameters:
@@ -8029,7 +8117,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
issueTracking.collectionsAll:
"":
parameters:
@@ -8133,7 +8221,7 @@ examples:
"402":
application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"}
"404":
- application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": {"not_found": {"entity": "widget", "id": "123"}}, "ref": "https://developers.apideck.com/errors#entitynotfounderror"}
+ application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"}
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
@@ -8218,7 +8306,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
issueTracking.collectionTicketCommentsAll:
"":
parameters:
@@ -8275,7 +8363,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
issueTracking.collectionTicketCommentsOne:
"":
parameters:
@@ -8359,7 +8447,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
issueTracking.collectionUsersAll:
"":
parameters:
@@ -8612,7 +8700,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
vault.consumersAll:
"":
parameters:
@@ -8701,7 +8789,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
vault.consumerRequestCountsAll:
"":
parameters:
@@ -8822,7 +8910,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
vault.connectionsImport:
"":
parameters:
@@ -8870,7 +8958,7 @@ examples:
"404":
application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"}
"422":
- application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"}
+ application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
vault.validateConnectionState:
@@ -8892,7 +8980,7 @@ examples:
"402":
application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"}
"404":
- application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": {"not_found": {"entity": "widget", "id": "123"}}, "ref": "https://developers.apideck.com/errors#entitynotfounderror"}
+ application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"}
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
@@ -8918,7 +9006,7 @@ examples:
"402":
application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"}
"404":
- application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": {"not_found": {"entity": "widget", "id": "123"}}, "ref": "https://developers.apideck.com/errors#entitynotfounderror"}
+ application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": "Could not find widget with id: '123'", "ref": "https://developers.apideck.com/errors#entitynotfounderror"}
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
@@ -9187,7 +9275,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
webhook.webhooksDelete:
"":
parameters:
@@ -9209,7 +9297,7 @@ examples:
"422":
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
- application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": {"missing": [{"x-apideck-consumer-id": "required"}]}, "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
webhook.eventLogsAll:
"":
parameters:
@@ -9232,4 +9320,56 @@ examples:
application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": {"error": "Unprocessable", "message": "Unprocessable request, please verify your request headers and body."}, "ref": "https://developers.apideck.com/errors#invalidstateerror"}
default:
application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ accounting.agedCreditorsOne:
+ "":
+ parameters:
+ query:
+ filter: {"customer_id": "123abc", "report_as_of_date": "2024-01-01", "period_count": 3, "period_length": 30}
+ pass_through: {"search": "San Francisco"}
+ fields: "id,updated_at"
+ header:
+ x-apideck-consumer-id: "test-consumer"
+ x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX"
+ x-apideck-service-id: "salesforce"
+ responses:
+ "200":
+ application/json: {"status_code": 200, "status": "OK", "service": "quickbooks", "resource": "AgedCreditors", "operation": "one", "data": {"report_generated_at": "2024-11-14T12:00:00.000Z", "report_as_of_date": "2024-11-13", "period_count": 4, "period_length": 30, "outstanding_balances": [{"customer_id": "123", "customer_name": "Super Store", "outstanding_balances_by_currency": [{"currency": "USD", "balances_by_period": [{"start_date": "2024-01-01", "end_date": "2024-01-30", "total_amount": 1500, "balances_by_transaction": [{"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800}, {"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800}]}, {"start_date": "2024-01-01", "end_date": "2024-01-30", "total_amount": 1500, "balances_by_transaction": [{"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800}, {"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800}, {"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800}]}]}, {"currency": "USD", "balances_by_period": [{"start_date": "2024-01-01", "end_date": "2024-01-30", "total_amount": 1500, "balances_by_transaction": [{"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800}]}]}]}, {"customer_id": "123", "customer_name": "Super Store", "outstanding_balances_by_currency": [{"currency": "USD", "balances_by_period": []}]}]}}
+ "400":
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"}
+ "401":
+ application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": "Missing authentication", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ "402":
+ application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"}
+ "404":
+ application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": {"not_found": {"entity": "widget", "id": "123"}}, "ref": "https://developers.apideck.com/errors#entitynotfounderror"}
+ "422":
+ application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
+ default:
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ accounting.agedDebtorsOne:
+ "":
+ parameters:
+ query:
+ filter: {"customer_id": "123abc", "report_as_of_date": "2024-01-01", "period_count": 3, "period_length": 30}
+ pass_through: {"search": "San Francisco"}
+ fields: "id,updated_at"
+ header:
+ x-apideck-consumer-id: "test-consumer"
+ x-apideck-app-id: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX"
+ x-apideck-service-id: "salesforce"
+ responses:
+ "200":
+ application/json: {"status_code": 200, "status": "OK", "service": "quickbooks", "resource": "AgedDebtors", "operation": "one", "data": {"report_generated_at": "2024-11-14T12:00:00.000Z", "report_as_of_date": "2024-11-13", "period_count": 4, "period_length": 30, "outstanding_balances": [{"customer_id": "123", "customer_name": "Super Store", "outstanding_balances_by_currency": [{"currency": "USD", "balances_by_period": [{"start_date": "2024-01-01", "end_date": "2024-01-30", "total_amount": 1500, "balances_by_transaction": [{"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800}, {"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800}]}, {"start_date": "2024-01-01", "end_date": "2024-01-30", "total_amount": 1500, "balances_by_transaction": [{"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800}, {"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800}, {"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800}]}]}, {"currency": "USD", "balances_by_period": [{"start_date": "2024-01-01", "end_date": "2024-01-30", "total_amount": 1500, "balances_by_transaction": [{"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800}]}]}]}, {"customer_id": "123", "customer_name": "Super Store", "outstanding_balances_by_currency": [{"currency": "USD", "balances_by_period": []}]}]}}
+ "400":
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"}
+ "401":
+ application/json: {"status_code": 401, "error": "Unauthorized", "type_name": "UnauthorizedError", "message": "Unauthorized Request", "detail": "Missing authentication", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
+ "402":
+ application/json: {"status_code": 402, "error": "Payment Required", "type_name": "RequestLimitError", "message": "Request Limit Reached", "detail": "You have reached your limit of 2000", "ref": "https://developers.apideck.com/errors#requestlimiterror"}
+ "404":
+ application/json: {"status_code": 404, "error": "Not Found", "type_name": "EntityNotFoundError", "message": "Unknown Widget", "detail": {"not_found": {"entity": "widget", "id": "123"}}, "ref": "https://developers.apideck.com/errors#entitynotfounderror"}
+ "422":
+ application/json: {"status_code": 422, "error": "Unprocessable Entity", "type_name": "InvalidStateError", "message": "Invalid State", "detail": "Unprocessable request, please verify your request headers and body.", "ref": "https://developers.apideck.com/errors#invalidstateerror"}
+ default:
+ application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"}
generatedTests: {}
diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml
index 2a8cc718..80200126 100644
--- a/.speakeasy/gen.yaml
+++ b/.speakeasy/gen.yaml
@@ -16,7 +16,7 @@ generation:
oAuth2ClientCredentialsEnabled: true
oAuth2PasswordEnabled: true
python:
- version: 0.1.7
+ version: 0.2.0
additionalDependencies:
dev: {}
main: {}
@@ -30,7 +30,7 @@ python:
fixFlags:
responseRequiredSep2024: true
flattenGlobalSecurity: true
- flattenRequests: true # keyword arguments are more idiomatic in python
+ flattenRequests: true
flatteningOrder: parameters-first
imports:
option: openapi
@@ -41,7 +41,7 @@ python:
shared: ""
webhooks: ""
inputModelSuffix: input
- maxMethodParams: 999 # an arbitrarily high number, keyword arguments are more idiomatic in python
+ maxMethodParams: 999
methodArguments: infer-optional-args
outputModelSuffix: output
packageName: apideck-unify
diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock
index f5e2e107..fd09ce49 100644
--- a/.speakeasy/workflow.lock
+++ b/.speakeasy/workflow.lock
@@ -1,20 +1,21 @@
-speakeasyVersion: 1.453.8
+speakeasyVersion: 1.455.7
sources:
Apideck:
sourceNamespace: apideck
- sourceRevisionDigest: sha256:4370f91648df925a9cd5ee51f82e76448642303ca9fde1ea6aadf656bfe5694e
- sourceBlobDigest: sha256:19939b73f05d1c30fba2779c43866e9c4d163b4e97a074b3a8961a34e04e5e8f
+ sourceRevisionDigest: sha256:7ad98940134a0b924d775969413213f4b1482c45c5c9d403e320b0ce7bb53497
+ sourceBlobDigest: sha256:9bef0e086cb2350115d5a1ae42a521b9afd171752d7b9a5628ee0eab8c7e3ca0
tags:
- latest
- - 10.8.3
+ - speakeasy-sdk-regen-1734394679
+ - 10.9.0
targets:
apideck:
source: Apideck
sourceNamespace: apideck
- sourceRevisionDigest: sha256:4370f91648df925a9cd5ee51f82e76448642303ca9fde1ea6aadf656bfe5694e
- sourceBlobDigest: sha256:19939b73f05d1c30fba2779c43866e9c4d163b4e97a074b3a8961a34e04e5e8f
+ sourceRevisionDigest: sha256:7ad98940134a0b924d775969413213f4b1482c45c5c9d403e320b0ce7bb53497
+ sourceBlobDigest: sha256:9bef0e086cb2350115d5a1ae42a521b9afd171752d7b9a5628ee0eab8c7e3ca0
codeSamplesNamespace: apideck-python-code-samples
- codeSamplesRevisionDigest: sha256:3e9b2e781657df8ba931972b4537cab054eedda9568491c6d850f139a1b9c52b
+ codeSamplesRevisionDigest: sha256:35106c07382fcda3b0d6ce19e116943fdf606a8bb7d1fc4a6d3b7bc31927c171
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest
diff --git a/README.md b/README.md
index e16ba403..020d1831 100644
--- a/README.md
+++ b/README.md
@@ -31,6 +31,7 @@ For more information about the API: [Apideck Developer Docs](https://developers.
* [SDK Example Usage](#sdk-example-usage)
* [Authentication](#authentication)
* [Available Resources and Operations](#available-resources-and-operations)
+ * [Pagination](#pagination)
* [Retries](#retries)
* [Error Handling](#error-handling)
* [Server Selection](#server-selection)
@@ -89,24 +90,21 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.accounting.tax_rates.list(request={
- "service_id": "salesforce",
- "filter_": {
- "assets": True,
- "equity": True,
- "expenses": True,
- "liabilities": True,
- "revenue": True,
- },
- "pass_through": {
- "search": "San Francisco",
- },
- "fields": "id,updated_at",
- })
- if res is not None:
- # handle response
- pass
+ res = apideck.accounting.tax_rates.list(service_id="salesforce", filter_={
+ "assets": True,
+ "equity": True,
+ "expenses": True,
+ "liabilities": True,
+ "revenue": True,
+ }, pass_through={
+ "search": "San Francisco",
+ }, fields="id,updated_at")
+
+ while res is not None:
+ # Handle items
+
+ res = res.next()
```
@@ -124,24 +122,21 @@ async def main():
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = await apideck.accounting.tax_rates.list_async(request={
- "service_id": "salesforce",
- "filter_": {
- "assets": True,
- "equity": True,
- "expenses": True,
- "liabilities": True,
- "revenue": True,
- },
- "pass_through": {
- "search": "San Francisco",
- },
- "fields": "id,updated_at",
- })
-
- if res is not None:
- # handle response
- pass
+
+ res = await apideck.accounting.tax_rates.list_async(service_id="salesforce", filter_={
+ "assets": True,
+ "equity": True,
+ "expenses": True,
+ "liabilities": True,
+ "revenue": True,
+ }, pass_through={
+ "search": "San Francisco",
+ }, fields="id,updated_at")
+
+ while res is not None:
+ # Handle items
+
+ res = res.next()
asyncio.run(main())
```
@@ -168,24 +163,21 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.accounting.tax_rates.list(request={
- "service_id": "salesforce",
- "filter_": {
- "assets": True,
- "equity": True,
- "expenses": True,
- "liabilities": True,
- "revenue": True,
- },
- "pass_through": {
- "search": "San Francisco",
- },
- "fields": "id,updated_at",
- })
- if res is not None:
- # handle response
- pass
+ res = apideck.accounting.tax_rates.list(service_id="salesforce", filter_={
+ "assets": True,
+ "equity": True,
+ "expenses": True,
+ "liabilities": True,
+ "revenue": True,
+ }, pass_through={
+ "search": "San Francisco",
+ }, fields="id,updated_at")
+
+ while res is not None:
+ # Handle items
+
+ res = res.next()
```
@@ -199,6 +191,14 @@ with Apideck(
### [accounting](docs/sdks/accounting/README.md)
+#### [accounting.aged_creditors](docs/sdks/agedcreditorssdk/README.md)
+
+* [get](docs/sdks/agedcreditorssdk/README.md#get) - Get Aged Creditors
+
+#### [accounting.aged_debtors](docs/sdks/ageddebtorssdk/README.md)
+
+* [get](docs/sdks/ageddebtorssdk/README.md#get) - Get Aged Debtors
+
#### [accounting.attachments](docs/sdks/attachments/README.md)
* [list](docs/sdks/attachments/README.md#list) - List Attachments
@@ -717,6 +717,42 @@ with Apideck(
+
+## Pagination
+
+Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the
+returned response object will have a `Next` method that can be called to pull down the next group of results. If the
+return value of `Next` is `None`, then there are no more pages to be fetched.
+
+Here's an example of one such pagination call:
+```python
+from apideck_unify import Apideck
+import os
+
+with Apideck(
+ api_key=os.getenv("APIDECK_API_KEY", ""),
+ consumer_id="test-consumer",
+ app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
+) as apideck:
+
+ res = apideck.accounting.tax_rates.list(service_id="salesforce", filter_={
+ "assets": True,
+ "equity": True,
+ "expenses": True,
+ "liabilities": True,
+ "revenue": True,
+ }, pass_through={
+ "search": "San Francisco",
+ }, fields="id,updated_at")
+
+ while res is not None:
+ # Handle items
+
+ res = res.next()
+
+```
+
+
## Retries
@@ -733,25 +769,22 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.accounting.tax_rates.list(request={
- "service_id": "salesforce",
- "filter_": {
- "assets": True,
- "equity": True,
- "expenses": True,
- "liabilities": True,
- "revenue": True,
- },
- "pass_through": {
- "search": "San Francisco",
- },
- "fields": "id,updated_at",
- },
+
+ res = apideck.accounting.tax_rates.list(service_id="salesforce", filter_={
+ "assets": True,
+ "equity": True,
+ "expenses": True,
+ "liabilities": True,
+ "revenue": True,
+ }, pass_through={
+ "search": "San Francisco",
+ }, fields="id,updated_at",
RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
- if res is not None:
- # handle response
- pass
+ while res is not None:
+ # Handle items
+
+ res = res.next()
```
@@ -767,24 +800,21 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.accounting.tax_rates.list(request={
- "service_id": "salesforce",
- "filter_": {
- "assets": True,
- "equity": True,
- "expenses": True,
- "liabilities": True,
- "revenue": True,
- },
- "pass_through": {
- "search": "San Francisco",
- },
- "fields": "id,updated_at",
- })
- if res is not None:
- # handle response
- pass
+ res = apideck.accounting.tax_rates.list(service_id="salesforce", filter_={
+ "assets": True,
+ "equity": True,
+ "expenses": True,
+ "liabilities": True,
+ "revenue": True,
+ }, pass_through={
+ "search": "San Francisco",
+ }, fields="id,updated_at")
+
+ while res is not None:
+ # Handle items
+
+ res = res.next()
```
@@ -827,24 +857,21 @@ with Apideck(
) as apideck:
res = None
try:
- res = apideck.accounting.tax_rates.list(request={
- "service_id": "salesforce",
- "filter_": {
- "assets": True,
- "equity": True,
- "expenses": True,
- "liabilities": True,
- "revenue": True,
- },
- "pass_through": {
- "search": "San Francisco",
- },
- "fields": "id,updated_at",
- })
-
- if res is not None:
- # handle response
- pass
+
+ res = apideck.accounting.tax_rates.list(service_id="salesforce", filter_={
+ "assets": True,
+ "equity": True,
+ "expenses": True,
+ "liabilities": True,
+ "revenue": True,
+ }, pass_through={
+ "search": "San Francisco",
+ }, fields="id,updated_at")
+
+ while res is not None:
+ # Handle items
+
+ res = res.next()
except models.BadRequestResponse as e:
# handle e.data: models.BadRequestResponseData
@@ -883,24 +910,21 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.accounting.tax_rates.list(request={
- "service_id": "salesforce",
- "filter_": {
- "assets": True,
- "equity": True,
- "expenses": True,
- "liabilities": True,
- "revenue": True,
- },
- "pass_through": {
- "search": "San Francisco",
- },
- "fields": "id,updated_at",
- })
- if res is not None:
- # handle response
- pass
+ res = apideck.accounting.tax_rates.list(service_id="salesforce", filter_={
+ "assets": True,
+ "equity": True,
+ "expenses": True,
+ "liabilities": True,
+ "revenue": True,
+ }, pass_through={
+ "search": "San Francisco",
+ }, fields="id,updated_at")
+
+ while res is not None:
+ # Handle items
+
+ res = res.next()
```
@@ -916,39 +940,33 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.file_storage.upload_sessions.create(create_upload_session_request={
- "name": "Documents",
- "parent_folder_id": "1234",
- "size": 1810673,
- "drive_id": "1234",
- "pass_through": [
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+
+ res = apideck.file_storage.upload_sessions.create(name="Documents", parent_folder_id="1234", size=1810673, service_id="salesforce", drive_id="1234", pass_through=[
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- ],
- }, service_id="salesforce", server_url="https://upload.apideck.com")
-
- if res is not None:
- # handle response
- pass
+ },
+ ],
+ },
+ ], server_url="https://upload.apideck.com")
+
+ # Handle response
+ print(res)
```
diff --git a/RELEASES.md b/RELEASES.md
new file mode 100644
index 00000000..dd7a9322
--- /dev/null
+++ b/RELEASES.md
@@ -0,0 +1,11 @@
+
+
+## 2024-12-17 00:17:55
+### Changes
+Based on:
+- OpenAPI Doc
+- Speakeasy CLI 1.455.7 (2.480.1) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [python v0.2.0] .
+### Releases
+- [PyPI v0.2.0] https://pypi.org/project/apideck-unify/0.2.0 - .
\ No newline at end of file
diff --git a/USAGE.md b/USAGE.md
index 3897ae4e..4740e4bb 100644
--- a/USAGE.md
+++ b/USAGE.md
@@ -9,24 +9,21 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.accounting.tax_rates.list(request={
- "service_id": "salesforce",
- "filter_": {
- "assets": True,
- "equity": True,
- "expenses": True,
- "liabilities": True,
- "revenue": True,
- },
- "pass_through": {
- "search": "San Francisco",
- },
- "fields": "id,updated_at",
- })
- if res is not None:
- # handle response
- pass
+ res = apideck.accounting.tax_rates.list(service_id="salesforce", filter_={
+ "assets": True,
+ "equity": True,
+ "expenses": True,
+ "liabilities": True,
+ "revenue": True,
+ }, pass_through={
+ "search": "San Francisco",
+ }, fields="id,updated_at")
+
+ while res is not None:
+ # Handle items
+
+ res = res.next()
```
@@ -44,24 +41,21 @@ async def main():
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = await apideck.accounting.tax_rates.list_async(request={
- "service_id": "salesforce",
- "filter_": {
- "assets": True,
- "equity": True,
- "expenses": True,
- "liabilities": True,
- "revenue": True,
- },
- "pass_through": {
- "search": "San Francisco",
- },
- "fields": "id,updated_at",
- })
- if res is not None:
- # handle response
- pass
+ res = await apideck.accounting.tax_rates.list_async(service_id="salesforce", filter_={
+ "assets": True,
+ "equity": True,
+ "expenses": True,
+ "liabilities": True,
+ "revenue": True,
+ }, pass_through={
+ "search": "San Francisco",
+ }, fields="id,updated_at")
+
+ while res is not None:
+ # Handle items
+
+ res = res.next()
asyncio.run(main())
```
diff --git a/docs/models/accountingagedcreditorsoneglobals.md b/docs/models/accountingagedcreditorsoneglobals.md
new file mode 100644
index 00000000..75b5cafc
--- /dev/null
+++ b/docs/models/accountingagedcreditorsoneglobals.md
@@ -0,0 +1,9 @@
+# AccountingAgedCreditorsOneGlobals
+
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
+| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer |
+| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX |
\ No newline at end of file
diff --git a/docs/models/accountingagedcreditorsonerequest.md b/docs/models/accountingagedcreditorsonerequest.md
new file mode 100644
index 00000000..40ccf114
--- /dev/null
+++ b/docs/models/accountingagedcreditorsonerequest.md
@@ -0,0 +1,12 @@
+# AccountingAgedCreditorsOneRequest
+
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `filter_` | [Optional[models.AgedReportFilter]](../models/agedreportfilter.md) | :heavy_minus_sign: | Apply filters | {
"customer_id": "123abc",
"report_as_of_date": "2024-01-01",
"period_count": 3,
"period_length": 30
} |
+| `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} |
+| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: `fields=name,email,addresses.city`
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at |
\ No newline at end of file
diff --git a/docs/models/accountingagedcreditorsoneresponse.md b/docs/models/accountingagedcreditorsoneresponse.md
new file mode 100644
index 00000000..de2976ff
--- /dev/null
+++ b/docs/models/accountingagedcreditorsoneresponse.md
@@ -0,0 +1,17 @@
+# AccountingAgedCreditorsOneResponse
+
+
+## Supported Types
+
+### `models.GetAgedCreditorsResponse`
+
+```python
+value: models.GetAgedCreditorsResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/accountingageddebtorsoneglobals.md b/docs/models/accountingageddebtorsoneglobals.md
new file mode 100644
index 00000000..86c3330b
--- /dev/null
+++ b/docs/models/accountingageddebtorsoneglobals.md
@@ -0,0 +1,9 @@
+# AccountingAgedDebtorsOneGlobals
+
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
+| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer |
+| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX |
\ No newline at end of file
diff --git a/docs/models/accountingageddebtorsonerequest.md b/docs/models/accountingageddebtorsonerequest.md
new file mode 100644
index 00000000..3464963a
--- /dev/null
+++ b/docs/models/accountingageddebtorsonerequest.md
@@ -0,0 +1,12 @@
+# AccountingAgedDebtorsOneRequest
+
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `filter_` | [Optional[models.AgedReportFilter]](../models/agedreportfilter.md) | :heavy_minus_sign: | Apply filters | {
"customer_id": "123abc",
"report_as_of_date": "2024-01-01",
"period_count": 3,
"period_length": 30
} |
+| `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} |
+| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: `fields=name,email,addresses.city`
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at |
\ No newline at end of file
diff --git a/docs/models/accountingageddebtorsoneresponse.md b/docs/models/accountingageddebtorsoneresponse.md
new file mode 100644
index 00000000..fc51e073
--- /dev/null
+++ b/docs/models/accountingageddebtorsoneresponse.md
@@ -0,0 +1,17 @@
+# AccountingAgedDebtorsOneResponse
+
+
+## Supported Types
+
+### `models.GetAgedDebtorsResponse`
+
+```python
+value: models.GetAgedDebtorsResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/accountingattachmentsallresponse.md b/docs/models/accountingattachmentsallresponse.md
index 557a01ab..a1fcd0ed 100644
--- a/docs/models/accountingattachmentsallresponse.md
+++ b/docs/models/accountingattachmentsallresponse.md
@@ -1,17 +1,8 @@
# AccountingAttachmentsAllResponse
-## Supported Types
-
-### `models.GetAttachmentsResponse`
-
-```python
-value: models.GetAttachmentsResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
+| `result` | [models.AccountingAttachmentsAllResponseResult](../models/accountingattachmentsallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/accountingattachmentsallresponseresult.md b/docs/models/accountingattachmentsallresponseresult.md
new file mode 100644
index 00000000..218fed77
--- /dev/null
+++ b/docs/models/accountingattachmentsallresponseresult.md
@@ -0,0 +1,17 @@
+# AccountingAttachmentsAllResponseResult
+
+
+## Supported Types
+
+### `models.GetAttachmentsResponse`
+
+```python
+value: models.GetAttachmentsResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/accountingbillpaymentsallresponse.md b/docs/models/accountingbillpaymentsallresponse.md
index 51f2c203..7530c647 100644
--- a/docs/models/accountingbillpaymentsallresponse.md
+++ b/docs/models/accountingbillpaymentsallresponse.md
@@ -1,17 +1,8 @@
# AccountingBillPaymentsAllResponse
-## Supported Types
-
-### `models.GetBillPaymentsResponse`
-
-```python
-value: models.GetBillPaymentsResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
+| `result` | [models.AccountingBillPaymentsAllResponseResult](../models/accountingbillpaymentsallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/accountingbillpaymentsallresponseresult.md b/docs/models/accountingbillpaymentsallresponseresult.md
new file mode 100644
index 00000000..1748663a
--- /dev/null
+++ b/docs/models/accountingbillpaymentsallresponseresult.md
@@ -0,0 +1,17 @@
+# AccountingBillPaymentsAllResponseResult
+
+
+## Supported Types
+
+### `models.GetBillPaymentsResponse`
+
+```python
+value: models.GetBillPaymentsResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/accountingbillsallresponse.md b/docs/models/accountingbillsallresponse.md
index f1ae11a2..6fcfe650 100644
--- a/docs/models/accountingbillsallresponse.md
+++ b/docs/models/accountingbillsallresponse.md
@@ -1,17 +1,8 @@
# AccountingBillsAllResponse
-## Supported Types
-
-### `models.GetBillsResponse`
-
-```python
-value: models.GetBillsResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
+| `result` | [models.AccountingBillsAllResponseResult](../models/accountingbillsallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/accountingbillsallresponseresult.md b/docs/models/accountingbillsallresponseresult.md
new file mode 100644
index 00000000..90378232
--- /dev/null
+++ b/docs/models/accountingbillsallresponseresult.md
@@ -0,0 +1,17 @@
+# AccountingBillsAllResponseResult
+
+
+## Supported Types
+
+### `models.GetBillsResponse`
+
+```python
+value: models.GetBillsResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/accountingcreditnotesallresponse.md b/docs/models/accountingcreditnotesallresponse.md
index 47dce138..2b72e116 100644
--- a/docs/models/accountingcreditnotesallresponse.md
+++ b/docs/models/accountingcreditnotesallresponse.md
@@ -1,17 +1,8 @@
# AccountingCreditNotesAllResponse
-## Supported Types
-
-### `models.GetCreditNotesResponse`
-
-```python
-value: models.GetCreditNotesResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
+| `result` | [models.AccountingCreditNotesAllResponseResult](../models/accountingcreditnotesallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/accountingcreditnotesallresponseresult.md b/docs/models/accountingcreditnotesallresponseresult.md
new file mode 100644
index 00000000..e3ca80cd
--- /dev/null
+++ b/docs/models/accountingcreditnotesallresponseresult.md
@@ -0,0 +1,17 @@
+# AccountingCreditNotesAllResponseResult
+
+
+## Supported Types
+
+### `models.GetCreditNotesResponse`
+
+```python
+value: models.GetCreditNotesResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/accountingcustomersallresponse.md b/docs/models/accountingcustomersallresponse.md
index fe6f2466..c9ec73c4 100644
--- a/docs/models/accountingcustomersallresponse.md
+++ b/docs/models/accountingcustomersallresponse.md
@@ -1,17 +1,8 @@
# AccountingCustomersAllResponse
-## Supported Types
-
-### `models.GetCustomersResponse`
-
-```python
-value: models.GetCustomersResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
+| `result` | [models.AccountingCustomersAllResponseResult](../models/accountingcustomersallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/accountingcustomersallresponseresult.md b/docs/models/accountingcustomersallresponseresult.md
new file mode 100644
index 00000000..a4e0abdd
--- /dev/null
+++ b/docs/models/accountingcustomersallresponseresult.md
@@ -0,0 +1,17 @@
+# AccountingCustomersAllResponseResult
+
+
+## Supported Types
+
+### `models.GetCustomersResponse`
+
+```python
+value: models.GetCustomersResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/accountingdepartmentsallresponse.md b/docs/models/accountingdepartmentsallresponse.md
index 95602f57..967966a8 100644
--- a/docs/models/accountingdepartmentsallresponse.md
+++ b/docs/models/accountingdepartmentsallresponse.md
@@ -1,17 +1,8 @@
# AccountingDepartmentsAllResponse
-## Supported Types
-
-### `models.GetAccountingDepartmentsResponse`
-
-```python
-value: models.GetAccountingDepartmentsResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
+| `result` | [models.AccountingDepartmentsAllResponseResult](../models/accountingdepartmentsallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/accountingdepartmentsallresponseresult.md b/docs/models/accountingdepartmentsallresponseresult.md
new file mode 100644
index 00000000..30c7fe22
--- /dev/null
+++ b/docs/models/accountingdepartmentsallresponseresult.md
@@ -0,0 +1,17 @@
+# AccountingDepartmentsAllResponseResult
+
+
+## Supported Types
+
+### `models.GetAccountingDepartmentsResponse`
+
+```python
+value: models.GetAccountingDepartmentsResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/accountingexpensesallresponse.md b/docs/models/accountingexpensesallresponse.md
index 5b4e32eb..04a092a6 100644
--- a/docs/models/accountingexpensesallresponse.md
+++ b/docs/models/accountingexpensesallresponse.md
@@ -1,17 +1,8 @@
# AccountingExpensesAllResponse
-## Supported Types
-
-### `models.GetExpensesResponse`
-
-```python
-value: models.GetExpensesResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
+| `result` | [models.AccountingExpensesAllResponseResult](../models/accountingexpensesallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/accountingexpensesallresponseresult.md b/docs/models/accountingexpensesallresponseresult.md
new file mode 100644
index 00000000..c92b26e2
--- /dev/null
+++ b/docs/models/accountingexpensesallresponseresult.md
@@ -0,0 +1,17 @@
+# AccountingExpensesAllResponseResult
+
+
+## Supported Types
+
+### `models.GetExpensesResponse`
+
+```python
+value: models.GetExpensesResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/accountinginvoiceitemsallresponse.md b/docs/models/accountinginvoiceitemsallresponse.md
index c9d5fe2e..2b137db1 100644
--- a/docs/models/accountinginvoiceitemsallresponse.md
+++ b/docs/models/accountinginvoiceitemsallresponse.md
@@ -1,17 +1,8 @@
# AccountingInvoiceItemsAllResponse
-## Supported Types
-
-### `models.GetInvoiceItemsResponse`
-
-```python
-value: models.GetInvoiceItemsResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
+| `result` | [models.AccountingInvoiceItemsAllResponseResult](../models/accountinginvoiceitemsallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/accountinginvoiceitemsallresponseresult.md b/docs/models/accountinginvoiceitemsallresponseresult.md
new file mode 100644
index 00000000..80b109fe
--- /dev/null
+++ b/docs/models/accountinginvoiceitemsallresponseresult.md
@@ -0,0 +1,17 @@
+# AccountingInvoiceItemsAllResponseResult
+
+
+## Supported Types
+
+### `models.GetInvoiceItemsResponse`
+
+```python
+value: models.GetInvoiceItemsResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/accountinginvoicesallresponse.md b/docs/models/accountinginvoicesallresponse.md
index 48361ce5..1db36567 100644
--- a/docs/models/accountinginvoicesallresponse.md
+++ b/docs/models/accountinginvoicesallresponse.md
@@ -1,17 +1,8 @@
# AccountingInvoicesAllResponse
-## Supported Types
-
-### `models.GetInvoicesResponse`
-
-```python
-value: models.GetInvoicesResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
+| `result` | [models.AccountingInvoicesAllResponseResult](../models/accountinginvoicesallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/accountinginvoicesallresponseresult.md b/docs/models/accountinginvoicesallresponseresult.md
new file mode 100644
index 00000000..1e725b98
--- /dev/null
+++ b/docs/models/accountinginvoicesallresponseresult.md
@@ -0,0 +1,17 @@
+# AccountingInvoicesAllResponseResult
+
+
+## Supported Types
+
+### `models.GetInvoicesResponse`
+
+```python
+value: models.GetInvoicesResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/accountingjournalentriesallresponse.md b/docs/models/accountingjournalentriesallresponse.md
index 427eba2c..6205ed97 100644
--- a/docs/models/accountingjournalentriesallresponse.md
+++ b/docs/models/accountingjournalentriesallresponse.md
@@ -1,17 +1,8 @@
# AccountingJournalEntriesAllResponse
-## Supported Types
-
-### `models.GetJournalEntriesResponse`
-
-```python
-value: models.GetJournalEntriesResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
+| `result` | [models.AccountingJournalEntriesAllResponseResult](../models/accountingjournalentriesallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/accountingjournalentriesallresponseresult.md b/docs/models/accountingjournalentriesallresponseresult.md
new file mode 100644
index 00000000..e3327105
--- /dev/null
+++ b/docs/models/accountingjournalentriesallresponseresult.md
@@ -0,0 +1,17 @@
+# AccountingJournalEntriesAllResponseResult
+
+
+## Supported Types
+
+### `models.GetJournalEntriesResponse`
+
+```python
+value: models.GetJournalEntriesResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/accountingledgeraccountsallresponse.md b/docs/models/accountingledgeraccountsallresponse.md
index 57e274f4..684dc1c8 100644
--- a/docs/models/accountingledgeraccountsallresponse.md
+++ b/docs/models/accountingledgeraccountsallresponse.md
@@ -1,17 +1,8 @@
# AccountingLedgerAccountsAllResponse
-## Supported Types
-
-### `models.GetLedgerAccountsResponse`
-
-```python
-value: models.GetLedgerAccountsResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
+| `result` | [models.AccountingLedgerAccountsAllResponseResult](../models/accountingledgeraccountsallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/accountingledgeraccountsallresponseresult.md b/docs/models/accountingledgeraccountsallresponseresult.md
new file mode 100644
index 00000000..79ed47b6
--- /dev/null
+++ b/docs/models/accountingledgeraccountsallresponseresult.md
@@ -0,0 +1,17 @@
+# AccountingLedgerAccountsAllResponseResult
+
+
+## Supported Types
+
+### `models.GetLedgerAccountsResponse`
+
+```python
+value: models.GetLedgerAccountsResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/accountinglocationsallresponse.md b/docs/models/accountinglocationsallresponse.md
index 3fc2ee6b..53f0c01b 100644
--- a/docs/models/accountinglocationsallresponse.md
+++ b/docs/models/accountinglocationsallresponse.md
@@ -1,17 +1,8 @@
# AccountingLocationsAllResponse
-## Supported Types
-
-### `models.GetAccountingLocationsResponse`
-
-```python
-value: models.GetAccountingLocationsResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
+| `result` | [models.AccountingLocationsAllResponseResult](../models/accountinglocationsallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/accountinglocationsallresponseresult.md b/docs/models/accountinglocationsallresponseresult.md
new file mode 100644
index 00000000..7a227878
--- /dev/null
+++ b/docs/models/accountinglocationsallresponseresult.md
@@ -0,0 +1,17 @@
+# AccountingLocationsAllResponseResult
+
+
+## Supported Types
+
+### `models.GetAccountingLocationsResponse`
+
+```python
+value: models.GetAccountingLocationsResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/accountingpaymentsallresponse.md b/docs/models/accountingpaymentsallresponse.md
index a019370d..4f89514d 100644
--- a/docs/models/accountingpaymentsallresponse.md
+++ b/docs/models/accountingpaymentsallresponse.md
@@ -1,17 +1,8 @@
# AccountingPaymentsAllResponse
-## Supported Types
-
-### `models.GetPaymentsResponse`
-
-```python
-value: models.GetPaymentsResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
+| `result` | [models.AccountingPaymentsAllResponseResult](../models/accountingpaymentsallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/accountingpaymentsallresponseresult.md b/docs/models/accountingpaymentsallresponseresult.md
new file mode 100644
index 00000000..ae3d1b48
--- /dev/null
+++ b/docs/models/accountingpaymentsallresponseresult.md
@@ -0,0 +1,17 @@
+# AccountingPaymentsAllResponseResult
+
+
+## Supported Types
+
+### `models.GetPaymentsResponse`
+
+```python
+value: models.GetPaymentsResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/accountingpurchaseordersallresponse.md b/docs/models/accountingpurchaseordersallresponse.md
index 64b6ab35..bf974173 100644
--- a/docs/models/accountingpurchaseordersallresponse.md
+++ b/docs/models/accountingpurchaseordersallresponse.md
@@ -1,17 +1,8 @@
# AccountingPurchaseOrdersAllResponse
-## Supported Types
-
-### `models.GetPurchaseOrdersResponse`
-
-```python
-value: models.GetPurchaseOrdersResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
+| `result` | [models.AccountingPurchaseOrdersAllResponseResult](../models/accountingpurchaseordersallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/accountingpurchaseordersallresponseresult.md b/docs/models/accountingpurchaseordersallresponseresult.md
new file mode 100644
index 00000000..f585c998
--- /dev/null
+++ b/docs/models/accountingpurchaseordersallresponseresult.md
@@ -0,0 +1,17 @@
+# AccountingPurchaseOrdersAllResponseResult
+
+
+## Supported Types
+
+### `models.GetPurchaseOrdersResponse`
+
+```python
+value: models.GetPurchaseOrdersResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/accountingsubsidiariesallresponse.md b/docs/models/accountingsubsidiariesallresponse.md
index f188b118..ee218816 100644
--- a/docs/models/accountingsubsidiariesallresponse.md
+++ b/docs/models/accountingsubsidiariesallresponse.md
@@ -1,17 +1,8 @@
# AccountingSubsidiariesAllResponse
-## Supported Types
-
-### `models.GetSubsidiariesResponse`
-
-```python
-value: models.GetSubsidiariesResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
+| `result` | [models.AccountingSubsidiariesAllResponseResult](../models/accountingsubsidiariesallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/accountingsubsidiariesallresponseresult.md b/docs/models/accountingsubsidiariesallresponseresult.md
new file mode 100644
index 00000000..e5e18053
--- /dev/null
+++ b/docs/models/accountingsubsidiariesallresponseresult.md
@@ -0,0 +1,17 @@
+# AccountingSubsidiariesAllResponseResult
+
+
+## Supported Types
+
+### `models.GetSubsidiariesResponse`
+
+```python
+value: models.GetSubsidiariesResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/accountingsuppliersallresponse.md b/docs/models/accountingsuppliersallresponse.md
index a29135fe..80e45ffd 100644
--- a/docs/models/accountingsuppliersallresponse.md
+++ b/docs/models/accountingsuppliersallresponse.md
@@ -1,17 +1,8 @@
# AccountingSuppliersAllResponse
-## Supported Types
-
-### `models.GetSuppliersResponse`
-
-```python
-value: models.GetSuppliersResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
+| `result` | [models.AccountingSuppliersAllResponseResult](../models/accountingsuppliersallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/accountingsuppliersallresponseresult.md b/docs/models/accountingsuppliersallresponseresult.md
new file mode 100644
index 00000000..0dbc6c95
--- /dev/null
+++ b/docs/models/accountingsuppliersallresponseresult.md
@@ -0,0 +1,17 @@
+# AccountingSuppliersAllResponseResult
+
+
+## Supported Types
+
+### `models.GetSuppliersResponse`
+
+```python
+value: models.GetSuppliersResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/accountingtaxratesallresponse.md b/docs/models/accountingtaxratesallresponse.md
index 7c7b024d..3988cf71 100644
--- a/docs/models/accountingtaxratesallresponse.md
+++ b/docs/models/accountingtaxratesallresponse.md
@@ -1,17 +1,8 @@
# AccountingTaxRatesAllResponse
-## Supported Types
-
-### `models.GetTaxRatesResponse`
-
-```python
-value: models.GetTaxRatesResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
+| `result` | [models.AccountingTaxRatesAllResponseResult](../models/accountingtaxratesallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/accountingtaxratesallresponseresult.md b/docs/models/accountingtaxratesallresponseresult.md
new file mode 100644
index 00000000..5ffc119d
--- /dev/null
+++ b/docs/models/accountingtaxratesallresponseresult.md
@@ -0,0 +1,17 @@
+# AccountingTaxRatesAllResponseResult
+
+
+## Supported Types
+
+### `models.GetTaxRatesResponse`
+
+```python
+value: models.GetTaxRatesResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/accountingtaxratesupdaterequest.md b/docs/models/accountingtaxratesupdaterequest.md
index 88a16402..8ce2d33c 100644
--- a/docs/models/accountingtaxratesupdaterequest.md
+++ b/docs/models/accountingtaxratesupdaterequest.md
@@ -5,7 +5,7 @@
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
+| `id_param` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
| `tax_rate` | [models.TaxRateInput](../models/taxrateinput.md) | :heavy_check_mark: | N/A | |
| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
\ No newline at end of file
diff --git a/docs/models/accountingtrackingcategoriesallresponse.md b/docs/models/accountingtrackingcategoriesallresponse.md
index 51c1d1e0..f308cc40 100644
--- a/docs/models/accountingtrackingcategoriesallresponse.md
+++ b/docs/models/accountingtrackingcategoriesallresponse.md
@@ -1,17 +1,8 @@
# AccountingTrackingCategoriesAllResponse
-## Supported Types
-
-### `models.GetTrackingCategoriesResponse`
-
-```python
-value: models.GetTrackingCategoriesResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
+| `result` | [models.AccountingTrackingCategoriesAllResponseResult](../models/accountingtrackingcategoriesallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/accountingtrackingcategoriesallresponseresult.md b/docs/models/accountingtrackingcategoriesallresponseresult.md
new file mode 100644
index 00000000..9c4c669d
--- /dev/null
+++ b/docs/models/accountingtrackingcategoriesallresponseresult.md
@@ -0,0 +1,17 @@
+# AccountingTrackingCategoriesAllResponseResult
+
+
+## Supported Types
+
+### `models.GetTrackingCategoriesResponse`
+
+```python
+value: models.GetTrackingCategoriesResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/agedcreditors.md b/docs/models/agedcreditors.md
new file mode 100644
index 00000000..7efa6774
--- /dev/null
+++ b/docs/models/agedcreditors.md
@@ -0,0 +1,12 @@
+# AgedCreditors
+
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
+| `report_generated_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | The exact date and time the report was generated. | 2024-11-14T12:00:00.000Z |
+| `report_as_of_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The cutoff date for transactions included in the report. | 2024-11-13 |
+| `period_count` | *Optional[int]* | :heavy_minus_sign: | Number of aging periods shown in the report. | 4 |
+| `period_length` | *Optional[int]* | :heavy_minus_sign: | Length of each aging period in days. | 30 |
+| `outstanding_balances` | List[[models.OutstandingBalance](../models/outstandingbalance.md)] | :heavy_minus_sign: | N/A | |
\ No newline at end of file
diff --git a/docs/models/ageddebtors.md b/docs/models/ageddebtors.md
new file mode 100644
index 00000000..839212e7
--- /dev/null
+++ b/docs/models/ageddebtors.md
@@ -0,0 +1,12 @@
+# AgedDebtors
+
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
+| `report_generated_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | The exact date and time the report was generated. | 2024-11-14T12:00:00.000Z |
+| `report_as_of_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The cutoff date for transactions included in the report. | 2024-11-13 |
+| `period_count` | *Optional[int]* | :heavy_minus_sign: | Number of aging periods shown in the report. | 4 |
+| `period_length` | *Optional[int]* | :heavy_minus_sign: | Length of each aging period in days. | 30 |
+| `outstanding_balances` | List[[models.OutstandingBalance](../models/outstandingbalance.md)] | :heavy_minus_sign: | N/A | |
\ No newline at end of file
diff --git a/docs/models/agedreportfilter.md b/docs/models/agedreportfilter.md
new file mode 100644
index 00000000..dac27542
--- /dev/null
+++ b/docs/models/agedreportfilter.md
@@ -0,0 +1,11 @@
+# AgedReportFilter
+
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- |
+| `customer_id` | *Optional[str]* | :heavy_minus_sign: | Filter by customer id | 123abc |
+| `report_as_of_date` | *Optional[str]* | :heavy_minus_sign: | The cutoff date for considering transactions | 2024-01-01 |
+| `period_count` | *Optional[int]* | :heavy_minus_sign: | Number of periods to split the aged creditors report into | 3 |
+| `period_length` | *Optional[int]* | :heavy_minus_sign: | Length of each period in days | 30 |
\ No newline at end of file
diff --git a/docs/models/atsapplicantsallresponse.md b/docs/models/atsapplicantsallresponse.md
index bad0b647..05d49d12 100644
--- a/docs/models/atsapplicantsallresponse.md
+++ b/docs/models/atsapplicantsallresponse.md
@@ -1,17 +1,8 @@
# AtsApplicantsAllResponse
-## Supported Types
-
-### `models.GetApplicantsResponse`
-
-```python
-value: models.GetApplicantsResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
+| `result` | [models.AtsApplicantsAllResponseResult](../models/atsapplicantsallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/atsapplicantsallresponseresult.md b/docs/models/atsapplicantsallresponseresult.md
new file mode 100644
index 00000000..39f1980a
--- /dev/null
+++ b/docs/models/atsapplicantsallresponseresult.md
@@ -0,0 +1,17 @@
+# AtsApplicantsAllResponseResult
+
+
+## Supported Types
+
+### `models.GetApplicantsResponse`
+
+```python
+value: models.GetApplicantsResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/atsapplicationsallresponse.md b/docs/models/atsapplicationsallresponse.md
index 59d4aafa..02ac0972 100644
--- a/docs/models/atsapplicationsallresponse.md
+++ b/docs/models/atsapplicationsallresponse.md
@@ -1,17 +1,8 @@
# AtsApplicationsAllResponse
-## Supported Types
-
-### `models.GetApplicationsResponse`
-
-```python
-value: models.GetApplicationsResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
+| `result` | [models.AtsApplicationsAllResponseResult](../models/atsapplicationsallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/atsapplicationsallresponseresult.md b/docs/models/atsapplicationsallresponseresult.md
new file mode 100644
index 00000000..41bc2a9f
--- /dev/null
+++ b/docs/models/atsapplicationsallresponseresult.md
@@ -0,0 +1,17 @@
+# AtsApplicationsAllResponseResult
+
+
+## Supported Types
+
+### `models.GetApplicationsResponse`
+
+```python
+value: models.GetApplicationsResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/atsjobsallresponse.md b/docs/models/atsjobsallresponse.md
index 4c27f29f..77c2ed14 100644
--- a/docs/models/atsjobsallresponse.md
+++ b/docs/models/atsjobsallresponse.md
@@ -1,17 +1,8 @@
# AtsJobsAllResponse
-## Supported Types
-
-### `models.GetJobsResponse`
-
-```python
-value: models.GetJobsResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
+| `result` | [models.AtsJobsAllResponseResult](../models/atsjobsallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/atsjobsallresponseresult.md b/docs/models/atsjobsallresponseresult.md
new file mode 100644
index 00000000..a372e21d
--- /dev/null
+++ b/docs/models/atsjobsallresponseresult.md
@@ -0,0 +1,17 @@
+# AtsJobsAllResponseResult
+
+
+## Supported Types
+
+### `models.GetJobsResponse`
+
+```python
+value: models.GetJobsResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/balancebyperiod.md b/docs/models/balancebyperiod.md
new file mode 100644
index 00000000..802d96e7
--- /dev/null
+++ b/docs/models/balancebyperiod.md
@@ -0,0 +1,11 @@
+# BalanceByPeriod
+
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
+| `start_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | Start date of the period. | 2024-01-01 |
+| `end_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | End date of the period. | 2024-01-30 |
+| `total_amount` | *Optional[float]* | :heavy_minus_sign: | Total amount of the period. | 1500 |
+| `balances_by_transaction` | List[[models.BalanceByTransaction](../models/balancebytransaction.md)] | :heavy_minus_sign: | N/A | |
\ No newline at end of file
diff --git a/docs/models/balancebytransaction.md b/docs/models/balancebytransaction.md
new file mode 100644
index 00000000..c10df041
--- /dev/null
+++ b/docs/models/balancebytransaction.md
@@ -0,0 +1,13 @@
+# BalanceByTransaction
+
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
+| `transaction_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the transaction. | INV-1001 |
+| `transaction_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | Date of the transaction. | 2024-01-15 |
+| `transaction_type` | [Optional[models.TransactionType]](../models/transactiontype.md) | :heavy_minus_sign: | Type of the transaction. | invoice |
+| `due_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | Due date of the transaction. | 2024-02-15 |
+| `original_amount` | *Optional[float]* | :heavy_minus_sign: | Original amount of the transaction. | 1000 |
+| `outstanding_balance` | *Optional[float]* | :heavy_minus_sign: | Outstanding balance of the transaction. | 800 |
\ No newline at end of file
diff --git a/docs/models/connectorapisallresponse.md b/docs/models/connectorapisallresponse.md
index 0a6a51c4..b10e14e9 100644
--- a/docs/models/connectorapisallresponse.md
+++ b/docs/models/connectorapisallresponse.md
@@ -1,17 +1,8 @@
# ConnectorApisAllResponse
-## Supported Types
-
-### `models.GetApisResponse`
-
-```python
-value: models.GetApisResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
+| `result` | [models.ConnectorApisAllResponseResult](../models/connectorapisallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/connectorapisallresponseresult.md b/docs/models/connectorapisallresponseresult.md
new file mode 100644
index 00000000..53ca1b50
--- /dev/null
+++ b/docs/models/connectorapisallresponseresult.md
@@ -0,0 +1,17 @@
+# ConnectorApisAllResponseResult
+
+
+## Supported Types
+
+### `models.GetApisResponse`
+
+```python
+value: models.GetApisResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/connectorconnectorsallresponse.md b/docs/models/connectorconnectorsallresponse.md
index 99a1e4c4..236b1c78 100644
--- a/docs/models/connectorconnectorsallresponse.md
+++ b/docs/models/connectorconnectorsallresponse.md
@@ -1,17 +1,8 @@
# ConnectorConnectorsAllResponse
-## Supported Types
-
-### `models.GetConnectorsResponse`
-
-```python
-value: models.GetConnectorsResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
+| `result` | [models.ConnectorConnectorsAllResponseResult](../models/connectorconnectorsallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/connectorconnectorsallresponseresult.md b/docs/models/connectorconnectorsallresponseresult.md
new file mode 100644
index 00000000..bfb0a936
--- /dev/null
+++ b/docs/models/connectorconnectorsallresponseresult.md
@@ -0,0 +1,17 @@
+# ConnectorConnectorsAllResponseResult
+
+
+## Supported Types
+
+### `models.GetConnectorsResponse`
+
+```python
+value: models.GetConnectorsResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/crmactivitiesallresponse.md b/docs/models/crmactivitiesallresponse.md
index 681b1e74..cfcee817 100644
--- a/docs/models/crmactivitiesallresponse.md
+++ b/docs/models/crmactivitiesallresponse.md
@@ -1,17 +1,8 @@
# CrmActivitiesAllResponse
-## Supported Types
-
-### `models.GetActivitiesResponse`
-
-```python
-value: models.GetActivitiesResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
+| `result` | [models.CrmActivitiesAllResponseResult](../models/crmactivitiesallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/crmactivitiesallresponseresult.md b/docs/models/crmactivitiesallresponseresult.md
new file mode 100644
index 00000000..1649730b
--- /dev/null
+++ b/docs/models/crmactivitiesallresponseresult.md
@@ -0,0 +1,17 @@
+# CrmActivitiesAllResponseResult
+
+
+## Supported Types
+
+### `models.GetActivitiesResponse`
+
+```python
+value: models.GetActivitiesResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/crmcompaniesallresponse.md b/docs/models/crmcompaniesallresponse.md
index e9a07aee..8c1a0be5 100644
--- a/docs/models/crmcompaniesallresponse.md
+++ b/docs/models/crmcompaniesallresponse.md
@@ -1,17 +1,8 @@
# CrmCompaniesAllResponse
-## Supported Types
-
-### `models.GetCompaniesResponse`
-
-```python
-value: models.GetCompaniesResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
+| `result` | [models.CrmCompaniesAllResponseResult](../models/crmcompaniesallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/crmcompaniesallresponseresult.md b/docs/models/crmcompaniesallresponseresult.md
new file mode 100644
index 00000000..10c1a175
--- /dev/null
+++ b/docs/models/crmcompaniesallresponseresult.md
@@ -0,0 +1,17 @@
+# CrmCompaniesAllResponseResult
+
+
+## Supported Types
+
+### `models.GetCompaniesResponse`
+
+```python
+value: models.GetCompaniesResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/crmcontactsallresponse.md b/docs/models/crmcontactsallresponse.md
index b401d056..4015a392 100644
--- a/docs/models/crmcontactsallresponse.md
+++ b/docs/models/crmcontactsallresponse.md
@@ -1,17 +1,8 @@
# CrmContactsAllResponse
-## Supported Types
-
-### `models.GetContactsResponse`
-
-```python
-value: models.GetContactsResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
+| `result` | [models.CrmContactsAllResponseResult](../models/crmcontactsallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/crmcontactsallresponseresult.md b/docs/models/crmcontactsallresponseresult.md
new file mode 100644
index 00000000..8388bab1
--- /dev/null
+++ b/docs/models/crmcontactsallresponseresult.md
@@ -0,0 +1,17 @@
+# CrmContactsAllResponseResult
+
+
+## Supported Types
+
+### `models.GetContactsResponse`
+
+```python
+value: models.GetContactsResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/crmleadsallresponse.md b/docs/models/crmleadsallresponse.md
index fea2e9a2..2edb7025 100644
--- a/docs/models/crmleadsallresponse.md
+++ b/docs/models/crmleadsallresponse.md
@@ -1,17 +1,8 @@
# CrmLeadsAllResponse
-## Supported Types
-
-### `models.GetLeadsResponse`
-
-```python
-value: models.GetLeadsResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
+| `result` | [models.CrmLeadsAllResponseResult](../models/crmleadsallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/crmleadsallresponseresult.md b/docs/models/crmleadsallresponseresult.md
new file mode 100644
index 00000000..7cce29ba
--- /dev/null
+++ b/docs/models/crmleadsallresponseresult.md
@@ -0,0 +1,17 @@
+# CrmLeadsAllResponseResult
+
+
+## Supported Types
+
+### `models.GetLeadsResponse`
+
+```python
+value: models.GetLeadsResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/crmnotesallresponse.md b/docs/models/crmnotesallresponse.md
index 9bcf0250..bff74576 100644
--- a/docs/models/crmnotesallresponse.md
+++ b/docs/models/crmnotesallresponse.md
@@ -1,17 +1,8 @@
# CrmNotesAllResponse
-## Supported Types
-
-### `models.GetNotesResponse`
-
-```python
-value: models.GetNotesResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
+| `result` | [models.CrmNotesAllResponseResult](../models/crmnotesallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/crmnotesallresponseresult.md b/docs/models/crmnotesallresponseresult.md
new file mode 100644
index 00000000..b9a4d50d
--- /dev/null
+++ b/docs/models/crmnotesallresponseresult.md
@@ -0,0 +1,17 @@
+# CrmNotesAllResponseResult
+
+
+## Supported Types
+
+### `models.GetNotesResponse`
+
+```python
+value: models.GetNotesResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/crmopportunitiesallresponse.md b/docs/models/crmopportunitiesallresponse.md
index 8a5bd699..cacb3b9d 100644
--- a/docs/models/crmopportunitiesallresponse.md
+++ b/docs/models/crmopportunitiesallresponse.md
@@ -1,17 +1,8 @@
# CrmOpportunitiesAllResponse
-## Supported Types
-
-### `models.GetOpportunitiesResponse`
-
-```python
-value: models.GetOpportunitiesResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
+| `result` | [models.CrmOpportunitiesAllResponseResult](../models/crmopportunitiesallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/crmopportunitiesallresponseresult.md b/docs/models/crmopportunitiesallresponseresult.md
new file mode 100644
index 00000000..455f6dc2
--- /dev/null
+++ b/docs/models/crmopportunitiesallresponseresult.md
@@ -0,0 +1,17 @@
+# CrmOpportunitiesAllResponseResult
+
+
+## Supported Types
+
+### `models.GetOpportunitiesResponse`
+
+```python
+value: models.GetOpportunitiesResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/crmpipelinesallresponse.md b/docs/models/crmpipelinesallresponse.md
index 083b1523..39cdeb66 100644
--- a/docs/models/crmpipelinesallresponse.md
+++ b/docs/models/crmpipelinesallresponse.md
@@ -1,17 +1,8 @@
# CrmPipelinesAllResponse
-## Supported Types
-
-### `models.GetPipelinesResponse`
-
-```python
-value: models.GetPipelinesResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
+| `result` | [models.CrmPipelinesAllResponseResult](../models/crmpipelinesallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/crmpipelinesallresponseresult.md b/docs/models/crmpipelinesallresponseresult.md
new file mode 100644
index 00000000..54f4d5bb
--- /dev/null
+++ b/docs/models/crmpipelinesallresponseresult.md
@@ -0,0 +1,17 @@
+# CrmPipelinesAllResponseResult
+
+
+## Supported Types
+
+### `models.GetPipelinesResponse`
+
+```python
+value: models.GetPipelinesResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/crmpipelinesupdaterequest.md b/docs/models/crmpipelinesupdaterequest.md
index 26299b10..966a278e 100644
--- a/docs/models/crmpipelinesupdaterequest.md
+++ b/docs/models/crmpipelinesupdaterequest.md
@@ -5,7 +5,7 @@
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
+| `id_param` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
| `pipeline` | [models.PipelineInput](../models/pipelineinput.md) | :heavy_check_mark: | N/A | |
| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
\ No newline at end of file
diff --git a/docs/models/crmusersallresponse.md b/docs/models/crmusersallresponse.md
index b7824bfb..47191e1f 100644
--- a/docs/models/crmusersallresponse.md
+++ b/docs/models/crmusersallresponse.md
@@ -1,17 +1,8 @@
# CrmUsersAllResponse
-## Supported Types
-
-### `models.GetUsersResponse`
-
-```python
-value: models.GetUsersResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
+| `result` | [models.CrmUsersAllResponseResult](../models/crmusersallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/crmusersallresponseresult.md b/docs/models/crmusersallresponseresult.md
new file mode 100644
index 00000000..38b8e219
--- /dev/null
+++ b/docs/models/crmusersallresponseresult.md
@@ -0,0 +1,17 @@
+# CrmUsersAllResponseResult
+
+
+## Supported Types
+
+### `models.GetUsersResponse`
+
+```python
+value: models.GetUsersResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/ecommercecustomersallresponse.md b/docs/models/ecommercecustomersallresponse.md
index 114fb32f..4eb8b487 100644
--- a/docs/models/ecommercecustomersallresponse.md
+++ b/docs/models/ecommercecustomersallresponse.md
@@ -1,17 +1,8 @@
# EcommerceCustomersAllResponse
-## Supported Types
-
-### `models.GetEcommerceCustomersResponse`
-
-```python
-value: models.GetEcommerceCustomersResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
+| `result` | [models.EcommerceCustomersAllResponseResult](../models/ecommercecustomersallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/ecommercecustomersallresponseresult.md b/docs/models/ecommercecustomersallresponseresult.md
new file mode 100644
index 00000000..2b05c236
--- /dev/null
+++ b/docs/models/ecommercecustomersallresponseresult.md
@@ -0,0 +1,17 @@
+# EcommerceCustomersAllResponseResult
+
+
+## Supported Types
+
+### `models.GetEcommerceCustomersResponse`
+
+```python
+value: models.GetEcommerceCustomersResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/ecommerceordersallresponse.md b/docs/models/ecommerceordersallresponse.md
index 182762c0..19293dbb 100644
--- a/docs/models/ecommerceordersallresponse.md
+++ b/docs/models/ecommerceordersallresponse.md
@@ -1,17 +1,8 @@
# EcommerceOrdersAllResponse
-## Supported Types
-
-### `models.GetEcommerceOrdersResponse`
-
-```python
-value: models.GetEcommerceOrdersResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
+| `result` | [models.EcommerceOrdersAllResponseResult](../models/ecommerceordersallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/ecommerceordersallresponseresult.md b/docs/models/ecommerceordersallresponseresult.md
new file mode 100644
index 00000000..007edc5a
--- /dev/null
+++ b/docs/models/ecommerceordersallresponseresult.md
@@ -0,0 +1,17 @@
+# EcommerceOrdersAllResponseResult
+
+
+## Supported Types
+
+### `models.GetEcommerceOrdersResponse`
+
+```python
+value: models.GetEcommerceOrdersResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/ecommerceproductsallresponse.md b/docs/models/ecommerceproductsallresponse.md
index 20af03bd..dddfa848 100644
--- a/docs/models/ecommerceproductsallresponse.md
+++ b/docs/models/ecommerceproductsallresponse.md
@@ -1,17 +1,8 @@
# EcommerceProductsAllResponse
-## Supported Types
-
-### `models.GetProductsResponse`
-
-```python
-value: models.GetProductsResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
+| `result` | [models.EcommerceProductsAllResponseResult](../models/ecommerceproductsallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/ecommerceproductsallresponseresult.md b/docs/models/ecommerceproductsallresponseresult.md
new file mode 100644
index 00000000..75ee04b4
--- /dev/null
+++ b/docs/models/ecommerceproductsallresponseresult.md
@@ -0,0 +1,17 @@
+# EcommerceProductsAllResponseResult
+
+
+## Supported Types
+
+### `models.GetProductsResponse`
+
+```python
+value: models.GetProductsResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/filestoragedrivegroupsallresponse.md b/docs/models/filestoragedrivegroupsallresponse.md
index 1d4949b2..4079295c 100644
--- a/docs/models/filestoragedrivegroupsallresponse.md
+++ b/docs/models/filestoragedrivegroupsallresponse.md
@@ -1,17 +1,8 @@
# FileStorageDriveGroupsAllResponse
-## Supported Types
-
-### `models.GetDriveGroupsResponse`
-
-```python
-value: models.GetDriveGroupsResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
+| `result` | [models.FileStorageDriveGroupsAllResponseResult](../models/filestoragedrivegroupsallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/filestoragedrivegroupsallresponseresult.md b/docs/models/filestoragedrivegroupsallresponseresult.md
new file mode 100644
index 00000000..709b6636
--- /dev/null
+++ b/docs/models/filestoragedrivegroupsallresponseresult.md
@@ -0,0 +1,17 @@
+# FileStorageDriveGroupsAllResponseResult
+
+
+## Supported Types
+
+### `models.GetDriveGroupsResponse`
+
+```python
+value: models.GetDriveGroupsResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/filestoragedrivesallresponse.md b/docs/models/filestoragedrivesallresponse.md
index 04620299..af0b3af7 100644
--- a/docs/models/filestoragedrivesallresponse.md
+++ b/docs/models/filestoragedrivesallresponse.md
@@ -1,17 +1,8 @@
# FileStorageDrivesAllResponse
-## Supported Types
-
-### `models.GetDrivesResponse`
-
-```python
-value: models.GetDrivesResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
+| `result` | [models.FileStorageDrivesAllResponseResult](../models/filestoragedrivesallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/filestoragedrivesallresponseresult.md b/docs/models/filestoragedrivesallresponseresult.md
new file mode 100644
index 00000000..fa2d3fab
--- /dev/null
+++ b/docs/models/filestoragedrivesallresponseresult.md
@@ -0,0 +1,17 @@
+# FileStorageDrivesAllResponseResult
+
+
+## Supported Types
+
+### `models.GetDrivesResponse`
+
+```python
+value: models.GetDrivesResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/filestoragefilesallresponse.md b/docs/models/filestoragefilesallresponse.md
index b03d6ebf..26465fce 100644
--- a/docs/models/filestoragefilesallresponse.md
+++ b/docs/models/filestoragefilesallresponse.md
@@ -1,17 +1,8 @@
# FileStorageFilesAllResponse
-## Supported Types
-
-### `models.GetFilesResponse`
-
-```python
-value: models.GetFilesResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
+| `result` | [models.FileStorageFilesAllResponseResult](../models/filestoragefilesallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/filestoragefilesallresponseresult.md b/docs/models/filestoragefilesallresponseresult.md
new file mode 100644
index 00000000..ce7a93b7
--- /dev/null
+++ b/docs/models/filestoragefilesallresponseresult.md
@@ -0,0 +1,17 @@
+# FileStorageFilesAllResponseResult
+
+
+## Supported Types
+
+### `models.GetFilesResponse`
+
+```python
+value: models.GetFilesResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/filestoragefilessearchrequest.md b/docs/models/filestoragefilessearchrequest.md
index d696eab4..b757c812 100644
--- a/docs/models/filestoragefilessearchrequest.md
+++ b/docs/models/filestoragefilessearchrequest.md
@@ -7,7 +7,7 @@
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `files_search` | [models.FilesSearch](../models/filessearch.md) | :heavy_check_mark: | N/A | {
"query": "logo jpg"
} |
| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
-| `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} |
+| `pass_through_param` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} |
| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: `fields=name,email,addresses.city`
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at |
| `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | |
| `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | |
diff --git a/docs/models/filestoragesharedlinksallresponse.md b/docs/models/filestoragesharedlinksallresponse.md
index 4eddfd68..36654439 100644
--- a/docs/models/filestoragesharedlinksallresponse.md
+++ b/docs/models/filestoragesharedlinksallresponse.md
@@ -1,17 +1,8 @@
# FileStorageSharedLinksAllResponse
-## Supported Types
-
-### `models.GetSharedLinksResponse`
-
-```python
-value: models.GetSharedLinksResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
+| `result` | [models.FileStorageSharedLinksAllResponseResult](../models/filestoragesharedlinksallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/filestoragesharedlinksallresponseresult.md b/docs/models/filestoragesharedlinksallresponseresult.md
new file mode 100644
index 00000000..a0b4d883
--- /dev/null
+++ b/docs/models/filestoragesharedlinksallresponseresult.md
@@ -0,0 +1,17 @@
+# FileStorageSharedLinksAllResponseResult
+
+
+## Supported Types
+
+### `models.GetSharedLinksResponse`
+
+```python
+value: models.GetSharedLinksResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/getagedcreditorsresponse.md b/docs/models/getagedcreditorsresponse.md
new file mode 100644
index 00000000..eaa911b4
--- /dev/null
+++ b/docs/models/getagedcreditorsresponse.md
@@ -0,0 +1,15 @@
+# GetAgedCreditorsResponse
+
+Aged Creditors
+
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- |
+| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 |
+| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK |
+| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | quickbooks |
+| `resource` | *str* | :heavy_check_mark: | Unified API resource name | AgedCreditors |
+| `operation` | *str* | :heavy_check_mark: | Operation performed | one |
+| `data` | [models.AgedCreditors](../models/agedcreditors.md) | :heavy_check_mark: | N/A | |
\ No newline at end of file
diff --git a/docs/models/getageddebtorsresponse.md b/docs/models/getageddebtorsresponse.md
new file mode 100644
index 00000000..190937cd
--- /dev/null
+++ b/docs/models/getageddebtorsresponse.md
@@ -0,0 +1,15 @@
+# GetAgedDebtorsResponse
+
+Aged Debtors
+
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
+| `status_code` | *int* | :heavy_check_mark: | HTTP Response Status Code | 200 |
+| `status` | *str* | :heavy_check_mark: | HTTP Response Status | OK |
+| `service` | *str* | :heavy_check_mark: | Apideck ID of service provider | quickbooks |
+| `resource` | *str* | :heavy_check_mark: | Unified API resource name | AgedDebtors |
+| `operation` | *str* | :heavy_check_mark: | Operation performed | one |
+| `data` | [models.AgedDebtors](../models/ageddebtors.md) | :heavy_check_mark: | N/A | |
\ No newline at end of file
diff --git a/docs/models/hriscompaniesallresponse.md b/docs/models/hriscompaniesallresponse.md
index 4f4c1f48..17a19820 100644
--- a/docs/models/hriscompaniesallresponse.md
+++ b/docs/models/hriscompaniesallresponse.md
@@ -1,17 +1,8 @@
# HrisCompaniesAllResponse
-## Supported Types
-
-### `models.GetHrisCompaniesResponse`
-
-```python
-value: models.GetHrisCompaniesResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
+| `result` | [models.HrisCompaniesAllResponseResult](../models/hriscompaniesallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/hriscompaniesallresponseresult.md b/docs/models/hriscompaniesallresponseresult.md
new file mode 100644
index 00000000..3d6a8a7f
--- /dev/null
+++ b/docs/models/hriscompaniesallresponseresult.md
@@ -0,0 +1,17 @@
+# HrisCompaniesAllResponseResult
+
+
+## Supported Types
+
+### `models.GetHrisCompaniesResponse`
+
+```python
+value: models.GetHrisCompaniesResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/hrisdepartmentsallresponse.md b/docs/models/hrisdepartmentsallresponse.md
index 3f44e84d..9d622833 100644
--- a/docs/models/hrisdepartmentsallresponse.md
+++ b/docs/models/hrisdepartmentsallresponse.md
@@ -1,17 +1,8 @@
# HrisDepartmentsAllResponse
-## Supported Types
-
-### `models.GetDepartmentsResponse`
-
-```python
-value: models.GetDepartmentsResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
+| `result` | [models.HrisDepartmentsAllResponseResult](../models/hrisdepartmentsallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/hrisdepartmentsallresponseresult.md b/docs/models/hrisdepartmentsallresponseresult.md
new file mode 100644
index 00000000..1736ea43
--- /dev/null
+++ b/docs/models/hrisdepartmentsallresponseresult.md
@@ -0,0 +1,17 @@
+# HrisDepartmentsAllResponseResult
+
+
+## Supported Types
+
+### `models.GetDepartmentsResponse`
+
+```python
+value: models.GetDepartmentsResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/hrisemployeesallresponse.md b/docs/models/hrisemployeesallresponse.md
index cd47b5ca..31c5040e 100644
--- a/docs/models/hrisemployeesallresponse.md
+++ b/docs/models/hrisemployeesallresponse.md
@@ -1,17 +1,8 @@
# HrisEmployeesAllResponse
-## Supported Types
-
-### `models.GetEmployeesResponse`
-
-```python
-value: models.GetEmployeesResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
+| `result` | [models.HrisEmployeesAllResponseResult](../models/hrisemployeesallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/hrisemployeesallresponseresult.md b/docs/models/hrisemployeesallresponseresult.md
new file mode 100644
index 00000000..6e685b8b
--- /dev/null
+++ b/docs/models/hrisemployeesallresponseresult.md
@@ -0,0 +1,17 @@
+# HrisEmployeesAllResponseResult
+
+
+## Supported Types
+
+### `models.GetEmployeesResponse`
+
+```python
+value: models.GetEmployeesResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/hrisemployeesupdaterequest.md b/docs/models/hrisemployeesupdaterequest.md
index 5f739f4f..9c41c58f 100644
--- a/docs/models/hrisemployeesupdaterequest.md
+++ b/docs/models/hrisemployeesupdaterequest.md
@@ -5,7 +5,7 @@
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
+| `id_param` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
| `employee` | [models.EmployeeInput](../models/employeeinput.md) | :heavy_check_mark: | N/A | |
| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
\ No newline at end of file
diff --git a/docs/models/hristimeoffrequestsallresponse.md b/docs/models/hristimeoffrequestsallresponse.md
index 5c922e4f..3b009949 100644
--- a/docs/models/hristimeoffrequestsallresponse.md
+++ b/docs/models/hristimeoffrequestsallresponse.md
@@ -1,17 +1,8 @@
# HrisTimeOffRequestsAllResponse
-## Supported Types
-
-### `models.GetTimeOffRequestsResponse`
-
-```python
-value: models.GetTimeOffRequestsResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
+| `result` | [models.HrisTimeOffRequestsAllResponseResult](../models/hristimeoffrequestsallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/hristimeoffrequestsallresponseresult.md b/docs/models/hristimeoffrequestsallresponseresult.md
new file mode 100644
index 00000000..cf916aac
--- /dev/null
+++ b/docs/models/hristimeoffrequestsallresponseresult.md
@@ -0,0 +1,17 @@
+# HrisTimeOffRequestsAllResponseResult
+
+
+## Supported Types
+
+### `models.GetTimeOffRequestsResponse`
+
+```python
+value: models.GetTimeOffRequestsResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/hristimeoffrequestsupdaterequest.md b/docs/models/hristimeoffrequestsupdaterequest.md
index ab1e15df..db0d0a7a 100644
--- a/docs/models/hristimeoffrequestsupdaterequest.md
+++ b/docs/models/hristimeoffrequestsupdaterequest.md
@@ -6,7 +6,7 @@
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
-| `employee_id` | *str* | :heavy_check_mark: | ID of the employee you are acting upon. | |
+| `employee_id_param` | *str* | :heavy_check_mark: | ID of the employee you are acting upon. | |
| `time_off_request` | [models.TimeOffRequestInput](../models/timeoffrequestinput.md) | :heavy_check_mark: | N/A | |
| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
\ No newline at end of file
diff --git a/docs/models/issuetrackingcollectionsallresponse.md b/docs/models/issuetrackingcollectionsallresponse.md
index e49a901a..1533e801 100644
--- a/docs/models/issuetrackingcollectionsallresponse.md
+++ b/docs/models/issuetrackingcollectionsallresponse.md
@@ -1,17 +1,8 @@
# IssueTrackingCollectionsAllResponse
-## Supported Types
-
-### `models.GetCollectionsResponse`
-
-```python
-value: models.GetCollectionsResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
+| `result` | [models.IssueTrackingCollectionsAllResponseResult](../models/issuetrackingcollectionsallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/issuetrackingcollectionsallresponseresult.md b/docs/models/issuetrackingcollectionsallresponseresult.md
new file mode 100644
index 00000000..308e17b3
--- /dev/null
+++ b/docs/models/issuetrackingcollectionsallresponseresult.md
@@ -0,0 +1,17 @@
+# IssueTrackingCollectionsAllResponseResult
+
+
+## Supported Types
+
+### `models.GetCollectionsResponse`
+
+```python
+value: models.GetCollectionsResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/issuetrackingcollectiontagsallresponse.md b/docs/models/issuetrackingcollectiontagsallresponse.md
index 71c01e8e..954b28f7 100644
--- a/docs/models/issuetrackingcollectiontagsallresponse.md
+++ b/docs/models/issuetrackingcollectiontagsallresponse.md
@@ -1,17 +1,8 @@
# IssueTrackingCollectionTagsAllResponse
-## Supported Types
-
-### `models.GetCollectionTagsResponse`
-
-```python
-value: models.GetCollectionTagsResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
+| `result` | [models.IssueTrackingCollectionTagsAllResponseResult](../models/issuetrackingcollectiontagsallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/issuetrackingcollectiontagsallresponseresult.md b/docs/models/issuetrackingcollectiontagsallresponseresult.md
new file mode 100644
index 00000000..caa1be61
--- /dev/null
+++ b/docs/models/issuetrackingcollectiontagsallresponseresult.md
@@ -0,0 +1,17 @@
+# IssueTrackingCollectionTagsAllResponseResult
+
+
+## Supported Types
+
+### `models.GetCollectionTagsResponse`
+
+```python
+value: models.GetCollectionTagsResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/issuetrackingcollectionticketcommentsallresponse.md b/docs/models/issuetrackingcollectionticketcommentsallresponse.md
index 5fda726c..7e0bc539 100644
--- a/docs/models/issuetrackingcollectionticketcommentsallresponse.md
+++ b/docs/models/issuetrackingcollectionticketcommentsallresponse.md
@@ -1,17 +1,8 @@
# IssueTrackingCollectionTicketCommentsAllResponse
-## Supported Types
-
-### `models.GetCommentsResponse`
-
-```python
-value: models.GetCommentsResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ |
+| `result` | [models.IssueTrackingCollectionTicketCommentsAllResponseResult](../models/issuetrackingcollectionticketcommentsallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/issuetrackingcollectionticketcommentsallresponseresult.md b/docs/models/issuetrackingcollectionticketcommentsallresponseresult.md
new file mode 100644
index 00000000..7b898bf6
--- /dev/null
+++ b/docs/models/issuetrackingcollectionticketcommentsallresponseresult.md
@@ -0,0 +1,17 @@
+# IssueTrackingCollectionTicketCommentsAllResponseResult
+
+
+## Supported Types
+
+### `models.GetCommentsResponse`
+
+```python
+value: models.GetCommentsResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/issuetrackingcollectionticketcommentsoneresponse.md b/docs/models/issuetrackingcollectionticketcommentsoneresponse.md
index 724ae305..14c16b85 100644
--- a/docs/models/issuetrackingcollectionticketcommentsoneresponse.md
+++ b/docs/models/issuetrackingcollectionticketcommentsoneresponse.md
@@ -1,17 +1,8 @@
# IssueTrackingCollectionTicketCommentsOneResponse
-## Supported Types
-
-### `models.GetCommentResponse`
-
-```python
-value: models.GetCommentResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ |
+| `result` | [models.IssueTrackingCollectionTicketCommentsOneResponseResult](../models/issuetrackingcollectionticketcommentsoneresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/issuetrackingcollectionticketcommentsoneresponseresult.md b/docs/models/issuetrackingcollectionticketcommentsoneresponseresult.md
new file mode 100644
index 00000000..70e96a5e
--- /dev/null
+++ b/docs/models/issuetrackingcollectionticketcommentsoneresponseresult.md
@@ -0,0 +1,17 @@
+# IssueTrackingCollectionTicketCommentsOneResponseResult
+
+
+## Supported Types
+
+### `models.GetCommentResponse`
+
+```python
+value: models.GetCommentResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/issuetrackingcollectionticketsallresponse.md b/docs/models/issuetrackingcollectionticketsallresponse.md
index c02bdb6f..d47ecdda 100644
--- a/docs/models/issuetrackingcollectionticketsallresponse.md
+++ b/docs/models/issuetrackingcollectionticketsallresponse.md
@@ -1,17 +1,8 @@
# IssueTrackingCollectionTicketsAllResponse
-## Supported Types
-
-### `models.GetTicketsResponse`
-
-```python
-value: models.GetTicketsResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
+| `result` | [models.IssueTrackingCollectionTicketsAllResponseResult](../models/issuetrackingcollectionticketsallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/issuetrackingcollectionticketsallresponseresult.md b/docs/models/issuetrackingcollectionticketsallresponseresult.md
new file mode 100644
index 00000000..1814377f
--- /dev/null
+++ b/docs/models/issuetrackingcollectionticketsallresponseresult.md
@@ -0,0 +1,17 @@
+# IssueTrackingCollectionTicketsAllResponseResult
+
+
+## Supported Types
+
+### `models.GetTicketsResponse`
+
+```python
+value: models.GetTicketsResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/issuetrackingcollectionusersallresponse.md b/docs/models/issuetrackingcollectionusersallresponse.md
index 1e2557a5..d0cf6473 100644
--- a/docs/models/issuetrackingcollectionusersallresponse.md
+++ b/docs/models/issuetrackingcollectionusersallresponse.md
@@ -1,17 +1,8 @@
# IssueTrackingCollectionUsersAllResponse
-## Supported Types
-
-### `models.GetCollectionUsersResponse`
-
-```python
-value: models.GetCollectionUsersResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
+| `result` | [models.IssueTrackingCollectionUsersAllResponseResult](../models/issuetrackingcollectionusersallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/issuetrackingcollectionusersallresponseresult.md b/docs/models/issuetrackingcollectionusersallresponseresult.md
new file mode 100644
index 00000000..389c2a9c
--- /dev/null
+++ b/docs/models/issuetrackingcollectionusersallresponseresult.md
@@ -0,0 +1,17 @@
+# IssueTrackingCollectionUsersAllResponseResult
+
+
+## Supported Types
+
+### `models.GetCollectionUsersResponse`
+
+```python
+value: models.GetCollectionUsersResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/outstandingbalance.md b/docs/models/outstandingbalance.md
new file mode 100644
index 00000000..728257fb
--- /dev/null
+++ b/docs/models/outstandingbalance.md
@@ -0,0 +1,10 @@
+# OutstandingBalance
+
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
+| `customer_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the customer or supplier. | 123 |
+| `customer_name` | *Optional[str]* | :heavy_minus_sign: | Full name of the customer or supplier. | Super Store |
+| `outstanding_balances_by_currency` | List[[models.OutstandingBalanceByCurrency](../models/outstandingbalancebycurrency.md)] | :heavy_minus_sign: | N/A | |
\ No newline at end of file
diff --git a/docs/models/outstandingbalancebycurrency.md b/docs/models/outstandingbalancebycurrency.md
new file mode 100644
index 00000000..874ba9d3
--- /dev/null
+++ b/docs/models/outstandingbalancebycurrency.md
@@ -0,0 +1,9 @@
+# OutstandingBalanceByCurrency
+
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
+| `currency` | [OptionalNullable[models.Currency]](../models/currency.md) | :heavy_minus_sign: | Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). | USD |
+| `balances_by_period` | List[[models.BalanceByPeriod](../models/balancebyperiod.md)] | :heavy_minus_sign: | N/A | |
\ No newline at end of file
diff --git a/docs/models/smsmessagesallresponse.md b/docs/models/smsmessagesallresponse.md
index a508978d..115129a5 100644
--- a/docs/models/smsmessagesallresponse.md
+++ b/docs/models/smsmessagesallresponse.md
@@ -1,17 +1,8 @@
# SmsMessagesAllResponse
-## Supported Types
-
-### `models.GetMessagesResponse`
-
-```python
-value: models.GetMessagesResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
+| `result` | [models.SmsMessagesAllResponseResult](../models/smsmessagesallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/smsmessagesallresponseresult.md b/docs/models/smsmessagesallresponseresult.md
new file mode 100644
index 00000000..7b019f2e
--- /dev/null
+++ b/docs/models/smsmessagesallresponseresult.md
@@ -0,0 +1,17 @@
+# SmsMessagesAllResponseResult
+
+
+## Supported Types
+
+### `models.GetMessagesResponse`
+
+```python
+value: models.GetMessagesResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/transactiontype.md b/docs/models/transactiontype.md
new file mode 100644
index 00000000..d2869a11
--- /dev/null
+++ b/docs/models/transactiontype.md
@@ -0,0 +1,14 @@
+# TransactionType
+
+Type of the transaction.
+
+
+## Values
+
+| Name | Value |
+| -------------- | -------------- |
+| `INVOICE` | invoice |
+| `CREDIT_NOTE` | credit_note |
+| `BILL` | bill |
+| `PAYMENT` | payment |
+| `BILL_PAYMENT` | bill-payment |
\ No newline at end of file
diff --git a/docs/models/vaultconsumersallresponse.md b/docs/models/vaultconsumersallresponse.md
index fe9789a6..1cf14dd5 100644
--- a/docs/models/vaultconsumersallresponse.md
+++ b/docs/models/vaultconsumersallresponse.md
@@ -1,17 +1,8 @@
# VaultConsumersAllResponse
-## Supported Types
-
-### `models.GetConsumersResponse`
-
-```python
-value: models.GetConsumersResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
+| `result` | [models.VaultConsumersAllResponseResult](../models/vaultconsumersallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/vaultconsumersallresponseresult.md b/docs/models/vaultconsumersallresponseresult.md
new file mode 100644
index 00000000..841645ae
--- /dev/null
+++ b/docs/models/vaultconsumersallresponseresult.md
@@ -0,0 +1,17 @@
+# VaultConsumersAllResponseResult
+
+
+## Supported Types
+
+### `models.GetConsumersResponse`
+
+```python
+value: models.GetConsumersResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/vaultlogsallresponse.md b/docs/models/vaultlogsallresponse.md
index 34f8bc7b..13d80995 100644
--- a/docs/models/vaultlogsallresponse.md
+++ b/docs/models/vaultlogsallresponse.md
@@ -1,17 +1,8 @@
# VaultLogsAllResponse
-## Supported Types
-
-### `models.GetLogsResponse`
-
-```python
-value: models.GetLogsResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
+| `result` | [models.VaultLogsAllResponseResult](../models/vaultlogsallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/vaultlogsallresponseresult.md b/docs/models/vaultlogsallresponseresult.md
new file mode 100644
index 00000000..d6a5136b
--- /dev/null
+++ b/docs/models/vaultlogsallresponseresult.md
@@ -0,0 +1,17 @@
+# VaultLogsAllResponseResult
+
+
+## Supported Types
+
+### `models.GetLogsResponse`
+
+```python
+value: models.GetLogsResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/webhookeventlogsallresponse.md b/docs/models/webhookeventlogsallresponse.md
index 212274aa..29f5b298 100644
--- a/docs/models/webhookeventlogsallresponse.md
+++ b/docs/models/webhookeventlogsallresponse.md
@@ -1,17 +1,8 @@
# WebhookEventLogsAllResponse
-## Supported Types
-
-### `models.GetWebhookEventLogsResponse`
-
-```python
-value: models.GetWebhookEventLogsResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
+| `result` | [models.WebhookEventLogsAllResponseResult](../models/webhookeventlogsallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/webhookeventlogsallresponseresult.md b/docs/models/webhookeventlogsallresponseresult.md
new file mode 100644
index 00000000..97682500
--- /dev/null
+++ b/docs/models/webhookeventlogsallresponseresult.md
@@ -0,0 +1,17 @@
+# WebhookEventLogsAllResponseResult
+
+
+## Supported Types
+
+### `models.GetWebhookEventLogsResponse`
+
+```python
+value: models.GetWebhookEventLogsResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/models/webhookwebhooksallresponse.md b/docs/models/webhookwebhooksallresponse.md
index d3f737a1..f3dcb570 100644
--- a/docs/models/webhookwebhooksallresponse.md
+++ b/docs/models/webhookwebhooksallresponse.md
@@ -1,17 +1,8 @@
# WebhookWebhooksAllResponse
-## Supported Types
-
-### `models.GetWebhooksResponse`
-
-```python
-value: models.GetWebhooksResponse = /* values here */
-```
-
-### `models.UnexpectedErrorResponse`
-
-```python
-value: models.UnexpectedErrorResponse = /* values here */
-```
+## Fields
+| Field | Type | Required | Description |
+| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
+| `result` | [models.WebhookWebhooksAllResponseResult](../models/webhookwebhooksallresponseresult.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/docs/models/webhookwebhooksallresponseresult.md b/docs/models/webhookwebhooksallresponseresult.md
new file mode 100644
index 00000000..cdb96f7c
--- /dev/null
+++ b/docs/models/webhookwebhooksallresponseresult.md
@@ -0,0 +1,17 @@
+# WebhookWebhooksAllResponseResult
+
+
+## Supported Types
+
+### `models.GetWebhooksResponse`
+
+```python
+value: models.GetWebhooksResponse = /* values here */
+```
+
+### `models.UnexpectedErrorResponse`
+
+```python
+value: models.UnexpectedErrorResponse = /* values here */
+```
+
diff --git a/docs/sdks/activities/README.md b/docs/sdks/activities/README.md
index 6fc4f05d..6a13cfbd 100644
--- a/docs/sdks/activities/README.md
+++ b/docs/sdks/activities/README.md
@@ -28,33 +28,36 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.crm.activities.list(request={
- "service_id": "salesforce",
- "filter_": {
- "updated_since": dateutil.parser.isoparse("2020-09-30T07:43:32.000Z"),
- },
- "sort": {
- "by": apideck_unify.ActivitiesSortBy.CREATED_AT,
- "direction": apideck_unify.SortDirection.DESC,
- },
- "pass_through": {
- "search": "San Francisco",
- },
- "fields": "id,updated_at",
- })
- if res is not None:
- # handle response
- pass
+ res = apideck.crm.activities.list(service_id="salesforce", filter_={
+ "updated_since": dateutil.parser.isoparse("2020-09-30T07:43:32.000Z"),
+ }, sort={
+ "by": apideck_unify.ActivitiesSortBy.CREATED_AT,
+ "direction": apideck_unify.SortDirection.DESC,
+ }, pass_through={
+ "search": "San Francisco",
+ }, fields="id,updated_at")
+
+ while res is not None:
+ # Handle items
+
+ res = res.next()
```
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
-| `request` | [models.CrmActivitiesAllRequest](../../models/crmactivitiesallrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
+| Parameter | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | |
+| `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | |
+| `filter_` | [Optional[models.ActivitiesFilter]](../../models/activitiesfilter.md) | :heavy_minus_sign: | Apply filters | {
"updated_since": "2020-09-30T07:43:32.000Z"
} |
+| `sort` | [Optional[models.ActivitiesSort]](../../models/activitiessort.md) | :heavy_minus_sign: | Apply sorting | {
"by": "created_at",
"direction": "desc"
} |
+| `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} |
+| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: `fields=name,email,addresses.city`
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -87,124 +90,122 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.crm.activities.create(activity={
- "type": apideck_unify.ActivityType.MEETING,
- "activity_datetime": "2021-05-01T12:00:00.000Z",
- "duration_seconds": 1800,
- "user_id": "12345",
- "account_id": "12345",
- "contact_id": "12345",
- "company_id": "12345",
- "opportunity_id": "12345",
- "lead_id": "12345",
- "owner_id": "12345",
- "campaign_id": "12345",
- "case_id": "12345",
- "asset_id": "12345",
- "contract_id": "12345",
- "product_id": "12345",
- "solution_id": "12345",
- "custom_object_id": "12345",
- "title": "Meeting",
- "description": "More info about the meeting",
- "note": "An internal note about the meeting",
- "location": "Space",
- "location_address": {
- "id": "123",
- "type": apideck_unify.Type.PRIMARY,
- "string": "25 Spring Street, Blackburn, VIC 3130",
- "name": "HQ US",
- "line1": "Main street",
- "line2": "apt #",
- "line3": "Suite #",
- "line4": "delivery instructions",
- "street_number": "25",
- "city": "San Francisco",
- "state": "CA",
- "postal_code": "94104",
- "country": "US",
- "latitude": "40.759211",
- "longitude": "-73.984638",
- "county": "Santa Clara",
- "contact_name": "Elon Musk",
- "salutation": "Mr",
- "phone_number": "111-111-1111",
- "fax": "122-111-1111",
- "email": "elon@musk.com",
- "website": "https://elonmusk.com",
- "notes": "Address notes or delivery instructions.",
- "row_version": "1-12345",
+
+ res = apideck.crm.activities.create(type_=apideck_unify.ActivityType.MEETING, service_id="salesforce", activity_datetime="2021-05-01T12:00:00.000Z", duration_seconds=1800, user_id="12345", account_id="12345", contact_id="12345", company_id="12345", opportunity_id="12345", lead_id="12345", owner_id="12345", campaign_id="12345", case_id="12345", asset_id="12345", contract_id="12345", product_id="12345", solution_id="12345", custom_object_id="12345", title="Meeting", description="More info about the meeting", note="An internal note about the meeting", location="Space", location_address={
+ "id": "123",
+ "type": apideck_unify.Type.PRIMARY,
+ "string": "25 Spring Street, Blackburn, VIC 3130",
+ "name": "HQ US",
+ "line1": "Main street",
+ "line2": "apt #",
+ "line3": "Suite #",
+ "line4": "delivery instructions",
+ "street_number": "25",
+ "city": "San Francisco",
+ "state": "CA",
+ "postal_code": "94104",
+ "country": "US",
+ "latitude": "40.759211",
+ "longitude": "-73.984638",
+ "county": "Santa Clara",
+ "contact_name": "Elon Musk",
+ "salutation": "Mr",
+ "phone_number": "111-111-1111",
+ "fax": "122-111-1111",
+ "email": "elon@musk.com",
+ "website": "https://elonmusk.com",
+ "notes": "Address notes or delivery instructions.",
+ "row_version": "1-12345",
+ }, all_day_event=False, private=True, group_event=True, event_sub_type="debrief", group_event_type="Proposed", child=False, archived=False, deleted=False, show_as=apideck_unify.ShowAs.BUSY, done=False, start_datetime="2021-05-01T12:00:00.000Z", end_datetime="2021-05-01T12:30:00.000Z", activity_date="2021-05-01", end_date="2021-05-01", recurrent=False, reminder_datetime="2021-05-01T17:00:00.000Z", reminder_set=False, video_conference_url="https://us02web.zoom.us/j/88120759396", video_conference_id="zoom:88120759396", custom_fields=[
+ {
+ "id": "2389328923893298",
+ "name": "employee_level",
+ "description": "Employee Level",
+ },
+ ], attendees=[
+ {
+ "name": "Elon Musk",
+ "first_name": "Elon",
+ "middle_name": "D.",
+ "last_name": "Musk",
+ "prefix": "Mr.",
+ "suffix": "PhD",
+ "email_address": "elon@musk.com",
+ "is_organizer": True,
+ "status": apideck_unify.ActivityAttendeeStatus.ACCEPTED,
},
- "all_day_event": False,
- "private": True,
- "group_event": True,
- "event_sub_type": "debrief",
- "group_event_type": "Proposed",
- "child": False,
- "archived": False,
- "deleted": False,
- "show_as": apideck_unify.ShowAs.BUSY,
- "done": False,
- "start_datetime": "2021-05-01T12:00:00.000Z",
- "end_datetime": "2021-05-01T12:30:00.000Z",
- "activity_date": "2021-05-01",
- "end_date": "2021-05-01",
- "recurrent": False,
- "reminder_datetime": "2021-05-01T17:00:00.000Z",
- "reminder_set": False,
- "video_conference_url": "https://us02web.zoom.us/j/88120759396",
- "video_conference_id": "zoom:88120759396",
- "custom_fields": [
- {
- "id": "2389328923893298",
- "name": "employee_level",
- "description": "Employee Level",
- },
- ],
- "attendees": [
- {
- "name": "Elon Musk",
- "first_name": "Elon",
- "middle_name": "D.",
- "last_name": "Musk",
- "prefix": "Mr.",
- "suffix": "PhD",
- "email_address": "elon@musk.com",
- "is_organizer": True,
- "status": apideck_unify.ActivityAttendeeStatus.ACCEPTED,
- },
- ],
- "pass_through": [
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ ], pass_through=[
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- ],
- }, service_id="salesforce")
+ },
+ ],
+ },
+ ])
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description | Example |
-| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| `activity` | [models.ActivityInput](../../models/activityinput.md) | :heavy_check_mark: | N/A | |
-| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
-| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
+| Parameter | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `type` | [Nullable[models.ActivityType]](../../models/activitytype.md) | :heavy_check_mark: | The type of the activity | meeting |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `activity_datetime` | *OptionalNullable[str]* | :heavy_minus_sign: | The date and time of the activity | 2021-05-01T12:00:00.000Z |
+| `duration_seconds` | *OptionalNullable[int]* | :heavy_minus_sign: | The duration of the activity in seconds | 1800 |
+| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The user related to the activity | 12345 |
+| `account_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The account related to the activity | 12345 |
+| `contact_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The contact related to the activity | 12345 |
+| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company related to the activity | 12345 |
+| `opportunity_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The opportunity related to the activity | 12345 |
+| `lead_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The lead related to the activity | 12345 |
+| `owner_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The owner of the activity | 12345 |
+| `campaign_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The campaign related to the activity | 12345 |
+| `case_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The case related to the activity | 12345 |
+| `asset_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The asset related to the activity | 12345 |
+| `contract_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The contract related to the activity | 12345 |
+| `product_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The product related to the activity | 12345 |
+| `solution_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The solution related to the activity | 12345 |
+| `custom_object_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The custom object related to the activity | 12345 |
+| `title` | *OptionalNullable[str]* | :heavy_minus_sign: | The title of the activity | Meeting |
+| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | A description of the activity | More info about the meeting |
+| `note` | *OptionalNullable[str]* | :heavy_minus_sign: | An internal note about the activity | An internal note about the meeting |
+| `location` | *OptionalNullable[str]* | :heavy_minus_sign: | The location of the activity | Space |
+| `location_address` | [Optional[models.Address]](../../models/address.md) | :heavy_minus_sign: | N/A | |
+| `all_day_event` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether the Activity is an all day event or not | false |
+| `private` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether the Activity is private or not | true |
+| `group_event` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether the Activity is a group event or not | true |
+| `event_sub_type` | *OptionalNullable[str]* | :heavy_minus_sign: | The sub type of the group event | debrief |
+| `group_event_type` | *OptionalNullable[str]* | :heavy_minus_sign: | The type of the group event | Proposed |
+| `child` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether the activity is a child of another activity or not | false |
+| `archived` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether the activity is archived or not | false |
+| `deleted` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether the activity is deleted or not | false |
+| `show_as` | [OptionalNullable[models.ShowAs]](../../models/showas.md) | :heavy_minus_sign: | N/A | busy |
+| `done` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether the Activity is done or not | false |
+| `start_datetime` | *OptionalNullable[str]* | :heavy_minus_sign: | The start date and time of the activity | 2021-05-01T12:00:00.000Z |
+| `end_datetime` | *OptionalNullable[str]* | :heavy_minus_sign: | The end date and time of the activity | 2021-05-01T12:30:00.000Z |
+| `activity_date` | *OptionalNullable[str]* | :heavy_minus_sign: | The date of the activity | 2021-05-01 |
+| `end_date` | *OptionalNullable[str]* | :heavy_minus_sign: | The end date of the activity | 2021-05-01 |
+| `recurrent` | *Optional[bool]* | :heavy_minus_sign: | Whether the activity is recurrent or not | false |
+| `reminder_datetime` | *OptionalNullable[str]* | :heavy_minus_sign: | The date and time of the reminder | 2021-05-01T17:00:00.000Z |
+| `reminder_set` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether the reminder is set or not | false |
+| `video_conference_url` | *OptionalNullable[str]* | :heavy_minus_sign: | The URL of the video conference | https://us02web.zoom.us/j/88120759396 |
+| `video_conference_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the video conference | zoom:88120759396 |
+| `custom_fields` | List[[models.CustomField](../../models/customfield.md)] | :heavy_minus_sign: | Custom fields of the activity | |
+| `attendees` | List[[models.ActivityAttendeeInput](../../models/activityattendeeinput.md)] | :heavy_minus_sign: | N/A | |
+| `pass_through` | List[[models.PassThroughBody](../../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -236,11 +237,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.crm.activities.get(id="", service_id="salesforce", fields="id,updated_at")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
@@ -285,178 +286,176 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.crm.activities.update(id="", activity={
- "type": apideck_unify.ActivityType.MEETING,
- "activity_datetime": "2021-05-01T12:00:00.000Z",
- "duration_seconds": 1800,
- "user_id": "12345",
- "account_id": "12345",
- "contact_id": "12345",
- "company_id": "12345",
- "opportunity_id": "12345",
- "lead_id": "12345",
- "owner_id": "12345",
- "campaign_id": "12345",
- "case_id": "12345",
- "asset_id": "12345",
- "contract_id": "12345",
- "product_id": "12345",
- "solution_id": "12345",
- "custom_object_id": "12345",
- "title": "Meeting",
- "description": "More info about the meeting",
- "note": "An internal note about the meeting",
- "location": "Space",
- "location_address": {
- "id": "123",
- "type": apideck_unify.Type.PRIMARY,
- "string": "25 Spring Street, Blackburn, VIC 3130",
- "name": "HQ US",
- "line1": "Main street",
- "line2": "apt #",
- "line3": "Suite #",
- "line4": "delivery instructions",
- "street_number": "25",
- "city": "San Francisco",
- "state": "CA",
- "postal_code": "94104",
- "country": "US",
- "latitude": "40.759211",
- "longitude": "-73.984638",
- "county": "Santa Clara",
- "contact_name": "Elon Musk",
- "salutation": "Mr",
- "phone_number": "111-111-1111",
- "fax": "122-111-1111",
- "email": "elon@musk.com",
- "website": "https://elonmusk.com",
- "notes": "Address notes or delivery instructions.",
- "row_version": "1-12345",
+
+ res = apideck.crm.activities.update(id="", type_=apideck_unify.ActivityType.MEETING, service_id="salesforce", activity_datetime="2021-05-01T12:00:00.000Z", duration_seconds=1800, user_id="12345", account_id="12345", contact_id="12345", company_id="12345", opportunity_id="12345", lead_id="12345", owner_id="12345", campaign_id="12345", case_id="12345", asset_id="12345", contract_id="12345", product_id="12345", solution_id="12345", custom_object_id="12345", title="Meeting", description="More info about the meeting", note="An internal note about the meeting", location="Space", location_address={
+ "id": "123",
+ "type": apideck_unify.Type.PRIMARY,
+ "string": "25 Spring Street, Blackburn, VIC 3130",
+ "name": "HQ US",
+ "line1": "Main street",
+ "line2": "apt #",
+ "line3": "Suite #",
+ "line4": "delivery instructions",
+ "street_number": "25",
+ "city": "San Francisco",
+ "state": "CA",
+ "postal_code": "94104",
+ "country": "US",
+ "latitude": "40.759211",
+ "longitude": "-73.984638",
+ "county": "Santa Clara",
+ "contact_name": "Elon Musk",
+ "salutation": "Mr",
+ "phone_number": "111-111-1111",
+ "fax": "122-111-1111",
+ "email": "elon@musk.com",
+ "website": "https://elonmusk.com",
+ "notes": "Address notes or delivery instructions.",
+ "row_version": "1-12345",
+ }, all_day_event=False, private=True, group_event=True, event_sub_type="debrief", group_event_type="Proposed", child=False, archived=False, deleted=False, show_as=apideck_unify.ShowAs.BUSY, done=False, start_datetime="2021-05-01T12:00:00.000Z", end_datetime="2021-05-01T12:30:00.000Z", activity_date="2021-05-01", end_date="2021-05-01", recurrent=False, reminder_datetime="2021-05-01T17:00:00.000Z", reminder_set=False, video_conference_url="https://us02web.zoom.us/j/88120759396", video_conference_id="zoom:88120759396", custom_fields=[
+ {
+ "id": "2389328923893298",
+ "name": "employee_level",
+ "description": "Employee Level",
+ },
+ {
+ "id": "2389328923893298",
+ "name": "employee_level",
+ "description": "Employee Level",
+ "value": True,
},
- "all_day_event": False,
- "private": True,
- "group_event": True,
- "event_sub_type": "debrief",
- "group_event_type": "Proposed",
- "child": False,
- "archived": False,
- "deleted": False,
- "show_as": apideck_unify.ShowAs.BUSY,
- "done": False,
- "start_datetime": "2021-05-01T12:00:00.000Z",
- "end_datetime": "2021-05-01T12:30:00.000Z",
- "activity_date": "2021-05-01",
- "end_date": "2021-05-01",
- "recurrent": False,
- "reminder_datetime": "2021-05-01T17:00:00.000Z",
- "reminder_set": False,
- "video_conference_url": "https://us02web.zoom.us/j/88120759396",
- "video_conference_id": "zoom:88120759396",
- "custom_fields": [
- {
- "id": "2389328923893298",
- "name": "employee_level",
- "description": "Employee Level",
- },
- {
- "id": "2389328923893298",
- "name": "employee_level",
- "description": "Employee Level",
- "value": True,
- },
- {
- "id": "2389328923893298",
- "name": "employee_level",
- "description": "Employee Level",
- },
- ],
- "attendees": [
- {
- "name": "Elon Musk",
- "first_name": "Elon",
- "middle_name": "D.",
- "last_name": "Musk",
- "prefix": "Mr.",
- "suffix": "PhD",
- "email_address": "elon@musk.com",
- "is_organizer": True,
- "status": apideck_unify.ActivityAttendeeStatus.ACCEPTED,
- },
- ],
- "pass_through": [
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ {
+ "id": "2389328923893298",
+ "name": "employee_level",
+ "description": "Employee Level",
+ },
+ ], attendees=[
+ {
+ "name": "Elon Musk",
+ "first_name": "Elon",
+ "middle_name": "D.",
+ "last_name": "Musk",
+ "prefix": "Mr.",
+ "suffix": "PhD",
+ "email_address": "elon@musk.com",
+ "is_organizer": True,
+ "status": apideck_unify.ActivityAttendeeStatus.ACCEPTED,
+ },
+ ], pass_through=[
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ ],
+ },
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ ],
+ },
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- ],
- }, service_id="salesforce")
+ },
+ ],
+ },
+ ])
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description | Example |
-| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
-| `activity` | [models.ActivityInput](../../models/activityinput.md) | :heavy_check_mark: | N/A | |
-| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
-| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
+| Parameter | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
+| `type` | [Nullable[models.ActivityType]](../../models/activitytype.md) | :heavy_check_mark: | The type of the activity | meeting |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `activity_datetime` | *OptionalNullable[str]* | :heavy_minus_sign: | The date and time of the activity | 2021-05-01T12:00:00.000Z |
+| `duration_seconds` | *OptionalNullable[int]* | :heavy_minus_sign: | The duration of the activity in seconds | 1800 |
+| `user_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The user related to the activity | 12345 |
+| `account_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The account related to the activity | 12345 |
+| `contact_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The contact related to the activity | 12345 |
+| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company related to the activity | 12345 |
+| `opportunity_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The opportunity related to the activity | 12345 |
+| `lead_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The lead related to the activity | 12345 |
+| `owner_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The owner of the activity | 12345 |
+| `campaign_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The campaign related to the activity | 12345 |
+| `case_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The case related to the activity | 12345 |
+| `asset_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The asset related to the activity | 12345 |
+| `contract_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The contract related to the activity | 12345 |
+| `product_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The product related to the activity | 12345 |
+| `solution_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The solution related to the activity | 12345 |
+| `custom_object_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The custom object related to the activity | 12345 |
+| `title` | *OptionalNullable[str]* | :heavy_minus_sign: | The title of the activity | Meeting |
+| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | A description of the activity | More info about the meeting |
+| `note` | *OptionalNullable[str]* | :heavy_minus_sign: | An internal note about the activity | An internal note about the meeting |
+| `location` | *OptionalNullable[str]* | :heavy_minus_sign: | The location of the activity | Space |
+| `location_address` | [Optional[models.Address]](../../models/address.md) | :heavy_minus_sign: | N/A | |
+| `all_day_event` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether the Activity is an all day event or not | false |
+| `private` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether the Activity is private or not | true |
+| `group_event` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether the Activity is a group event or not | true |
+| `event_sub_type` | *OptionalNullable[str]* | :heavy_minus_sign: | The sub type of the group event | debrief |
+| `group_event_type` | *OptionalNullable[str]* | :heavy_minus_sign: | The type of the group event | Proposed |
+| `child` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether the activity is a child of another activity or not | false |
+| `archived` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether the activity is archived or not | false |
+| `deleted` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether the activity is deleted or not | false |
+| `show_as` | [OptionalNullable[models.ShowAs]](../../models/showas.md) | :heavy_minus_sign: | N/A | busy |
+| `done` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether the Activity is done or not | false |
+| `start_datetime` | *OptionalNullable[str]* | :heavy_minus_sign: | The start date and time of the activity | 2021-05-01T12:00:00.000Z |
+| `end_datetime` | *OptionalNullable[str]* | :heavy_minus_sign: | The end date and time of the activity | 2021-05-01T12:30:00.000Z |
+| `activity_date` | *OptionalNullable[str]* | :heavy_minus_sign: | The date of the activity | 2021-05-01 |
+| `end_date` | *OptionalNullable[str]* | :heavy_minus_sign: | The end date of the activity | 2021-05-01 |
+| `recurrent` | *Optional[bool]* | :heavy_minus_sign: | Whether the activity is recurrent or not | false |
+| `reminder_datetime` | *OptionalNullable[str]* | :heavy_minus_sign: | The date and time of the reminder | 2021-05-01T17:00:00.000Z |
+| `reminder_set` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether the reminder is set or not | false |
+| `video_conference_url` | *OptionalNullable[str]* | :heavy_minus_sign: | The URL of the video conference | https://us02web.zoom.us/j/88120759396 |
+| `video_conference_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the video conference | zoom:88120759396 |
+| `custom_fields` | List[[models.CustomField](../../models/customfield.md)] | :heavy_minus_sign: | Custom fields of the activity | |
+| `attendees` | List[[models.ActivityAttendeeInput](../../models/activityattendeeinput.md)] | :heavy_minus_sign: | N/A | |
+| `pass_through` | List[[models.PassThroughBody](../../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -488,11 +487,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.crm.activities.delete(id="", service_id="salesforce")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
diff --git a/docs/sdks/agedcreditorssdk/README.md b/docs/sdks/agedcreditorssdk/README.md
new file mode 100644
index 00000000..8b9e6ed1
--- /dev/null
+++ b/docs/sdks/agedcreditorssdk/README.md
@@ -0,0 +1,64 @@
+# AgedCreditorsSDK
+(*accounting.aged_creditors*)
+
+## Overview
+
+### Available Operations
+
+* [get](#get) - Get Aged Creditors
+
+## get
+
+Get Aged Creditors
+
+### Example Usage
+
+```python
+from apideck_unify import Apideck
+import os
+
+with Apideck(
+ api_key=os.getenv("APIDECK_API_KEY", ""),
+ consumer_id="test-consumer",
+ app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
+) as apideck:
+
+ res = apideck.accounting.aged_creditors.get(service_id="salesforce", filter_={
+ "customer_id": "123abc",
+ "report_as_of_date": "2024-01-01",
+ "period_count": 3,
+ "period_length": 30,
+ }, pass_through={
+ "search": "San Francisco",
+ }, fields="id,updated_at")
+
+ # Handle response
+ print(res)
+
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `filter_` | [Optional[models.AgedReportFilter]](../../models/agedreportfilter.md) | :heavy_minus_sign: | Apply filters | {
"customer_id": "123abc",
"report_as_of_date": "2024-01-01",
"period_count": 3,
"period_length": 30
} |
+| `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} |
+| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: `fields=name,email,addresses.city`
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
+
+### Response
+
+**[models.AccountingAgedCreditorsOneResponse](../../models/accountingagedcreditorsoneresponse.md)**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ------------------------------ | ------------------------------ | ------------------------------ |
+| models.BadRequestResponse | 400 | application/json |
+| models.UnauthorizedResponse | 401 | application/json |
+| models.PaymentRequiredResponse | 402 | application/json |
+| models.NotFoundResponse | 404 | application/json |
+| models.UnprocessableResponse | 422 | application/json |
+| models.APIError | 4XX, 5XX | \*/\* |
\ No newline at end of file
diff --git a/docs/sdks/ageddebtorssdk/README.md b/docs/sdks/ageddebtorssdk/README.md
new file mode 100644
index 00000000..647bc8c4
--- /dev/null
+++ b/docs/sdks/ageddebtorssdk/README.md
@@ -0,0 +1,64 @@
+# AgedDebtorsSDK
+(*accounting.aged_debtors*)
+
+## Overview
+
+### Available Operations
+
+* [get](#get) - Get Aged Debtors
+
+## get
+
+Get Aged Debtors
+
+### Example Usage
+
+```python
+from apideck_unify import Apideck
+import os
+
+with Apideck(
+ api_key=os.getenv("APIDECK_API_KEY", ""),
+ consumer_id="test-consumer",
+ app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
+) as apideck:
+
+ res = apideck.accounting.aged_debtors.get(service_id="salesforce", filter_={
+ "customer_id": "123abc",
+ "report_as_of_date": "2024-01-01",
+ "period_count": 3,
+ "period_length": 30,
+ }, pass_through={
+ "search": "San Francisco",
+ }, fields="id,updated_at")
+
+ # Handle response
+ print(res)
+
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `filter_` | [Optional[models.AgedReportFilter]](../../models/agedreportfilter.md) | :heavy_minus_sign: | Apply filters | {
"customer_id": "123abc",
"report_as_of_date": "2024-01-01",
"period_count": 3,
"period_length": 30
} |
+| `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} |
+| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: `fields=name,email,addresses.city`
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
+
+### Response
+
+**[models.AccountingAgedDebtorsOneResponse](../../models/accountingageddebtorsoneresponse.md)**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ------------------------------ | ------------------------------ | ------------------------------ |
+| models.BadRequestResponse | 400 | application/json |
+| models.UnauthorizedResponse | 401 | application/json |
+| models.PaymentRequiredResponse | 402 | application/json |
+| models.NotFoundResponse | 404 | application/json |
+| models.UnprocessableResponse | 422 | application/json |
+| models.APIError | 4XX, 5XX | \*/\* |
\ No newline at end of file
diff --git a/docs/sdks/apideckcompanies/README.md b/docs/sdks/apideckcompanies/README.md
index 53f07d97..05a4733e 100644
--- a/docs/sdks/apideckcompanies/README.md
+++ b/docs/sdks/apideckcompanies/README.md
@@ -26,26 +26,29 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.hris.companies.list(request={
- "service_id": "salesforce",
- "pass_through": {
- "search": "San Francisco",
- },
- "fields": "id,updated_at",
- })
- if res is not None:
- # handle response
- pass
+ res = apideck.hris.companies.list(service_id="salesforce", pass_through={
+ "search": "San Francisco",
+ }, fields="id,updated_at")
+
+ while res is not None:
+ # Handle items
+
+ res = res.next()
```
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
-| `request` | [models.HrisCompaniesAllRequest](../../models/hriscompaniesallrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
+| Parameter | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | |
+| `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | |
+| `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} |
+| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: `fields=name,email,addresses.city`
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -78,105 +81,103 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.hris.companies.create(hris_company={
- "legal_name": "SpaceX",
- "display_name": "SpaceX",
- "subdomain": "company",
- "status": apideck_unify.HrisCompanyStatus.ACTIVE,
- "company_number": "123456-AB",
- "currency": apideck_unify.Currency.USD,
- "addresses": [
- {
- "id": "123",
- "type": apideck_unify.Type.PRIMARY,
- "string": "25 Spring Street, Blackburn, VIC 3130",
- "name": "HQ US",
- "line1": "Main street",
- "line2": "apt #",
- "line3": "Suite #",
- "line4": "delivery instructions",
- "street_number": "25",
- "city": "San Francisco",
- "state": "CA",
- "postal_code": "94104",
- "country": "US",
- "latitude": "40.759211",
- "longitude": "-73.984638",
- "county": "Santa Clara",
- "contact_name": "Elon Musk",
- "salutation": "Mr",
- "phone_number": "111-111-1111",
- "fax": "122-111-1111",
- "email": "elon@musk.com",
- "website": "https://elonmusk.com",
- "notes": "Address notes or delivery instructions.",
- "row_version": "1-12345",
- },
- ],
- "phone_numbers": [
- {
- "number": "111-111-1111",
- "id": "12345",
- "country_code": "1",
- "area_code": "323",
- "extension": "105",
- "type": apideck_unify.PhoneNumberType.PRIMARY,
- },
- {
- "number": "111-111-1111",
- "id": "12345",
- "country_code": "1",
- "area_code": "323",
- "extension": "105",
- "type": apideck_unify.PhoneNumberType.PRIMARY,
- },
- ],
- "emails": [
- {
- "email": "elon@musk.com",
- "id": "123",
- "type": apideck_unify.EmailType.PRIMARY,
- },
- ],
- "websites": [
- {
- "url": "http://example.com",
- "id": "12345",
- "type": apideck_unify.WebsiteType.PRIMARY,
- },
- ],
- "debtor_id": "12345",
- "pass_through": [
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+
+ res = apideck.hris.companies.create(legal_name="SpaceX", service_id="salesforce", display_name="SpaceX", subdomain="company", status=apideck_unify.HrisCompanyStatus.ACTIVE, company_number="123456-AB", currency=apideck_unify.Currency.USD, addresses=[
+ {
+ "id": "123",
+ "type": apideck_unify.Type.PRIMARY,
+ "string": "25 Spring Street, Blackburn, VIC 3130",
+ "name": "HQ US",
+ "line1": "Main street",
+ "line2": "apt #",
+ "line3": "Suite #",
+ "line4": "delivery instructions",
+ "street_number": "25",
+ "city": "San Francisco",
+ "state": "CA",
+ "postal_code": "94104",
+ "country": "US",
+ "latitude": "40.759211",
+ "longitude": "-73.984638",
+ "county": "Santa Clara",
+ "contact_name": "Elon Musk",
+ "salutation": "Mr",
+ "phone_number": "111-111-1111",
+ "fax": "122-111-1111",
+ "email": "elon@musk.com",
+ "website": "https://elonmusk.com",
+ "notes": "Address notes or delivery instructions.",
+ "row_version": "1-12345",
+ },
+ ], phone_numbers=[
+ {
+ "number": "111-111-1111",
+ "id": "12345",
+ "country_code": "1",
+ "area_code": "323",
+ "extension": "105",
+ "type": apideck_unify.PhoneNumberType.PRIMARY,
+ },
+ {
+ "number": "111-111-1111",
+ "id": "12345",
+ "country_code": "1",
+ "area_code": "323",
+ "extension": "105",
+ "type": apideck_unify.PhoneNumberType.PRIMARY,
+ },
+ ], emails=[
+ {
+ "email": "elon@musk.com",
+ "id": "123",
+ "type": apideck_unify.EmailType.PRIMARY,
+ },
+ ], websites=[
+ {
+ "url": "http://example.com",
+ "id": "12345",
+ "type": apideck_unify.WebsiteType.PRIMARY,
+ },
+ ], debtor_id="12345", pass_through=[
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- ],
- }, service_id="salesforce")
+ },
+ ],
+ },
+ ])
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description | Example |
-| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| `hris_company` | [models.HrisCompanyInput](../../models/hriscompanyinput.md) | :heavy_check_mark: | N/A | |
-| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
-| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
+| Parameter | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `legal_name` | *Nullable[str]* | :heavy_check_mark: | N/A | SpaceX |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `display_name` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | SpaceX |
+| `subdomain` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | company |
+| `status` | [Optional[models.HrisCompanyStatus]](../../models/hriscompanystatus.md) | :heavy_minus_sign: | N/A | active |
+| `company_number` | *OptionalNullable[str]* | :heavy_minus_sign: | An Company Number, Company ID or Company Code, is a unique number that has been assigned to each company. | 123456-AB |
+| `currency` | [OptionalNullable[models.Currency]](../../models/currency.md) | :heavy_minus_sign: | Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). | USD |
+| `addresses` | List[[models.Address](../../models/address.md)] | :heavy_minus_sign: | N/A | |
+| `phone_numbers` | List[[models.PhoneNumber](../../models/phonenumber.md)] | :heavy_minus_sign: | N/A | |
+| `emails` | List[[models.Email](../../models/email.md)] | :heavy_minus_sign: | N/A | |
+| `websites` | List[[models.Website](../../models/website.md)] | :heavy_minus_sign: | N/A | |
+| `debtor_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 12345 |
+| `pass_through` | List[[models.PassThroughBody](../../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -208,11 +209,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.hris.companies.get(id="", service_id="salesforce", fields="id,updated_at")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
@@ -257,197 +258,195 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.hris.companies.update(id="", hris_company={
- "legal_name": "SpaceX",
- "display_name": "SpaceX",
- "subdomain": "company",
- "status": apideck_unify.HrisCompanyStatus.ACTIVE,
- "company_number": "123456-AB",
- "currency": apideck_unify.Currency.USD,
- "addresses": [
- {
- "id": "123",
- "type": apideck_unify.Type.PRIMARY,
- "string": "25 Spring Street, Blackburn, VIC 3130",
- "name": "HQ US",
- "line1": "Main street",
- "line2": "apt #",
- "line3": "Suite #",
- "line4": "delivery instructions",
- "street_number": "25",
- "city": "San Francisco",
- "state": "CA",
- "postal_code": "94104",
- "country": "US",
- "latitude": "40.759211",
- "longitude": "-73.984638",
- "county": "Santa Clara",
- "contact_name": "Elon Musk",
- "salutation": "Mr",
- "phone_number": "111-111-1111",
- "fax": "122-111-1111",
- "email": "elon@musk.com",
- "website": "https://elonmusk.com",
- "notes": "Address notes or delivery instructions.",
- "row_version": "1-12345",
- },
- {
- "id": "123",
- "type": apideck_unify.Type.PRIMARY,
- "string": "25 Spring Street, Blackburn, VIC 3130",
- "name": "HQ US",
- "line1": "Main street",
- "line2": "apt #",
- "line3": "Suite #",
- "line4": "delivery instructions",
- "street_number": "25",
- "city": "San Francisco",
- "state": "CA",
- "postal_code": "94104",
- "country": "US",
- "latitude": "40.759211",
- "longitude": "-73.984638",
- "county": "Santa Clara",
- "contact_name": "Elon Musk",
- "salutation": "Mr",
- "phone_number": "111-111-1111",
- "fax": "122-111-1111",
- "email": "elon@musk.com",
- "website": "https://elonmusk.com",
- "notes": "Address notes or delivery instructions.",
- "row_version": "1-12345",
- },
- {
- "id": "123",
- "type": apideck_unify.Type.PRIMARY,
- "string": "25 Spring Street, Blackburn, VIC 3130",
- "name": "HQ US",
- "line1": "Main street",
- "line2": "apt #",
- "line3": "Suite #",
- "line4": "delivery instructions",
- "street_number": "25",
- "city": "San Francisco",
- "state": "CA",
- "postal_code": "94104",
- "country": "US",
- "latitude": "40.759211",
- "longitude": "-73.984638",
- "county": "Santa Clara",
- "contact_name": "Elon Musk",
- "salutation": "Mr",
- "phone_number": "111-111-1111",
- "fax": "122-111-1111",
- "email": "elon@musk.com",
- "website": "https://elonmusk.com",
- "notes": "Address notes or delivery instructions.",
- "row_version": "1-12345",
- },
- ],
- "phone_numbers": [
- {
- "number": "111-111-1111",
- "id": "12345",
- "country_code": "1",
- "area_code": "323",
- "extension": "105",
- "type": apideck_unify.PhoneNumberType.PRIMARY,
- },
- {
- "number": "111-111-1111",
- "id": "12345",
- "country_code": "1",
- "area_code": "323",
- "extension": "105",
- "type": apideck_unify.PhoneNumberType.PRIMARY,
- },
- ],
- "emails": [
- {
- "email": "elon@musk.com",
- "id": "123",
- "type": apideck_unify.EmailType.PRIMARY,
- },
- ],
- "websites": [
- {
- "url": "http://example.com",
- "id": "12345",
- "type": apideck_unify.WebsiteType.PRIMARY,
- },
- {
- "url": "http://example.com",
- "id": "12345",
- "type": apideck_unify.WebsiteType.PRIMARY,
- },
- {
- "url": "http://example.com",
- "id": "12345",
- "type": apideck_unify.WebsiteType.PRIMARY,
- },
- ],
- "debtor_id": "12345",
- "pass_through": [
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+
+ res = apideck.hris.companies.update(id="", legal_name="SpaceX", service_id="salesforce", display_name="SpaceX", subdomain="company", status=apideck_unify.HrisCompanyStatus.ACTIVE, company_number="123456-AB", currency=apideck_unify.Currency.USD, addresses=[
+ {
+ "id": "123",
+ "type": apideck_unify.Type.PRIMARY,
+ "string": "25 Spring Street, Blackburn, VIC 3130",
+ "name": "HQ US",
+ "line1": "Main street",
+ "line2": "apt #",
+ "line3": "Suite #",
+ "line4": "delivery instructions",
+ "street_number": "25",
+ "city": "San Francisco",
+ "state": "CA",
+ "postal_code": "94104",
+ "country": "US",
+ "latitude": "40.759211",
+ "longitude": "-73.984638",
+ "county": "Santa Clara",
+ "contact_name": "Elon Musk",
+ "salutation": "Mr",
+ "phone_number": "111-111-1111",
+ "fax": "122-111-1111",
+ "email": "elon@musk.com",
+ "website": "https://elonmusk.com",
+ "notes": "Address notes or delivery instructions.",
+ "row_version": "1-12345",
+ },
+ {
+ "id": "123",
+ "type": apideck_unify.Type.PRIMARY,
+ "string": "25 Spring Street, Blackburn, VIC 3130",
+ "name": "HQ US",
+ "line1": "Main street",
+ "line2": "apt #",
+ "line3": "Suite #",
+ "line4": "delivery instructions",
+ "street_number": "25",
+ "city": "San Francisco",
+ "state": "CA",
+ "postal_code": "94104",
+ "country": "US",
+ "latitude": "40.759211",
+ "longitude": "-73.984638",
+ "county": "Santa Clara",
+ "contact_name": "Elon Musk",
+ "salutation": "Mr",
+ "phone_number": "111-111-1111",
+ "fax": "122-111-1111",
+ "email": "elon@musk.com",
+ "website": "https://elonmusk.com",
+ "notes": "Address notes or delivery instructions.",
+ "row_version": "1-12345",
+ },
+ {
+ "id": "123",
+ "type": apideck_unify.Type.PRIMARY,
+ "string": "25 Spring Street, Blackburn, VIC 3130",
+ "name": "HQ US",
+ "line1": "Main street",
+ "line2": "apt #",
+ "line3": "Suite #",
+ "line4": "delivery instructions",
+ "street_number": "25",
+ "city": "San Francisco",
+ "state": "CA",
+ "postal_code": "94104",
+ "country": "US",
+ "latitude": "40.759211",
+ "longitude": "-73.984638",
+ "county": "Santa Clara",
+ "contact_name": "Elon Musk",
+ "salutation": "Mr",
+ "phone_number": "111-111-1111",
+ "fax": "122-111-1111",
+ "email": "elon@musk.com",
+ "website": "https://elonmusk.com",
+ "notes": "Address notes or delivery instructions.",
+ "row_version": "1-12345",
+ },
+ ], phone_numbers=[
+ {
+ "number": "111-111-1111",
+ "id": "12345",
+ "country_code": "1",
+ "area_code": "323",
+ "extension": "105",
+ "type": apideck_unify.PhoneNumberType.PRIMARY,
+ },
+ {
+ "number": "111-111-1111",
+ "id": "12345",
+ "country_code": "1",
+ "area_code": "323",
+ "extension": "105",
+ "type": apideck_unify.PhoneNumberType.PRIMARY,
+ },
+ ], emails=[
+ {
+ "email": "elon@musk.com",
+ "id": "123",
+ "type": apideck_unify.EmailType.PRIMARY,
+ },
+ ], websites=[
+ {
+ "url": "http://example.com",
+ "id": "12345",
+ "type": apideck_unify.WebsiteType.PRIMARY,
+ },
+ {
+ "url": "http://example.com",
+ "id": "12345",
+ "type": apideck_unify.WebsiteType.PRIMARY,
+ },
+ {
+ "url": "http://example.com",
+ "id": "12345",
+ "type": apideck_unify.WebsiteType.PRIMARY,
+ },
+ ], debtor_id="12345", pass_through=[
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ ],
+ },
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- ],
- }, service_id="salesforce")
+ },
+ ],
+ },
+ ])
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description | Example |
-| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
-| `hris_company` | [models.HrisCompanyInput](../../models/hriscompanyinput.md) | :heavy_check_mark: | N/A | |
-| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
-| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
+| Parameter | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
+| `legal_name` | *Nullable[str]* | :heavy_check_mark: | N/A | SpaceX |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `display_name` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | SpaceX |
+| `subdomain` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | company |
+| `status` | [Optional[models.HrisCompanyStatus]](../../models/hriscompanystatus.md) | :heavy_minus_sign: | N/A | active |
+| `company_number` | *OptionalNullable[str]* | :heavy_minus_sign: | An Company Number, Company ID or Company Code, is a unique number that has been assigned to each company. | 123456-AB |
+| `currency` | [OptionalNullable[models.Currency]](../../models/currency.md) | :heavy_minus_sign: | Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). | USD |
+| `addresses` | List[[models.Address](../../models/address.md)] | :heavy_minus_sign: | N/A | |
+| `phone_numbers` | List[[models.PhoneNumber](../../models/phonenumber.md)] | :heavy_minus_sign: | N/A | |
+| `emails` | List[[models.Email](../../models/email.md)] | :heavy_minus_sign: | N/A | |
+| `websites` | List[[models.Website](../../models/website.md)] | :heavy_minus_sign: | N/A | |
+| `debtor_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 12345 |
+| `pass_through` | List[[models.PassThroughBody](../../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -479,11 +478,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.hris.companies.delete(id="", service_id="salesforce")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
diff --git a/docs/sdks/apideckcustomers/README.md b/docs/sdks/apideckcustomers/README.md
index 729ba9e5..b3766781 100644
--- a/docs/sdks/apideckcustomers/README.md
+++ b/docs/sdks/apideckcustomers/README.md
@@ -23,30 +23,33 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.ecommerce.customers.list(request={
- "service_id": "salesforce",
- "filter_": {
- "email": "elon@musk.com",
- "phone_number": "111-111-1111",
- },
- "pass_through": {
- "search": "San Francisco",
- },
- "fields": "id,updated_at",
- })
-
- if res is not None:
- # handle response
- pass
+
+ res = apideck.ecommerce.customers.list(service_id="salesforce", filter_={
+ "email": "elon@musk.com",
+ "phone_number": "111-111-1111",
+ }, pass_through={
+ "search": "San Francisco",
+ }, fields="id,updated_at")
+
+ while res is not None:
+ # Handle items
+
+ res = res.next()
```
### Parameters
-| Parameter | Type | Required | Description |
-| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
-| `request` | [models.EcommerceCustomersAllRequest](../../models/ecommercecustomersallrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
+| Parameter | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | |
+| `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | |
+| `filter_` | [Optional[models.EcommerceCustomersFilter]](../../models/ecommercecustomersfilter.md) | :heavy_minus_sign: | Apply filters | {
"email": "elon@musk.com",
"phone_number": "111-111-1111"
} |
+| `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} |
+| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: `fields=name,email,addresses.city`
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -78,11 +81,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.ecommerce.customers.get(id="", service_id="salesforce", fields="id,updated_at")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
diff --git a/docs/sdks/apideckdepartments/README.md b/docs/sdks/apideckdepartments/README.md
index e160f809..160da66d 100644
--- a/docs/sdks/apideckdepartments/README.md
+++ b/docs/sdks/apideckdepartments/README.md
@@ -26,26 +26,29 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.hris.departments.list(request={
- "service_id": "salesforce",
- "pass_through": {
- "search": "San Francisco",
- },
- "fields": "id,updated_at",
- })
- if res is not None:
- # handle response
- pass
+ res = apideck.hris.departments.list(service_id="salesforce", pass_through={
+ "search": "San Francisco",
+ }, fields="id,updated_at")
+
+ while res is not None:
+ # Handle items
+
+ res = res.next()
```
### Parameters
-| Parameter | Type | Required | Description |
-| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
-| `request` | [models.HrisDepartmentsAllRequest](../../models/hrisdepartmentsallrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
+| Parameter | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | |
+| `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | |
+| `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} |
+| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: `fields=name,email,addresses.city`
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -77,49 +80,47 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.hris.departments.create(department={
- "name": "R&D",
- "code": "2",
- "description": "R&D",
- "pass_through": [
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+
+ res = apideck.hris.departments.create(service_id="salesforce", name="R&D", code="2", description="R&D", pass_through=[
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- ],
- }, service_id="salesforce")
+ },
+ ],
+ },
+ ])
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description | Example |
-| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| `department` | [models.DepartmentInput](../../models/departmentinput.md) | :heavy_check_mark: | N/A | |
-| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
-| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
+| Parameter | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `name` | *OptionalNullable[str]* | :heavy_minus_sign: | Department name | R&D |
+| `code` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 2 |
+| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | R&D |
+| `pass_through` | List[[models.PassThroughBody](../../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -151,11 +152,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.hris.departments.get(id="", service_id="salesforce", fields="id,updated_at")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
@@ -199,92 +200,90 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.hris.departments.update(id="", department={
- "name": "R&D",
- "code": "2",
- "description": "R&D",
- "pass_through": [
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+
+ res = apideck.hris.departments.update(id="", service_id="salesforce", name="R&D", code="2", description="R&D", pass_through=[
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ ],
+ },
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ ],
+ },
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- ],
- }, service_id="salesforce")
+ },
+ ],
+ },
+ ])
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description | Example |
-| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
-| `department` | [models.DepartmentInput](../../models/departmentinput.md) | :heavy_check_mark: | N/A | |
-| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
-| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
+| Parameter | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `name` | *OptionalNullable[str]* | :heavy_minus_sign: | Department name | R&D |
+| `code` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 2 |
+| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | R&D |
+| `pass_through` | List[[models.PassThroughBody](../../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -316,11 +315,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.hris.departments.delete(id="", service_id="salesforce")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
diff --git a/docs/sdks/apiresourcecoveragesdk/README.md b/docs/sdks/apiresourcecoveragesdk/README.md
index ba6dab7b..fe4a5bcd 100644
--- a/docs/sdks/apiresourcecoveragesdk/README.md
+++ b/docs/sdks/apiresourcecoveragesdk/README.md
@@ -22,11 +22,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.connector.api_resource_coverage.get(id="", resource_id="")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
diff --git a/docs/sdks/apiresources/README.md b/docs/sdks/apiresources/README.md
index 2f38dc8f..f7a754ee 100644
--- a/docs/sdks/apiresources/README.md
+++ b/docs/sdks/apiresources/README.md
@@ -22,11 +22,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.connector.api_resources.get(id="", resource_id="")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
diff --git a/docs/sdks/apis/README.md b/docs/sdks/apis/README.md
index a4023685..ca2aec86 100644
--- a/docs/sdks/apis/README.md
+++ b/docs/sdks/apis/README.md
@@ -24,13 +24,15 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.connector.apis.list(filter_={
"status": apideck_unify.APIStatus.BETA,
})
- if res is not None:
- # handle response
- pass
+ while res is not None:
+ # Handle items
+
+ res = res.next()
```
@@ -71,11 +73,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.connector.apis.get(id="")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
diff --git a/docs/sdks/applicants/README.md b/docs/sdks/applicants/README.md
index 4cf0d64e..8635c0d2 100644
--- a/docs/sdks/applicants/README.md
+++ b/docs/sdks/applicants/README.md
@@ -26,29 +26,32 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.ats.applicants.list(request={
- "service_id": "salesforce",
- "filter_": {
- "job_id": "1234",
- },
- "pass_through": {
- "search": "San Francisco",
- },
- "fields": "id,updated_at",
- })
- if res is not None:
- # handle response
- pass
+ res = apideck.ats.applicants.list(service_id="salesforce", filter_={
+ "job_id": "1234",
+ }, pass_through={
+ "search": "San Francisco",
+ }, fields="id,updated_at")
+
+ while res is not None:
+ # Handle items
+
+ res = res.next()
```
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
-| `request` | [models.AtsApplicantsAllRequest](../../models/atsapplicantsallrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
+| Parameter | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | |
+| `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | |
+| `filter_` | [Optional[models.ApplicantsFilter]](../../models/applicantsfilter.md) | :heavy_minus_sign: | Apply filters | {
"job_id": "1234"
} |
+| `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} |
+| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: `fields=name,email,addresses.city`
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -82,210 +85,208 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.ats.applicants.create(applicant={
- "name": "Elon Musk",
- "first_name": "Elon",
- "last_name": "Musk",
- "middle_name": "D.",
- "initials": "EM",
- "birthday": dateutil.parser.parse("2000-08-12").date(),
- "cover_letter": "I submit this application to express my sincere interest in the API developer position. In the previous role, I was responsible for leadership and ...",
- "photo_url": "https://unavatar.io/elon-musk",
- "headline": "PepsiCo, Inc, Central Perk",
- "title": "CEO",
- "emails": [
- {
- "email": "elon@musk.com",
- "id": "123",
- "type": apideck_unify.EmailType.PRIMARY,
- },
- ],
- "custom_fields": [
- {
- "id": "2389328923893298",
- "name": "employee_level",
- "description": "Employee Level",
- "value": True,
- },
- {
- "id": "2389328923893298",
- "name": "employee_level",
- "description": "Employee Level",
- "value": "Uses Salesforce and Marketo",
- },
- ],
- "phone_numbers": [
- {
- "number": "111-111-1111",
- "id": "12345",
- "country_code": "1",
- "area_code": "323",
- "extension": "105",
- "type": apideck_unify.PhoneNumberType.PRIMARY,
- },
- ],
- "addresses": [
- {
- "id": "123",
- "type": apideck_unify.Type.PRIMARY,
- "string": "25 Spring Street, Blackburn, VIC 3130",
- "name": "HQ US",
- "line1": "Main street",
- "line2": "apt #",
- "line3": "Suite #",
- "line4": "delivery instructions",
- "street_number": "25",
- "city": "San Francisco",
- "state": "CA",
- "postal_code": "94104",
- "country": "US",
- "latitude": "40.759211",
- "longitude": "-73.984638",
- "county": "Santa Clara",
- "contact_name": "Elon Musk",
- "salutation": "Mr",
- "phone_number": "111-111-1111",
- "fax": "122-111-1111",
- "email": "elon@musk.com",
- "website": "https://elonmusk.com",
- "notes": "Address notes or delivery instructions.",
- "row_version": "1-12345",
- },
- {
- "id": "123",
- "type": apideck_unify.Type.PRIMARY,
- "string": "25 Spring Street, Blackburn, VIC 3130",
- "name": "HQ US",
- "line1": "Main street",
- "line2": "apt #",
- "line3": "Suite #",
- "line4": "delivery instructions",
- "street_number": "25",
- "city": "San Francisco",
- "state": "CA",
- "postal_code": "94104",
- "country": "US",
- "latitude": "40.759211",
- "longitude": "-73.984638",
- "county": "Santa Clara",
- "contact_name": "Elon Musk",
- "salutation": "Mr",
- "phone_number": "111-111-1111",
- "fax": "122-111-1111",
- "email": "elon@musk.com",
- "website": "https://elonmusk.com",
- "notes": "Address notes or delivery instructions.",
- "row_version": "1-12345",
- },
- {
- "id": "123",
- "type": apideck_unify.Type.PRIMARY,
- "string": "25 Spring Street, Blackburn, VIC 3130",
- "name": "HQ US",
- "line1": "Main street",
- "line2": "apt #",
- "line3": "Suite #",
- "line4": "delivery instructions",
- "street_number": "25",
- "city": "San Francisco",
- "state": "CA",
- "postal_code": "94104",
- "country": "US",
- "latitude": "40.759211",
- "longitude": "-73.984638",
- "county": "Santa Clara",
- "contact_name": "Elon Musk",
- "salutation": "Mr",
- "phone_number": "111-111-1111",
- "fax": "122-111-1111",
- "email": "elon@musk.com",
- "website": "https://elonmusk.com",
- "notes": "Address notes or delivery instructions.",
- "row_version": "1-12345",
- },
- ],
- "websites": [
- {
- "url": "http://example.com",
- "id": "12345",
- "type": apideck_unify.ApplicantType.PRIMARY,
- },
- {
- "url": "http://example.com",
- "id": "12345",
- "type": apideck_unify.ApplicantType.PRIMARY,
- },
- {
- "url": "http://example.com",
- "id": "12345",
- "type": apideck_unify.ApplicantType.PRIMARY,
- },
- ],
- "social_links": [
- {
- "url": "https://www.twitter.com/apideck",
- "id": "12345",
- "type": "twitter",
- },
- ],
- "stage_id": "12345",
- "recruiter_id": "12345",
- "coordinator_id": "12345",
- "application_ids": [
- "a0d636c6-43b3-4bde-8c70-85b707d992f4",
- "a98lfd96-43b3-4bde-8c70-85b707d992e6",
- ],
- "applications": [
- "a0d636c6-43b3-4bde-8c70-85b707d992f4",
- "a98lfd96-43b3-4bde-8c70-85b707d992e6",
- ],
- "followers": [
- "a0d636c6-43b3-4bde-8c70-85b707d992f4",
- "a98lfd96-43b3-4bde-8c70-85b707d992e6",
- ],
- "sources": [
- "Job site",
- ],
- "confidential": False,
- "anonymized": True,
- "tags": [
- "New",
- ],
- "archived": False,
- "owner_id": "54321",
- "record_url": "https://app.intercom.io/contacts/12345",
- "deleted": True,
- "pass_through": [
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+
+ res = apideck.ats.applicants.create(service_id="salesforce", name="Elon Musk", first_name="Elon", last_name="Musk", middle_name="D.", initials="EM", birthday=dateutil.parser.parse("2000-08-12").date(), cover_letter="I submit this application to express my sincere interest in the API developer position. In the previous role, I was responsible for leadership and ...", photo_url="https://unavatar.io/elon-musk", headline="PepsiCo, Inc, Central Perk", title="CEO", emails=[
+ {
+ "email": "elon@musk.com",
+ "id": "123",
+ "type": apideck_unify.EmailType.PRIMARY,
+ },
+ ], custom_fields=[
+ {
+ "id": "2389328923893298",
+ "name": "employee_level",
+ "description": "Employee Level",
+ "value": True,
+ },
+ {
+ "id": "2389328923893298",
+ "name": "employee_level",
+ "description": "Employee Level",
+ "value": "Uses Salesforce and Marketo",
+ },
+ ], phone_numbers=[
+ {
+ "number": "111-111-1111",
+ "id": "12345",
+ "country_code": "1",
+ "area_code": "323",
+ "extension": "105",
+ "type": apideck_unify.PhoneNumberType.PRIMARY,
+ },
+ ], addresses=[
+ {
+ "id": "123",
+ "type": apideck_unify.Type.PRIMARY,
+ "string": "25 Spring Street, Blackburn, VIC 3130",
+ "name": "HQ US",
+ "line1": "Main street",
+ "line2": "apt #",
+ "line3": "Suite #",
+ "line4": "delivery instructions",
+ "street_number": "25",
+ "city": "San Francisco",
+ "state": "CA",
+ "postal_code": "94104",
+ "country": "US",
+ "latitude": "40.759211",
+ "longitude": "-73.984638",
+ "county": "Santa Clara",
+ "contact_name": "Elon Musk",
+ "salutation": "Mr",
+ "phone_number": "111-111-1111",
+ "fax": "122-111-1111",
+ "email": "elon@musk.com",
+ "website": "https://elonmusk.com",
+ "notes": "Address notes or delivery instructions.",
+ "row_version": "1-12345",
+ },
+ {
+ "id": "123",
+ "type": apideck_unify.Type.PRIMARY,
+ "string": "25 Spring Street, Blackburn, VIC 3130",
+ "name": "HQ US",
+ "line1": "Main street",
+ "line2": "apt #",
+ "line3": "Suite #",
+ "line4": "delivery instructions",
+ "street_number": "25",
+ "city": "San Francisco",
+ "state": "CA",
+ "postal_code": "94104",
+ "country": "US",
+ "latitude": "40.759211",
+ "longitude": "-73.984638",
+ "county": "Santa Clara",
+ "contact_name": "Elon Musk",
+ "salutation": "Mr",
+ "phone_number": "111-111-1111",
+ "fax": "122-111-1111",
+ "email": "elon@musk.com",
+ "website": "https://elonmusk.com",
+ "notes": "Address notes or delivery instructions.",
+ "row_version": "1-12345",
+ },
+ {
+ "id": "123",
+ "type": apideck_unify.Type.PRIMARY,
+ "string": "25 Spring Street, Blackburn, VIC 3130",
+ "name": "HQ US",
+ "line1": "Main street",
+ "line2": "apt #",
+ "line3": "Suite #",
+ "line4": "delivery instructions",
+ "street_number": "25",
+ "city": "San Francisco",
+ "state": "CA",
+ "postal_code": "94104",
+ "country": "US",
+ "latitude": "40.759211",
+ "longitude": "-73.984638",
+ "county": "Santa Clara",
+ "contact_name": "Elon Musk",
+ "salutation": "Mr",
+ "phone_number": "111-111-1111",
+ "fax": "122-111-1111",
+ "email": "elon@musk.com",
+ "website": "https://elonmusk.com",
+ "notes": "Address notes or delivery instructions.",
+ "row_version": "1-12345",
+ },
+ ], websites=[
+ {
+ "url": "http://example.com",
+ "id": "12345",
+ "type": apideck_unify.ApplicantType.PRIMARY,
+ },
+ {
+ "url": "http://example.com",
+ "id": "12345",
+ "type": apideck_unify.ApplicantType.PRIMARY,
+ },
+ {
+ "url": "http://example.com",
+ "id": "12345",
+ "type": apideck_unify.ApplicantType.PRIMARY,
+ },
+ ], social_links=[
+ {
+ "url": "https://www.twitter.com/apideck",
+ "id": "12345",
+ "type": "twitter",
+ },
+ ], stage_id="12345", recruiter_id="12345", coordinator_id="12345", application_ids=[
+ "a0d636c6-43b3-4bde-8c70-85b707d992f4",
+ "a98lfd96-43b3-4bde-8c70-85b707d992e6",
+ ], applications=[
+ "a0d636c6-43b3-4bde-8c70-85b707d992f4",
+ "a98lfd96-43b3-4bde-8c70-85b707d992e6",
+ ], followers=[
+ "a0d636c6-43b3-4bde-8c70-85b707d992f4",
+ "a98lfd96-43b3-4bde-8c70-85b707d992e6",
+ ], sources=[
+ "Job site",
+ ], confidential=False, anonymized=True, tags=[
+ "New",
+ ], archived=False, owner_id="54321", record_url="https://app.intercom.io/contacts/12345", deleted=True, pass_through=[
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- ],
- }, service_id="salesforce")
+ },
+ ],
+ },
+ ])
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description | Example |
-| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| `applicant` | [models.ApplicantInput](../../models/applicantinput.md) | :heavy_check_mark: | N/A | |
-| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
-| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
+| Parameter | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `name` | *Optional[str]* | :heavy_minus_sign: | The name of an applicant. | Elon Musk |
+| `first_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The first name of the person. | Elon |
+| `last_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The last name of the person. | Musk |
+| `middle_name` | *OptionalNullable[str]* | :heavy_minus_sign: | Middle name of the person. | D. |
+| `initials` | *OptionalNullable[str]* | :heavy_minus_sign: | The initials of the person, usually derived from their first, middle, and last names. | EM |
+| `birthday` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The date of birth of the person. | 2000-08-12 |
+| `cover_letter` | *Optional[str]* | :heavy_minus_sign: | N/A | I submit this application to express my sincere interest in the API developer position. In the previous role, I was responsible for leadership and ... |
+| `photo_url` | *OptionalNullable[str]* | :heavy_minus_sign: | The URL of the photo of a person. | https://unavatar.io/elon-musk |
+| `headline` | *Optional[str]* | :heavy_minus_sign: | Typically a list of previous companies where the contact has worked or schools that the contact has attended | PepsiCo, Inc, Central Perk |
+| `title` | *OptionalNullable[str]* | :heavy_minus_sign: | The job title of the person. | CEO |
+| `emails` | List[[models.Email](../../models/email.md)] | :heavy_minus_sign: | N/A | |
+| `custom_fields` | List[[models.CustomField](../../models/customfield.md)] | :heavy_minus_sign: | N/A | |
+| `phone_numbers` | List[[models.PhoneNumber](../../models/phonenumber.md)] | :heavy_minus_sign: | N/A | |
+| `addresses` | List[[models.Address](../../models/address.md)] | :heavy_minus_sign: | N/A | |
+| `websites` | List[[models.Websites](../../models/websites.md)] | :heavy_minus_sign: | N/A | |
+| `social_links` | List[[models.SocialLinks](../../models/sociallinks.md)] | :heavy_minus_sign: | N/A | |
+| `stage_id` | *Optional[str]* | :heavy_minus_sign: | N/A | 12345 |
+| `recruiter_id` | *Optional[str]* | :heavy_minus_sign: | N/A | 12345 |
+| `coordinator_id` | *Optional[str]* | :heavy_minus_sign: | N/A | 12345 |
+| `application_ids` | List[*str*] | :heavy_minus_sign: | N/A | [
"a0d636c6-43b3-4bde-8c70-85b707d992f4",
"a98lfd96-43b3-4bde-8c70-85b707d992e6"
] |
+| `applications` | List[*str*] | :heavy_minus_sign: | N/A | [
"a0d636c6-43b3-4bde-8c70-85b707d992f4",
"a98lfd96-43b3-4bde-8c70-85b707d992e6"
] |
+| `followers` | List[*str*] | :heavy_minus_sign: | N/A | [
"a0d636c6-43b3-4bde-8c70-85b707d992f4",
"a98lfd96-43b3-4bde-8c70-85b707d992e6"
] |
+| `sources` | List[*str*] | :heavy_minus_sign: | N/A | [
"Job site"
] |
+| `confidential` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
+| `anonymized` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
+| `tags` | List[*str*] | :heavy_minus_sign: | N/A | [
"New"
] |
+| `archived` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | false |
+| `owner_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 54321 |
+| `record_url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | https://app.intercom.io/contacts/12345 |
+| `deleted` | *OptionalNullable[bool]* | :heavy_minus_sign: | Flag to indicate if the object is deleted. | true |
+| `pass_through` | List[[models.PassThroughBody](../../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -317,11 +318,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.ats.applicants.get(id="", service_id="salesforce", fields="id,updated_at")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
@@ -367,220 +368,218 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.ats.applicants.update(id="", applicant={
- "name": "Elon Musk",
- "first_name": "Elon",
- "last_name": "Musk",
- "middle_name": "D.",
- "initials": "EM",
- "birthday": dateutil.parser.parse("2000-08-12").date(),
- "cover_letter": "I submit this application to express my sincere interest in the API developer position. In the previous role, I was responsible for leadership and ...",
- "photo_url": "https://unavatar.io/elon-musk",
- "headline": "PepsiCo, Inc, Central Perk",
- "title": "CEO",
- "emails": [
- {
- "email": "elon@musk.com",
- "id": "123",
- "type": apideck_unify.EmailType.PRIMARY,
- },
- {
- "email": "elon@musk.com",
- "id": "123",
- "type": apideck_unify.EmailType.PRIMARY,
- },
- {
- "email": "elon@musk.com",
- "id": "123",
- "type": apideck_unify.EmailType.PRIMARY,
- },
- ],
- "custom_fields": [
- {
- "id": "2389328923893298",
- "name": "employee_level",
- "description": "Employee Level",
- "value": True,
- },
- {
- "id": "2389328923893298",
- "name": "employee_level",
- "description": "Employee Level",
- },
- ],
- "phone_numbers": [
- {
- "number": "111-111-1111",
- "id": "12345",
- "country_code": "1",
- "area_code": "323",
- "extension": "105",
- "type": apideck_unify.PhoneNumberType.PRIMARY,
- },
- ],
- "addresses": [
- {
- "id": "123",
- "type": apideck_unify.Type.PRIMARY,
- "string": "25 Spring Street, Blackburn, VIC 3130",
- "name": "HQ US",
- "line1": "Main street",
- "line2": "apt #",
- "line3": "Suite #",
- "line4": "delivery instructions",
- "street_number": "25",
- "city": "San Francisco",
- "state": "CA",
- "postal_code": "94104",
- "country": "US",
- "latitude": "40.759211",
- "longitude": "-73.984638",
- "county": "Santa Clara",
- "contact_name": "Elon Musk",
- "salutation": "Mr",
- "phone_number": "111-111-1111",
- "fax": "122-111-1111",
- "email": "elon@musk.com",
- "website": "https://elonmusk.com",
- "notes": "Address notes or delivery instructions.",
- "row_version": "1-12345",
- },
- {
- "id": "123",
- "type": apideck_unify.Type.PRIMARY,
- "string": "25 Spring Street, Blackburn, VIC 3130",
- "name": "HQ US",
- "line1": "Main street",
- "line2": "apt #",
- "line3": "Suite #",
- "line4": "delivery instructions",
- "street_number": "25",
- "city": "San Francisco",
- "state": "CA",
- "postal_code": "94104",
- "country": "US",
- "latitude": "40.759211",
- "longitude": "-73.984638",
- "county": "Santa Clara",
- "contact_name": "Elon Musk",
- "salutation": "Mr",
- "phone_number": "111-111-1111",
- "fax": "122-111-1111",
- "email": "elon@musk.com",
- "website": "https://elonmusk.com",
- "notes": "Address notes or delivery instructions.",
- "row_version": "1-12345",
- },
- {
- "id": "123",
- "type": apideck_unify.Type.PRIMARY,
- "string": "25 Spring Street, Blackburn, VIC 3130",
- "name": "HQ US",
- "line1": "Main street",
- "line2": "apt #",
- "line3": "Suite #",
- "line4": "delivery instructions",
- "street_number": "25",
- "city": "San Francisco",
- "state": "CA",
- "postal_code": "94104",
- "country": "US",
- "latitude": "40.759211",
- "longitude": "-73.984638",
- "county": "Santa Clara",
- "contact_name": "Elon Musk",
- "salutation": "Mr",
- "phone_number": "111-111-1111",
- "fax": "122-111-1111",
- "email": "elon@musk.com",
- "website": "https://elonmusk.com",
- "notes": "Address notes or delivery instructions.",
- "row_version": "1-12345",
- },
- ],
- "websites": [
- {
- "url": "http://example.com",
- "id": "12345",
- "type": apideck_unify.ApplicantType.PRIMARY,
- },
- ],
- "social_links": [
- {
- "url": "https://www.twitter.com/apideck",
- "id": "12345",
- "type": "twitter",
- },
- {
- "url": "https://www.twitter.com/apideck",
- "id": "12345",
- "type": "twitter",
- },
- {
- "url": "https://www.twitter.com/apideck",
- "id": "12345",
- "type": "twitter",
- },
- ],
- "stage_id": "12345",
- "recruiter_id": "12345",
- "coordinator_id": "12345",
- "application_ids": [
- "a0d636c6-43b3-4bde-8c70-85b707d992f4",
- "a98lfd96-43b3-4bde-8c70-85b707d992e6",
- ],
- "applications": [
- "a0d636c6-43b3-4bde-8c70-85b707d992f4",
- "a98lfd96-43b3-4bde-8c70-85b707d992e6",
- ],
- "followers": [
- "a0d636c6-43b3-4bde-8c70-85b707d992f4",
- "a98lfd96-43b3-4bde-8c70-85b707d992e6",
- ],
- "sources": [
- "Job site",
- ],
- "confidential": False,
- "anonymized": True,
- "tags": [
- "New",
- ],
- "archived": False,
- "owner_id": "54321",
- "record_url": "https://app.intercom.io/contacts/12345",
- "deleted": True,
- "pass_through": [
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+
+ res = apideck.ats.applicants.update(id="", service_id="salesforce", name="Elon Musk", first_name="Elon", last_name="Musk", middle_name="D.", initials="EM", birthday=dateutil.parser.parse("2000-08-12").date(), cover_letter="I submit this application to express my sincere interest in the API developer position. In the previous role, I was responsible for leadership and ...", photo_url="https://unavatar.io/elon-musk", headline="PepsiCo, Inc, Central Perk", title="CEO", emails=[
+ {
+ "email": "elon@musk.com",
+ "id": "123",
+ "type": apideck_unify.EmailType.PRIMARY,
+ },
+ {
+ "email": "elon@musk.com",
+ "id": "123",
+ "type": apideck_unify.EmailType.PRIMARY,
+ },
+ {
+ "email": "elon@musk.com",
+ "id": "123",
+ "type": apideck_unify.EmailType.PRIMARY,
+ },
+ ], custom_fields=[
+ {
+ "id": "2389328923893298",
+ "name": "employee_level",
+ "description": "Employee Level",
+ "value": True,
+ },
+ {
+ "id": "2389328923893298",
+ "name": "employee_level",
+ "description": "Employee Level",
+ },
+ ], phone_numbers=[
+ {
+ "number": "111-111-1111",
+ "id": "12345",
+ "country_code": "1",
+ "area_code": "323",
+ "extension": "105",
+ "type": apideck_unify.PhoneNumberType.PRIMARY,
+ },
+ ], addresses=[
+ {
+ "id": "123",
+ "type": apideck_unify.Type.PRIMARY,
+ "string": "25 Spring Street, Blackburn, VIC 3130",
+ "name": "HQ US",
+ "line1": "Main street",
+ "line2": "apt #",
+ "line3": "Suite #",
+ "line4": "delivery instructions",
+ "street_number": "25",
+ "city": "San Francisco",
+ "state": "CA",
+ "postal_code": "94104",
+ "country": "US",
+ "latitude": "40.759211",
+ "longitude": "-73.984638",
+ "county": "Santa Clara",
+ "contact_name": "Elon Musk",
+ "salutation": "Mr",
+ "phone_number": "111-111-1111",
+ "fax": "122-111-1111",
+ "email": "elon@musk.com",
+ "website": "https://elonmusk.com",
+ "notes": "Address notes or delivery instructions.",
+ "row_version": "1-12345",
+ },
+ {
+ "id": "123",
+ "type": apideck_unify.Type.PRIMARY,
+ "string": "25 Spring Street, Blackburn, VIC 3130",
+ "name": "HQ US",
+ "line1": "Main street",
+ "line2": "apt #",
+ "line3": "Suite #",
+ "line4": "delivery instructions",
+ "street_number": "25",
+ "city": "San Francisco",
+ "state": "CA",
+ "postal_code": "94104",
+ "country": "US",
+ "latitude": "40.759211",
+ "longitude": "-73.984638",
+ "county": "Santa Clara",
+ "contact_name": "Elon Musk",
+ "salutation": "Mr",
+ "phone_number": "111-111-1111",
+ "fax": "122-111-1111",
+ "email": "elon@musk.com",
+ "website": "https://elonmusk.com",
+ "notes": "Address notes or delivery instructions.",
+ "row_version": "1-12345",
+ },
+ {
+ "id": "123",
+ "type": apideck_unify.Type.PRIMARY,
+ "string": "25 Spring Street, Blackburn, VIC 3130",
+ "name": "HQ US",
+ "line1": "Main street",
+ "line2": "apt #",
+ "line3": "Suite #",
+ "line4": "delivery instructions",
+ "street_number": "25",
+ "city": "San Francisco",
+ "state": "CA",
+ "postal_code": "94104",
+ "country": "US",
+ "latitude": "40.759211",
+ "longitude": "-73.984638",
+ "county": "Santa Clara",
+ "contact_name": "Elon Musk",
+ "salutation": "Mr",
+ "phone_number": "111-111-1111",
+ "fax": "122-111-1111",
+ "email": "elon@musk.com",
+ "website": "https://elonmusk.com",
+ "notes": "Address notes or delivery instructions.",
+ "row_version": "1-12345",
+ },
+ ], websites=[
+ {
+ "url": "http://example.com",
+ "id": "12345",
+ "type": apideck_unify.ApplicantType.PRIMARY,
+ },
+ ], social_links=[
+ {
+ "url": "https://www.twitter.com/apideck",
+ "id": "12345",
+ "type": "twitter",
+ },
+ {
+ "url": "https://www.twitter.com/apideck",
+ "id": "12345",
+ "type": "twitter",
+ },
+ {
+ "url": "https://www.twitter.com/apideck",
+ "id": "12345",
+ "type": "twitter",
+ },
+ ], stage_id="12345", recruiter_id="12345", coordinator_id="12345", application_ids=[
+ "a0d636c6-43b3-4bde-8c70-85b707d992f4",
+ "a98lfd96-43b3-4bde-8c70-85b707d992e6",
+ ], applications=[
+ "a0d636c6-43b3-4bde-8c70-85b707d992f4",
+ "a98lfd96-43b3-4bde-8c70-85b707d992e6",
+ ], followers=[
+ "a0d636c6-43b3-4bde-8c70-85b707d992f4",
+ "a98lfd96-43b3-4bde-8c70-85b707d992e6",
+ ], sources=[
+ "Job site",
+ ], confidential=False, anonymized=True, tags=[
+ "New",
+ ], archived=False, owner_id="54321", record_url="https://app.intercom.io/contacts/12345", deleted=True, pass_through=[
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- ],
- }, service_id="salesforce")
+ },
+ ],
+ },
+ ])
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description | Example |
-| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
-| `applicant` | [models.ApplicantInput](../../models/applicantinput.md) | :heavy_check_mark: | N/A | |
-| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
-| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
+| Parameter | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `name` | *Optional[str]* | :heavy_minus_sign: | The name of an applicant. | Elon Musk |
+| `first_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The first name of the person. | Elon |
+| `last_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The last name of the person. | Musk |
+| `middle_name` | *OptionalNullable[str]* | :heavy_minus_sign: | Middle name of the person. | D. |
+| `initials` | *OptionalNullable[str]* | :heavy_minus_sign: | The initials of the person, usually derived from their first, middle, and last names. | EM |
+| `birthday` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The date of birth of the person. | 2000-08-12 |
+| `cover_letter` | *Optional[str]* | :heavy_minus_sign: | N/A | I submit this application to express my sincere interest in the API developer position. In the previous role, I was responsible for leadership and ... |
+| `photo_url` | *OptionalNullable[str]* | :heavy_minus_sign: | The URL of the photo of a person. | https://unavatar.io/elon-musk |
+| `headline` | *Optional[str]* | :heavy_minus_sign: | Typically a list of previous companies where the contact has worked or schools that the contact has attended | PepsiCo, Inc, Central Perk |
+| `title` | *OptionalNullable[str]* | :heavy_minus_sign: | The job title of the person. | CEO |
+| `emails` | List[[models.Email](../../models/email.md)] | :heavy_minus_sign: | N/A | |
+| `custom_fields` | List[[models.CustomField](../../models/customfield.md)] | :heavy_minus_sign: | N/A | |
+| `phone_numbers` | List[[models.PhoneNumber](../../models/phonenumber.md)] | :heavy_minus_sign: | N/A | |
+| `addresses` | List[[models.Address](../../models/address.md)] | :heavy_minus_sign: | N/A | |
+| `websites` | List[[models.Websites](../../models/websites.md)] | :heavy_minus_sign: | N/A | |
+| `social_links` | List[[models.SocialLinks](../../models/sociallinks.md)] | :heavy_minus_sign: | N/A | |
+| `stage_id` | *Optional[str]* | :heavy_minus_sign: | N/A | 12345 |
+| `recruiter_id` | *Optional[str]* | :heavy_minus_sign: | N/A | 12345 |
+| `coordinator_id` | *Optional[str]* | :heavy_minus_sign: | N/A | 12345 |
+| `application_ids` | List[*str*] | :heavy_minus_sign: | N/A | [
"a0d636c6-43b3-4bde-8c70-85b707d992f4",
"a98lfd96-43b3-4bde-8c70-85b707d992e6"
] |
+| `applications` | List[*str*] | :heavy_minus_sign: | N/A | [
"a0d636c6-43b3-4bde-8c70-85b707d992f4",
"a98lfd96-43b3-4bde-8c70-85b707d992e6"
] |
+| `followers` | List[*str*] | :heavy_minus_sign: | N/A | [
"a0d636c6-43b3-4bde-8c70-85b707d992f4",
"a98lfd96-43b3-4bde-8c70-85b707d992e6"
] |
+| `sources` | List[*str*] | :heavy_minus_sign: | N/A | [
"Job site"
] |
+| `confidential` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
+| `anonymized` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
+| `tags` | List[*str*] | :heavy_minus_sign: | N/A | [
"New"
] |
+| `archived` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | false |
+| `owner_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 54321 |
+| `record_url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | https://app.intercom.io/contacts/12345 |
+| `deleted` | *OptionalNullable[bool]* | :heavy_minus_sign: | Flag to indicate if the object is deleted. | true |
+| `pass_through` | List[[models.PassThroughBody](../../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -612,11 +611,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.ats.applicants.delete(id="", service_id="salesforce")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
diff --git a/docs/sdks/applications/README.md b/docs/sdks/applications/README.md
index 992a2bb4..35540f38 100644
--- a/docs/sdks/applications/README.md
+++ b/docs/sdks/applications/README.md
@@ -26,25 +26,28 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.ats.applications.list(request={
- "service_id": "salesforce",
- "pass_through": {
- "search": "San Francisco",
- },
+
+ res = apideck.ats.applications.list(service_id="salesforce", pass_through={
+ "search": "San Francisco",
})
- if res is not None:
- # handle response
- pass
+ while res is not None:
+ # Handle items
+
+ res = res.next()
```
### Parameters
-| Parameter | Type | Required | Description |
-| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
-| `request` | [models.AtsApplicationsAllRequest](../../models/atsapplicationsallrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
+| Parameter | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | |
+| `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} |
+| `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -77,53 +80,51 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.ats.applications.create(application={
- "applicant_id": "12345",
- "job_id": "12345",
- "status": apideck_unify.ApplicationStatus.OPEN,
- "stage": {
- "id": "12345",
- "name": "12345",
- },
- "pass_through": [
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+
+ res = apideck.ats.applications.create(applicant_id="12345", job_id="12345", service_id="salesforce", status=apideck_unify.ApplicationStatus.OPEN, stage={
+ "id": "12345",
+ "name": "12345",
+ }, pass_through=[
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- ],
- }, service_id="salesforce")
+ },
+ ],
+ },
+ ])
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description | Example |
-| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| `application` | [models.ApplicationInput](../../models/applicationinput.md) | :heavy_check_mark: | N/A | |
-| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
-| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
+| Parameter | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `applicant_id` | *Nullable[str]* | :heavy_check_mark: | N/A | 12345 |
+| `job_id` | *Nullable[str]* | :heavy_check_mark: | N/A | 12345 |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `status` | [OptionalNullable[models.ApplicationStatus]](../../models/applicationstatus.md) | :heavy_minus_sign: | N/A | open |
+| `stage` | [Optional[models.Stage]](../../models/stage.md) | :heavy_minus_sign: | N/A | |
+| `pass_through` | List[[models.PassThroughBody](../../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -155,11 +156,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.ats.applications.get(id="", service_id="salesforce")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
@@ -203,96 +204,94 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.ats.applications.update(id="", application={
- "applicant_id": "12345",
- "job_id": "12345",
- "status": apideck_unify.ApplicationStatus.OPEN,
- "stage": {
- "id": "12345",
- "name": "12345",
- },
- "pass_through": [
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+
+ res = apideck.ats.applications.update(id="", applicant_id="12345", job_id="12345", service_id="salesforce", status=apideck_unify.ApplicationStatus.OPEN, stage={
+ "id": "12345",
+ "name": "12345",
+ }, pass_through=[
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ ],
+ },
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ ],
+ },
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- ],
- }, service_id="salesforce")
+ },
+ ],
+ },
+ ])
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description | Example |
-| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
-| `application` | [models.ApplicationInput](../../models/applicationinput.md) | :heavy_check_mark: | N/A | |
-| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
-| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
+| Parameter | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
+| `applicant_id` | *Nullable[str]* | :heavy_check_mark: | N/A | 12345 |
+| `job_id` | *Nullable[str]* | :heavy_check_mark: | N/A | 12345 |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `status` | [OptionalNullable[models.ApplicationStatus]](../../models/applicationstatus.md) | :heavy_minus_sign: | N/A | open |
+| `stage` | [Optional[models.Stage]](../../models/stage.md) | :heavy_minus_sign: | N/A | |
+| `pass_through` | List[[models.PassThroughBody](../../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -324,11 +323,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.ats.applications.delete(id="", service_id="salesforce")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
diff --git a/docs/sdks/attachments/README.md b/docs/sdks/attachments/README.md
index 1ec902e3..995e5d2e 100644
--- a/docs/sdks/attachments/README.md
+++ b/docs/sdks/attachments/README.md
@@ -26,25 +26,28 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.accounting.attachments.list(request={
- "reference_type": apideck_unify.AttachmentReferenceType.INVOICE,
- "reference_id": "123456",
- "service_id": "salesforce",
- "fields": "id,updated_at",
- })
- if res is not None:
- # handle response
- pass
+ res = apideck.accounting.attachments.list(reference_type=apideck_unify.AttachmentReferenceType.INVOICE, reference_id="123456", service_id="salesforce", fields="id,updated_at")
+
+ while res is not None:
+ # Handle items
+
+ res = res.next()
```
### Parameters
-| Parameter | Type | Required | Description |
-| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
-| `request` | [models.AccountingAttachmentsAllRequest](../../models/accountingattachmentsallrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
+| Parameter | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `reference_type` | [models.AttachmentReferenceType](../../models/attachmentreferencetype.md) | :heavy_check_mark: | The reference type of the document. | invoice |
+| `reference_id` | *str* | :heavy_check_mark: | The reference id of the object to retrieve. | 12345 |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | |
+| `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | |
+| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: `fields=name,email,addresses.city`
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -77,26 +80,25 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.accounting.attachments.get(request={
- "reference_type": apideck_unify.AttachmentReferenceType.INVOICE,
- "reference_id": "123456",
- "id": "",
- "service_id": "salesforce",
- "fields": "id,updated_at",
- })
-
- if res is not None:
- # handle response
- pass
+
+ res = apideck.accounting.attachments.get(reference_type=apideck_unify.AttachmentReferenceType.INVOICE, reference_id="123456", id="", service_id="salesforce", fields="id,updated_at")
+
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description |
-| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
-| `request` | [models.AccountingAttachmentsOneRequest](../../models/accountingattachmentsonerequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
+| Parameter | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `reference_type` | [models.AttachmentReferenceType](../../models/attachmentreferencetype.md) | :heavy_check_mark: | The reference type of the document. | invoice |
+| `reference_id` | *str* | :heavy_check_mark: | The reference id of the object to retrieve. | 12345 |
+| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: `fields=name,email,addresses.city`
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -129,25 +131,24 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.accounting.attachments.delete(request={
- "reference_type": apideck_unify.AttachmentReferenceType.INVOICE,
- "reference_id": "123456",
- "id": "",
- "service_id": "salesforce",
- })
- if res is not None:
- # handle response
- pass
+ res = apideck.accounting.attachments.delete(reference_type=apideck_unify.AttachmentReferenceType.INVOICE, reference_id="123456", id="", service_id="salesforce")
+
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description |
-| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
-| `request` | [models.AccountingAttachmentsDeleteRequest](../../models/accountingattachmentsdeleterequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
+| Parameter | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
+| `reference_type` | [models.AttachmentReferenceType](../../models/attachmentreferencetype.md) | :heavy_check_mark: | The reference type of the document. | invoice |
+| `reference_id` | *str* | :heavy_check_mark: | The reference id of the object to retrieve. | 12345 |
+| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -180,26 +181,24 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.accounting.attachments.download(request={
- "reference_type": apideck_unify.AttachmentReferenceType.INVOICE,
- "reference_id": "123456",
- "id": "",
- "service_id": "salesforce",
- "fields": "id,updated_at",
- })
-
- if res is not None:
- # handle response
- pass
+
+ res = apideck.accounting.attachments.download(reference_type=apideck_unify.AttachmentReferenceType.INVOICE, reference_id="123456", id="", service_id="salesforce", fields="id,updated_at")
+
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description |
-| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
-| `request` | [models.AccountingAttachmentsDownloadRequest](../../models/accountingattachmentsdownloadrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
+| Parameter | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `reference_type` | [models.AttachmentReferenceType](../../models/attachmentreferencetype.md) | :heavy_check_mark: | The reference type of the document. | invoice |
+| `reference_id` | *str* | :heavy_check_mark: | The reference id of the object to retrieve. | 12345 |
+| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: `fields=name,email,addresses.city`
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
diff --git a/docs/sdks/balancesheetsdk/README.md b/docs/sdks/balancesheetsdk/README.md
index b2d6bd53..ca8b0bf0 100644
--- a/docs/sdks/balancesheetsdk/README.md
+++ b/docs/sdks/balancesheetsdk/README.md
@@ -23,6 +23,7 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.accounting.balance_sheet.get(service_id="salesforce", pass_through={
"search": "San Francisco",
}, filter_={
@@ -32,9 +33,8 @@ with Apideck(
"period_type": apideck_unify.PeriodType.MONTH,
})
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
diff --git a/docs/sdks/billpayments/README.md b/docs/sdks/billpayments/README.md
index f7cbe8f5..8a87d360 100644
--- a/docs/sdks/billpayments/README.md
+++ b/docs/sdks/billpayments/README.md
@@ -28,33 +28,36 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.accounting.bill_payments.list(request={
- "service_id": "salesforce",
- "filter_": {
- "updated_since": dateutil.parser.isoparse("2020-09-30T07:43:32.000Z"),
- },
- "sort": {
- "by": apideck_unify.PaymentsSortBy.UPDATED_AT,
- "direction": apideck_unify.SortDirection.DESC,
- },
- "pass_through": {
- "search": "San Francisco",
- },
- "fields": "id,updated_at",
- })
- if res is not None:
- # handle response
- pass
+ res = apideck.accounting.bill_payments.list(service_id="salesforce", filter_={
+ "updated_since": dateutil.parser.isoparse("2020-09-30T07:43:32.000Z"),
+ }, sort={
+ "by": apideck_unify.PaymentsSortBy.UPDATED_AT,
+ "direction": apideck_unify.SortDirection.DESC,
+ }, pass_through={
+ "search": "San Francisco",
+ }, fields="id,updated_at")
+
+ while res is not None:
+ # Handle items
+
+ res = res.next()
```
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
-| `request` | [models.AccountingBillPaymentsAllRequest](../../models/accountingbillpaymentsallrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
+| Parameter | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | |
+| `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | |
+| `filter_` | [Optional[models.PaymentsFilter]](../../models/paymentsfilter.md) | :heavy_minus_sign: | Apply filters | {
"updated_since": "2020-09-30T07:43:32.000Z"
} |
+| `sort` | [Optional[models.PaymentsSort]](../../models/paymentssort.md) | :heavy_minus_sign: | Apply sorting | {
"by": "updated_at",
"direction": "desc"
} |
+| `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} |
+| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: `fields=name,email,addresses.city`
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -88,115 +91,113 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.accounting.bill_payments.create(bill_payment={
- "total_amount": 49.99,
- "transaction_date": dateutil.parser.isoparse("2021-05-01T12:00:00.000Z"),
- "currency": apideck_unify.Currency.USD,
- "currency_rate": 0.69,
- "reference": "123456",
- "payment_method": "cash",
- "payment_method_reference": "123456",
- "payment_method_id": "12345",
- "account": {
- "id": "123456",
- "nominal_code": "N091",
- "code": "453",
+
+ res = apideck.accounting.bill_payments.create(total_amount=49.99, transaction_date=dateutil.parser.isoparse("2021-05-01T12:00:00.000Z"), service_id="salesforce", currency=apideck_unify.Currency.USD, currency_rate=0.69, reference="123456", payment_method="cash", payment_method_reference="123456", payment_method_id="12345", account={
+ "id": "123456",
+ "nominal_code": "N091",
+ "code": "453",
+ }, supplier={
+ "id": "12345",
+ "display_name": "Windsurf Shop",
+ "address": {
+ "id": "123",
+ "type": apideck_unify.Type.PRIMARY,
+ "string": "25 Spring Street, Blackburn, VIC 3130",
+ "name": "HQ US",
+ "line1": "Main street",
+ "line2": "apt #",
+ "line3": "Suite #",
+ "line4": "delivery instructions",
+ "street_number": "25",
+ "city": "San Francisco",
+ "state": "CA",
+ "postal_code": "94104",
+ "country": "US",
+ "latitude": "40.759211",
+ "longitude": "-73.984638",
+ "county": "Santa Clara",
+ "contact_name": "Elon Musk",
+ "salutation": "Mr",
+ "phone_number": "111-111-1111",
+ "fax": "122-111-1111",
+ "email": "elon@musk.com",
+ "website": "https://elonmusk.com",
+ "notes": "Address notes or delivery instructions.",
+ "row_version": "1-12345",
},
- "supplier": {
+ }, company_id="12345", reconciled=True, status=apideck_unify.PaymentStatus.AUTHORISED, type_=apideck_unify.BillPaymentType.ACCOUNTS_PAYABLE, allocations=[
+ {
"id": "12345",
- "display_name": "Windsurf Shop",
- "address": {
- "id": "123",
- "type": apideck_unify.Type.PRIMARY,
- "string": "25 Spring Street, Blackburn, VIC 3130",
- "name": "HQ US",
- "line1": "Main street",
- "line2": "apt #",
- "line3": "Suite #",
- "line4": "delivery instructions",
- "street_number": "25",
- "city": "San Francisco",
- "state": "CA",
- "postal_code": "94104",
- "country": "US",
- "latitude": "40.759211",
- "longitude": "-73.984638",
- "county": "Santa Clara",
- "contact_name": "Elon Musk",
- "salutation": "Mr",
- "phone_number": "111-111-1111",
- "fax": "122-111-1111",
- "email": "elon@musk.com",
- "website": "https://elonmusk.com",
- "notes": "Address notes or delivery instructions.",
- "row_version": "1-12345",
- },
+ "type": apideck_unify.BillPaymentAllocationType.BILL,
+ "amount": 49.99,
+ "allocation_id": "123456",
+ },
+ ], note="Some notes about this transaction", number="123456", tracking_categories=[
+ {
+ "id": "123456",
+ "name": "New York",
+ },
+ {
+ "id": "123456",
+ "name": "New York",
},
- "company_id": "12345",
- "reconciled": True,
- "status": apideck_unify.PaymentStatus.AUTHORISED,
- "type": apideck_unify.BillPaymentType.ACCOUNTS_PAYABLE,
- "allocations": [
- {
- "id": "12345",
- "type": apideck_unify.BillPaymentAllocationType.BILL,
- "amount": 49.99,
- "allocation_id": "123456",
- },
- ],
- "note": "Some notes about this transaction",
- "number": "123456",
- "tracking_categories": [
- {
- "id": "123456",
- "name": "New York",
- },
- {
- "id": "123456",
- "name": "New York",
- },
- ],
- "custom_fields": [
- {
- "id": "2389328923893298",
- "name": "employee_level",
- "description": "Employee Level",
- "value": "Uses Salesforce and Marketo",
- },
- ],
- "row_version": "1-12345",
- "display_id": "123456",
- "pass_through": [
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ ], custom_fields=[
+ {
+ "id": "2389328923893298",
+ "name": "employee_level",
+ "description": "Employee Level",
+ "value": "Uses Salesforce and Marketo",
+ },
+ ], row_version="1-12345", display_id="123456", pass_through=[
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- ],
- }, service_id="salesforce")
+ },
+ ],
+ },
+ ])
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description | Example |
-| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| `bill_payment` | [models.BillPaymentInput](../../models/billpaymentinput.md) | :heavy_check_mark: | N/A | |
-| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
-| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
+| Parameter | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `total_amount` | *Nullable[float]* | :heavy_check_mark: | The total amount of the transaction | 49.99 |
+| `transaction_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD | 2021-05-01T12:00:00.000Z |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `currency` | [OptionalNullable[models.Currency]](../../models/currency.md) | :heavy_minus_sign: | Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). | USD |
+| `currency_rate` | *OptionalNullable[float]* | :heavy_minus_sign: | Currency Exchange Rate at the time entity was recorded/generated. | 0.69 |
+| `reference` | *OptionalNullable[str]* | :heavy_minus_sign: | Optional transaction reference message ie: Debit remittance detail. | 123456 |
+| `payment_method` | *OptionalNullable[str]* | :heavy_minus_sign: | Payment method used for the transaction, such as cash, credit card, bank transfer, or check | cash |
+| `payment_method_reference` | *OptionalNullable[str]* | :heavy_minus_sign: | Optional reference message returned by payment method on processing | 123456 |
+| `payment_method_id` | *OptionalNullable[str]* | :heavy_minus_sign: | A unique identifier for an object. | 12345 |
+| `account` | [OptionalNullable[models.LinkedLedgerAccountInput]](../../models/linkedledgeraccountinput.md) | :heavy_minus_sign: | N/A | |
+| `supplier` | [OptionalNullable[models.LinkedSupplierInput]](../../models/linkedsupplierinput.md) | :heavy_minus_sign: | The supplier this entity is linked to. | |
+| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 |
+| `reconciled` | *OptionalNullable[bool]* | :heavy_minus_sign: | Indicates if the transaction has been reconciled. | true |
+| `status` | [Optional[models.PaymentStatus]](../../models/paymentstatus.md) | :heavy_minus_sign: | Status of payment | authorised |
+| `type` | [Optional[models.BillPaymentType]](../../models/billpaymenttype.md) | :heavy_minus_sign: | Type of payment | accounts_payable |
+| `allocations` | List[[models.BillPaymentAllocations](../../models/billpaymentallocations.md)] | :heavy_minus_sign: | N/A | |
+| `note` | *OptionalNullable[str]* | :heavy_minus_sign: | Note associated with the transaction | Some notes about this transaction |
+| `number` | *OptionalNullable[str]* | :heavy_minus_sign: | Number associated with the transaction | 123456 |
+| `tracking_categories` | List[[models.LinkedTrackingCategory](../../models/linkedtrackingcategory.md)] | :heavy_minus_sign: | A list of linked tracking categories. | |
+| `custom_fields` | List[[models.CustomField](../../models/customfield.md)] | :heavy_minus_sign: | N/A | |
+| `row_version` | *OptionalNullable[str]* | :heavy_minus_sign: | A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. | 1-12345 |
+| `display_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Id to be displayed. | 123456 |
+| `pass_through` | List[[models.PassThroughBody](../../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -228,11 +229,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.accounting.bill_payments.get(id="", service_id="salesforce", fields="id,updated_at")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
@@ -278,143 +279,141 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.accounting.bill_payments.update(id="", bill_payment={
- "total_amount": 49.99,
- "transaction_date": dateutil.parser.isoparse("2021-05-01T12:00:00.000Z"),
- "currency": apideck_unify.Currency.USD,
- "currency_rate": 0.69,
- "reference": "123456",
- "payment_method": "cash",
- "payment_method_reference": "123456",
- "payment_method_id": "12345",
- "account": {
- "id": "123456",
- "nominal_code": "N091",
- "code": "453",
+
+ res = apideck.accounting.bill_payments.update(id="", total_amount=49.99, transaction_date=dateutil.parser.isoparse("2021-05-01T12:00:00.000Z"), service_id="salesforce", currency=apideck_unify.Currency.USD, currency_rate=0.69, reference="123456", payment_method="cash", payment_method_reference="123456", payment_method_id="12345", account={
+ "id": "123456",
+ "nominal_code": "N091",
+ "code": "453",
+ }, supplier={
+ "id": "12345",
+ "display_name": "Windsurf Shop",
+ "address": {
+ "id": "123",
+ "type": apideck_unify.Type.PRIMARY,
+ "string": "25 Spring Street, Blackburn, VIC 3130",
+ "name": "HQ US",
+ "line1": "Main street",
+ "line2": "apt #",
+ "line3": "Suite #",
+ "line4": "delivery instructions",
+ "street_number": "25",
+ "city": "San Francisco",
+ "state": "CA",
+ "postal_code": "94104",
+ "country": "US",
+ "latitude": "40.759211",
+ "longitude": "-73.984638",
+ "county": "Santa Clara",
+ "contact_name": "Elon Musk",
+ "salutation": "Mr",
+ "phone_number": "111-111-1111",
+ "fax": "122-111-1111",
+ "email": "elon@musk.com",
+ "website": "https://elonmusk.com",
+ "notes": "Address notes or delivery instructions.",
+ "row_version": "1-12345",
},
- "supplier": {
+ }, company_id="12345", reconciled=True, status=apideck_unify.PaymentStatus.AUTHORISED, type_=apideck_unify.BillPaymentType.ACCOUNTS_PAYABLE, allocations=[
+ {
"id": "12345",
- "display_name": "Windsurf Shop",
- "address": {
- "id": "123",
- "type": apideck_unify.Type.PRIMARY,
- "string": "25 Spring Street, Blackburn, VIC 3130",
- "name": "HQ US",
- "line1": "Main street",
- "line2": "apt #",
- "line3": "Suite #",
- "line4": "delivery instructions",
- "street_number": "25",
- "city": "San Francisco",
- "state": "CA",
- "postal_code": "94104",
- "country": "US",
- "latitude": "40.759211",
- "longitude": "-73.984638",
- "county": "Santa Clara",
- "contact_name": "Elon Musk",
- "salutation": "Mr",
- "phone_number": "111-111-1111",
- "fax": "122-111-1111",
- "email": "elon@musk.com",
- "website": "https://elonmusk.com",
- "notes": "Address notes or delivery instructions.",
- "row_version": "1-12345",
- },
+ "type": apideck_unify.BillPaymentAllocationType.BILL,
+ "amount": 49.99,
+ "allocation_id": "123456",
+ },
+ {
+ "id": "12345",
+ "type": apideck_unify.BillPaymentAllocationType.BILL,
+ "amount": 49.99,
+ "allocation_id": "123456",
+ },
+ {
+ "id": "12345",
+ "type": apideck_unify.BillPaymentAllocationType.BILL,
+ "amount": 49.99,
+ "allocation_id": "123456",
+ },
+ ], note="Some notes about this transaction", number="123456", tracking_categories=[
+ {
+ "id": "123456",
+ "name": "New York",
},
- "company_id": "12345",
- "reconciled": True,
- "status": apideck_unify.PaymentStatus.AUTHORISED,
- "type": apideck_unify.BillPaymentType.ACCOUNTS_PAYABLE,
- "allocations": [
- {
- "id": "12345",
- "type": apideck_unify.BillPaymentAllocationType.BILL,
- "amount": 49.99,
- "allocation_id": "123456",
- },
- {
- "id": "12345",
- "type": apideck_unify.BillPaymentAllocationType.BILL,
- "amount": 49.99,
- "allocation_id": "123456",
- },
- {
- "id": "12345",
- "type": apideck_unify.BillPaymentAllocationType.BILL,
- "amount": 49.99,
- "allocation_id": "123456",
- },
- ],
- "note": "Some notes about this transaction",
- "number": "123456",
- "tracking_categories": [
- {
- "id": "123456",
- "name": "New York",
- },
- {
- "id": "123456",
- "name": "New York",
- },
- ],
- "custom_fields": [
- {
- "id": "2389328923893298",
- "name": "employee_level",
- "description": "Employee Level",
- },
- ],
- "row_version": "1-12345",
- "display_id": "123456",
- "pass_through": [
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ {
+ "id": "123456",
+ "name": "New York",
+ },
+ ], custom_fields=[
+ {
+ "id": "2389328923893298",
+ "name": "employee_level",
+ "description": "Employee Level",
+ },
+ ], row_version="1-12345", display_id="123456", pass_through=[
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- ],
- }, service_id="salesforce")
+ },
+ ],
+ },
+ ])
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description | Example |
-| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
-| `bill_payment` | [models.BillPaymentInput](../../models/billpaymentinput.md) | :heavy_check_mark: | N/A | |
-| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
-| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
+| Parameter | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
+| `total_amount` | *Nullable[float]* | :heavy_check_mark: | The total amount of the transaction | 49.99 |
+| `transaction_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD | 2021-05-01T12:00:00.000Z |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `currency` | [OptionalNullable[models.Currency]](../../models/currency.md) | :heavy_minus_sign: | Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). | USD |
+| `currency_rate` | *OptionalNullable[float]* | :heavy_minus_sign: | Currency Exchange Rate at the time entity was recorded/generated. | 0.69 |
+| `reference` | *OptionalNullable[str]* | :heavy_minus_sign: | Optional transaction reference message ie: Debit remittance detail. | 123456 |
+| `payment_method` | *OptionalNullable[str]* | :heavy_minus_sign: | Payment method used for the transaction, such as cash, credit card, bank transfer, or check | cash |
+| `payment_method_reference` | *OptionalNullable[str]* | :heavy_minus_sign: | Optional reference message returned by payment method on processing | 123456 |
+| `payment_method_id` | *OptionalNullable[str]* | :heavy_minus_sign: | A unique identifier for an object. | 12345 |
+| `account` | [OptionalNullable[models.LinkedLedgerAccountInput]](../../models/linkedledgeraccountinput.md) | :heavy_minus_sign: | N/A | |
+| `supplier` | [OptionalNullable[models.LinkedSupplierInput]](../../models/linkedsupplierinput.md) | :heavy_minus_sign: | The supplier this entity is linked to. | |
+| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 |
+| `reconciled` | *OptionalNullable[bool]* | :heavy_minus_sign: | Indicates if the transaction has been reconciled. | true |
+| `status` | [Optional[models.PaymentStatus]](../../models/paymentstatus.md) | :heavy_minus_sign: | Status of payment | authorised |
+| `type` | [Optional[models.BillPaymentType]](../../models/billpaymenttype.md) | :heavy_minus_sign: | Type of payment | accounts_payable |
+| `allocations` | List[[models.BillPaymentAllocations](../../models/billpaymentallocations.md)] | :heavy_minus_sign: | N/A | |
+| `note` | *OptionalNullable[str]* | :heavy_minus_sign: | Note associated with the transaction | Some notes about this transaction |
+| `number` | *OptionalNullable[str]* | :heavy_minus_sign: | Number associated with the transaction | 123456 |
+| `tracking_categories` | List[[models.LinkedTrackingCategory](../../models/linkedtrackingcategory.md)] | :heavy_minus_sign: | A list of linked tracking categories. | |
+| `custom_fields` | List[[models.CustomField](../../models/customfield.md)] | :heavy_minus_sign: | N/A | |
+| `row_version` | *OptionalNullable[str]* | :heavy_minus_sign: | A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. | 1-12345 |
+| `display_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Id to be displayed. | 123456 |
+| `pass_through` | List[[models.PassThroughBody](../../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -446,11 +445,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.accounting.bill_payments.delete(id="", service_id="salesforce")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
diff --git a/docs/sdks/bills/README.md b/docs/sdks/bills/README.md
index d73210d6..9d8da22e 100644
--- a/docs/sdks/bills/README.md
+++ b/docs/sdks/bills/README.md
@@ -28,33 +28,36 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.accounting.bills.list(request={
- "service_id": "salesforce",
- "filter_": {
- "updated_since": dateutil.parser.isoparse("2020-09-30T07:43:32.000Z"),
- },
- "sort": {
- "by": apideck_unify.By.UPDATED_AT,
- "direction": apideck_unify.SortDirection.DESC,
- },
- "pass_through": {
- "search": "San Francisco",
- },
- "fields": "id,updated_at",
- })
- if res is not None:
- # handle response
- pass
+ res = apideck.accounting.bills.list(service_id="salesforce", filter_={
+ "updated_since": dateutil.parser.isoparse("2020-09-30T07:43:32.000Z"),
+ }, sort={
+ "by": apideck_unify.By.UPDATED_AT,
+ "direction": apideck_unify.SortDirection.DESC,
+ }, pass_through={
+ "search": "San Francisco",
+ }, fields="id,updated_at")
+
+ while res is not None:
+ # Handle items
+
+ res = res.next()
```
### Parameters
-| Parameter | Type | Required | Description |
-| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
-| `request` | [models.AccountingBillsAllRequest](../../models/accountingbillsallrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
+| Parameter | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | |
+| `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | |
+| `filter_` | [Optional[models.BillsFilter]](../../models/billsfilter.md) | :heavy_minus_sign: | Apply filters | {
"updated_since": "2020-09-30T07:43:32.000Z"
} |
+| `sort` | [Optional[models.BillsSort]](../../models/billssort.md) | :heavy_minus_sign: | Apply sorting | {
"by": "updated_at",
"direction": "desc"
} |
+| `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} |
+| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: `fields=name,email,addresses.city`
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -88,161 +91,159 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.accounting.bills.create(bill={
- "bill_number": "10001",
- "supplier": {
- "id": "12345",
- "display_name": "Windsurf Shop",
- "address": {
- "id": "123",
- "type": apideck_unify.Type.PRIMARY,
- "string": "25 Spring Street, Blackburn, VIC 3130",
- "name": "HQ US",
- "line1": "Main street",
- "line2": "apt #",
- "line3": "Suite #",
- "line4": "delivery instructions",
- "street_number": "25",
- "city": "San Francisco",
- "state": "CA",
- "postal_code": "94104",
- "country": "US",
- "latitude": "40.759211",
- "longitude": "-73.984638",
- "county": "Santa Clara",
- "contact_name": "Elon Musk",
- "salutation": "Mr",
- "phone_number": "111-111-1111",
- "fax": "122-111-1111",
- "email": "elon@musk.com",
- "website": "https://elonmusk.com",
- "notes": "Address notes or delivery instructions.",
- "row_version": "1-12345",
- },
+
+ res = apideck.accounting.bills.create(service_id="salesforce", bill_number="10001", supplier={
+ "id": "12345",
+ "display_name": "Windsurf Shop",
+ "address": {
+ "id": "123",
+ "type": apideck_unify.Type.PRIMARY,
+ "string": "25 Spring Street, Blackburn, VIC 3130",
+ "name": "HQ US",
+ "line1": "Main street",
+ "line2": "apt #",
+ "line3": "Suite #",
+ "line4": "delivery instructions",
+ "street_number": "25",
+ "city": "San Francisco",
+ "state": "CA",
+ "postal_code": "94104",
+ "country": "US",
+ "latitude": "40.759211",
+ "longitude": "-73.984638",
+ "county": "Santa Clara",
+ "contact_name": "Elon Musk",
+ "salutation": "Mr",
+ "phone_number": "111-111-1111",
+ "fax": "122-111-1111",
+ "email": "elon@musk.com",
+ "website": "https://elonmusk.com",
+ "notes": "Address notes or delivery instructions.",
+ "row_version": "1-12345",
},
- "company_id": "12345",
- "currency": apideck_unify.Currency.USD,
- "currency_rate": 0.69,
- "tax_inclusive": True,
- "bill_date": dateutil.parser.parse("2020-09-30").date(),
- "due_date": dateutil.parser.parse("2020-10-30").date(),
- "paid_date": dateutil.parser.parse("2020-10-30").date(),
- "po_number": "90000117",
- "reference": "123456",
- "line_items": [
- {
- "row_id": "12345",
+ }, company_id="12345", currency=apideck_unify.Currency.USD, currency_rate=0.69, tax_inclusive=True, bill_date=dateutil.parser.parse("2020-09-30").date(), due_date=dateutil.parser.parse("2020-10-30").date(), paid_date=dateutil.parser.parse("2020-10-30").date(), po_number="90000117", reference="123456", line_items=[
+ {
+ "row_id": "12345",
+ "code": "120-C",
+ "line_number": 1,
+ "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
+ "type": apideck_unify.BillLineItemType.EXPENSE_ACCOUNT,
+ "tax_amount": 27500,
+ "total_amount": 27500,
+ "quantity": 1,
+ "unit_price": 27500.5,
+ "unit_of_measure": "pc.",
+ "discount_percentage": 0.01,
+ "discount_amount": 19.99,
+ "location_id": "1234",
+ "department_id": "1234",
+ "item": {
+ "id": "12344",
"code": "120-C",
- "line_number": 1,
- "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
- "type": apideck_unify.BillLineItemType.EXPENSE_ACCOUNT,
- "tax_amount": 27500,
- "total_amount": 27500,
- "quantity": 1,
- "unit_price": 27500.5,
- "unit_of_measure": "pc.",
- "discount_percentage": 0.01,
- "discount_amount": 19.99,
- "location_id": "1234",
- "department_id": "1234",
- "item": {
- "id": "12344",
- "code": "120-C",
- "name": "Model Y",
- },
- "tax_rate": {
+ "name": "Model Y",
+ },
+ "tax_rate": {
+ "id": "123456",
+ "rate": 10,
+ },
+ "ledger_account": {
+ "id": "123456",
+ "nominal_code": "N091",
+ "code": "453",
+ },
+ "tracking_categories": [
+ {
"id": "123456",
- "rate": 10,
+ "name": "New York",
},
- "ledger_account": {
+ {
"id": "123456",
- "nominal_code": "N091",
- "code": "453",
+ "name": "New York",
},
- "tracking_categories": [
- {
- "id": "123456",
- "name": "New York",
- },
- {
- "id": "123456",
- "name": "New York",
- },
- ],
- "row_version": "1-12345",
- },
- ],
- "terms": "Net 30 days",
- "balance": 27500,
- "deposit": 0,
- "sub_total": 27500,
- "total_tax": 2500,
- "total": 27500,
- "tax_code": "1234",
- "notes": "Some notes about this bill.",
- "status": apideck_unify.BillStatus.DRAFT,
- "ledger_account": {
- "id": "123456",
- "nominal_code": "N091",
- "code": "453",
+ ],
+ "row_version": "1-12345",
},
- "payment_method": "cash",
- "channel": "email",
- "language": "EN",
- "accounting_by_row": False,
- "bank_account": {
- "bank_name": "Monzo",
- "account_number": "123465",
- "account_name": "SPACEX LLC",
- "account_type": apideck_unify.AccountType.CREDIT_CARD,
- "iban": "CH2989144532982975332",
- "bic": "AUDSCHGGXXX",
- "routing_number": "012345678",
- "bsb_number": "062-001",
- "branch_identifier": "001",
- "bank_code": "BNH",
- "currency": apideck_unify.Currency.USD,
+ ], terms="Net 30 days", balance=27500, deposit=0, sub_total=27500, total_tax=2500, total=27500, tax_code="1234", notes="Some notes about this bill.", status=apideck_unify.BillStatus.DRAFT, ledger_account={
+ "id": "123456",
+ "nominal_code": "N091",
+ "code": "453",
+ }, payment_method="cash", channel="email", language="EN", accounting_by_row=False, bank_account={
+ "bank_name": "Monzo",
+ "account_number": "123465",
+ "account_name": "SPACEX LLC",
+ "account_type": apideck_unify.AccountType.CREDIT_CARD,
+ "iban": "CH2989144532982975332",
+ "bic": "AUDSCHGGXXX",
+ "routing_number": "012345678",
+ "bsb_number": "062-001",
+ "branch_identifier": "001",
+ "bank_code": "BNH",
+ "currency": apideck_unify.Currency.USD,
+ }, discount_percentage=5.5, tracking_categories=[
+ {
+ "id": "123456",
+ "name": "New York",
},
- "discount_percentage": 5.5,
- "tracking_categories": [
- {
- "id": "123456",
- "name": "New York",
- },
- ],
- "row_version": "1-12345",
- "pass_through": [
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ ], row_version="1-12345", pass_through=[
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- ],
- "accounting_period": "01-24",
- }, service_id="salesforce")
+ },
+ ],
+ },
+ ], accounting_period="01-24")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description | Example |
-| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| `bill` | [models.BillInput](../../models/billinput.md) | :heavy_check_mark: | N/A | |
-| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
-| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
+| Parameter | Type | Required | Description | Example |
+| ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `bill_number` | *OptionalNullable[str]* | :heavy_minus_sign: | Reference to supplier bill number | 10001 |
+| `supplier` | [OptionalNullable[models.LinkedSupplierInput]](../../models/linkedsupplierinput.md) | :heavy_minus_sign: | The supplier this entity is linked to. | |
+| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 |
+| `currency` | [OptionalNullable[models.Currency]](../../models/currency.md) | :heavy_minus_sign: | Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). | USD |
+| `currency_rate` | *OptionalNullable[float]* | :heavy_minus_sign: | Currency Exchange Rate at the time entity was recorded/generated. | 0.69 |
+| `tax_inclusive` | *OptionalNullable[bool]* | :heavy_minus_sign: | Amounts are including tax | true |
+| `bill_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | Date bill was issued - YYYY-MM-DD. | 2020-09-30 |
+| `due_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The due date is the date on which a payment is scheduled to be received - YYYY-MM-DD. | 2020-10-30 |
+| `paid_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The paid date is the date on which a payment was sent to the supplier - YYYY-MM-DD. | 2020-10-30 |
+| `po_number` | *OptionalNullable[str]* | :heavy_minus_sign: | A PO Number uniquely identifies a purchase order and is generally defined by the buyer. The buyer will match the PO number in the invoice to the Purchase Order. | 90000117 |
+| `reference` | *OptionalNullable[str]* | :heavy_minus_sign: | Optional bill reference. | 123456 |
+| `line_items` | List[[models.BillLineItemInput](../../models/billlineiteminput.md)] | :heavy_minus_sign: | N/A | |
+| `terms` | *OptionalNullable[str]* | :heavy_minus_sign: | Terms of payment. | Net 30 days |
+| `balance` | *OptionalNullable[float]* | :heavy_minus_sign: | Balance of bill due. | 27500 |
+| `deposit` | *OptionalNullable[float]* | :heavy_minus_sign: | Amount of deposit made to this bill. | 0 |
+| `sub_total` | *OptionalNullable[float]* | :heavy_minus_sign: | Sub-total amount, normally before tax. | 27500 |
+| `total_tax` | *OptionalNullable[float]* | :heavy_minus_sign: | Total tax amount applied to this bill. | 2500 |
+| `total` | *OptionalNullable[float]* | :heavy_minus_sign: | Total amount of bill, including tax. | 27500 |
+| `tax_code` | *OptionalNullable[str]* | :heavy_minus_sign: | Applicable tax id/code override if tax is not supplied on a line item basis. | 1234 |
+| `notes` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | Some notes about this bill. |
+| `status` | [OptionalNullable[models.BillStatus]](../../models/billstatus.md) | :heavy_minus_sign: | Invoice status | draft |
+| `ledger_account` | [OptionalNullable[models.LinkedLedgerAccountInput]](../../models/linkedledgeraccountinput.md) | :heavy_minus_sign: | N/A | |
+| `payment_method` | *OptionalNullable[str]* | :heavy_minus_sign: | Payment method used for the transaction, such as cash, credit card, bank transfer, or check | cash |
+| `channel` | *OptionalNullable[str]* | :heavy_minus_sign: | The channel through which the transaction is processed. | email |
+| `language` | *OptionalNullable[str]* | :heavy_minus_sign: | language code according to ISO 639-1. For the United States - EN | EN |
+| `accounting_by_row` | *OptionalNullable[bool]* | :heavy_minus_sign: | Indicates if accounting by row is used (true) or not (false). Accounting by row means that a separate ledger transaction is created for each row. | false |
+| `bank_account` | [Optional[models.BankAccount]](../../models/bankaccount.md) | :heavy_minus_sign: | N/A | |
+| `discount_percentage` | *OptionalNullable[float]* | :heavy_minus_sign: | Discount percentage applied to this transaction. | 5.5 |
+| `tracking_categories` | List[[models.LinkedTrackingCategory](../../models/linkedtrackingcategory.md)] | :heavy_minus_sign: | A list of linked tracking categories. | |
+| `row_version` | *OptionalNullable[str]* | :heavy_minus_sign: | A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. | 1-12345 |
+| `pass_through` | List[[models.PassThroughBody](../../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | |
+| `accounting_period` | *OptionalNullable[str]* | :heavy_minus_sign: | Accounting period | 01-24 |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -274,11 +275,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.accounting.bills.get(id="", service_id="salesforce", fields="id,updated_at")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
@@ -324,264 +325,262 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.accounting.bills.update(id="", bill={
- "bill_number": "10001",
- "supplier": {
- "id": "12345",
- "display_name": "Windsurf Shop",
- "address": {
- "id": "123",
- "type": apideck_unify.Type.PRIMARY,
- "string": "25 Spring Street, Blackburn, VIC 3130",
- "name": "HQ US",
- "line1": "Main street",
- "line2": "apt #",
- "line3": "Suite #",
- "line4": "delivery instructions",
- "street_number": "25",
- "city": "San Francisco",
- "state": "CA",
- "postal_code": "94104",
- "country": "US",
- "latitude": "40.759211",
- "longitude": "-73.984638",
- "county": "Santa Clara",
- "contact_name": "Elon Musk",
- "salutation": "Mr",
- "phone_number": "111-111-1111",
- "fax": "122-111-1111",
- "email": "elon@musk.com",
- "website": "https://elonmusk.com",
- "notes": "Address notes or delivery instructions.",
- "row_version": "1-12345",
- },
+
+ res = apideck.accounting.bills.update(id="", service_id="salesforce", bill_number="10001", supplier={
+ "id": "12345",
+ "display_name": "Windsurf Shop",
+ "address": {
+ "id": "123",
+ "type": apideck_unify.Type.PRIMARY,
+ "string": "25 Spring Street, Blackburn, VIC 3130",
+ "name": "HQ US",
+ "line1": "Main street",
+ "line2": "apt #",
+ "line3": "Suite #",
+ "line4": "delivery instructions",
+ "street_number": "25",
+ "city": "San Francisco",
+ "state": "CA",
+ "postal_code": "94104",
+ "country": "US",
+ "latitude": "40.759211",
+ "longitude": "-73.984638",
+ "county": "Santa Clara",
+ "contact_name": "Elon Musk",
+ "salutation": "Mr",
+ "phone_number": "111-111-1111",
+ "fax": "122-111-1111",
+ "email": "elon@musk.com",
+ "website": "https://elonmusk.com",
+ "notes": "Address notes or delivery instructions.",
+ "row_version": "1-12345",
},
- "company_id": "12345",
- "currency": apideck_unify.Currency.USD,
- "currency_rate": 0.69,
- "tax_inclusive": True,
- "bill_date": dateutil.parser.parse("2020-09-30").date(),
- "due_date": dateutil.parser.parse("2020-10-30").date(),
- "paid_date": dateutil.parser.parse("2020-10-30").date(),
- "po_number": "90000117",
- "reference": "123456",
- "line_items": [
- {
- "row_id": "12345",
+ }, company_id="12345", currency=apideck_unify.Currency.USD, currency_rate=0.69, tax_inclusive=True, bill_date=dateutil.parser.parse("2020-09-30").date(), due_date=dateutil.parser.parse("2020-10-30").date(), paid_date=dateutil.parser.parse("2020-10-30").date(), po_number="90000117", reference="123456", line_items=[
+ {
+ "row_id": "12345",
+ "code": "120-C",
+ "line_number": 1,
+ "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
+ "type": apideck_unify.BillLineItemType.EXPENSE_ACCOUNT,
+ "tax_amount": 27500,
+ "total_amount": 27500,
+ "quantity": 1,
+ "unit_price": 27500.5,
+ "unit_of_measure": "pc.",
+ "discount_percentage": 0.01,
+ "discount_amount": 19.99,
+ "location_id": "1234",
+ "department_id": "1234",
+ "item": {
+ "id": "12344",
"code": "120-C",
- "line_number": 1,
- "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
- "type": apideck_unify.BillLineItemType.EXPENSE_ACCOUNT,
- "tax_amount": 27500,
- "total_amount": 27500,
- "quantity": 1,
- "unit_price": 27500.5,
- "unit_of_measure": "pc.",
- "discount_percentage": 0.01,
- "discount_amount": 19.99,
- "location_id": "1234",
- "department_id": "1234",
- "item": {
- "id": "12344",
- "code": "120-C",
- "name": "Model Y",
- },
- "tax_rate": {
+ "name": "Model Y",
+ },
+ "tax_rate": {
+ "id": "123456",
+ "rate": 10,
+ },
+ "ledger_account": {
+ "id": "123456",
+ "nominal_code": "N091",
+ "code": "453",
+ },
+ "tracking_categories": [
+ {
"id": "123456",
- "rate": 10,
+ "name": "New York",
},
- "ledger_account": {
+ {
"id": "123456",
- "nominal_code": "N091",
- "code": "453",
+ "name": "New York",
},
- "tracking_categories": [
- {
- "id": "123456",
- "name": "New York",
- },
- {
- "id": "123456",
- "name": "New York",
- },
- ],
- "row_version": "1-12345",
- },
- {
- "row_id": "12345",
+ ],
+ "row_version": "1-12345",
+ },
+ {
+ "row_id": "12345",
+ "code": "120-C",
+ "line_number": 1,
+ "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
+ "type": apideck_unify.BillLineItemType.EXPENSE_ACCOUNT,
+ "tax_amount": 27500,
+ "total_amount": 27500,
+ "quantity": 1,
+ "unit_price": 27500.5,
+ "unit_of_measure": "pc.",
+ "discount_percentage": 0.01,
+ "discount_amount": 19.99,
+ "location_id": "1234",
+ "department_id": "1234",
+ "item": {
+ "id": "12344",
"code": "120-C",
- "line_number": 1,
- "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
- "type": apideck_unify.BillLineItemType.EXPENSE_ACCOUNT,
- "tax_amount": 27500,
- "total_amount": 27500,
- "quantity": 1,
- "unit_price": 27500.5,
- "unit_of_measure": "pc.",
- "discount_percentage": 0.01,
- "discount_amount": 19.99,
- "location_id": "1234",
- "department_id": "1234",
- "item": {
- "id": "12344",
- "code": "120-C",
- "name": "Model Y",
- },
- "tax_rate": {
- "id": "123456",
- "rate": 10,
- },
- "ledger_account": {
+ "name": "Model Y",
+ },
+ "tax_rate": {
+ "id": "123456",
+ "rate": 10,
+ },
+ "ledger_account": {
+ "id": "123456",
+ "nominal_code": "N091",
+ "code": "453",
+ },
+ "tracking_categories": [
+ {
"id": "123456",
- "nominal_code": "N091",
- "code": "453",
+ "name": "New York",
},
- "tracking_categories": [
- {
- "id": "123456",
- "name": "New York",
- },
- ],
- "row_version": "1-12345",
- },
- {
- "row_id": "12345",
+ ],
+ "row_version": "1-12345",
+ },
+ {
+ "row_id": "12345",
+ "code": "120-C",
+ "line_number": 1,
+ "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
+ "type": apideck_unify.BillLineItemType.EXPENSE_ACCOUNT,
+ "tax_amount": 27500,
+ "total_amount": 27500,
+ "quantity": 1,
+ "unit_price": 27500.5,
+ "unit_of_measure": "pc.",
+ "discount_percentage": 0.01,
+ "discount_amount": 19.99,
+ "location_id": "1234",
+ "department_id": "1234",
+ "item": {
+ "id": "12344",
"code": "120-C",
- "line_number": 1,
- "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
- "type": apideck_unify.BillLineItemType.EXPENSE_ACCOUNT,
- "tax_amount": 27500,
- "total_amount": 27500,
- "quantity": 1,
- "unit_price": 27500.5,
- "unit_of_measure": "pc.",
- "discount_percentage": 0.01,
- "discount_amount": 19.99,
- "location_id": "1234",
- "department_id": "1234",
- "item": {
- "id": "12344",
- "code": "120-C",
- "name": "Model Y",
+ "name": "Model Y",
+ },
+ "tax_rate": {
+ "id": "123456",
+ "rate": 10,
+ },
+ "ledger_account": {
+ "id": "123456",
+ "nominal_code": "N091",
+ "code": "453",
+ },
+ "tracking_categories": [
+ {
+ "id": "123456",
+ "name": "New York",
},
- "tax_rate": {
+ {
"id": "123456",
- "rate": 10,
+ "name": "New York",
},
- "ledger_account": {
+ {
"id": "123456",
- "nominal_code": "N091",
- "code": "453",
+ "name": "New York",
},
- "tracking_categories": [
- {
- "id": "123456",
- "name": "New York",
- },
- {
- "id": "123456",
- "name": "New York",
- },
- {
- "id": "123456",
- "name": "New York",
- },
- ],
- "row_version": "1-12345",
- },
- ],
- "terms": "Net 30 days",
- "balance": 27500,
- "deposit": 0,
- "sub_total": 27500,
- "total_tax": 2500,
- "total": 27500,
- "tax_code": "1234",
- "notes": "Some notes about this bill.",
- "status": apideck_unify.BillStatus.DRAFT,
- "ledger_account": {
+ ],
+ "row_version": "1-12345",
+ },
+ ], terms="Net 30 days", balance=27500, deposit=0, sub_total=27500, total_tax=2500, total=27500, tax_code="1234", notes="Some notes about this bill.", status=apideck_unify.BillStatus.DRAFT, ledger_account={
+ "id": "123456",
+ "nominal_code": "N091",
+ "code": "453",
+ }, payment_method="cash", channel="email", language="EN", accounting_by_row=False, bank_account={
+ "bank_name": "Monzo",
+ "account_number": "123465",
+ "account_name": "SPACEX LLC",
+ "account_type": apideck_unify.AccountType.CREDIT_CARD,
+ "iban": "CH2989144532982975332",
+ "bic": "AUDSCHGGXXX",
+ "routing_number": "012345678",
+ "bsb_number": "062-001",
+ "branch_identifier": "001",
+ "bank_code": "BNH",
+ "currency": apideck_unify.Currency.USD,
+ }, discount_percentage=5.5, tracking_categories=[
+ {
"id": "123456",
- "nominal_code": "N091",
- "code": "453",
+ "name": "New York",
},
- "payment_method": "cash",
- "channel": "email",
- "language": "EN",
- "accounting_by_row": False,
- "bank_account": {
- "bank_name": "Monzo",
- "account_number": "123465",
- "account_name": "SPACEX LLC",
- "account_type": apideck_unify.AccountType.CREDIT_CARD,
- "iban": "CH2989144532982975332",
- "bic": "AUDSCHGGXXX",
- "routing_number": "012345678",
- "bsb_number": "062-001",
- "branch_identifier": "001",
- "bank_code": "BNH",
- "currency": apideck_unify.Currency.USD,
+ {
+ "id": "123456",
+ "name": "New York",
},
- "discount_percentage": 5.5,
- "tracking_categories": [
- {
- "id": "123456",
- "name": "New York",
- },
- {
- "id": "123456",
- "name": "New York",
- },
- ],
- "row_version": "1-12345",
- "pass_through": [
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ ], row_version="1-12345", pass_through=[
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- ],
- "accounting_period": "01-24",
- }, service_id="salesforce")
+ },
+ ],
+ },
+ ], accounting_period="01-24")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description | Example |
-| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
-| `bill` | [models.BillInput](../../models/billinput.md) | :heavy_check_mark: | N/A | |
-| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
-| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
+| Parameter | Type | Required | Description | Example |
+| ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `bill_number` | *OptionalNullable[str]* | :heavy_minus_sign: | Reference to supplier bill number | 10001 |
+| `supplier` | [OptionalNullable[models.LinkedSupplierInput]](../../models/linkedsupplierinput.md) | :heavy_minus_sign: | The supplier this entity is linked to. | |
+| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 |
+| `currency` | [OptionalNullable[models.Currency]](../../models/currency.md) | :heavy_minus_sign: | Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). | USD |
+| `currency_rate` | *OptionalNullable[float]* | :heavy_minus_sign: | Currency Exchange Rate at the time entity was recorded/generated. | 0.69 |
+| `tax_inclusive` | *OptionalNullable[bool]* | :heavy_minus_sign: | Amounts are including tax | true |
+| `bill_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | Date bill was issued - YYYY-MM-DD. | 2020-09-30 |
+| `due_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The due date is the date on which a payment is scheduled to be received - YYYY-MM-DD. | 2020-10-30 |
+| `paid_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The paid date is the date on which a payment was sent to the supplier - YYYY-MM-DD. | 2020-10-30 |
+| `po_number` | *OptionalNullable[str]* | :heavy_minus_sign: | A PO Number uniquely identifies a purchase order and is generally defined by the buyer. The buyer will match the PO number in the invoice to the Purchase Order. | 90000117 |
+| `reference` | *OptionalNullable[str]* | :heavy_minus_sign: | Optional bill reference. | 123456 |
+| `line_items` | List[[models.BillLineItemInput](../../models/billlineiteminput.md)] | :heavy_minus_sign: | N/A | |
+| `terms` | *OptionalNullable[str]* | :heavy_minus_sign: | Terms of payment. | Net 30 days |
+| `balance` | *OptionalNullable[float]* | :heavy_minus_sign: | Balance of bill due. | 27500 |
+| `deposit` | *OptionalNullable[float]* | :heavy_minus_sign: | Amount of deposit made to this bill. | 0 |
+| `sub_total` | *OptionalNullable[float]* | :heavy_minus_sign: | Sub-total amount, normally before tax. | 27500 |
+| `total_tax` | *OptionalNullable[float]* | :heavy_minus_sign: | Total tax amount applied to this bill. | 2500 |
+| `total` | *OptionalNullable[float]* | :heavy_minus_sign: | Total amount of bill, including tax. | 27500 |
+| `tax_code` | *OptionalNullable[str]* | :heavy_minus_sign: | Applicable tax id/code override if tax is not supplied on a line item basis. | 1234 |
+| `notes` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | Some notes about this bill. |
+| `status` | [OptionalNullable[models.BillStatus]](../../models/billstatus.md) | :heavy_minus_sign: | Invoice status | draft |
+| `ledger_account` | [OptionalNullable[models.LinkedLedgerAccountInput]](../../models/linkedledgeraccountinput.md) | :heavy_minus_sign: | N/A | |
+| `payment_method` | *OptionalNullable[str]* | :heavy_minus_sign: | Payment method used for the transaction, such as cash, credit card, bank transfer, or check | cash |
+| `channel` | *OptionalNullable[str]* | :heavy_minus_sign: | The channel through which the transaction is processed. | email |
+| `language` | *OptionalNullable[str]* | :heavy_minus_sign: | language code according to ISO 639-1. For the United States - EN | EN |
+| `accounting_by_row` | *OptionalNullable[bool]* | :heavy_minus_sign: | Indicates if accounting by row is used (true) or not (false). Accounting by row means that a separate ledger transaction is created for each row. | false |
+| `bank_account` | [Optional[models.BankAccount]](../../models/bankaccount.md) | :heavy_minus_sign: | N/A | |
+| `discount_percentage` | *OptionalNullable[float]* | :heavy_minus_sign: | Discount percentage applied to this transaction. | 5.5 |
+| `tracking_categories` | List[[models.LinkedTrackingCategory](../../models/linkedtrackingcategory.md)] | :heavy_minus_sign: | A list of linked tracking categories. | |
+| `row_version` | *OptionalNullable[str]* | :heavy_minus_sign: | A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. | 1-12345 |
+| `pass_through` | List[[models.PassThroughBody](../../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | |
+| `accounting_period` | *OptionalNullable[str]* | :heavy_minus_sign: | Accounting period | 01-24 |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -613,11 +612,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.accounting.bills.delete(id="", service_id="salesforce")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
diff --git a/docs/sdks/collections/README.md b/docs/sdks/collections/README.md
index 1e9f0707..5aaa62ff 100644
--- a/docs/sdks/collections/README.md
+++ b/docs/sdks/collections/README.md
@@ -24,30 +24,33 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.issue_tracking.collections.list(request={
- "service_id": "salesforce",
- "sort": {
- "by": apideck_unify.CollectionsSortBy.NAME,
- "direction": apideck_unify.SortDirection.DESC,
- },
- "pass_through": {
- "search": "San Francisco",
- },
- "fields": "id,updated_at",
- })
-
- if res is not None:
- # handle response
- pass
+
+ res = apideck.issue_tracking.collections.list(service_id="salesforce", sort={
+ "by": apideck_unify.CollectionsSortBy.NAME,
+ "direction": apideck_unify.SortDirection.DESC,
+ }, pass_through={
+ "search": "San Francisco",
+ }, fields="id,updated_at")
+
+ while res is not None:
+ # Handle items
+
+ res = res.next()
```
### Parameters
-| Parameter | Type | Required | Description |
-| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
-| `request` | [models.IssueTrackingCollectionsAllRequest](../../models/issuetrackingcollectionsallrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
+| Parameter | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | |
+| `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | |
+| `sort` | [Optional[models.CollectionsSort]](../../models/collectionssort.md) | :heavy_minus_sign: | Apply sorting | {
"by": "name",
"direction": "desc"
} |
+| `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} |
+| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: `fields=name,email,addresses.city`
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -79,11 +82,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.issue_tracking.collections.get(collection_id="apideck-io", service_id="salesforce", fields="id,updated_at")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
diff --git a/docs/sdks/collectiontags/README.md b/docs/sdks/collectiontags/README.md
index f7178d76..c65906ef 100644
--- a/docs/sdks/collectiontags/README.md
+++ b/docs/sdks/collectiontags/README.md
@@ -22,27 +22,30 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.issue_tracking.collection_tags.list(request={
- "collection_id": "apideck-io",
- "service_id": "salesforce",
- "pass_through": {
- "search": "San Francisco",
- },
- "fields": "id,updated_at",
- })
-
- if res is not None:
- # handle response
- pass
+
+ res = apideck.issue_tracking.collection_tags.list(collection_id="apideck-io", service_id="salesforce", pass_through={
+ "search": "San Francisco",
+ }, fields="id,updated_at")
+
+ while res is not None:
+ # Handle items
+
+ res = res.next()
```
### Parameters
-| Parameter | Type | Required | Description |
-| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
-| `request` | [models.IssueTrackingCollectionTagsAllRequest](../../models/issuetrackingcollectiontagsallrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
+| Parameter | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | |
+| `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | |
+| `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} |
+| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: `fields=name,email,addresses.city`
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
diff --git a/docs/sdks/collectionticketcomments/README.md b/docs/sdks/collectionticketcomments/README.md
index 9ecf9180..6d85c13d 100644
--- a/docs/sdks/collectionticketcomments/README.md
+++ b/docs/sdks/collectionticketcomments/README.md
@@ -27,32 +27,35 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.issue_tracking.collection_ticket_comments.list(request={
- "collection_id": "apideck-io",
- "ticket_id": "",
- "service_id": "salesforce",
- "sort": {
- "by": apideck_unify.CommentsSortBy.CREATED_AT,
- "direction": apideck_unify.SortDirection.DESC,
- },
- "pass_through": {
- "search": "San Francisco",
- },
- "fields": "id,updated_at",
- })
- if res is not None:
- # handle response
- pass
+ res = apideck.issue_tracking.collection_ticket_comments.list(collection_id="apideck-io", ticket_id="", service_id="salesforce", sort={
+ "by": apideck_unify.CommentsSortBy.CREATED_AT,
+ "direction": apideck_unify.SortDirection.DESC,
+ }, pass_through={
+ "search": "San Francisco",
+ }, fields="id,updated_at")
+
+ while res is not None:
+ # Handle items
+
+ res = res.next()
```
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
-| `request` | [models.IssueTrackingCollectionTicketCommentsAllRequest](../../models/issuetrackingcollectionticketcommentsallrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
+| Parameter | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io |
+| `ticket_id` | *str* | :heavy_check_mark: | ID of the ticket you are acting upon. | |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | |
+| `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | |
+| `sort` | [Optional[models.CommentsSort]](../../models/commentssort.md) | :heavy_minus_sign: | Apply sorting | {
"by": "created_at",
"direction": "desc"
} |
+| `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} |
+| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: `fields=name,email,addresses.city`
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -84,50 +87,47 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.issue_tracking.collection_ticket_comments.create(request={
- "collection_id": "apideck-io",
- "ticket_id": "",
- "collection_ticket_comment": {
- "body": "What internet provider do you use?",
- "pass_through": [
+
+ res = apideck.issue_tracking.collection_ticket_comments.create(collection_id="apideck-io", ticket_id="", service_id="salesforce", body="What internet provider do you use?", pass_through=[
+ {
+ "service_id": "",
+ "extend_paths": [
{
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
- },
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
- },
+ },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
- ],
+ },
},
],
},
- "service_id": "salesforce",
- })
+ ])
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
-| `request` | [models.IssueTrackingCollectionTicketCommentsAddRequest](../../models/issuetrackingcollectionticketcommentsaddrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
+| Parameter | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io |
+| `ticket_id` | *str* | :heavy_check_mark: | ID of the ticket you are acting upon. | |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `body` | *OptionalNullable[str]* | :heavy_minus_sign: | Body of the comment | What internet provider do you use? |
+| `pass_through` | List[[models.PassThroughBody](../../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -159,26 +159,29 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.issue_tracking.collection_ticket_comments.get(request={
- "id": "",
- "collection_id": "apideck-io",
- "ticket_id": "",
- "service_id": "salesforce",
- "fields": "id,updated_at",
- })
-
- if res is not None:
- # handle response
- pass
+
+ res = apideck.issue_tracking.collection_ticket_comments.get(id="", collection_id="apideck-io", ticket_id="", service_id="salesforce", fields="id,updated_at")
+
+ while res is not None:
+ # Handle items
+
+ res = res.next()
```
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
-| `request` | [models.IssueTrackingCollectionTicketCommentsOneRequest](../../models/issuetrackingcollectionticketcommentsonerequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
+| Parameter | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
+| `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io |
+| `ticket_id` | *str* | :heavy_check_mark: | ID of the ticket you are acting upon. | |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | |
+| `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | |
+| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: `fields=name,email,addresses.city`
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -210,93 +213,90 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.issue_tracking.collection_ticket_comments.update(request={
- "id": "",
- "collection_id": "apideck-io",
- "ticket_id": "",
- "collection_ticket_comment": {
- "body": "What internet provider do you use?",
- "pass_through": [
+
+ res = apideck.issue_tracking.collection_ticket_comments.update(id="", collection_id="apideck-io", ticket_id="", service_id="salesforce", body="What internet provider do you use?", pass_through=[
+ {
+ "service_id": "",
+ "extend_paths": [
{
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
- },
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
- },
+ },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
- ],
+ },
},
+ ],
+ },
+ {
+ "service_id": "",
+ "extend_paths": [
{
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
- },
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
- ],
+ },
},
+ ],
+ },
+ {
+ "service_id": "",
+ "extend_paths": [
{
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
- },
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
- },
+ },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
- },
+ },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
- ],
+ },
},
],
},
- "service_id": "salesforce",
- })
+ ])
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
-| `request` | [models.IssueTrackingCollectionTicketCommentsUpdateRequest](../../models/issuetrackingcollectionticketcommentsupdaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
+| Parameter | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
+| `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io |
+| `ticket_id` | *str* | :heavy_check_mark: | ID of the ticket you are acting upon. | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `body` | *OptionalNullable[str]* | :heavy_minus_sign: | Body of the comment | What internet provider do you use? |
+| `pass_through` | List[[models.PassThroughBody](../../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -328,25 +328,24 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.issue_tracking.collection_ticket_comments.delete(request={
- "id": "",
- "collection_id": "apideck-io",
- "ticket_id": "",
- "service_id": "salesforce",
- })
- if res is not None:
- # handle response
- pass
+ res = apideck.issue_tracking.collection_ticket_comments.delete(id="", collection_id="apideck-io", ticket_id="", service_id="salesforce")
+
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
-| `request` | [models.IssueTrackingCollectionTicketCommentsDeleteRequest](../../models/issuetrackingcollectionticketcommentsdeleterequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
+| Parameter | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
+| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
+| `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io |
+| `ticket_id` | *str* | :heavy_check_mark: | ID of the ticket you are acting upon. | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
diff --git a/docs/sdks/collectiontickets/README.md b/docs/sdks/collectiontickets/README.md
index 714b58e7..aaa79a49 100644
--- a/docs/sdks/collectiontickets/README.md
+++ b/docs/sdks/collectiontickets/README.md
@@ -27,36 +27,39 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.issue_tracking.collection_tickets.list(request={
- "collection_id": "apideck-io",
- "service_id": "salesforce",
- "sort": {
- "by": apideck_unify.TicketsSortBy.CREATED_AT,
- "direction": apideck_unify.SortDirection.DESC,
- },
- "filter_": {
- "status": [
- "open",
- ],
- },
- "pass_through": {
- "search": "San Francisco",
- },
- "fields": "id,updated_at",
- })
- if res is not None:
- # handle response
- pass
+ res = apideck.issue_tracking.collection_tickets.list(collection_id="apideck-io", service_id="salesforce", sort={
+ "by": apideck_unify.TicketsSortBy.CREATED_AT,
+ "direction": apideck_unify.SortDirection.DESC,
+ }, filter_={
+ "status": [
+ "open",
+ ],
+ }, pass_through={
+ "search": "San Francisco",
+ }, fields="id,updated_at")
+
+ while res is not None:
+ # Handle items
+
+ res = res.next()
```
### Parameters
-| Parameter | Type | Required | Description |
-| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
-| `request` | [models.IssueTrackingCollectionTicketsAllRequest](../../models/issuetrackingcollectionticketsallrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
+| Parameter | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | |
+| `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | |
+| `sort` | [Optional[models.TicketsSort]](../../models/ticketssort.md) | :heavy_minus_sign: | Apply sorting | {
"by": "created_at",
"direction": "desc"
} |
+| `filter_` | [Optional[models.IssuesFilter]](../../models/issuesfilter.md) | :heavy_minus_sign: | Apply filters | {
"status": [
"open"
]
} |
+| `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} |
+| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: `fields=name,email,addresses.city`
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -90,59 +93,57 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.issue_tracking.collection_tickets.create(collection_id="apideck-io", ticket={
- "parent_id": "12345",
- "type": "Technical",
- "subject": "Technical Support Request",
- "description": "I am facing issues with my internet connection",
- "status": "open",
- "priority": apideck_unify.Priority.HIGH,
- "assignees": [
- {
- "id": "12345",
- },
- ],
- "due_date": dateutil.parser.isoparse("2020-09-30T07:43:32.000Z"),
- "tags": [
- {
- "id": "12345",
- },
- {
- "id": "12345",
- },
- ],
- "pass_through": [
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+
+ res = apideck.issue_tracking.collection_tickets.create(collection_id="apideck-io", service_id="salesforce", parent_id="12345", type_="Technical", subject="Technical Support Request", description="I am facing issues with my internet connection", status="open", priority=apideck_unify.Priority.HIGH, assignees=[
+ {
+ "id": "12345",
+ },
+ ], due_date=dateutil.parser.isoparse("2020-09-30T07:43:32.000Z"), tags=[
+ {
+ "id": "12345",
+ },
+ {
+ "id": "12345",
+ },
+ ], pass_through=[
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- ],
- }, service_id="salesforce")
+ },
+ ],
+ },
+ ])
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description | Example |
-| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io |
-| `ticket` | [models.TicketInput](../../models/ticketinput.md) | :heavy_check_mark: | N/A | |
-| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
-| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
+| Parameter | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `parent_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ticket's parent ID | 12345 |
+| `type` | *OptionalNullable[str]* | :heavy_minus_sign: | The ticket's type | Technical |
+| `subject` | *OptionalNullable[str]* | :heavy_minus_sign: | Subject of the ticket | Technical Support Request |
+| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | The ticket's description. HTML version of description is mapped if supported by the third-party platform | I am facing issues with my internet connection |
+| `status` | *OptionalNullable[str]* | :heavy_minus_sign: | The current status of the ticket. Possible values include: open, in_progress, closed, or - in cases where there is no clear mapping - the original value passed through. | open |
+| `priority` | [OptionalNullable[models.Priority]](../../models/priority.md) | :heavy_minus_sign: | Priority of the ticket | high |
+| `assignees` | List[[models.AssigneeInput](../../models/assigneeinput.md)] | :heavy_minus_sign: | N/A | |
+| `due_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Due date of the ticket | 2020-09-30T07:43:32.000Z |
+| `tags` | List[[models.CollectionTagInput](../../models/collectiontaginput.md)] | :heavy_minus_sign: | N/A | |
+| `pass_through` | List[[models.PassThroughBody](../../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -174,25 +175,24 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.issue_tracking.collection_tickets.get(request={
- "ticket_id": "",
- "collection_id": "apideck-io",
- "service_id": "salesforce",
- "fields": "id,updated_at",
- })
- if res is not None:
- # handle response
- pass
+ res = apideck.issue_tracking.collection_tickets.get(ticket_id="", collection_id="apideck-io", service_id="salesforce", fields="id,updated_at")
+
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description |
-| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
-| `request` | [models.IssueTrackingCollectionTicketsOneRequest](../../models/issuetrackingcollectionticketsonerequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
+| Parameter | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `ticket_id` | *str* | :heavy_check_mark: | ID of the ticket you are acting upon. | |
+| `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: `fields=name,email,addresses.city`
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -226,83 +226,80 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.issue_tracking.collection_tickets.update(request={
- "ticket_id": "",
- "collection_id": "apideck-io",
- "ticket": {
- "parent_id": "12345",
- "type": "Technical",
- "subject": "Technical Support Request",
- "description": "I am facing issues with my internet connection",
- "status": "open",
- "priority": apideck_unify.Priority.HIGH,
- "assignees": [
- {
- "id": "12345",
- },
- {
- "id": "12345",
- },
- {
- "id": "12345",
- },
- ],
- "due_date": dateutil.parser.isoparse("2020-09-30T07:43:32.000Z"),
- "tags": [
+
+ res = apideck.issue_tracking.collection_tickets.update(ticket_id="", collection_id="apideck-io", service_id="salesforce", parent_id="12345", type_="Technical", subject="Technical Support Request", description="I am facing issues with my internet connection", status="open", priority=apideck_unify.Priority.HIGH, assignees=[
+ {
+ "id": "12345",
+ },
+ {
+ "id": "12345",
+ },
+ {
+ "id": "12345",
+ },
+ ], due_date=dateutil.parser.isoparse("2020-09-30T07:43:32.000Z"), tags=[
+ {
+ "id": "12345",
+ },
+ {
+ "id": "12345",
+ },
+ ], pass_through=[
+ {
+ "service_id": "",
+ "extend_paths": [
{
- "id": "12345",
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
+ },
+ },
},
{
- "id": "12345",
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
+ },
+ },
},
- ],
- "pass_through": [
{
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
- },
- },
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
- },
- },
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
- },
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
- ],
+ },
},
],
},
- "service_id": "salesforce",
- })
+ ])
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description |
-| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
-| `request` | [models.IssueTrackingCollectionTicketsUpdateRequest](../../models/issuetrackingcollectionticketsupdaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
+| Parameter | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `ticket_id` | *str* | :heavy_check_mark: | ID of the ticket you are acting upon. | |
+| `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `parent_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ticket's parent ID | 12345 |
+| `type` | *OptionalNullable[str]* | :heavy_minus_sign: | The ticket's type | Technical |
+| `subject` | *OptionalNullable[str]* | :heavy_minus_sign: | Subject of the ticket | Technical Support Request |
+| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | The ticket's description. HTML version of description is mapped if supported by the third-party platform | I am facing issues with my internet connection |
+| `status` | *OptionalNullable[str]* | :heavy_minus_sign: | The current status of the ticket. Possible values include: open, in_progress, closed, or - in cases where there is no clear mapping - the original value passed through. | open |
+| `priority` | [OptionalNullable[models.Priority]](../../models/priority.md) | :heavy_minus_sign: | Priority of the ticket | high |
+| `assignees` | List[[models.AssigneeInput](../../models/assigneeinput.md)] | :heavy_minus_sign: | N/A | |
+| `due_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Due date of the ticket | 2020-09-30T07:43:32.000Z |
+| `tags` | List[[models.CollectionTagInput](../../models/collectiontaginput.md)] | :heavy_minus_sign: | N/A | |
+| `pass_through` | List[[models.PassThroughBody](../../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -334,11 +331,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.issue_tracking.collection_tickets.delete(ticket_id="", collection_id="apideck-io", service_id="salesforce")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
diff --git a/docs/sdks/collectionusers/README.md b/docs/sdks/collectionusers/README.md
index 5fb21e8c..8cfe12c9 100644
--- a/docs/sdks/collectionusers/README.md
+++ b/docs/sdks/collectionusers/README.md
@@ -23,27 +23,30 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.issue_tracking.collection_users.list(request={
- "collection_id": "apideck-io",
- "service_id": "salesforce",
- "pass_through": {
- "search": "San Francisco",
- },
- "fields": "id,updated_at",
- })
-
- if res is not None:
- # handle response
- pass
+
+ res = apideck.issue_tracking.collection_users.list(collection_id="apideck-io", service_id="salesforce", pass_through={
+ "search": "San Francisco",
+ }, fields="id,updated_at")
+
+ while res is not None:
+ # Handle items
+
+ res = res.next()
```
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
-| `request` | [models.IssueTrackingCollectionUsersAllRequest](../../models/issuetrackingcollectionusersallrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
+| Parameter | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | |
+| `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | |
+| `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} |
+| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: `fields=name,email,addresses.city`
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -75,25 +78,24 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.issue_tracking.collection_users.get(request={
- "collection_id": "apideck-io",
- "id": "",
- "service_id": "salesforce",
- "fields": "id,updated_at",
- })
- if res is not None:
- # handle response
- pass
+ res = apideck.issue_tracking.collection_users.get(collection_id="apideck-io", id="", service_id="salesforce", fields="id,updated_at")
+
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
-| `request` | [models.IssueTrackingCollectionUsersOneRequest](../../models/issuetrackingcollectionusersonerequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
+| Parameter | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `collection_id` | *str* | :heavy_check_mark: | The collection ID | apideck-io |
+| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: `fields=name,email,addresses.city`
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
diff --git a/docs/sdks/companies/README.md b/docs/sdks/companies/README.md
index 438987a2..8c5c3150 100644
--- a/docs/sdks/companies/README.md
+++ b/docs/sdks/companies/README.md
@@ -27,33 +27,36 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.crm.companies.list(request={
- "service_id": "salesforce",
- "filter_": {
- "name": "SpaceX",
- },
- "sort": {
- "by": apideck_unify.CompaniesSortBy.CREATED_AT,
- "direction": apideck_unify.SortDirection.DESC,
- },
- "pass_through": {
- "search": "San Francisco",
- },
- "fields": "id,updated_at",
- })
- if res is not None:
- # handle response
- pass
+ res = apideck.crm.companies.list(service_id="salesforce", filter_={
+ "name": "SpaceX",
+ }, sort={
+ "by": apideck_unify.CompaniesSortBy.CREATED_AT,
+ "direction": apideck_unify.SortDirection.DESC,
+ }, pass_through={
+ "search": "San Francisco",
+ }, fields="id,updated_at")
+
+ while res is not None:
+ # Handle items
+
+ res = res.next()
```
### Parameters
-| Parameter | Type | Required | Description |
-| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
-| `request` | [models.CrmCompaniesAllRequest](../../models/crmcompaniesallrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
+| Parameter | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | |
+| `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | |
+| `filter_` | [Optional[models.CompaniesFilter]](../../models/companiesfilter.md) | :heavy_minus_sign: | Apply filters | {
"name": "SpaceX"
} |
+| `sort` | [Optional[models.CompaniesSort]](../../models/companiessort.md) | :heavy_minus_sign: | Apply sorting | {
"by": "created_at",
"direction": "desc"
} |
+| `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} |
+| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: `fields=name,email,addresses.city`
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -87,242 +90,240 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.crm.companies.create(company={
- "name": "SpaceX",
- "owner_id": "12345",
- "image": "https://www.spacex.com/static/images/share.jpg",
- "description": "Space Exploration Technologies Corp. is an American aerospace manufacturer, space transportation services and communications company headquartered in Hawthorne, California.",
- "vat_number": "BE0689615164",
- "currency": apideck_unify.Currency.USD,
- "status": "Open",
- "fax": "+12129876543",
- "annual_revenue": "+$35m",
- "number_of_employees": "500-1000",
- "industry": "Apparel",
- "ownership": "Public",
- "sales_tax_number": "12456EN",
- "payee_number": "78932EN",
- "abn_or_tfn": "46 115 614 695",
- "abn_branch": "123",
- "acn": "XXX XXX XXX",
- "first_name": "Elon",
- "last_name": "Musk",
- "bank_accounts": [
- {
- "bank_name": "Monzo",
- "account_number": "123465",
- "account_name": "SPACEX LLC",
- "account_type": apideck_unify.AccountType.CREDIT_CARD,
- "iban": "CH2989144532982975332",
- "bic": "AUDSCHGGXXX",
- "routing_number": "012345678",
- "bsb_number": "062-001",
- "branch_identifier": "001",
- "bank_code": "BNH",
- "currency": apideck_unify.Currency.USD,
- },
- ],
- "websites": [
- {
- "url": "http://example.com",
- "id": "12345",
- "type": apideck_unify.WebsiteType.PRIMARY,
- },
- {
- "url": "http://example.com",
- "id": "12345",
- "type": apideck_unify.WebsiteType.PRIMARY,
- },
- ],
- "addresses": [
- {
- "id": "123",
- "type": apideck_unify.Type.PRIMARY,
- "string": "25 Spring Street, Blackburn, VIC 3130",
- "name": "HQ US",
- "line1": "Main street",
- "line2": "apt #",
- "line3": "Suite #",
- "line4": "delivery instructions",
- "street_number": "25",
- "city": "San Francisco",
- "state": "CA",
- "postal_code": "94104",
- "country": "US",
- "latitude": "40.759211",
- "longitude": "-73.984638",
- "county": "Santa Clara",
- "contact_name": "Elon Musk",
- "salutation": "Mr",
- "phone_number": "111-111-1111",
- "fax": "122-111-1111",
- "email": "elon@musk.com",
- "website": "https://elonmusk.com",
- "notes": "Address notes or delivery instructions.",
- "row_version": "1-12345",
- },
- ],
- "social_links": [
- {
- "url": "https://www.twitter.com/apideck",
- "id": "12345",
- "type": "twitter",
- },
- ],
- "phone_numbers": [
- {
- "number": "111-111-1111",
- "id": "12345",
- "country_code": "1",
- "area_code": "323",
- "extension": "105",
- "type": apideck_unify.PhoneNumberType.PRIMARY,
- },
- ],
- "emails": [
- {
- "email": "elon@musk.com",
- "id": "123",
- "type": apideck_unify.EmailType.PRIMARY,
- },
- {
- "email": "elon@musk.com",
- "id": "123",
- "type": apideck_unify.EmailType.PRIMARY,
- },
- {
- "email": "elon@musk.com",
- "id": "123",
- "type": apideck_unify.EmailType.PRIMARY,
- },
- ],
- "row_type": {
+
+ res = apideck.crm.companies.create(name="SpaceX", service_id="salesforce", owner_id="12345", image="https://www.spacex.com/static/images/share.jpg", description="Space Exploration Technologies Corp. is an American aerospace manufacturer, space transportation services and communications company headquartered in Hawthorne, California.", vat_number="BE0689615164", currency=apideck_unify.Currency.USD, status="Open", fax="+12129876543", annual_revenue="+$35m", number_of_employees="500-1000", industry="Apparel", ownership="Public", sales_tax_number="12456EN", payee_number="78932EN", abn_or_tfn="46 115 614 695", abn_branch="123", acn="XXX XXX XXX", first_name="Elon", last_name="Musk", bank_accounts=[
+ {
+ "bank_name": "Monzo",
+ "account_number": "123465",
+ "account_name": "SPACEX LLC",
+ "account_type": apideck_unify.AccountType.CREDIT_CARD,
+ "iban": "CH2989144532982975332",
+ "bic": "AUDSCHGGXXX",
+ "routing_number": "012345678",
+ "bsb_number": "062-001",
+ "branch_identifier": "001",
+ "bank_code": "BNH",
+ "currency": apideck_unify.Currency.USD,
+ },
+ ], websites=[
+ {
+ "url": "http://example.com",
+ "id": "12345",
+ "type": apideck_unify.WebsiteType.PRIMARY,
+ },
+ {
+ "url": "http://example.com",
"id": "12345",
- "name": "Customer Account",
+ "type": apideck_unify.WebsiteType.PRIMARY,
},
- "custom_fields": [
- {
- "id": "2389328923893298",
- "name": "employee_level",
- "description": "Employee Level",
- "value": "Uses Salesforce and Marketo",
- },
- {
- "id": "2389328923893298",
- "name": "employee_level",
- "description": "Employee Level",
- "value": 10,
- },
- {
- "id": "2389328923893298",
- "name": "employee_level",
- "description": "Employee Level",
- "value": "Uses Salesforce and Marketo",
- },
- ],
- "tags": [
- "New",
- ],
- "read_only": False,
- "salutation": "Mr",
- "birthday": dateutil.parser.parse("2000-08-12").date(),
- "pass_through": [
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ ], addresses=[
+ {
+ "id": "123",
+ "type": apideck_unify.Type.PRIMARY,
+ "string": "25 Spring Street, Blackburn, VIC 3130",
+ "name": "HQ US",
+ "line1": "Main street",
+ "line2": "apt #",
+ "line3": "Suite #",
+ "line4": "delivery instructions",
+ "street_number": "25",
+ "city": "San Francisco",
+ "state": "CA",
+ "postal_code": "94104",
+ "country": "US",
+ "latitude": "40.759211",
+ "longitude": "-73.984638",
+ "county": "Santa Clara",
+ "contact_name": "Elon Musk",
+ "salutation": "Mr",
+ "phone_number": "111-111-1111",
+ "fax": "122-111-1111",
+ "email": "elon@musk.com",
+ "website": "https://elonmusk.com",
+ "notes": "Address notes or delivery instructions.",
+ "row_version": "1-12345",
+ },
+ ], social_links=[
+ {
+ "url": "https://www.twitter.com/apideck",
+ "id": "12345",
+ "type": "twitter",
+ },
+ ], phone_numbers=[
+ {
+ "number": "111-111-1111",
+ "id": "12345",
+ "country_code": "1",
+ "area_code": "323",
+ "extension": "105",
+ "type": apideck_unify.PhoneNumberType.PRIMARY,
+ },
+ ], emails=[
+ {
+ "email": "elon@musk.com",
+ "id": "123",
+ "type": apideck_unify.EmailType.PRIMARY,
+ },
+ {
+ "email": "elon@musk.com",
+ "id": "123",
+ "type": apideck_unify.EmailType.PRIMARY,
+ },
+ {
+ "email": "elon@musk.com",
+ "id": "123",
+ "type": apideck_unify.EmailType.PRIMARY,
+ },
+ ], row_type={
+ "id": "12345",
+ "name": "Customer Account",
+ }, custom_fields=[
+ {
+ "id": "2389328923893298",
+ "name": "employee_level",
+ "description": "Employee Level",
+ "value": "Uses Salesforce and Marketo",
+ },
+ {
+ "id": "2389328923893298",
+ "name": "employee_level",
+ "description": "Employee Level",
+ "value": 10,
+ },
+ {
+ "id": "2389328923893298",
+ "name": "employee_level",
+ "description": "Employee Level",
+ "value": "Uses Salesforce and Marketo",
+ },
+ ], tags=[
+ "New",
+ ], read_only=False, salutation="Mr", birthday=dateutil.parser.parse("2000-08-12").date(), pass_through=[
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ ],
+ },
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ ],
+ },
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- ],
- }, service_id="salesforce")
+ },
+ ],
+ },
+ ])
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description | Example |
-| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| `company` | [models.CompanyInput](../../models/companyinput.md) | :heavy_check_mark: | N/A | |
-| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
-| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
+| Parameter | Type | Required | Description | Example |
+| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `name` | *Nullable[str]* | :heavy_check_mark: | Name of the company | SpaceX |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `owner_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Owner ID | 12345 |
+| `image` | *OptionalNullable[str]* | :heavy_minus_sign: | The Image URL of the company | https://www.spacex.com/static/images/share.jpg |
+| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | A description of the company | Space Exploration Technologies Corp. is an American aerospace manufacturer, space transportation services and communications company headquartered in Hawthorne, California. |
+| `vat_number` | *OptionalNullable[str]* | :heavy_minus_sign: | The VAT number of the company | BE0689615164 |
+| `currency` | [OptionalNullable[models.Currency]](../../models/currency.md) | :heavy_minus_sign: | Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). | USD |
+| `status` | *OptionalNullable[str]* | :heavy_minus_sign: | The status of the company | Open |
+| `fax` | *OptionalNullable[str]* | :heavy_minus_sign: | The fax number of the company | +12129876543 |
+| `annual_revenue` | *OptionalNullable[str]* | :heavy_minus_sign: | The annual revenue of the company | +$35m |
+| `number_of_employees` | *OptionalNullable[str]* | :heavy_minus_sign: | Number of employees | 500-1000 |
+| `industry` | *OptionalNullable[str]* | :heavy_minus_sign: | The industry represents the type of business the company is in. | Apparel |
+| `ownership` | *OptionalNullable[str]* | :heavy_minus_sign: | The ownership indicates the type of ownership of the company. | Public |
+| `sales_tax_number` | *OptionalNullable[str]* | :heavy_minus_sign: | A sales tax number is a unique number that identifies a company for tax purposes. | 12456EN |
+| `payee_number` | *OptionalNullable[str]* | :heavy_minus_sign: | A payee number is a unique number that identifies a payee for tax purposes. | 78932EN |
+| `abn_or_tfn` | *OptionalNullable[str]* | :heavy_minus_sign: | An ABN is necessary for operating a business, while a TFN (Tax File Number) is required for any person working in Australia. | 46 115 614 695 |
+| `abn_branch` | *OptionalNullable[str]* | :heavy_minus_sign: | An ABN Branch (also known as a GST Branch) is used if part of your business needs to account for GST separately from its parent entity. | 123 |
+| `acn` | *OptionalNullable[str]* | :heavy_minus_sign: | The Australian Company Number (ACN) is a nine digit number with the last digit being a check digit calculated using a modified modulus 10 calculation. ASIC has adopted a convention of always printing and displaying the ACN in the format XXX XXX XXX; three blocks of three characters, each block separated by a blank. | XXX XXX XXX |
+| `first_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The first name of the person. | Elon |
+| `last_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The last name of the person. | Musk |
+| `bank_accounts` | List[[models.BankAccount](../../models/bankaccount.md)] | :heavy_minus_sign: | N/A | |
+| `websites` | List[[models.Website](../../models/website.md)] | :heavy_minus_sign: | N/A | |
+| `addresses` | List[[models.Address](../../models/address.md)] | :heavy_minus_sign: | N/A | |
+| `social_links` | List[[models.SocialLink](../../models/sociallink.md)] | :heavy_minus_sign: | N/A | |
+| `phone_numbers` | List[[models.PhoneNumber](../../models/phonenumber.md)] | :heavy_minus_sign: | N/A | |
+| `emails` | List[[models.Email](../../models/email.md)] | :heavy_minus_sign: | N/A | |
+| `row_type` | [Optional[models.CompanyRowType]](../../models/companyrowtype.md) | :heavy_minus_sign: | N/A | |
+| `custom_fields` | List[[models.CustomField](../../models/customfield.md)] | :heavy_minus_sign: | N/A | |
+| `tags` | List[*str*] | :heavy_minus_sign: | N/A | [
"New"
] |
+| `read_only` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether the company is read-only or not | false |
+| `salutation` | *OptionalNullable[str]* | :heavy_minus_sign: | A formal salutation for the person. For example, 'Mr', 'Mrs' | Mr |
+| `birthday` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The date of birth of the person. | 2000-08-12 |
+| `pass_through` | List[[models.PassThroughBody](../../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -354,11 +355,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.crm.companies.get(id="", service_id="salesforce", fields="id,updated_at")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
@@ -404,210 +405,208 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.crm.companies.update(id="", company={
- "name": "SpaceX",
- "owner_id": "12345",
- "image": "https://www.spacex.com/static/images/share.jpg",
- "description": "Space Exploration Technologies Corp. is an American aerospace manufacturer, space transportation services and communications company headquartered in Hawthorne, California.",
- "vat_number": "BE0689615164",
- "currency": apideck_unify.Currency.USD,
- "status": "Open",
- "fax": "+12129876543",
- "annual_revenue": "+$35m",
- "number_of_employees": "500-1000",
- "industry": "Apparel",
- "ownership": "Public",
- "sales_tax_number": "12456EN",
- "payee_number": "78932EN",
- "abn_or_tfn": "46 115 614 695",
- "abn_branch": "123",
- "acn": "XXX XXX XXX",
- "first_name": "Elon",
- "last_name": "Musk",
- "bank_accounts": [
- {
- "bank_name": "Monzo",
- "account_number": "123465",
- "account_name": "SPACEX LLC",
- "account_type": apideck_unify.AccountType.CREDIT_CARD,
- "iban": "CH2989144532982975332",
- "bic": "AUDSCHGGXXX",
- "routing_number": "012345678",
- "bsb_number": "062-001",
- "branch_identifier": "001",
- "bank_code": "BNH",
- "currency": apideck_unify.Currency.USD,
- },
- {
- "bank_name": "Monzo",
- "account_number": "123465",
- "account_name": "SPACEX LLC",
- "account_type": apideck_unify.AccountType.CREDIT_CARD,
- "iban": "CH2989144532982975332",
- "bic": "AUDSCHGGXXX",
- "routing_number": "012345678",
- "bsb_number": "062-001",
- "branch_identifier": "001",
- "bank_code": "BNH",
- "currency": apideck_unify.Currency.USD,
- },
- {
- "bank_name": "Monzo",
- "account_number": "123465",
- "account_name": "SPACEX LLC",
- "account_type": apideck_unify.AccountType.CREDIT_CARD,
- "iban": "CH2989144532982975332",
- "bic": "AUDSCHGGXXX",
- "routing_number": "012345678",
- "bsb_number": "062-001",
- "branch_identifier": "001",
- "bank_code": "BNH",
- "currency": apideck_unify.Currency.USD,
- },
- ],
- "websites": [
- {
- "url": "http://example.com",
- "id": "12345",
- "type": apideck_unify.WebsiteType.PRIMARY,
- },
- {
- "url": "http://example.com",
- "id": "12345",
- "type": apideck_unify.WebsiteType.PRIMARY,
- },
- ],
- "addresses": [
- {
- "id": "123",
- "type": apideck_unify.Type.PRIMARY,
- "string": "25 Spring Street, Blackburn, VIC 3130",
- "name": "HQ US",
- "line1": "Main street",
- "line2": "apt #",
- "line3": "Suite #",
- "line4": "delivery instructions",
- "street_number": "25",
- "city": "San Francisco",
- "state": "CA",
- "postal_code": "94104",
- "country": "US",
- "latitude": "40.759211",
- "longitude": "-73.984638",
- "county": "Santa Clara",
- "contact_name": "Elon Musk",
- "salutation": "Mr",
- "phone_number": "111-111-1111",
- "fax": "122-111-1111",
- "email": "elon@musk.com",
- "website": "https://elonmusk.com",
- "notes": "Address notes or delivery instructions.",
- "row_version": "1-12345",
- },
- ],
- "social_links": [
- {
- "url": "https://www.twitter.com/apideck",
- "id": "12345",
- "type": "twitter",
- },
- {
- "url": "https://www.twitter.com/apideck",
- "id": "12345",
- "type": "twitter",
- },
- {
- "url": "https://www.twitter.com/apideck",
- "id": "12345",
- "type": "twitter",
- },
- ],
- "phone_numbers": [
- {
- "number": "111-111-1111",
- "id": "12345",
- "country_code": "1",
- "area_code": "323",
- "extension": "105",
- "type": apideck_unify.PhoneNumberType.PRIMARY,
- },
- {
- "number": "111-111-1111",
- "id": "12345",
- "country_code": "1",
- "area_code": "323",
- "extension": "105",
- "type": apideck_unify.PhoneNumberType.PRIMARY,
- },
- ],
- "emails": [
- {
- "email": "elon@musk.com",
- "id": "123",
- "type": apideck_unify.EmailType.PRIMARY,
- },
- ],
- "row_type": {
+
+ res = apideck.crm.companies.update(id="", name="SpaceX", service_id="salesforce", owner_id="12345", image="https://www.spacex.com/static/images/share.jpg", description="Space Exploration Technologies Corp. is an American aerospace manufacturer, space transportation services and communications company headquartered in Hawthorne, California.", vat_number="BE0689615164", currency=apideck_unify.Currency.USD, status="Open", fax="+12129876543", annual_revenue="+$35m", number_of_employees="500-1000", industry="Apparel", ownership="Public", sales_tax_number="12456EN", payee_number="78932EN", abn_or_tfn="46 115 614 695", abn_branch="123", acn="XXX XXX XXX", first_name="Elon", last_name="Musk", bank_accounts=[
+ {
+ "bank_name": "Monzo",
+ "account_number": "123465",
+ "account_name": "SPACEX LLC",
+ "account_type": apideck_unify.AccountType.CREDIT_CARD,
+ "iban": "CH2989144532982975332",
+ "bic": "AUDSCHGGXXX",
+ "routing_number": "012345678",
+ "bsb_number": "062-001",
+ "branch_identifier": "001",
+ "bank_code": "BNH",
+ "currency": apideck_unify.Currency.USD,
+ },
+ {
+ "bank_name": "Monzo",
+ "account_number": "123465",
+ "account_name": "SPACEX LLC",
+ "account_type": apideck_unify.AccountType.CREDIT_CARD,
+ "iban": "CH2989144532982975332",
+ "bic": "AUDSCHGGXXX",
+ "routing_number": "012345678",
+ "bsb_number": "062-001",
+ "branch_identifier": "001",
+ "bank_code": "BNH",
+ "currency": apideck_unify.Currency.USD,
+ },
+ {
+ "bank_name": "Monzo",
+ "account_number": "123465",
+ "account_name": "SPACEX LLC",
+ "account_type": apideck_unify.AccountType.CREDIT_CARD,
+ "iban": "CH2989144532982975332",
+ "bic": "AUDSCHGGXXX",
+ "routing_number": "012345678",
+ "bsb_number": "062-001",
+ "branch_identifier": "001",
+ "bank_code": "BNH",
+ "currency": apideck_unify.Currency.USD,
+ },
+ ], websites=[
+ {
+ "url": "http://example.com",
+ "id": "12345",
+ "type": apideck_unify.WebsiteType.PRIMARY,
+ },
+ {
+ "url": "http://example.com",
+ "id": "12345",
+ "type": apideck_unify.WebsiteType.PRIMARY,
+ },
+ ], addresses=[
+ {
+ "id": "123",
+ "type": apideck_unify.Type.PRIMARY,
+ "string": "25 Spring Street, Blackburn, VIC 3130",
+ "name": "HQ US",
+ "line1": "Main street",
+ "line2": "apt #",
+ "line3": "Suite #",
+ "line4": "delivery instructions",
+ "street_number": "25",
+ "city": "San Francisco",
+ "state": "CA",
+ "postal_code": "94104",
+ "country": "US",
+ "latitude": "40.759211",
+ "longitude": "-73.984638",
+ "county": "Santa Clara",
+ "contact_name": "Elon Musk",
+ "salutation": "Mr",
+ "phone_number": "111-111-1111",
+ "fax": "122-111-1111",
+ "email": "elon@musk.com",
+ "website": "https://elonmusk.com",
+ "notes": "Address notes or delivery instructions.",
+ "row_version": "1-12345",
+ },
+ ], social_links=[
+ {
+ "url": "https://www.twitter.com/apideck",
+ "id": "12345",
+ "type": "twitter",
+ },
+ {
+ "url": "https://www.twitter.com/apideck",
+ "id": "12345",
+ "type": "twitter",
+ },
+ {
+ "url": "https://www.twitter.com/apideck",
"id": "12345",
- "name": "Customer Account",
+ "type": "twitter",
},
- "custom_fields": [
- {
- "id": "2389328923893298",
- "name": "employee_level",
- "description": "Employee Level",
- "value": "Uses Salesforce and Marketo",
- },
- {
- "id": "2389328923893298",
- "name": "employee_level",
- "description": "Employee Level",
- },
- {
- "id": "2389328923893298",
- "name": "employee_level",
- "description": "Employee Level",
- "value": 10,
- },
- ],
- "tags": [
- "New",
- ],
- "read_only": False,
- "salutation": "Mr",
- "birthday": dateutil.parser.parse("2000-08-12").date(),
- "pass_through": [
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ ], phone_numbers=[
+ {
+ "number": "111-111-1111",
+ "id": "12345",
+ "country_code": "1",
+ "area_code": "323",
+ "extension": "105",
+ "type": apideck_unify.PhoneNumberType.PRIMARY,
+ },
+ {
+ "number": "111-111-1111",
+ "id": "12345",
+ "country_code": "1",
+ "area_code": "323",
+ "extension": "105",
+ "type": apideck_unify.PhoneNumberType.PRIMARY,
+ },
+ ], emails=[
+ {
+ "email": "elon@musk.com",
+ "id": "123",
+ "type": apideck_unify.EmailType.PRIMARY,
+ },
+ ], row_type={
+ "id": "12345",
+ "name": "Customer Account",
+ }, custom_fields=[
+ {
+ "id": "2389328923893298",
+ "name": "employee_level",
+ "description": "Employee Level",
+ "value": "Uses Salesforce and Marketo",
+ },
+ {
+ "id": "2389328923893298",
+ "name": "employee_level",
+ "description": "Employee Level",
+ },
+ {
+ "id": "2389328923893298",
+ "name": "employee_level",
+ "description": "Employee Level",
+ "value": 10,
+ },
+ ], tags=[
+ "New",
+ ], read_only=False, salutation="Mr", birthday=dateutil.parser.parse("2000-08-12").date(), pass_through=[
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- ],
- }, service_id="salesforce")
+ },
+ ],
+ },
+ ])
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description | Example |
-| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
-| `company` | [models.CompanyInput](../../models/companyinput.md) | :heavy_check_mark: | N/A | |
-| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
-| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
+| Parameter | Type | Required | Description | Example |
+| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
+| `name` | *Nullable[str]* | :heavy_check_mark: | Name of the company | SpaceX |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `owner_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Owner ID | 12345 |
+| `image` | *OptionalNullable[str]* | :heavy_minus_sign: | The Image URL of the company | https://www.spacex.com/static/images/share.jpg |
+| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | A description of the company | Space Exploration Technologies Corp. is an American aerospace manufacturer, space transportation services and communications company headquartered in Hawthorne, California. |
+| `vat_number` | *OptionalNullable[str]* | :heavy_minus_sign: | The VAT number of the company | BE0689615164 |
+| `currency` | [OptionalNullable[models.Currency]](../../models/currency.md) | :heavy_minus_sign: | Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). | USD |
+| `status` | *OptionalNullable[str]* | :heavy_minus_sign: | The status of the company | Open |
+| `fax` | *OptionalNullable[str]* | :heavy_minus_sign: | The fax number of the company | +12129876543 |
+| `annual_revenue` | *OptionalNullable[str]* | :heavy_minus_sign: | The annual revenue of the company | +$35m |
+| `number_of_employees` | *OptionalNullable[str]* | :heavy_minus_sign: | Number of employees | 500-1000 |
+| `industry` | *OptionalNullable[str]* | :heavy_minus_sign: | The industry represents the type of business the company is in. | Apparel |
+| `ownership` | *OptionalNullable[str]* | :heavy_minus_sign: | The ownership indicates the type of ownership of the company. | Public |
+| `sales_tax_number` | *OptionalNullable[str]* | :heavy_minus_sign: | A sales tax number is a unique number that identifies a company for tax purposes. | 12456EN |
+| `payee_number` | *OptionalNullable[str]* | :heavy_minus_sign: | A payee number is a unique number that identifies a payee for tax purposes. | 78932EN |
+| `abn_or_tfn` | *OptionalNullable[str]* | :heavy_minus_sign: | An ABN is necessary for operating a business, while a TFN (Tax File Number) is required for any person working in Australia. | 46 115 614 695 |
+| `abn_branch` | *OptionalNullable[str]* | :heavy_minus_sign: | An ABN Branch (also known as a GST Branch) is used if part of your business needs to account for GST separately from its parent entity. | 123 |
+| `acn` | *OptionalNullable[str]* | :heavy_minus_sign: | The Australian Company Number (ACN) is a nine digit number with the last digit being a check digit calculated using a modified modulus 10 calculation. ASIC has adopted a convention of always printing and displaying the ACN in the format XXX XXX XXX; three blocks of three characters, each block separated by a blank. | XXX XXX XXX |
+| `first_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The first name of the person. | Elon |
+| `last_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The last name of the person. | Musk |
+| `bank_accounts` | List[[models.BankAccount](../../models/bankaccount.md)] | :heavy_minus_sign: | N/A | |
+| `websites` | List[[models.Website](../../models/website.md)] | :heavy_minus_sign: | N/A | |
+| `addresses` | List[[models.Address](../../models/address.md)] | :heavy_minus_sign: | N/A | |
+| `social_links` | List[[models.SocialLink](../../models/sociallink.md)] | :heavy_minus_sign: | N/A | |
+| `phone_numbers` | List[[models.PhoneNumber](../../models/phonenumber.md)] | :heavy_minus_sign: | N/A | |
+| `emails` | List[[models.Email](../../models/email.md)] | :heavy_minus_sign: | N/A | |
+| `row_type` | [Optional[models.CompanyRowType]](../../models/companyrowtype.md) | :heavy_minus_sign: | N/A | |
+| `custom_fields` | List[[models.CustomField](../../models/customfield.md)] | :heavy_minus_sign: | N/A | |
+| `tags` | List[*str*] | :heavy_minus_sign: | N/A | [
"New"
] |
+| `read_only` | *OptionalNullable[bool]* | :heavy_minus_sign: | Whether the company is read-only or not | false |
+| `salutation` | *OptionalNullable[str]* | :heavy_minus_sign: | A formal salutation for the person. For example, 'Mr', 'Mrs' | Mr |
+| `birthday` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The date of birth of the person. | 2000-08-12 |
+| `pass_through` | List[[models.PassThroughBody](../../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -639,11 +638,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.crm.companies.delete(id="", service_id="salesforce")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
diff --git a/docs/sdks/companyinfosdk/README.md b/docs/sdks/companyinfosdk/README.md
index 6233c747..c85c00dc 100644
--- a/docs/sdks/companyinfosdk/README.md
+++ b/docs/sdks/companyinfosdk/README.md
@@ -22,11 +22,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.accounting.company_info.get(service_id="salesforce", fields="id,updated_at")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
diff --git a/docs/sdks/connectioncustommappings/README.md b/docs/sdks/connectioncustommappings/README.md
index efd4797a..cb0be28a 100644
--- a/docs/sdks/connectioncustommappings/README.md
+++ b/docs/sdks/connectioncustommappings/README.md
@@ -22,11 +22,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.vault.connection_custom_mappings.list(unified_api="crm", service_id="pipedrive", resource="leads", resource_id="1234")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
diff --git a/docs/sdks/connections/README.md b/docs/sdks/connections/README.md
index 94cf39ec..81914c83 100644
--- a/docs/sdks/connections/README.md
+++ b/docs/sdks/connections/README.md
@@ -30,11 +30,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.vault.connections.list(api="crm", configured=True)
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
@@ -76,11 +76,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.vault.connections.get(service_id="pipedrive", unified_api="crm")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
@@ -122,198 +122,196 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.vault.connections.update(service_id="pipedrive", unified_api="crm", connection={
- "enabled": True,
- "settings": {
- "instance_url": "https://eu28.salesforce.com",
- "api_key": "12345xxxxxx",
+
+ res = apideck.vault.connections.update(service_id="pipedrive", unified_api="crm", enabled=True, settings={
+ "instance_url": "https://eu28.salesforce.com",
+ "api_key": "12345xxxxxx",
+ }, metadata={
+ "account": {
+ "name": "My Company",
+ "id": "c01458a5-7276-41ce-bc19-639906b0450a",
},
- "metadata": {
- "account": {
- "name": "My Company",
- "id": "c01458a5-7276-41ce-bc19-639906b0450a",
- },
- "plan": "enterprise",
+ "plan": "enterprise",
+ }, configuration=[
+ {
+ "resource": "leads",
+ "defaults": [
+ {
+ "id": "ProductInterest",
+ "options": [
+ {
+ "id": "1234",
+ "label": "General Channel",
+ "options": [
+ {
+ "label": "General Channel",
+ "value": 12.5,
+ },
+ {
+ "label": "General Channel",
+ "value": [
+ "team",
+ "general",
+ ],
+ },
+ ],
+ },
+ ],
+ "value": "GC5000 series",
+ },
+ {
+ "id": "ProductInterest",
+ "options": [
+ {
+ "label": "General Channel",
+ "value": 123,
+ },
+ {
+ "label": "General Channel",
+ "value": "general",
+ },
+ {
+ "id": "1234",
+ "label": "General Channel",
+ "options": [
+ {
+ "label": "General Channel",
+ "value": 123,
+ },
+ {
+ "label": "General Channel",
+ "value": 12.5,
+ },
+ {
+ "label": "General Channel",
+ "value": True,
+ },
+ ],
+ },
+ ],
+ "value": True,
+ },
+ ],
},
- "configuration": [
- {
- "resource": "leads",
- "defaults": [
- {
- "id": "ProductInterest",
- "options": [
- {
- "id": "1234",
- "label": "General Channel",
- "options": [
- {
- "label": "General Channel",
- "value": 12.5,
- },
- {
- "label": "General Channel",
- "value": [
- "team",
- "general",
- ],
- },
- ],
- },
- ],
- "value": "GC5000 series",
- },
- {
- "id": "ProductInterest",
- "options": [
- {
- "label": "General Channel",
- "value": 123,
- },
- {
- "label": "General Channel",
- "value": "general",
- },
- {
- "id": "1234",
- "label": "General Channel",
- "options": [
- {
- "label": "General Channel",
- "value": 123,
- },
- {
- "label": "General Channel",
- "value": 12.5,
- },
- {
- "label": "General Channel",
- "value": True,
- },
- ],
- },
- ],
- "value": True,
- },
- ],
- },
- {
- "resource": "leads",
- "defaults": [
- {
- "id": "ProductInterest",
- "options": [
- {
- "id": "1234",
- "label": "General Channel",
- "options": [
- {
- "label": "General Channel",
- "value": 12.5,
- },
- ],
- },
- ],
- "value": True,
- },
- ],
- },
- {
- "resource": "leads",
- "defaults": [
- {
- "id": "ProductInterest",
- "options": [
- {
- "id": "1234",
- "label": "General Channel",
- "options": [
- {
- "label": "General Channel",
- "value": 123,
- },
- ],
- },
- ],
- "value": 10,
- },
- {
- "id": "ProductInterest",
- "options": [
- {
- "id": "1234",
- "label": "General Channel",
- "options": [
- {
- "label": "General Channel",
- "value": [
- "team",
- "general",
- ],
- },
- {
- "label": "General Channel",
- "value": True,
- },
- {
- "label": "General Channel",
- "value": 12.5,
- },
- ],
- },
- ],
- "value": 10,
- },
- {
- "id": "ProductInterest",
- "options": [
- {
- "id": "1234",
- "label": "General Channel",
- "options": [
- {
- "label": "General Channel",
- "value": [
- "team",
- "general",
- ],
- },
- {
- "label": "General Channel",
- "value": "general",
- },
- ],
- },
- {
- "label": "General Channel",
- "value": 123,
- },
- ],
- "value": True,
- },
- ],
- },
- ],
- "custom_mappings": [
- {
- "value": "$.root.training.first_aid",
- },
- ],
- })
+ {
+ "resource": "leads",
+ "defaults": [
+ {
+ "id": "ProductInterest",
+ "options": [
+ {
+ "id": "1234",
+ "label": "General Channel",
+ "options": [
+ {
+ "label": "General Channel",
+ "value": 12.5,
+ },
+ ],
+ },
+ ],
+ "value": True,
+ },
+ ],
+ },
+ {
+ "resource": "leads",
+ "defaults": [
+ {
+ "id": "ProductInterest",
+ "options": [
+ {
+ "id": "1234",
+ "label": "General Channel",
+ "options": [
+ {
+ "label": "General Channel",
+ "value": 123,
+ },
+ ],
+ },
+ ],
+ "value": 10,
+ },
+ {
+ "id": "ProductInterest",
+ "options": [
+ {
+ "id": "1234",
+ "label": "General Channel",
+ "options": [
+ {
+ "label": "General Channel",
+ "value": [
+ "team",
+ "general",
+ ],
+ },
+ {
+ "label": "General Channel",
+ "value": True,
+ },
+ {
+ "label": "General Channel",
+ "value": 12.5,
+ },
+ ],
+ },
+ ],
+ "value": 10,
+ },
+ {
+ "id": "ProductInterest",
+ "options": [
+ {
+ "id": "1234",
+ "label": "General Channel",
+ "options": [
+ {
+ "label": "General Channel",
+ "value": [
+ "team",
+ "general",
+ ],
+ },
+ {
+ "label": "General Channel",
+ "value": "general",
+ },
+ ],
+ },
+ {
+ "label": "General Channel",
+ "value": 123,
+ },
+ ],
+ "value": True,
+ },
+ ],
+ },
+ ], custom_mappings=[
+ {
+ "value": "$.root.training.first_aid",
+ },
+ ])
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description | Example |
-| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
-| `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive |
-| `unified_api` | *str* | :heavy_check_mark: | Unified API | crm |
-| `connection` | [models.ConnectionInput](../../models/connectioninput.md) | :heavy_check_mark: | Fields that need to be updated on the resource | |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
+| Parameter | Type | Required | Description | Example |
+| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
+| `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive |
+| `unified_api` | *str* | :heavy_check_mark: | Unified API | crm |
+| `enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether the connection is enabled or not. You can enable or disable a connection using the Update Connection API. | true |
+| `settings` | Dict[str, *Any*] | :heavy_minus_sign: | Connection settings. Values will persist to `form_fields` with corresponding id | {
"instance_url": "https://eu28.salesforce.com",
"api_key": "12345xxxxxx"
} |
+| `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Attach your own consumer specific metadata | {
"account": {
"name": "My Company",
"id": "c01458a5-7276-41ce-bc19-639906b0450a"
},
"plan": "enterprise"
} |
+| `configuration` | List[[models.ConnectionConfiguration](../../models/connectionconfiguration.md)] | :heavy_minus_sign: | N/A | |
+| `custom_mappings` | List[[models.CustomMappingInput](../../models/custommappinginput.md)] | :heavy_minus_sign: | List of custom mappings configured for this connection | |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -345,11 +343,13 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.vault.connections.delete(service_id="pipedrive", unified_api="crm")
- if res is not None:
- # handle response
- pass
+ assert res is not None
+
+ # Handle response
+ print(res)
```
@@ -392,34 +392,33 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.vault.connections.imports(service_id="pipedrive", unified_api="crm", connection_import_data={
- "credentials": {
- "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.cThIIoDvwdueQB468K5xDc5633seEFoqwxjF_xSJyQQ",
- "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
- },
- "metadata": {
- "account": {
- "name": "My Company",
- "id": "c01458a5-7276-41ce-bc19-639906b0450a",
- },
- "plan": "enterprise",
+
+ res = apideck.vault.connections.imports(service_id="pipedrive", unified_api="crm", credentials={
+ "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.cThIIoDvwdueQB468K5xDc5633seEFoqwxjF_xSJyQQ",
+ "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
+ }, settings={}, metadata={
+ "account": {
+ "name": "My Company",
+ "id": "c01458a5-7276-41ce-bc19-639906b0450a",
},
+ "plan": "enterprise",
})
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description | Example |
-| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
-| `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive |
-| `unified_api` | *str* | :heavy_check_mark: | Unified API | crm |
-| `connection_import_data` | [models.ConnectionImportData](../../models/connectionimportdata.md) | :heavy_check_mark: | Fields that need to be persisted on the resource | |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
+| Parameter | Type | Required | Description | Example |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive |
+| `unified_api` | *str* | :heavy_check_mark: | Unified API | crm |
+| `credentials` | [Optional[models.Credentials]](../../models/credentials.md) | :heavy_minus_sign: | N/A | {
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
"refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.cThIIoDvwdueQB468K5xDc5633seEFoqwxjF_xSJyQQ"
} |
+| `settings` | [OptionalNullable[models.ConnectionImportDataSettings]](../../models/connectionimportdatasettings.md) | :heavy_minus_sign: | Connection settings. Values will persist to `form_fields` with corresponding id | {
"instance_url": "https://eu28.salesforce.com"
} |
+| `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Attach your own consumer specific metadata | {
"account": {
"name": "My Company",
"id": "c01458a5-7276-41ce-bc19-639906b0450a"
},
"plan": "enterprise"
} |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -457,11 +456,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.vault.connections.token(service_id="pipedrive", unified_api="crm")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
diff --git a/docs/sdks/connectionsettings/README.md b/docs/sdks/connectionsettings/README.md
index bf45d12f..9edb5bd5 100644
--- a/docs/sdks/connectionsettings/README.md
+++ b/docs/sdks/connectionsettings/README.md
@@ -24,11 +24,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.vault.connection_settings.list(unified_api="crm", service_id="pipedrive", resource="leads")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
@@ -71,199 +71,197 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.vault.connection_settings.update(service_id="pipedrive", unified_api="crm", resource="leads", connection={
- "enabled": True,
- "settings": {
- "instance_url": "https://eu28.salesforce.com",
- "api_key": "12345xxxxxx",
+
+ res = apideck.vault.connection_settings.update(service_id="pipedrive", unified_api="crm", resource="leads", enabled=True, settings={
+ "instance_url": "https://eu28.salesforce.com",
+ "api_key": "12345xxxxxx",
+ }, metadata={
+ "account": {
+ "name": "My Company",
+ "id": "c01458a5-7276-41ce-bc19-639906b0450a",
+ },
+ "plan": "enterprise",
+ }, configuration=[
+ {
+ "resource": "leads",
+ "defaults": [
+ {
+ "id": "ProductInterest",
+ "options": [
+ {
+ "id": "1234",
+ "label": "General Channel",
+ "options": [
+ {
+ "label": "General Channel",
+ "value": 12.5,
+ },
+ {
+ "label": "General Channel",
+ "value": [
+ "team",
+ "general",
+ ],
+ },
+ ],
+ },
+ ],
+ "value": "GC5000 series",
+ },
+ {
+ "id": "ProductInterest",
+ "options": [
+ {
+ "label": "General Channel",
+ "value": 123,
+ },
+ {
+ "label": "General Channel",
+ "value": "general",
+ },
+ {
+ "id": "1234",
+ "label": "General Channel",
+ "options": [
+ {
+ "label": "General Channel",
+ "value": 123,
+ },
+ {
+ "label": "General Channel",
+ "value": 12.5,
+ },
+ {
+ "label": "General Channel",
+ "value": True,
+ },
+ ],
+ },
+ ],
+ "value": True,
+ },
+ ],
},
- "metadata": {
- "account": {
- "name": "My Company",
- "id": "c01458a5-7276-41ce-bc19-639906b0450a",
- },
- "plan": "enterprise",
+ {
+ "resource": "leads",
+ "defaults": [
+ {
+ "id": "ProductInterest",
+ "options": [
+ {
+ "id": "1234",
+ "label": "General Channel",
+ "options": [
+ {
+ "label": "General Channel",
+ "value": 12.5,
+ },
+ ],
+ },
+ ],
+ "value": True,
+ },
+ ],
},
- "configuration": [
- {
- "resource": "leads",
- "defaults": [
- {
- "id": "ProductInterest",
- "options": [
- {
- "id": "1234",
- "label": "General Channel",
- "options": [
- {
- "label": "General Channel",
- "value": 12.5,
- },
- {
- "label": "General Channel",
- "value": [
- "team",
- "general",
- ],
- },
- ],
- },
- ],
- "value": "GC5000 series",
- },
- {
- "id": "ProductInterest",
- "options": [
- {
- "label": "General Channel",
- "value": 123,
- },
- {
- "label": "General Channel",
- "value": "general",
- },
- {
- "id": "1234",
- "label": "General Channel",
- "options": [
- {
- "label": "General Channel",
- "value": 123,
- },
- {
- "label": "General Channel",
- "value": 12.5,
- },
- {
- "label": "General Channel",
- "value": True,
- },
- ],
- },
- ],
- "value": True,
- },
- ],
- },
- {
- "resource": "leads",
- "defaults": [
- {
- "id": "ProductInterest",
- "options": [
- {
- "id": "1234",
- "label": "General Channel",
- "options": [
- {
- "label": "General Channel",
- "value": 12.5,
- },
- ],
- },
- ],
- "value": True,
- },
- ],
- },
- {
- "resource": "leads",
- "defaults": [
- {
- "id": "ProductInterest",
- "options": [
- {
- "id": "1234",
- "label": "General Channel",
- "options": [
- {
- "label": "General Channel",
- "value": 123,
- },
- ],
- },
- ],
- "value": 10,
- },
- {
- "id": "ProductInterest",
- "options": [
- {
- "id": "1234",
- "label": "General Channel",
- "options": [
- {
- "label": "General Channel",
- "value": [
- "team",
- "general",
- ],
- },
- {
- "label": "General Channel",
- "value": True,
- },
- {
- "label": "General Channel",
- "value": 12.5,
- },
- ],
- },
- ],
- "value": 10,
- },
- {
- "id": "ProductInterest",
- "options": [
- {
- "id": "1234",
- "label": "General Channel",
- "options": [
- {
- "label": "General Channel",
- "value": [
- "team",
- "general",
- ],
- },
- {
- "label": "General Channel",
- "value": "general",
- },
- ],
- },
- {
- "label": "General Channel",
- "value": 123,
- },
- ],
- "value": True,
- },
- ],
- },
- ],
- "custom_mappings": [
- {
- "value": "$.root.training.first_aid",
- },
- ],
- })
-
- if res is not None:
- # handle response
- pass
+ {
+ "resource": "leads",
+ "defaults": [
+ {
+ "id": "ProductInterest",
+ "options": [
+ {
+ "id": "1234",
+ "label": "General Channel",
+ "options": [
+ {
+ "label": "General Channel",
+ "value": 123,
+ },
+ ],
+ },
+ ],
+ "value": 10,
+ },
+ {
+ "id": "ProductInterest",
+ "options": [
+ {
+ "id": "1234",
+ "label": "General Channel",
+ "options": [
+ {
+ "label": "General Channel",
+ "value": [
+ "team",
+ "general",
+ ],
+ },
+ {
+ "label": "General Channel",
+ "value": True,
+ },
+ {
+ "label": "General Channel",
+ "value": 12.5,
+ },
+ ],
+ },
+ ],
+ "value": 10,
+ },
+ {
+ "id": "ProductInterest",
+ "options": [
+ {
+ "id": "1234",
+ "label": "General Channel",
+ "options": [
+ {
+ "label": "General Channel",
+ "value": [
+ "team",
+ "general",
+ ],
+ },
+ {
+ "label": "General Channel",
+ "value": "general",
+ },
+ ],
+ },
+ {
+ "label": "General Channel",
+ "value": 123,
+ },
+ ],
+ "value": True,
+ },
+ ],
+ },
+ ], custom_mappings=[
+ {
+ "value": "$.root.training.first_aid",
+ },
+ ])
+
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description | Example |
-| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
-| `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive |
-| `unified_api` | *str* | :heavy_check_mark: | Unified API | crm |
-| `resource` | *str* | :heavy_check_mark: | Name of the resource (plural) | leads |
-| `connection` | [models.ConnectionInput](../../models/connectioninput.md) | :heavy_check_mark: | Fields that need to be updated on the resource | |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
+| Parameter | Type | Required | Description | Example |
+| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
+| `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive |
+| `unified_api` | *str* | :heavy_check_mark: | Unified API | crm |
+| `resource` | *str* | :heavy_check_mark: | Name of the resource (plural) | leads |
+| `enabled` | *Optional[bool]* | :heavy_minus_sign: | Whether the connection is enabled or not. You can enable or disable a connection using the Update Connection API. | true |
+| `settings` | Dict[str, *Any*] | :heavy_minus_sign: | Connection settings. Values will persist to `form_fields` with corresponding id | {
"instance_url": "https://eu28.salesforce.com",
"api_key": "12345xxxxxx"
} |
+| `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Attach your own consumer specific metadata | {
"account": {
"name": "My Company",
"id": "c01458a5-7276-41ce-bc19-639906b0450a"
},
"plan": "enterprise"
} |
+| `configuration` | List[[models.ConnectionConfiguration](../../models/connectionconfiguration.md)] | :heavy_minus_sign: | N/A | |
+| `custom_mappings` | List[[models.CustomMappingInput](../../models/custommappinginput.md)] | :heavy_minus_sign: | List of custom mappings configured for this connection | |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
diff --git a/docs/sdks/connectordocs/README.md b/docs/sdks/connectordocs/README.md
index 0f5229fb..efef0043 100644
--- a/docs/sdks/connectordocs/README.md
+++ b/docs/sdks/connectordocs/README.md
@@ -22,11 +22,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.connector.connector_docs.get(id="", doc_id="application_owner+oauth_credentials")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
diff --git a/docs/sdks/connectorresources/README.md b/docs/sdks/connectorresources/README.md
index e4c71d82..ca1efd21 100644
--- a/docs/sdks/connectorresources/README.md
+++ b/docs/sdks/connectorresources/README.md
@@ -23,11 +23,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.connector.connector_resources.get(id="", resource_id="", unified_api=apideck_unify.UnifiedAPIID.CRM)
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
diff --git a/docs/sdks/connectors/README.md b/docs/sdks/connectors/README.md
index af7cdde5..c4a09c50 100644
--- a/docs/sdks/connectors/README.md
+++ b/docs/sdks/connectors/README.md
@@ -24,13 +24,15 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.connector.connectors.list(filter_={
"unified_api": apideck_unify.UnifiedAPIID.FILE_STORAGE,
})
- if res is not None:
- # handle response
- pass
+ while res is not None:
+ # Handle items
+
+ res = res.next()
```
@@ -71,11 +73,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.connector.connectors.get(id="")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
diff --git a/docs/sdks/consumerrequestcounts/README.md b/docs/sdks/consumerrequestcounts/README.md
index b0bafcd3..fcb8c8a0 100644
--- a/docs/sdks/consumerrequestcounts/README.md
+++ b/docs/sdks/consumerrequestcounts/README.md
@@ -23,11 +23,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.vault.consumer_request_counts.list(consumer_id="test_user_id", start_datetime="2021-05-01T12:00:00.000Z", end_datetime="2021-05-30T12:00:00.000Z")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
diff --git a/docs/sdks/consumers/README.md b/docs/sdks/consumers/README.md
index f880d38e..137e6778 100644
--- a/docs/sdks/consumers/README.md
+++ b/docs/sdks/consumers/README.md
@@ -26,28 +26,26 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.vault.consumers.create(request={
- "consumer_id": "test_consumer_id",
- "metadata": {
- "account_name": "SpaceX",
- "user_name": "Elon Musk",
- "email": "elon@musk.com",
- "image": "https://www.spacex.com/static/images/share.jpg",
- },
+
+ res = apideck.vault.consumers.create(consumer_id="test_consumer_id", metadata={
+ "account_name": "SpaceX",
+ "user_name": "Elon Musk",
+ "email": "elon@musk.com",
+ "image": "https://www.spacex.com/static/images/share.jpg",
})
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
-| `request` | [models.ConsumerInput](../../models/consumerinput.md) | :heavy_check_mark: | N/A |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
+| Parameter | Type | Required | Description | Example |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `consumer_id` | *str* | :heavy_check_mark: | Unique consumer identifier. You can freely choose a consumer ID yourself. Most of the time, this is an ID of your internal data model that represents a user or account in your system (for example account:12345). If the consumer doesn't exist yet, Vault will upsert a consumer based on your ID. | test_consumer_id |
+| `metadata` | [Optional[models.ConsumerMetadata]](../../models/consumermetadata.md) | :heavy_minus_sign: | The metadata of the consumer. This is used to display the consumer in the sidebar. This is optional, but recommended. | |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -80,11 +78,13 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.vault.consumers.list()
- if res is not None:
- # handle response
- pass
+ while res is not None:
+ # Handle items
+
+ res = res.next()
```
@@ -127,11 +127,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.vault.consumers.get(consumer_id="test_user_id")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
@@ -172,28 +172,26 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.vault.consumers.update(consumer_id="test_user_id", update_consumer_request={
- "metadata": {
- "account_name": "SpaceX",
- "user_name": "Elon Musk",
- "email": "elon@musk.com",
- "image": "https://www.spacex.com/static/images/share.jpg",
- },
+
+ res = apideck.vault.consumers.update(consumer_id="test_user_id", metadata={
+ "account_name": "SpaceX",
+ "user_name": "Elon Musk",
+ "email": "elon@musk.com",
+ "image": "https://www.spacex.com/static/images/share.jpg",
})
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description | Example |
-| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
-| `consumer_id` | *str* | :heavy_check_mark: | ID of the consumer to return | test_user_id |
-| `update_consumer_request` | [models.UpdateConsumerRequest](../../models/updateconsumerrequest.md) | :heavy_check_mark: | N/A | |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
+| Parameter | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
+| `consumer_id` | *str* | :heavy_check_mark: | ID of the consumer to return | test_user_id |
+| `metadata` | [Optional[models.ConsumerMetadata]](../../models/consumermetadata.md) | :heavy_minus_sign: | The metadata of the consumer. This is used to display the consumer in the sidebar. This is optional, but recommended. | |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -225,11 +223,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.vault.consumers.delete(consumer_id="test_user_id")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
diff --git a/docs/sdks/contacts/README.md b/docs/sdks/contacts/README.md
index d119fcf5..d472dc86 100644
--- a/docs/sdks/contacts/README.md
+++ b/docs/sdks/contacts/README.md
@@ -27,37 +27,40 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.crm.contacts.list(request={
- "service_id": "salesforce",
- "filter_": {
- "first_name": "Elon",
- "last_name": "Musk",
- "email": "elon@tesla.com",
- "company_id": "12345",
- "owner_id": "12345",
- },
- "sort": {
- "by": apideck_unify.ContactsSortBy.CREATED_AT,
- "direction": apideck_unify.SortDirection.DESC,
- },
- "pass_through": {
- "search": "San Francisco",
- },
- "fields": "id,updated_at",
- })
- if res is not None:
- # handle response
- pass
+ res = apideck.crm.contacts.list(service_id="salesforce", filter_={
+ "first_name": "Elon",
+ "last_name": "Musk",
+ "email": "elon@tesla.com",
+ "company_id": "12345",
+ "owner_id": "12345",
+ }, sort={
+ "by": apideck_unify.ContactsSortBy.CREATED_AT,
+ "direction": apideck_unify.SortDirection.DESC,
+ }, pass_through={
+ "search": "San Francisco",
+ }, fields="id,updated_at")
+
+ while res is not None:
+ # Handle items
+
+ res = res.next()
```
### Parameters
-| Parameter | Type | Required | Description |
-| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
-| `request` | [models.CrmContactsAllRequest](../../models/crmcontactsallrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
+| Parameter | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | |
+| `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | |
+| `filter_` | [Optional[models.ContactsFilter]](../../models/contactsfilter.md) | :heavy_minus_sign: | Apply filters | {
"first_name": "Elon",
"last_name": "Musk",
"email": "elon@tesla.com",
"company_id": "12345",
"owner_id": "12345"
} |
+| `sort` | [Optional[models.ContactsSort]](../../models/contactssort.md) | :heavy_minus_sign: | Apply sorting | {
"by": "created_at",
"direction": "desc"
} |
+| `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} |
+| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: `fields=name,email,addresses.city`
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -90,239 +93,238 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.crm.contacts.create(contact={
- "name": "Elon Musk",
- "owner_id": "54321",
- "type": apideck_unify.ContactType.PERSONAL,
- "company_id": "23456",
- "company_name": "23456",
- "lead_id": "34567",
- "first_name": "Elon",
- "middle_name": "D.",
- "last_name": "Musk",
- "prefix": "Mr.",
- "suffix": "PhD",
- "title": "CEO",
- "department": "Engineering",
- "language": "EN",
- "gender": apideck_unify.ContactGender.FEMALE,
- "birthday": "2000-08-12",
- "photo_url": "https://unavatar.io/elon-musk",
- "lead_source": "Cold Call",
- "fax": "+12129876543",
- "description": "Internal champion",
- "current_balance": 10.5,
- "status": "open",
- "active": True,
- "websites": [
- {
- "url": "http://example.com",
- "id": "12345",
- "type": apideck_unify.WebsiteType.PRIMARY,
- },
- ],
- "addresses": [
- {
- "id": "123",
- "type": apideck_unify.Type.PRIMARY,
- "string": "25 Spring Street, Blackburn, VIC 3130",
- "name": "HQ US",
- "line1": "Main street",
- "line2": "apt #",
- "line3": "Suite #",
- "line4": "delivery instructions",
- "street_number": "25",
- "city": "San Francisco",
- "state": "CA",
- "postal_code": "94104",
- "country": "US",
- "latitude": "40.759211",
- "longitude": "-73.984638",
- "county": "Santa Clara",
- "contact_name": "Elon Musk",
- "salutation": "Mr",
- "phone_number": "111-111-1111",
- "fax": "122-111-1111",
- "email": "elon@musk.com",
- "website": "https://elonmusk.com",
- "notes": "Address notes or delivery instructions.",
- "row_version": "1-12345",
- },
- {
- "id": "123",
- "type": apideck_unify.Type.PRIMARY,
- "string": "25 Spring Street, Blackburn, VIC 3130",
- "name": "HQ US",
- "line1": "Main street",
- "line2": "apt #",
- "line3": "Suite #",
- "line4": "delivery instructions",
- "street_number": "25",
- "city": "San Francisco",
- "state": "CA",
- "postal_code": "94104",
- "country": "US",
- "latitude": "40.759211",
- "longitude": "-73.984638",
- "county": "Santa Clara",
- "contact_name": "Elon Musk",
- "salutation": "Mr",
- "phone_number": "111-111-1111",
- "fax": "122-111-1111",
- "email": "elon@musk.com",
- "website": "https://elonmusk.com",
- "notes": "Address notes or delivery instructions.",
- "row_version": "1-12345",
- },
- ],
- "social_links": [
- {
- "url": "https://www.twitter.com/apideck",
- "id": "12345",
- "type": "twitter",
- },
- ],
- "phone_numbers": [
- {
- "number": "111-111-1111",
- "id": "12345",
- "country_code": "1",
- "area_code": "323",
- "extension": "105",
- "type": apideck_unify.PhoneNumberType.PRIMARY,
- },
- ],
- "emails": [
- {
- "email": "elon@musk.com",
- "id": "123",
- "type": apideck_unify.EmailType.PRIMARY,
- },
- ],
- "email_domain": "gmail.com",
- "custom_fields": [
- {
- "id": "2389328923893298",
- "name": "employee_level",
- "description": "Employee Level",
- "value": {},
- },
- {
- "id": "2389328923893298",
- "name": "employee_level",
- "description": "Employee Level",
- "value": 10,
- },
- {
- "id": "2389328923893298",
- "name": "employee_level",
- "description": "Employee Level",
- "value": "Uses Salesforce and Marketo",
- },
- ],
- "tags": [
- "New",
- ],
- "opportunity_ids": [
- "12345",
- ],
- "pass_through": [
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+
+ res = apideck.crm.contacts.create(name="Elon Musk", service_id="salesforce", owner_id="54321", type_=apideck_unify.ContactType.PERSONAL, company_id="23456", company_name="23456", lead_id="34567", first_name="Elon", middle_name="D.", last_name="Musk", prefix="Mr.", suffix="PhD", title="CEO", department="Engineering", language="EN", gender=apideck_unify.ContactGender.FEMALE, birthday="2000-08-12", photo_url="https://unavatar.io/elon-musk", lead_source="Cold Call", fax="+12129876543", description="Internal champion", current_balance=10.5, status="open", active=True, websites=[
+ {
+ "url": "http://example.com",
+ "id": "12345",
+ "type": apideck_unify.WebsiteType.PRIMARY,
+ },
+ ], addresses=[
+ {
+ "id": "123",
+ "type": apideck_unify.Type.PRIMARY,
+ "string": "25 Spring Street, Blackburn, VIC 3130",
+ "name": "HQ US",
+ "line1": "Main street",
+ "line2": "apt #",
+ "line3": "Suite #",
+ "line4": "delivery instructions",
+ "street_number": "25",
+ "city": "San Francisco",
+ "state": "CA",
+ "postal_code": "94104",
+ "country": "US",
+ "latitude": "40.759211",
+ "longitude": "-73.984638",
+ "county": "Santa Clara",
+ "contact_name": "Elon Musk",
+ "salutation": "Mr",
+ "phone_number": "111-111-1111",
+ "fax": "122-111-1111",
+ "email": "elon@musk.com",
+ "website": "https://elonmusk.com",
+ "notes": "Address notes or delivery instructions.",
+ "row_version": "1-12345",
+ },
+ {
+ "id": "123",
+ "type": apideck_unify.Type.PRIMARY,
+ "string": "25 Spring Street, Blackburn, VIC 3130",
+ "name": "HQ US",
+ "line1": "Main street",
+ "line2": "apt #",
+ "line3": "Suite #",
+ "line4": "delivery instructions",
+ "street_number": "25",
+ "city": "San Francisco",
+ "state": "CA",
+ "postal_code": "94104",
+ "country": "US",
+ "latitude": "40.759211",
+ "longitude": "-73.984638",
+ "county": "Santa Clara",
+ "contact_name": "Elon Musk",
+ "salutation": "Mr",
+ "phone_number": "111-111-1111",
+ "fax": "122-111-1111",
+ "email": "elon@musk.com",
+ "website": "https://elonmusk.com",
+ "notes": "Address notes or delivery instructions.",
+ "row_version": "1-12345",
+ },
+ ], social_links=[
+ {
+ "url": "https://www.twitter.com/apideck",
+ "id": "12345",
+ "type": "twitter",
+ },
+ ], phone_numbers=[
+ {
+ "number": "111-111-1111",
+ "id": "12345",
+ "country_code": "1",
+ "area_code": "323",
+ "extension": "105",
+ "type": apideck_unify.PhoneNumberType.PRIMARY,
+ },
+ ], emails=[
+ {
+ "email": "elon@musk.com",
+ "id": "123",
+ "type": apideck_unify.EmailType.PRIMARY,
+ },
+ ], email_domain="gmail.com", custom_fields=[
+ {
+ "id": "2389328923893298",
+ "name": "employee_level",
+ "description": "Employee Level",
+ "value": {},
+ },
+ {
+ "id": "2389328923893298",
+ "name": "employee_level",
+ "description": "Employee Level",
+ "value": 10,
+ },
+ {
+ "id": "2389328923893298",
+ "name": "employee_level",
+ "description": "Employee Level",
+ "value": "Uses Salesforce and Marketo",
+ },
+ ], tags=[
+ "New",
+ ], opportunity_ids=[
+ "12345",
+ ], pass_through=[
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ ],
+ },
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ ],
+ },
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- ],
- }, service_id="salesforce")
+ },
+ ],
+ },
+ ])
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description | Example |
-| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| `contact` | [models.ContactInput](../../models/contactinput.md) | :heavy_check_mark: | N/A | |
-| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
-| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
+| Parameter | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `name` | *Nullable[str]* | :heavy_check_mark: | Full name of the contact. | Elon Musk |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `owner_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The owner of the contact. | 54321 |
+| `type` | [OptionalNullable[models.ContactType]](../../models/contacttype.md) | :heavy_minus_sign: | The type of the contact. | personal |
+| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company the contact is associated with. | 23456 |
+| `company_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The name of the company the contact is associated with. | 23456 |
+| `lead_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The lead the contact is associated with. | 34567 |
+| `first_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The first name of the contact. | Elon |
+| `middle_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The middle name of the contact. | D. |
+| `last_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The last name of the contact. | Musk |
+| `prefix` | *OptionalNullable[str]* | :heavy_minus_sign: | The prefix of the contact. | Mr. |
+| `suffix` | *OptionalNullable[str]* | :heavy_minus_sign: | The suffix of the contact. | PhD |
+| `title` | *OptionalNullable[str]* | :heavy_minus_sign: | The job title of the contact. | CEO |
+| `department` | *OptionalNullable[str]* | :heavy_minus_sign: | The department of the contact. | Engineering |
+| `language` | *OptionalNullable[str]* | :heavy_minus_sign: | language code according to ISO 639-1. For the United States - EN | EN |
+| `gender` | [OptionalNullable[models.ContactGender]](../../models/contactgender.md) | :heavy_minus_sign: | The gender of the contact. | female |
+| `birthday` | *OptionalNullable[str]* | :heavy_minus_sign: | The birthday of the contact. | 2000-08-12 |
+| `image` | *OptionalNullable[str]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | https://unavatar.io/elon-musk |
+| `photo_url` | *OptionalNullable[str]* | :heavy_minus_sign: | The URL of the photo of a person. | https://unavatar.io/elon-musk |
+| `lead_source` | *OptionalNullable[str]* | :heavy_minus_sign: | The lead source of the contact. | Cold Call |
+| `fax` | *OptionalNullable[str]* | :heavy_minus_sign: | The fax number of the contact. | +12129876543 |
+| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | The description of the contact. | Internal champion |
+| `current_balance` | *OptionalNullable[float]* | :heavy_minus_sign: | The current balance of the contact. | 10.5 |
+| `status` | *OptionalNullable[str]* | :heavy_minus_sign: | The status of the contact. | open |
+| `active` | *OptionalNullable[bool]* | :heavy_minus_sign: | The active status of the contact. | true |
+| `websites` | List[[models.Website](../../models/website.md)] | :heavy_minus_sign: | N/A | |
+| `addresses` | List[[models.Address](../../models/address.md)] | :heavy_minus_sign: | N/A | |
+| `social_links` | List[[models.SocialLink](../../models/sociallink.md)] | :heavy_minus_sign: | N/A | |
+| `phone_numbers` | List[[models.PhoneNumber](../../models/phonenumber.md)] | :heavy_minus_sign: | N/A | |
+| `emails` | List[[models.Email](../../models/email.md)] | :heavy_minus_sign: | N/A | |
+| `email_domain` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | gmail.com |
+| `custom_fields` | List[[models.CustomField](../../models/customfield.md)] | :heavy_minus_sign: | N/A | |
+| `tags` | List[*str*] | :heavy_minus_sign: | N/A | [
"New"
] |
+| `opportunity_ids` | List[*str*] | :heavy_minus_sign: | The opportunity ids of the contact. | |
+| `pass_through` | List[[models.PassThroughBody](../../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -354,31 +356,30 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.crm.contacts.get(request={
- "id": "",
- "service_id": "salesforce",
- "fields": "id,updated_at",
- "filter_": {
- "first_name": "Elon",
- "last_name": "Musk",
- "email": "elon@tesla.com",
- "company_id": "12345",
- "owner_id": "12345",
- },
+
+ res = apideck.crm.contacts.get(id="", service_id="salesforce", fields="id,updated_at", filter_={
+ "first_name": "Elon",
+ "last_name": "Musk",
+ "email": "elon@tesla.com",
+ "company_id": "12345",
+ "owner_id": "12345",
})
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description |
-| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
-| `request` | [models.CrmContactsOneRequest](../../models/crmcontactsonerequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
+| Parameter | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: `fields=name,email,addresses.city`
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at |
+| `filter_` | [Optional[models.ContactsFilter]](../../models/contactsfilter.md) | :heavy_minus_sign: | Apply filters | {
"first_name": "Elon",
"last_name": "Musk",
"email": "elon@tesla.com",
"company_id": "12345",
"owner_id": "12345"
} |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -411,219 +412,218 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.crm.contacts.update(id="", contact={
- "name": "Elon Musk",
- "owner_id": "54321",
- "type": apideck_unify.ContactType.PERSONAL,
- "company_id": "23456",
- "company_name": "23456",
- "lead_id": "34567",
- "first_name": "Elon",
- "middle_name": "D.",
- "last_name": "Musk",
- "prefix": "Mr.",
- "suffix": "PhD",
- "title": "CEO",
- "department": "Engineering",
- "language": "EN",
- "gender": apideck_unify.ContactGender.FEMALE,
- "birthday": "2000-08-12",
- "photo_url": "https://unavatar.io/elon-musk",
- "lead_source": "Cold Call",
- "fax": "+12129876543",
- "description": "Internal champion",
- "current_balance": 10.5,
- "status": "open",
- "active": True,
- "websites": [
- {
- "url": "http://example.com",
- "id": "12345",
- "type": apideck_unify.WebsiteType.PRIMARY,
- },
- {
- "url": "http://example.com",
- "id": "12345",
- "type": apideck_unify.WebsiteType.PRIMARY,
- },
- {
- "url": "http://example.com",
- "id": "12345",
- "type": apideck_unify.WebsiteType.PRIMARY,
- },
- ],
- "addresses": [
- {
- "id": "123",
- "type": apideck_unify.Type.PRIMARY,
- "string": "25 Spring Street, Blackburn, VIC 3130",
- "name": "HQ US",
- "line1": "Main street",
- "line2": "apt #",
- "line3": "Suite #",
- "line4": "delivery instructions",
- "street_number": "25",
- "city": "San Francisco",
- "state": "CA",
- "postal_code": "94104",
- "country": "US",
- "latitude": "40.759211",
- "longitude": "-73.984638",
- "county": "Santa Clara",
- "contact_name": "Elon Musk",
- "salutation": "Mr",
- "phone_number": "111-111-1111",
- "fax": "122-111-1111",
- "email": "elon@musk.com",
- "website": "https://elonmusk.com",
- "notes": "Address notes or delivery instructions.",
- "row_version": "1-12345",
- },
- {
- "id": "123",
- "type": apideck_unify.Type.PRIMARY,
- "string": "25 Spring Street, Blackburn, VIC 3130",
- "name": "HQ US",
- "line1": "Main street",
- "line2": "apt #",
- "line3": "Suite #",
- "line4": "delivery instructions",
- "street_number": "25",
- "city": "San Francisco",
- "state": "CA",
- "postal_code": "94104",
- "country": "US",
- "latitude": "40.759211",
- "longitude": "-73.984638",
- "county": "Santa Clara",
- "contact_name": "Elon Musk",
- "salutation": "Mr",
- "phone_number": "111-111-1111",
- "fax": "122-111-1111",
- "email": "elon@musk.com",
- "website": "https://elonmusk.com",
- "notes": "Address notes or delivery instructions.",
- "row_version": "1-12345",
- },
- ],
- "social_links": [
- {
- "url": "https://www.twitter.com/apideck",
- "id": "12345",
- "type": "twitter",
- },
- ],
- "phone_numbers": [
- {
- "number": "111-111-1111",
- "id": "12345",
- "country_code": "1",
- "area_code": "323",
- "extension": "105",
- "type": apideck_unify.PhoneNumberType.PRIMARY,
- },
- {
- "number": "111-111-1111",
- "id": "12345",
- "country_code": "1",
- "area_code": "323",
- "extension": "105",
- "type": apideck_unify.PhoneNumberType.PRIMARY,
- },
- {
- "number": "111-111-1111",
- "id": "12345",
- "country_code": "1",
- "area_code": "323",
- "extension": "105",
- "type": apideck_unify.PhoneNumberType.PRIMARY,
- },
- ],
- "emails": [
- {
- "email": "elon@musk.com",
- "id": "123",
- "type": apideck_unify.EmailType.PRIMARY,
- },
- {
- "email": "elon@musk.com",
- "id": "123",
- "type": apideck_unify.EmailType.PRIMARY,
- },
- ],
- "email_domain": "gmail.com",
- "custom_fields": [
- {
- "id": "2389328923893298",
- "name": "employee_level",
- "description": "Employee Level",
- "value": {},
- },
- ],
- "tags": [
- "New",
- ],
- "opportunity_ids": [
- "12345",
- ],
- "pass_through": [
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+
+ res = apideck.crm.contacts.update(id="", name="Elon Musk", service_id="salesforce", owner_id="54321", type_=apideck_unify.ContactType.PERSONAL, company_id="23456", company_name="23456", lead_id="34567", first_name="Elon", middle_name="D.", last_name="Musk", prefix="Mr.", suffix="PhD", title="CEO", department="Engineering", language="EN", gender=apideck_unify.ContactGender.FEMALE, birthday="2000-08-12", photo_url="https://unavatar.io/elon-musk", lead_source="Cold Call", fax="+12129876543", description="Internal champion", current_balance=10.5, status="open", active=True, websites=[
+ {
+ "url": "http://example.com",
+ "id": "12345",
+ "type": apideck_unify.WebsiteType.PRIMARY,
+ },
+ {
+ "url": "http://example.com",
+ "id": "12345",
+ "type": apideck_unify.WebsiteType.PRIMARY,
+ },
+ {
+ "url": "http://example.com",
+ "id": "12345",
+ "type": apideck_unify.WebsiteType.PRIMARY,
+ },
+ ], addresses=[
+ {
+ "id": "123",
+ "type": apideck_unify.Type.PRIMARY,
+ "string": "25 Spring Street, Blackburn, VIC 3130",
+ "name": "HQ US",
+ "line1": "Main street",
+ "line2": "apt #",
+ "line3": "Suite #",
+ "line4": "delivery instructions",
+ "street_number": "25",
+ "city": "San Francisco",
+ "state": "CA",
+ "postal_code": "94104",
+ "country": "US",
+ "latitude": "40.759211",
+ "longitude": "-73.984638",
+ "county": "Santa Clara",
+ "contact_name": "Elon Musk",
+ "salutation": "Mr",
+ "phone_number": "111-111-1111",
+ "fax": "122-111-1111",
+ "email": "elon@musk.com",
+ "website": "https://elonmusk.com",
+ "notes": "Address notes or delivery instructions.",
+ "row_version": "1-12345",
+ },
+ {
+ "id": "123",
+ "type": apideck_unify.Type.PRIMARY,
+ "string": "25 Spring Street, Blackburn, VIC 3130",
+ "name": "HQ US",
+ "line1": "Main street",
+ "line2": "apt #",
+ "line3": "Suite #",
+ "line4": "delivery instructions",
+ "street_number": "25",
+ "city": "San Francisco",
+ "state": "CA",
+ "postal_code": "94104",
+ "country": "US",
+ "latitude": "40.759211",
+ "longitude": "-73.984638",
+ "county": "Santa Clara",
+ "contact_name": "Elon Musk",
+ "salutation": "Mr",
+ "phone_number": "111-111-1111",
+ "fax": "122-111-1111",
+ "email": "elon@musk.com",
+ "website": "https://elonmusk.com",
+ "notes": "Address notes or delivery instructions.",
+ "row_version": "1-12345",
+ },
+ ], social_links=[
+ {
+ "url": "https://www.twitter.com/apideck",
+ "id": "12345",
+ "type": "twitter",
+ },
+ ], phone_numbers=[
+ {
+ "number": "111-111-1111",
+ "id": "12345",
+ "country_code": "1",
+ "area_code": "323",
+ "extension": "105",
+ "type": apideck_unify.PhoneNumberType.PRIMARY,
+ },
+ {
+ "number": "111-111-1111",
+ "id": "12345",
+ "country_code": "1",
+ "area_code": "323",
+ "extension": "105",
+ "type": apideck_unify.PhoneNumberType.PRIMARY,
+ },
+ {
+ "number": "111-111-1111",
+ "id": "12345",
+ "country_code": "1",
+ "area_code": "323",
+ "extension": "105",
+ "type": apideck_unify.PhoneNumberType.PRIMARY,
+ },
+ ], emails=[
+ {
+ "email": "elon@musk.com",
+ "id": "123",
+ "type": apideck_unify.EmailType.PRIMARY,
+ },
+ {
+ "email": "elon@musk.com",
+ "id": "123",
+ "type": apideck_unify.EmailType.PRIMARY,
+ },
+ ], email_domain="gmail.com", custom_fields=[
+ {
+ "id": "2389328923893298",
+ "name": "employee_level",
+ "description": "Employee Level",
+ "value": {},
+ },
+ ], tags=[
+ "New",
+ ], opportunity_ids=[
+ "12345",
+ ], pass_through=[
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ ],
+ },
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ ],
+ },
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- ],
- }, service_id="salesforce")
+ },
+ ],
+ },
+ ])
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description | Example |
-| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
-| `contact` | [models.ContactInput](../../models/contactinput.md) | :heavy_check_mark: | N/A | |
-| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
-| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
+| Parameter | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
+| `name` | *Nullable[str]* | :heavy_check_mark: | Full name of the contact. | Elon Musk |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `owner_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The owner of the contact. | 54321 |
+| `type` | [OptionalNullable[models.ContactType]](../../models/contacttype.md) | :heavy_minus_sign: | The type of the contact. | personal |
+| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company the contact is associated with. | 23456 |
+| `company_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The name of the company the contact is associated with. | 23456 |
+| `lead_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The lead the contact is associated with. | 34567 |
+| `first_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The first name of the contact. | Elon |
+| `middle_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The middle name of the contact. | D. |
+| `last_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The last name of the contact. | Musk |
+| `prefix` | *OptionalNullable[str]* | :heavy_minus_sign: | The prefix of the contact. | Mr. |
+| `suffix` | *OptionalNullable[str]* | :heavy_minus_sign: | The suffix of the contact. | PhD |
+| `title` | *OptionalNullable[str]* | :heavy_minus_sign: | The job title of the contact. | CEO |
+| `department` | *OptionalNullable[str]* | :heavy_minus_sign: | The department of the contact. | Engineering |
+| `language` | *OptionalNullable[str]* | :heavy_minus_sign: | language code according to ISO 639-1. For the United States - EN | EN |
+| `gender` | [OptionalNullable[models.ContactGender]](../../models/contactgender.md) | :heavy_minus_sign: | The gender of the contact. | female |
+| `birthday` | *OptionalNullable[str]* | :heavy_minus_sign: | The birthday of the contact. | 2000-08-12 |
+| `image` | *OptionalNullable[str]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | https://unavatar.io/elon-musk |
+| `photo_url` | *OptionalNullable[str]* | :heavy_minus_sign: | The URL of the photo of a person. | https://unavatar.io/elon-musk |
+| `lead_source` | *OptionalNullable[str]* | :heavy_minus_sign: | The lead source of the contact. | Cold Call |
+| `fax` | *OptionalNullable[str]* | :heavy_minus_sign: | The fax number of the contact. | +12129876543 |
+| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | The description of the contact. | Internal champion |
+| `current_balance` | *OptionalNullable[float]* | :heavy_minus_sign: | The current balance of the contact. | 10.5 |
+| `status` | *OptionalNullable[str]* | :heavy_minus_sign: | The status of the contact. | open |
+| `active` | *OptionalNullable[bool]* | :heavy_minus_sign: | The active status of the contact. | true |
+| `websites` | List[[models.Website](../../models/website.md)] | :heavy_minus_sign: | N/A | |
+| `addresses` | List[[models.Address](../../models/address.md)] | :heavy_minus_sign: | N/A | |
+| `social_links` | List[[models.SocialLink](../../models/sociallink.md)] | :heavy_minus_sign: | N/A | |
+| `phone_numbers` | List[[models.PhoneNumber](../../models/phonenumber.md)] | :heavy_minus_sign: | N/A | |
+| `emails` | List[[models.Email](../../models/email.md)] | :heavy_minus_sign: | N/A | |
+| `email_domain` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | gmail.com |
+| `custom_fields` | List[[models.CustomField](../../models/customfield.md)] | :heavy_minus_sign: | N/A | |
+| `tags` | List[*str*] | :heavy_minus_sign: | N/A | [
"New"
] |
+| `opportunity_ids` | List[*str*] | :heavy_minus_sign: | The opportunity ids of the contact. | |
+| `pass_through` | List[[models.PassThroughBody](../../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -655,11 +655,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.crm.contacts.delete(id="", service_id="salesforce")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
diff --git a/docs/sdks/createcallback/README.md b/docs/sdks/createcallback/README.md
index ba190639..844b0fac 100644
--- a/docs/sdks/createcallback/README.md
+++ b/docs/sdks/createcallback/README.md
@@ -23,13 +23,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.vault.create_callback.state(service_id="pipedrive", unified_api="crm", create_callback_state={
- "redirect_uri": "https://example.com/callback",
- })
- if res is not None:
- # handle response
- pass
+ res = apideck.vault.create_callback.state(service_id="pipedrive", unified_api="crm", redirect_uri="https://example.com/callback")
+
+ # Handle response
+ print(res)
```
@@ -39,7 +37,7 @@ with Apideck(
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
| `service_id` | *str* | :heavy_check_mark: | Service ID of the resource to return | pipedrive |
| `unified_api` | *str* | :heavy_check_mark: | Unified API | crm |
-| `create_callback_state` | [models.CreateCallbackState](../../models/createcallbackstate.md) | :heavy_check_mark: | Callback state data | |
+| `redirect_uri` | *Optional[str]* | :heavy_minus_sign: | The redirect URI to be used after the connection is created. | https://example.com/callback |
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
diff --git a/docs/sdks/creditnotes/README.md b/docs/sdks/creditnotes/README.md
index da62c94f..40450c50 100644
--- a/docs/sdks/creditnotes/README.md
+++ b/docs/sdks/creditnotes/README.md
@@ -28,33 +28,36 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.accounting.credit_notes.list(request={
- "service_id": "salesforce",
- "filter_": {
- "updated_since": dateutil.parser.isoparse("2020-09-30T07:43:32.000Z"),
- },
- "sort": {
- "by": apideck_unify.CreditNotesSortBy.UPDATED_AT,
- "direction": apideck_unify.SortDirection.DESC,
- },
- "pass_through": {
- "search": "San Francisco",
- },
- "fields": "id,updated_at",
- })
- if res is not None:
- # handle response
- pass
+ res = apideck.accounting.credit_notes.list(service_id="salesforce", filter_={
+ "updated_since": dateutil.parser.isoparse("2020-09-30T07:43:32.000Z"),
+ }, sort={
+ "by": apideck_unify.CreditNotesSortBy.UPDATED_AT,
+ "direction": apideck_unify.SortDirection.DESC,
+ }, pass_through={
+ "search": "San Francisco",
+ }, fields="id,updated_at")
+
+ while res is not None:
+ # Handle items
+
+ res = res.next()
```
### Parameters
-| Parameter | Type | Required | Description |
-| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
-| `request` | [models.AccountingCreditNotesAllRequest](../../models/accountingcreditnotesallrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
+| Parameter | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | |
+| `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | |
+| `filter_` | [Optional[models.CreditNotesFilter]](../../models/creditnotesfilter.md) | :heavy_minus_sign: | Apply filters | {
"updated_since": "2020-09-30T07:43:32.000Z"
} |
+| `sort` | [Optional[models.CreditNotesSort]](../../models/creditnotessort.md) | :heavy_minus_sign: | Apply sorting | {
"by": "updated_at",
"direction": "desc"
} |
+| `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} |
+| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: `fields=name,email,addresses.city`
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -88,278 +91,276 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.accounting.credit_notes.create(credit_note={
- "total_amount": 49.99,
- "number": "OIT00546",
- "customer": {
+
+ res = apideck.accounting.credit_notes.create(total_amount=49.99, service_id="salesforce", number="OIT00546", customer={
+ "id": "12345",
+ "display_name": "Windsurf Shop",
+ "email": "boring@boring.com",
+ }, company_id="12345", currency=apideck_unify.Currency.USD, currency_rate=0.69, tax_inclusive=True, sub_total=27500, total_tax=2500, tax_code="1234", balance=27500, remaining_credit=27500, status=apideck_unify.CreditNoteStatus.AUTHORISED, reference="123456", date_issued=dateutil.parser.isoparse("2021-05-01T12:00:00.000Z"), date_paid=dateutil.parser.isoparse("2021-05-01T12:00:00.000Z"), type_=apideck_unify.CreditNoteType.ACCOUNTS_RECEIVABLE_CREDIT, account={
+ "id": "123456",
+ "nominal_code": "N091",
+ "code": "453",
+ }, line_items=[
+ {
"id": "12345",
- "display_name": "Windsurf Shop",
- "email": "boring@boring.com",
- },
- "company_id": "12345",
- "currency": apideck_unify.Currency.USD,
- "currency_rate": 0.69,
- "tax_inclusive": True,
- "sub_total": 27500,
- "total_tax": 2500,
- "tax_code": "1234",
- "balance": 27500,
- "remaining_credit": 27500,
- "status": apideck_unify.CreditNoteStatus.AUTHORISED,
- "reference": "123456",
- "date_issued": dateutil.parser.isoparse("2021-05-01T12:00:00.000Z"),
- "date_paid": dateutil.parser.isoparse("2021-05-01T12:00:00.000Z"),
- "type": apideck_unify.CreditNoteType.ACCOUNTS_RECEIVABLE_CREDIT,
- "account": {
- "id": "123456",
- "nominal_code": "N091",
- "code": "453",
- },
- "line_items": [
- {
- "id": "12345",
- "row_id": "12345",
+ "row_id": "12345",
+ "code": "120-C",
+ "line_number": 1,
+ "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
+ "type": apideck_unify.InvoiceLineItemType.SALES_ITEM,
+ "tax_amount": 27500,
+ "total_amount": 27500,
+ "quantity": 1,
+ "unit_price": 27500.5,
+ "unit_of_measure": "pc.",
+ "discount_percentage": 0.01,
+ "discount_amount": 19.99,
+ "location_id": "1234",
+ "department_id": "1234",
+ "item": {
+ "id": "12344",
"code": "120-C",
- "line_number": 1,
- "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
- "type": apideck_unify.InvoiceLineItemType.SALES_ITEM,
- "tax_amount": 27500,
- "total_amount": 27500,
- "quantity": 1,
- "unit_price": 27500.5,
- "unit_of_measure": "pc.",
- "discount_percentage": 0.01,
- "discount_amount": 19.99,
- "location_id": "1234",
- "department_id": "1234",
- "item": {
- "id": "12344",
- "code": "120-C",
- "name": "Model Y",
- },
- "tax_rate": {
+ "name": "Model Y",
+ },
+ "tax_rate": {
+ "id": "123456",
+ "rate": 10,
+ },
+ "tracking_categories": [
+ {
"id": "123456",
- "rate": 10,
+ "name": "New York",
},
- "tracking_categories": [
- {
- "id": "123456",
- "name": "New York",
- },
- {
- "id": "123456",
- "name": "New York",
- },
- ],
- "ledger_account": {
+ {
"id": "123456",
- "nominal_code": "N091",
- "code": "453",
+ "name": "New York",
},
- "custom_fields": [
- {
- "id": "2389328923893298",
- "name": "employee_level",
- "description": "Employee Level",
- "value": "Uses Salesforce and Marketo",
- },
- ],
- "row_version": "1-12345",
- },
- ],
- "allocations": [
- {
+ ],
+ "ledger_account": {
"id": "123456",
- "amount": 49.99,
- "allocation_id": "123456",
+ "nominal_code": "N091",
+ "code": "453",
},
- ],
- "note": "Some notes about this credit note",
- "terms": "Some terms about this credit note",
- "billing_address": {
- "id": "123",
- "type": apideck_unify.Type.PRIMARY,
- "string": "25 Spring Street, Blackburn, VIC 3130",
- "name": "HQ US",
- "line1": "Main street",
- "line2": "apt #",
- "line3": "Suite #",
- "line4": "delivery instructions",
- "street_number": "25",
- "city": "San Francisco",
- "state": "CA",
- "postal_code": "94104",
- "country": "US",
- "latitude": "40.759211",
- "longitude": "-73.984638",
- "county": "Santa Clara",
- "contact_name": "Elon Musk",
- "salutation": "Mr",
- "phone_number": "111-111-1111",
- "fax": "122-111-1111",
- "email": "elon@musk.com",
- "website": "https://elonmusk.com",
- "notes": "Address notes or delivery instructions.",
+ "custom_fields": [
+ {
+ "id": "2389328923893298",
+ "name": "employee_level",
+ "description": "Employee Level",
+ "value": "Uses Salesforce and Marketo",
+ },
+ ],
"row_version": "1-12345",
},
- "shipping_address": {
- "id": "123",
- "type": apideck_unify.Type.PRIMARY,
- "string": "25 Spring Street, Blackburn, VIC 3130",
- "name": "HQ US",
- "line1": "Main street",
- "line2": "apt #",
- "line3": "Suite #",
- "line4": "delivery instructions",
- "street_number": "25",
- "city": "San Francisco",
- "state": "CA",
- "postal_code": "94104",
- "country": "US",
- "latitude": "40.759211",
- "longitude": "-73.984638",
- "county": "Santa Clara",
- "contact_name": "Elon Musk",
- "salutation": "Mr",
- "phone_number": "111-111-1111",
- "fax": "122-111-1111",
- "email": "elon@musk.com",
- "website": "https://elonmusk.com",
- "notes": "Address notes or delivery instructions.",
- "row_version": "1-12345",
+ ], allocations=[
+ {
+ "id": "123456",
+ "amount": 49.99,
+ "allocation_id": "123456",
},
- "tracking_categories": [
- {
- "id": "123456",
- "name": "New York",
- },
- {
- "id": "123456",
- "name": "New York",
- },
- {
- "id": "123456",
- "name": "New York",
- },
- ],
- "custom_fields": [
- {
- "id": "2389328923893298",
- "name": "employee_level",
- "description": "Employee Level",
- "value": "Uses Salesforce and Marketo",
- },
- {
- "id": "2389328923893298",
- "name": "employee_level",
- "description": "Employee Level",
- "value": 10,
- },
- {
- "id": "2389328923893298",
- "name": "employee_level",
- "description": "Employee Level",
- "value": "Uses Salesforce and Marketo",
- },
- ],
+ ], note="Some notes about this credit note", terms="Some terms about this credit note", billing_address={
+ "id": "123",
+ "type": apideck_unify.Type.PRIMARY,
+ "string": "25 Spring Street, Blackburn, VIC 3130",
+ "name": "HQ US",
+ "line1": "Main street",
+ "line2": "apt #",
+ "line3": "Suite #",
+ "line4": "delivery instructions",
+ "street_number": "25",
+ "city": "San Francisco",
+ "state": "CA",
+ "postal_code": "94104",
+ "country": "US",
+ "latitude": "40.759211",
+ "longitude": "-73.984638",
+ "county": "Santa Clara",
+ "contact_name": "Elon Musk",
+ "salutation": "Mr",
+ "phone_number": "111-111-1111",
+ "fax": "122-111-1111",
+ "email": "elon@musk.com",
+ "website": "https://elonmusk.com",
+ "notes": "Address notes or delivery instructions.",
+ "row_version": "1-12345",
+ }, shipping_address={
+ "id": "123",
+ "type": apideck_unify.Type.PRIMARY,
+ "string": "25 Spring Street, Blackburn, VIC 3130",
+ "name": "HQ US",
+ "line1": "Main street",
+ "line2": "apt #",
+ "line3": "Suite #",
+ "line4": "delivery instructions",
+ "street_number": "25",
+ "city": "San Francisco",
+ "state": "CA",
+ "postal_code": "94104",
+ "country": "US",
+ "latitude": "40.759211",
+ "longitude": "-73.984638",
+ "county": "Santa Clara",
+ "contact_name": "Elon Musk",
+ "salutation": "Mr",
+ "phone_number": "111-111-1111",
+ "fax": "122-111-1111",
+ "email": "elon@musk.com",
+ "website": "https://elonmusk.com",
+ "notes": "Address notes or delivery instructions.",
"row_version": "1-12345",
- "pass_through": [
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ }, tracking_categories=[
+ {
+ "id": "123456",
+ "name": "New York",
+ },
+ {
+ "id": "123456",
+ "name": "New York",
+ },
+ {
+ "id": "123456",
+ "name": "New York",
+ },
+ ], custom_fields=[
+ {
+ "id": "2389328923893298",
+ "name": "employee_level",
+ "description": "Employee Level",
+ "value": "Uses Salesforce and Marketo",
+ },
+ {
+ "id": "2389328923893298",
+ "name": "employee_level",
+ "description": "Employee Level",
+ "value": 10,
+ },
+ {
+ "id": "2389328923893298",
+ "name": "employee_level",
+ "description": "Employee Level",
+ "value": "Uses Salesforce and Marketo",
+ },
+ ], row_version="1-12345", pass_through=[
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ ],
+ },
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ ],
+ },
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- ],
- }, service_id="salesforce")
+ },
+ ],
+ },
+ ])
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description | Example |
-| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| `credit_note` | [models.CreditNoteInput](../../models/creditnoteinput.md) | :heavy_check_mark: | N/A | |
-| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
-| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
+| Parameter | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `total_amount` | *float* | :heavy_check_mark: | Amount of transaction | 49.99 |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `number` | *OptionalNullable[str]* | :heavy_minus_sign: | Credit note number. | OIT00546 |
+| `customer` | [OptionalNullable[models.LinkedCustomerInput]](../../models/linkedcustomerinput.md) | :heavy_minus_sign: | The customer this entity is linked to. | |
+| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 |
+| `currency` | [OptionalNullable[models.Currency]](../../models/currency.md) | :heavy_minus_sign: | Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). | USD |
+| `currency_rate` | *OptionalNullable[float]* | :heavy_minus_sign: | Currency Exchange Rate at the time entity was recorded/generated. | 0.69 |
+| `tax_inclusive` | *OptionalNullable[bool]* | :heavy_minus_sign: | Amounts are including tax | true |
+| `sub_total` | *OptionalNullable[float]* | :heavy_minus_sign: | Sub-total amount, normally before tax. | 27500 |
+| `total_tax` | *OptionalNullable[float]* | :heavy_minus_sign: | Total tax amount applied to this invoice. | 2500 |
+| `tax_code` | *OptionalNullable[str]* | :heavy_minus_sign: | Applicable tax id/code override if tax is not supplied on a line item basis. | 1234 |
+| `balance` | *OptionalNullable[float]* | :heavy_minus_sign: | The balance reflecting any payments made against the transaction. | 27500 |
+| `remaining_credit` | *OptionalNullable[float]* | :heavy_minus_sign: | Indicates the total credit amount still available to apply towards the payment. | 27500 |
+| `status` | [Optional[models.CreditNoteStatus]](../../models/creditnotestatus.md) | :heavy_minus_sign: | Status of credit notes | authorised |
+| `reference` | *OptionalNullable[str]* | :heavy_minus_sign: | Optional reference message ie: Debit remittance detail. | 123456 |
+| `date_issued` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Date credit note issued - YYYY:MM::DDThh:mm:ss.sTZD | 2021-05-01T12:00:00.000Z |
+| `date_paid` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Date credit note paid - YYYY:MM::DDThh:mm:ss.sTZD | 2021-05-01T12:00:00.000Z |
+| `type` | [Optional[models.CreditNoteType]](../../models/creditnotetype.md) | :heavy_minus_sign: | Type of payment | accounts_receivable_credit |
+| `account` | [OptionalNullable[models.LinkedLedgerAccountInput]](../../models/linkedledgeraccountinput.md) | :heavy_minus_sign: | N/A | |
+| `line_items` | List[[models.InvoiceLineItemInput](../../models/invoicelineiteminput.md)] | :heavy_minus_sign: | N/A | |
+| `allocations` | List[[models.AllocationInput](../../models/allocationinput.md)] | :heavy_minus_sign: | N/A | |
+| `note` | *OptionalNullable[str]* | :heavy_minus_sign: | Optional note to be associated with the credit note. | Some notes about this credit note |
+| `terms` | *OptionalNullable[str]* | :heavy_minus_sign: | Optional terms to be associated with the credit note. | Some terms about this credit note |
+| `billing_address` | [Optional[models.Address]](../../models/address.md) | :heavy_minus_sign: | N/A | |
+| `shipping_address` | [Optional[models.Address]](../../models/address.md) | :heavy_minus_sign: | N/A | |
+| `tracking_categories` | List[[models.LinkedTrackingCategory](../../models/linkedtrackingcategory.md)] | :heavy_minus_sign: | A list of linked tracking categories. | |
+| `custom_fields` | List[[models.CustomField](../../models/customfield.md)] | :heavy_minus_sign: | N/A | |
+| `row_version` | *OptionalNullable[str]* | :heavy_minus_sign: | A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. | 1-12345 |
+| `pass_through` | List[[models.PassThroughBody](../../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -391,11 +392,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.accounting.credit_notes.get(id="", service_id="salesforce", fields="id,updated_at")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
@@ -441,349 +442,347 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.accounting.credit_notes.update(id="", credit_note={
- "total_amount": 49.99,
- "number": "OIT00546",
- "customer": {
+
+ res = apideck.accounting.credit_notes.update(id="", total_amount=49.99, service_id="salesforce", number="OIT00546", customer={
+ "id": "12345",
+ "display_name": "Windsurf Shop",
+ "email": "boring@boring.com",
+ }, company_id="12345", currency=apideck_unify.Currency.USD, currency_rate=0.69, tax_inclusive=True, sub_total=27500, total_tax=2500, tax_code="1234", balance=27500, remaining_credit=27500, status=apideck_unify.CreditNoteStatus.AUTHORISED, reference="123456", date_issued=dateutil.parser.isoparse("2021-05-01T12:00:00.000Z"), date_paid=dateutil.parser.isoparse("2021-05-01T12:00:00.000Z"), type_=apideck_unify.CreditNoteType.ACCOUNTS_RECEIVABLE_CREDIT, account={
+ "id": "123456",
+ "nominal_code": "N091",
+ "code": "453",
+ }, line_items=[
+ {
"id": "12345",
- "display_name": "Windsurf Shop",
- "email": "boring@boring.com",
- },
- "company_id": "12345",
- "currency": apideck_unify.Currency.USD,
- "currency_rate": 0.69,
- "tax_inclusive": True,
- "sub_total": 27500,
- "total_tax": 2500,
- "tax_code": "1234",
- "balance": 27500,
- "remaining_credit": 27500,
- "status": apideck_unify.CreditNoteStatus.AUTHORISED,
- "reference": "123456",
- "date_issued": dateutil.parser.isoparse("2021-05-01T12:00:00.000Z"),
- "date_paid": dateutil.parser.isoparse("2021-05-01T12:00:00.000Z"),
- "type": apideck_unify.CreditNoteType.ACCOUNTS_RECEIVABLE_CREDIT,
- "account": {
- "id": "123456",
- "nominal_code": "N091",
- "code": "453",
- },
- "line_items": [
- {
- "id": "12345",
- "row_id": "12345",
+ "row_id": "12345",
+ "code": "120-C",
+ "line_number": 1,
+ "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
+ "type": apideck_unify.InvoiceLineItemType.SALES_ITEM,
+ "tax_amount": 27500,
+ "total_amount": 27500,
+ "quantity": 1,
+ "unit_price": 27500.5,
+ "unit_of_measure": "pc.",
+ "discount_percentage": 0.01,
+ "discount_amount": 19.99,
+ "location_id": "1234",
+ "department_id": "1234",
+ "item": {
+ "id": "12344",
"code": "120-C",
- "line_number": 1,
- "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
- "type": apideck_unify.InvoiceLineItemType.SALES_ITEM,
- "tax_amount": 27500,
- "total_amount": 27500,
- "quantity": 1,
- "unit_price": 27500.5,
- "unit_of_measure": "pc.",
- "discount_percentage": 0.01,
- "discount_amount": 19.99,
- "location_id": "1234",
- "department_id": "1234",
- "item": {
- "id": "12344",
- "code": "120-C",
- "name": "Model Y",
- },
- "tax_rate": {
+ "name": "Model Y",
+ },
+ "tax_rate": {
+ "id": "123456",
+ "rate": 10,
+ },
+ "tracking_categories": [
+ {
"id": "123456",
- "rate": 10,
+ "name": "New York",
},
- "tracking_categories": [
- {
- "id": "123456",
- "name": "New York",
- },
- {
- "id": "123456",
- "name": "New York",
- },
- ],
- "ledger_account": {
+ {
"id": "123456",
- "nominal_code": "N091",
- "code": "453",
+ "name": "New York",
},
- "custom_fields": [
- {
- "id": "2389328923893298",
- "name": "employee_level",
- "description": "Employee Level",
- },
- ],
- "row_version": "1-12345",
+ ],
+ "ledger_account": {
+ "id": "123456",
+ "nominal_code": "N091",
+ "code": "453",
},
- {
- "id": "12345",
- "row_id": "12345",
- "code": "120-C",
- "line_number": 1,
- "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
- "type": apideck_unify.InvoiceLineItemType.SALES_ITEM,
- "tax_amount": 27500,
- "total_amount": 27500,
- "quantity": 1,
- "unit_price": 27500.5,
- "unit_of_measure": "pc.",
- "discount_percentage": 0.01,
- "discount_amount": 19.99,
- "location_id": "1234",
- "department_id": "1234",
- "item": {
- "id": "12344",
- "code": "120-C",
- "name": "Model Y",
- },
- "tax_rate": {
- "id": "123456",
- "rate": 10,
+ "custom_fields": [
+ {
+ "id": "2389328923893298",
+ "name": "employee_level",
+ "description": "Employee Level",
},
- "tracking_categories": [
- {
- "id": "123456",
- "name": "New York",
- },
- ],
- "ledger_account": {
+ ],
+ "row_version": "1-12345",
+ },
+ {
+ "id": "12345",
+ "row_id": "12345",
+ "code": "120-C",
+ "line_number": 1,
+ "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
+ "type": apideck_unify.InvoiceLineItemType.SALES_ITEM,
+ "tax_amount": 27500,
+ "total_amount": 27500,
+ "quantity": 1,
+ "unit_price": 27500.5,
+ "unit_of_measure": "pc.",
+ "discount_percentage": 0.01,
+ "discount_amount": 19.99,
+ "location_id": "1234",
+ "department_id": "1234",
+ "item": {
+ "id": "12344",
+ "code": "120-C",
+ "name": "Model Y",
+ },
+ "tax_rate": {
+ "id": "123456",
+ "rate": 10,
+ },
+ "tracking_categories": [
+ {
"id": "123456",
- "nominal_code": "N091",
- "code": "453",
+ "name": "New York",
},
- "custom_fields": [
- {
- "id": "2389328923893298",
- "name": "employee_level",
- "description": "Employee Level",
- "value": "Uses Salesforce and Marketo",
- },
- {
- "id": "2389328923893298",
- "name": "employee_level",
- "description": "Employee Level",
- },
- {
- "id": "2389328923893298",
- "name": "employee_level",
- "description": "Employee Level",
- "value": 10,
- },
- ],
- "row_version": "1-12345",
+ ],
+ "ledger_account": {
+ "id": "123456",
+ "nominal_code": "N091",
+ "code": "453",
},
- {
- "id": "12345",
- "row_id": "12345",
- "code": "120-C",
- "line_number": 1,
- "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
- "type": apideck_unify.InvoiceLineItemType.SALES_ITEM,
- "tax_amount": 27500,
- "total_amount": 27500,
- "quantity": 1,
- "unit_price": 27500.5,
- "unit_of_measure": "pc.",
- "discount_percentage": 0.01,
- "discount_amount": 19.99,
- "location_id": "1234",
- "department_id": "1234",
- "item": {
- "id": "12344",
- "code": "120-C",
- "name": "Model Y",
+ "custom_fields": [
+ {
+ "id": "2389328923893298",
+ "name": "employee_level",
+ "description": "Employee Level",
+ "value": "Uses Salesforce and Marketo",
},
- "tax_rate": {
- "id": "123456",
- "rate": 10,
+ {
+ "id": "2389328923893298",
+ "name": "employee_level",
+ "description": "Employee Level",
},
- "tracking_categories": [
- {
- "id": "123456",
- "name": "New York",
- },
- ],
- "ledger_account": {
- "id": "123456",
- "nominal_code": "N091",
- "code": "453",
+ {
+ "id": "2389328923893298",
+ "name": "employee_level",
+ "description": "Employee Level",
+ "value": 10,
},
- "custom_fields": [
- {
- "id": "2389328923893298",
- "name": "employee_level",
- "description": "Employee Level",
- "value": [
- {},
- ],
- },
- ],
- "row_version": "1-12345",
- },
- ],
- "allocations": [
- {
- "id": "123456",
- "amount": 49.99,
- "allocation_id": "123456",
+ ],
+ "row_version": "1-12345",
+ },
+ {
+ "id": "12345",
+ "row_id": "12345",
+ "code": "120-C",
+ "line_number": 1,
+ "description": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
+ "type": apideck_unify.InvoiceLineItemType.SALES_ITEM,
+ "tax_amount": 27500,
+ "total_amount": 27500,
+ "quantity": 1,
+ "unit_price": 27500.5,
+ "unit_of_measure": "pc.",
+ "discount_percentage": 0.01,
+ "discount_amount": 19.99,
+ "location_id": "1234",
+ "department_id": "1234",
+ "item": {
+ "id": "12344",
+ "code": "120-C",
+ "name": "Model Y",
},
- {
+ "tax_rate": {
"id": "123456",
- "amount": 49.99,
- "allocation_id": "123456",
+ "rate": 10,
},
- {
+ "tracking_categories": [
+ {
+ "id": "123456",
+ "name": "New York",
+ },
+ ],
+ "ledger_account": {
"id": "123456",
- "amount": 49.99,
- "allocation_id": "123456",
+ "nominal_code": "N091",
+ "code": "453",
},
- ],
- "note": "Some notes about this credit note",
- "terms": "Some terms about this credit note",
- "billing_address": {
- "id": "123",
- "type": apideck_unify.Type.PRIMARY,
- "string": "25 Spring Street, Blackburn, VIC 3130",
- "name": "HQ US",
- "line1": "Main street",
- "line2": "apt #",
- "line3": "Suite #",
- "line4": "delivery instructions",
- "street_number": "25",
- "city": "San Francisco",
- "state": "CA",
- "postal_code": "94104",
- "country": "US",
- "latitude": "40.759211",
- "longitude": "-73.984638",
- "county": "Santa Clara",
- "contact_name": "Elon Musk",
- "salutation": "Mr",
- "phone_number": "111-111-1111",
- "fax": "122-111-1111",
- "email": "elon@musk.com",
- "website": "https://elonmusk.com",
- "notes": "Address notes or delivery instructions.",
+ "custom_fields": [
+ {
+ "id": "2389328923893298",
+ "name": "employee_level",
+ "description": "Employee Level",
+ "value": [
+ {},
+ ],
+ },
+ ],
"row_version": "1-12345",
},
- "shipping_address": {
- "id": "123",
- "type": apideck_unify.Type.PRIMARY,
- "string": "25 Spring Street, Blackburn, VIC 3130",
- "name": "HQ US",
- "line1": "Main street",
- "line2": "apt #",
- "line3": "Suite #",
- "line4": "delivery instructions",
- "street_number": "25",
- "city": "San Francisco",
- "state": "CA",
- "postal_code": "94104",
- "country": "US",
- "latitude": "40.759211",
- "longitude": "-73.984638",
- "county": "Santa Clara",
- "contact_name": "Elon Musk",
- "salutation": "Mr",
- "phone_number": "111-111-1111",
- "fax": "122-111-1111",
- "email": "elon@musk.com",
- "website": "https://elonmusk.com",
- "notes": "Address notes or delivery instructions.",
- "row_version": "1-12345",
+ ], allocations=[
+ {
+ "id": "123456",
+ "amount": 49.99,
+ "allocation_id": "123456",
},
- "tracking_categories": [
- {
- "id": "123456",
- "name": "New York",
- },
- {
- "id": "123456",
- "name": "New York",
- },
- {
- "id": "123456",
- "name": "New York",
- },
- ],
- "custom_fields": [
- {
- "id": "2389328923893298",
- "name": "employee_level",
- "description": "Employee Level",
- "value": True,
- },
- ],
+ {
+ "id": "123456",
+ "amount": 49.99,
+ "allocation_id": "123456",
+ },
+ {
+ "id": "123456",
+ "amount": 49.99,
+ "allocation_id": "123456",
+ },
+ ], note="Some notes about this credit note", terms="Some terms about this credit note", billing_address={
+ "id": "123",
+ "type": apideck_unify.Type.PRIMARY,
+ "string": "25 Spring Street, Blackburn, VIC 3130",
+ "name": "HQ US",
+ "line1": "Main street",
+ "line2": "apt #",
+ "line3": "Suite #",
+ "line4": "delivery instructions",
+ "street_number": "25",
+ "city": "San Francisco",
+ "state": "CA",
+ "postal_code": "94104",
+ "country": "US",
+ "latitude": "40.759211",
+ "longitude": "-73.984638",
+ "county": "Santa Clara",
+ "contact_name": "Elon Musk",
+ "salutation": "Mr",
+ "phone_number": "111-111-1111",
+ "fax": "122-111-1111",
+ "email": "elon@musk.com",
+ "website": "https://elonmusk.com",
+ "notes": "Address notes or delivery instructions.",
+ "row_version": "1-12345",
+ }, shipping_address={
+ "id": "123",
+ "type": apideck_unify.Type.PRIMARY,
+ "string": "25 Spring Street, Blackburn, VIC 3130",
+ "name": "HQ US",
+ "line1": "Main street",
+ "line2": "apt #",
+ "line3": "Suite #",
+ "line4": "delivery instructions",
+ "street_number": "25",
+ "city": "San Francisco",
+ "state": "CA",
+ "postal_code": "94104",
+ "country": "US",
+ "latitude": "40.759211",
+ "longitude": "-73.984638",
+ "county": "Santa Clara",
+ "contact_name": "Elon Musk",
+ "salutation": "Mr",
+ "phone_number": "111-111-1111",
+ "fax": "122-111-1111",
+ "email": "elon@musk.com",
+ "website": "https://elonmusk.com",
+ "notes": "Address notes or delivery instructions.",
"row_version": "1-12345",
- "pass_through": [
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ }, tracking_categories=[
+ {
+ "id": "123456",
+ "name": "New York",
+ },
+ {
+ "id": "123456",
+ "name": "New York",
+ },
+ {
+ "id": "123456",
+ "name": "New York",
+ },
+ ], custom_fields=[
+ {
+ "id": "2389328923893298",
+ "name": "employee_level",
+ "description": "Employee Level",
+ "value": True,
+ },
+ ], row_version="1-12345", pass_through=[
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ ],
+ },
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ ],
+ },
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- ],
- }, service_id="salesforce")
+ },
+ ],
+ },
+ ])
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description | Example |
-| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
-| `credit_note` | [models.CreditNoteInput](../../models/creditnoteinput.md) | :heavy_check_mark: | N/A | |
-| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
-| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
+| Parameter | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
+| `total_amount` | *float* | :heavy_check_mark: | Amount of transaction | 49.99 |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `number` | *OptionalNullable[str]* | :heavy_minus_sign: | Credit note number. | OIT00546 |
+| `customer` | [OptionalNullable[models.LinkedCustomerInput]](../../models/linkedcustomerinput.md) | :heavy_minus_sign: | The customer this entity is linked to. | |
+| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 |
+| `currency` | [OptionalNullable[models.Currency]](../../models/currency.md) | :heavy_minus_sign: | Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). | USD |
+| `currency_rate` | *OptionalNullable[float]* | :heavy_minus_sign: | Currency Exchange Rate at the time entity was recorded/generated. | 0.69 |
+| `tax_inclusive` | *OptionalNullable[bool]* | :heavy_minus_sign: | Amounts are including tax | true |
+| `sub_total` | *OptionalNullable[float]* | :heavy_minus_sign: | Sub-total amount, normally before tax. | 27500 |
+| `total_tax` | *OptionalNullable[float]* | :heavy_minus_sign: | Total tax amount applied to this invoice. | 2500 |
+| `tax_code` | *OptionalNullable[str]* | :heavy_minus_sign: | Applicable tax id/code override if tax is not supplied on a line item basis. | 1234 |
+| `balance` | *OptionalNullable[float]* | :heavy_minus_sign: | The balance reflecting any payments made against the transaction. | 27500 |
+| `remaining_credit` | *OptionalNullable[float]* | :heavy_minus_sign: | Indicates the total credit amount still available to apply towards the payment. | 27500 |
+| `status` | [Optional[models.CreditNoteStatus]](../../models/creditnotestatus.md) | :heavy_minus_sign: | Status of credit notes | authorised |
+| `reference` | *OptionalNullable[str]* | :heavy_minus_sign: | Optional reference message ie: Debit remittance detail. | 123456 |
+| `date_issued` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Date credit note issued - YYYY:MM::DDThh:mm:ss.sTZD | 2021-05-01T12:00:00.000Z |
+| `date_paid` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Date credit note paid - YYYY:MM::DDThh:mm:ss.sTZD | 2021-05-01T12:00:00.000Z |
+| `type` | [Optional[models.CreditNoteType]](../../models/creditnotetype.md) | :heavy_minus_sign: | Type of payment | accounts_receivable_credit |
+| `account` | [OptionalNullable[models.LinkedLedgerAccountInput]](../../models/linkedledgeraccountinput.md) | :heavy_minus_sign: | N/A | |
+| `line_items` | List[[models.InvoiceLineItemInput](../../models/invoicelineiteminput.md)] | :heavy_minus_sign: | N/A | |
+| `allocations` | List[[models.AllocationInput](../../models/allocationinput.md)] | :heavy_minus_sign: | N/A | |
+| `note` | *OptionalNullable[str]* | :heavy_minus_sign: | Optional note to be associated with the credit note. | Some notes about this credit note |
+| `terms` | *OptionalNullable[str]* | :heavy_minus_sign: | Optional terms to be associated with the credit note. | Some terms about this credit note |
+| `billing_address` | [Optional[models.Address]](../../models/address.md) | :heavy_minus_sign: | N/A | |
+| `shipping_address` | [Optional[models.Address]](../../models/address.md) | :heavy_minus_sign: | N/A | |
+| `tracking_categories` | List[[models.LinkedTrackingCategory](../../models/linkedtrackingcategory.md)] | :heavy_minus_sign: | A list of linked tracking categories. | |
+| `custom_fields` | List[[models.CustomField](../../models/customfield.md)] | :heavy_minus_sign: | N/A | |
+| `row_version` | *OptionalNullable[str]* | :heavy_minus_sign: | A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. | 1-12345 |
+| `pass_through` | List[[models.PassThroughBody](../../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -815,11 +814,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.accounting.credit_notes.delete(id="", service_id="salesforce")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
diff --git a/docs/sdks/customers/README.md b/docs/sdks/customers/README.md
index d7dd7009..ed37ac29 100644
--- a/docs/sdks/customers/README.md
+++ b/docs/sdks/customers/README.md
@@ -28,39 +28,42 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.accounting.customers.list(request={
- "service_id": "salesforce",
- "filter_": {
- "company_name": "SpaceX",
- "display_name": "Elon Musk",
- "first_name": "Elon",
- "last_name": "Musk",
- "email": "elon@musk.com",
- "status": apideck_unify.CustomersFilterStatus.ACTIVE,
- "updated_since": dateutil.parser.isoparse("2020-09-30T07:43:32.000Z"),
- },
- "sort": {
- "by": apideck_unify.CustomersSortBy.UPDATED_AT,
- "direction": apideck_unify.SortDirection.DESC,
- },
- "pass_through": {
- "search": "San Francisco",
- },
- "fields": "id,updated_at",
- })
- if res is not None:
- # handle response
- pass
+ res = apideck.accounting.customers.list(service_id="salesforce", filter_={
+ "company_name": "SpaceX",
+ "display_name": "Elon Musk",
+ "first_name": "Elon",
+ "last_name": "Musk",
+ "email": "elon@musk.com",
+ "status": apideck_unify.CustomersFilterStatus.ACTIVE,
+ "updated_since": dateutil.parser.isoparse("2020-09-30T07:43:32.000Z"),
+ }, sort={
+ "by": apideck_unify.CustomersSortBy.UPDATED_AT,
+ "direction": apideck_unify.SortDirection.DESC,
+ }, pass_through={
+ "search": "San Francisco",
+ }, fields="id,updated_at")
+
+ while res is not None:
+ # Handle items
+
+ res = res.next()
```
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
-| `request` | [models.AccountingCustomersAllRequest](../../models/accountingcustomersallrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
+| Parameter | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | |
+| `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | |
+| `filter_` | [Optional[models.CustomersFilter]](../../models/customersfilter.md) | :heavy_minus_sign: | Apply filters | {
"company_name": "SpaceX",
"display_name": "Elon Musk",
"first_name": "Elon",
"last_name": "Musk",
"email": "elon@musk.com",
"status": "active",
"updated_since": "2020-09-30T07:43:32.000Z"
} |
+| `sort` | [Optional[models.CustomersSort]](../../models/customerssort.md) | :heavy_minus_sign: | Apply sorting | {
"by": "updated_at",
"direction": "desc"
} |
+| `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} |
+| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: `fields=name,email,addresses.city`
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -93,186 +96,184 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.accounting.customers.create(customer={
- "display_id": "EMP00101",
- "display_name": "Windsurf Shop",
- "company_name": "SpaceX",
- "company_id": "12345",
- "title": "CEO",
- "first_name": "Elon",
- "middle_name": "D.",
- "last_name": "Musk",
- "suffix": "Jr.",
- "individual": True,
- "project": False,
- "addresses": [
- {
- "id": "123",
- "type": apideck_unify.Type.PRIMARY,
- "string": "25 Spring Street, Blackburn, VIC 3130",
- "name": "HQ US",
- "line1": "Main street",
- "line2": "apt #",
- "line3": "Suite #",
- "line4": "delivery instructions",
- "street_number": "25",
- "city": "San Francisco",
- "state": "CA",
- "postal_code": "94104",
- "country": "US",
- "latitude": "40.759211",
- "longitude": "-73.984638",
- "county": "Santa Clara",
- "contact_name": "Elon Musk",
- "salutation": "Mr",
- "phone_number": "111-111-1111",
- "fax": "122-111-1111",
- "email": "elon@musk.com",
- "website": "https://elonmusk.com",
- "notes": "Address notes or delivery instructions.",
- "row_version": "1-12345",
- },
- ],
- "phone_numbers": [
- {
- "number": "111-111-1111",
- "id": "12345",
- "country_code": "1",
- "area_code": "323",
- "extension": "105",
- "type": apideck_unify.PhoneNumberType.PRIMARY,
- },
- {
- "number": "111-111-1111",
- "id": "12345",
- "country_code": "1",
- "area_code": "323",
- "extension": "105",
- "type": apideck_unify.PhoneNumberType.PRIMARY,
- },
- ],
- "emails": [
- {
- "email": "elon@musk.com",
- "id": "123",
- "type": apideck_unify.EmailType.PRIMARY,
- },
- ],
- "websites": [
- {
- "url": "http://example.com",
- "id": "12345",
- "type": apideck_unify.WebsiteType.PRIMARY,
- },
- ],
- "bank_accounts": [
- {
- "bank_name": "Monzo",
- "account_number": "123465",
- "account_name": "SPACEX LLC",
- "account_type": apideck_unify.AccountType.CREDIT_CARD,
- "iban": "CH2989144532982975332",
- "bic": "AUDSCHGGXXX",
- "routing_number": "012345678",
- "bsb_number": "062-001",
- "branch_identifier": "001",
- "bank_code": "BNH",
- "currency": apideck_unify.Currency.USD,
- },
- ],
- "notes": "Some notes about this customer",
- "tax_rate": {
- "id": "123456",
- "rate": 10,
+
+ res = apideck.accounting.customers.create(service_id="salesforce", display_id="EMP00101", display_name="Windsurf Shop", company_name="SpaceX", company_id="12345", title="CEO", first_name="Elon", middle_name="D.", last_name="Musk", suffix="Jr.", individual=True, project=False, addresses=[
+ {
+ "id": "123",
+ "type": apideck_unify.Type.PRIMARY,
+ "string": "25 Spring Street, Blackburn, VIC 3130",
+ "name": "HQ US",
+ "line1": "Main street",
+ "line2": "apt #",
+ "line3": "Suite #",
+ "line4": "delivery instructions",
+ "street_number": "25",
+ "city": "San Francisco",
+ "state": "CA",
+ "postal_code": "94104",
+ "country": "US",
+ "latitude": "40.759211",
+ "longitude": "-73.984638",
+ "county": "Santa Clara",
+ "contact_name": "Elon Musk",
+ "salutation": "Mr",
+ "phone_number": "111-111-1111",
+ "fax": "122-111-1111",
+ "email": "elon@musk.com",
+ "website": "https://elonmusk.com",
+ "notes": "Address notes or delivery instructions.",
+ "row_version": "1-12345",
+ },
+ ], phone_numbers=[
+ {
+ "number": "111-111-1111",
+ "id": "12345",
+ "country_code": "1",
+ "area_code": "323",
+ "extension": "105",
+ "type": apideck_unify.PhoneNumberType.PRIMARY,
+ },
+ {
+ "number": "111-111-1111",
+ "id": "12345",
+ "country_code": "1",
+ "area_code": "323",
+ "extension": "105",
+ "type": apideck_unify.PhoneNumberType.PRIMARY,
},
- "tax_number": "US123945459",
- "currency": apideck_unify.Currency.USD,
- "account": {
- "id": "123456",
- "nominal_code": "N091",
- "code": "453",
+ ], emails=[
+ {
+ "email": "elon@musk.com",
+ "id": "123",
+ "type": apideck_unify.EmailType.PRIMARY,
},
- "parent": {
+ ], websites=[
+ {
+ "url": "http://example.com",
"id": "12345",
- "name": "Windsurf Shop",
+ "type": apideck_unify.WebsiteType.PRIMARY,
+ },
+ ], bank_accounts=[
+ {
+ "bank_name": "Monzo",
+ "account_number": "123465",
+ "account_name": "SPACEX LLC",
+ "account_type": apideck_unify.AccountType.CREDIT_CARD,
+ "iban": "CH2989144532982975332",
+ "bic": "AUDSCHGGXXX",
+ "routing_number": "012345678",
+ "bsb_number": "062-001",
+ "branch_identifier": "001",
+ "bank_code": "BNH",
+ "currency": apideck_unify.Currency.USD,
},
- "status": apideck_unify.CustomerStatusStatus.ACTIVE,
- "payment_method": "cash",
- "channel": "email",
- "row_version": "1-12345",
- "pass_through": [
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ ], notes="Some notes about this customer", tax_rate={
+ "id": "123456",
+ "rate": 10,
+ }, tax_number="US123945459", currency=apideck_unify.Currency.USD, account={
+ "id": "123456",
+ "nominal_code": "N091",
+ "code": "453",
+ }, parent={
+ "id": "12345",
+ "name": "Windsurf Shop",
+ }, status=apideck_unify.CustomerStatusStatus.ACTIVE, payment_method="cash", channel="email", row_version="1-12345", pass_through=[
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ ],
+ },
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ ],
+ },
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- ],
- }, service_id="salesforce")
+ },
+ ],
+ },
+ ])
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description | Example |
-| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| `customer` | [models.CustomerInput](../../models/customerinput.md) | :heavy_check_mark: | N/A | |
-| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
-| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
+| Parameter | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `display_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Display ID | EMP00101 |
+| `display_name` | *OptionalNullable[str]* | :heavy_minus_sign: | Display name | Windsurf Shop |
+| `company_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The name of the company. | SpaceX |
+| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 |
+| `title` | *OptionalNullable[str]* | :heavy_minus_sign: | The job title of the person. | CEO |
+| `first_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The first name of the person. | Elon |
+| `middle_name` | *OptionalNullable[str]* | :heavy_minus_sign: | Middle name of the person. | D. |
+| `last_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The last name of the person. | Musk |
+| `suffix` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | Jr. |
+| `individual` | *OptionalNullable[bool]* | :heavy_minus_sign: | Is this an individual or business customer | true |
+| `project` | *OptionalNullable[bool]* | :heavy_minus_sign: | If true, indicates this is a Project. | false |
+| `addresses` | List[[models.Address](../../models/address.md)] | :heavy_minus_sign: | N/A | |
+| `phone_numbers` | List[[models.PhoneNumber](../../models/phonenumber.md)] | :heavy_minus_sign: | N/A | |
+| `emails` | List[[models.Email](../../models/email.md)] | :heavy_minus_sign: | N/A | |
+| `websites` | List[[models.Website](../../models/website.md)] | :heavy_minus_sign: | N/A | |
+| `bank_accounts` | List[[models.BankAccount](../../models/bankaccount.md)] | :heavy_minus_sign: | N/A | |
+| `notes` | *OptionalNullable[str]* | :heavy_minus_sign: | Some notes about this customer | Some notes about this customer |
+| `tax_rate` | [Optional[models.LinkedTaxRateInput]](../../models/linkedtaxrateinput.md) | :heavy_minus_sign: | N/A | |
+| `tax_number` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | US123945459 |
+| `currency` | [OptionalNullable[models.Currency]](../../models/currency.md) | :heavy_minus_sign: | Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). | USD |
+| `account` | [OptionalNullable[models.LinkedLedgerAccountInput]](../../models/linkedledgeraccountinput.md) | :heavy_minus_sign: | N/A | |
+| `parent` | [OptionalNullable[models.LinkedParentCustomer]](../../models/linkedparentcustomer.md) | :heavy_minus_sign: | The parent customer this entity is linked to. | |
+| `status` | [OptionalNullable[models.CustomerStatusStatus]](../../models/customerstatusstatus.md) | :heavy_minus_sign: | Customer status | active |
+| `payment_method` | *OptionalNullable[str]* | :heavy_minus_sign: | Payment method used for the transaction, such as cash, credit card, bank transfer, or check | cash |
+| `channel` | *OptionalNullable[str]* | :heavy_minus_sign: | The channel through which the transaction is processed. | email |
+| `row_version` | *OptionalNullable[str]* | :heavy_minus_sign: | A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. | 1-12345 |
+| `pass_through` | List[[models.PassThroughBody](../../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -304,11 +305,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.accounting.customers.get(id="", service_id="salesforce", fields="id,updated_at")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
@@ -353,236 +354,234 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.accounting.customers.update(id="", customer={
- "display_id": "EMP00101",
- "display_name": "Windsurf Shop",
- "company_name": "SpaceX",
- "company_id": "12345",
- "title": "CEO",
- "first_name": "Elon",
- "middle_name": "D.",
- "last_name": "Musk",
- "suffix": "Jr.",
- "individual": True,
- "project": False,
- "addresses": [
- {
- "id": "123",
- "type": apideck_unify.Type.PRIMARY,
- "string": "25 Spring Street, Blackburn, VIC 3130",
- "name": "HQ US",
- "line1": "Main street",
- "line2": "apt #",
- "line3": "Suite #",
- "line4": "delivery instructions",
- "street_number": "25",
- "city": "San Francisco",
- "state": "CA",
- "postal_code": "94104",
- "country": "US",
- "latitude": "40.759211",
- "longitude": "-73.984638",
- "county": "Santa Clara",
- "contact_name": "Elon Musk",
- "salutation": "Mr",
- "phone_number": "111-111-1111",
- "fax": "122-111-1111",
- "email": "elon@musk.com",
- "website": "https://elonmusk.com",
- "notes": "Address notes or delivery instructions.",
- "row_version": "1-12345",
- },
- {
- "id": "123",
- "type": apideck_unify.Type.PRIMARY,
- "string": "25 Spring Street, Blackburn, VIC 3130",
- "name": "HQ US",
- "line1": "Main street",
- "line2": "apt #",
- "line3": "Suite #",
- "line4": "delivery instructions",
- "street_number": "25",
- "city": "San Francisco",
- "state": "CA",
- "postal_code": "94104",
- "country": "US",
- "latitude": "40.759211",
- "longitude": "-73.984638",
- "county": "Santa Clara",
- "contact_name": "Elon Musk",
- "salutation": "Mr",
- "phone_number": "111-111-1111",
- "fax": "122-111-1111",
- "email": "elon@musk.com",
- "website": "https://elonmusk.com",
- "notes": "Address notes or delivery instructions.",
- "row_version": "1-12345",
- },
- {
- "id": "123",
- "type": apideck_unify.Type.PRIMARY,
- "string": "25 Spring Street, Blackburn, VIC 3130",
- "name": "HQ US",
- "line1": "Main street",
- "line2": "apt #",
- "line3": "Suite #",
- "line4": "delivery instructions",
- "street_number": "25",
- "city": "San Francisco",
- "state": "CA",
- "postal_code": "94104",
- "country": "US",
- "latitude": "40.759211",
- "longitude": "-73.984638",
- "county": "Santa Clara",
- "contact_name": "Elon Musk",
- "salutation": "Mr",
- "phone_number": "111-111-1111",
- "fax": "122-111-1111",
- "email": "elon@musk.com",
- "website": "https://elonmusk.com",
- "notes": "Address notes or delivery instructions.",
- "row_version": "1-12345",
- },
- ],
- "phone_numbers": [
- {
- "number": "111-111-1111",
- "id": "12345",
- "country_code": "1",
- "area_code": "323",
- "extension": "105",
- "type": apideck_unify.PhoneNumberType.PRIMARY,
- },
- {
- "number": "111-111-1111",
- "id": "12345",
- "country_code": "1",
- "area_code": "323",
- "extension": "105",
- "type": apideck_unify.PhoneNumberType.PRIMARY,
- },
- ],
- "emails": [
- {
- "email": "elon@musk.com",
- "id": "123",
- "type": apideck_unify.EmailType.PRIMARY,
- },
- ],
- "websites": [
- {
- "url": "http://example.com",
- "id": "12345",
- "type": apideck_unify.WebsiteType.PRIMARY,
- },
- {
- "url": "http://example.com",
- "id": "12345",
- "type": apideck_unify.WebsiteType.PRIMARY,
- },
- {
- "url": "http://example.com",
- "id": "12345",
- "type": apideck_unify.WebsiteType.PRIMARY,
- },
- ],
- "bank_accounts": [
- {
- "bank_name": "Monzo",
- "account_number": "123465",
- "account_name": "SPACEX LLC",
- "account_type": apideck_unify.AccountType.CREDIT_CARD,
- "iban": "CH2989144532982975332",
- "bic": "AUDSCHGGXXX",
- "routing_number": "012345678",
- "bsb_number": "062-001",
- "branch_identifier": "001",
- "bank_code": "BNH",
- "currency": apideck_unify.Currency.USD,
- },
- {
- "bank_name": "Monzo",
- "account_number": "123465",
- "account_name": "SPACEX LLC",
- "account_type": apideck_unify.AccountType.CREDIT_CARD,
- "iban": "CH2989144532982975332",
- "bic": "AUDSCHGGXXX",
- "routing_number": "012345678",
- "bsb_number": "062-001",
- "branch_identifier": "001",
- "bank_code": "BNH",
- "currency": apideck_unify.Currency.USD,
- },
- ],
- "notes": "Some notes about this customer",
- "tax_rate": {
- "id": "123456",
- "rate": 10,
+
+ res = apideck.accounting.customers.update(id="", service_id="salesforce", display_id="EMP00101", display_name="Windsurf Shop", company_name="SpaceX", company_id="12345", title="CEO", first_name="Elon", middle_name="D.", last_name="Musk", suffix="Jr.", individual=True, project=False, addresses=[
+ {
+ "id": "123",
+ "type": apideck_unify.Type.PRIMARY,
+ "string": "25 Spring Street, Blackburn, VIC 3130",
+ "name": "HQ US",
+ "line1": "Main street",
+ "line2": "apt #",
+ "line3": "Suite #",
+ "line4": "delivery instructions",
+ "street_number": "25",
+ "city": "San Francisco",
+ "state": "CA",
+ "postal_code": "94104",
+ "country": "US",
+ "latitude": "40.759211",
+ "longitude": "-73.984638",
+ "county": "Santa Clara",
+ "contact_name": "Elon Musk",
+ "salutation": "Mr",
+ "phone_number": "111-111-1111",
+ "fax": "122-111-1111",
+ "email": "elon@musk.com",
+ "website": "https://elonmusk.com",
+ "notes": "Address notes or delivery instructions.",
+ "row_version": "1-12345",
},
- "tax_number": "US123945459",
- "currency": apideck_unify.Currency.USD,
- "account": {
- "id": "123456",
- "nominal_code": "N091",
- "code": "453",
+ {
+ "id": "123",
+ "type": apideck_unify.Type.PRIMARY,
+ "string": "25 Spring Street, Blackburn, VIC 3130",
+ "name": "HQ US",
+ "line1": "Main street",
+ "line2": "apt #",
+ "line3": "Suite #",
+ "line4": "delivery instructions",
+ "street_number": "25",
+ "city": "San Francisco",
+ "state": "CA",
+ "postal_code": "94104",
+ "country": "US",
+ "latitude": "40.759211",
+ "longitude": "-73.984638",
+ "county": "Santa Clara",
+ "contact_name": "Elon Musk",
+ "salutation": "Mr",
+ "phone_number": "111-111-1111",
+ "fax": "122-111-1111",
+ "email": "elon@musk.com",
+ "website": "https://elonmusk.com",
+ "notes": "Address notes or delivery instructions.",
+ "row_version": "1-12345",
+ },
+ {
+ "id": "123",
+ "type": apideck_unify.Type.PRIMARY,
+ "string": "25 Spring Street, Blackburn, VIC 3130",
+ "name": "HQ US",
+ "line1": "Main street",
+ "line2": "apt #",
+ "line3": "Suite #",
+ "line4": "delivery instructions",
+ "street_number": "25",
+ "city": "San Francisco",
+ "state": "CA",
+ "postal_code": "94104",
+ "country": "US",
+ "latitude": "40.759211",
+ "longitude": "-73.984638",
+ "county": "Santa Clara",
+ "contact_name": "Elon Musk",
+ "salutation": "Mr",
+ "phone_number": "111-111-1111",
+ "fax": "122-111-1111",
+ "email": "elon@musk.com",
+ "website": "https://elonmusk.com",
+ "notes": "Address notes or delivery instructions.",
+ "row_version": "1-12345",
+ },
+ ], phone_numbers=[
+ {
+ "number": "111-111-1111",
+ "id": "12345",
+ "country_code": "1",
+ "area_code": "323",
+ "extension": "105",
+ "type": apideck_unify.PhoneNumberType.PRIMARY,
},
- "parent": {
+ {
+ "number": "111-111-1111",
"id": "12345",
- "name": "Windsurf Shop",
+ "country_code": "1",
+ "area_code": "323",
+ "extension": "105",
+ "type": apideck_unify.PhoneNumberType.PRIMARY,
+ },
+ ], emails=[
+ {
+ "email": "elon@musk.com",
+ "id": "123",
+ "type": apideck_unify.EmailType.PRIMARY,
},
- "status": apideck_unify.CustomerStatusStatus.ACTIVE,
- "payment_method": "cash",
- "channel": "email",
- "row_version": "1-12345",
- "pass_through": [
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ ], websites=[
+ {
+ "url": "http://example.com",
+ "id": "12345",
+ "type": apideck_unify.WebsiteType.PRIMARY,
+ },
+ {
+ "url": "http://example.com",
+ "id": "12345",
+ "type": apideck_unify.WebsiteType.PRIMARY,
+ },
+ {
+ "url": "http://example.com",
+ "id": "12345",
+ "type": apideck_unify.WebsiteType.PRIMARY,
+ },
+ ], bank_accounts=[
+ {
+ "bank_name": "Monzo",
+ "account_number": "123465",
+ "account_name": "SPACEX LLC",
+ "account_type": apideck_unify.AccountType.CREDIT_CARD,
+ "iban": "CH2989144532982975332",
+ "bic": "AUDSCHGGXXX",
+ "routing_number": "012345678",
+ "bsb_number": "062-001",
+ "branch_identifier": "001",
+ "bank_code": "BNH",
+ "currency": apideck_unify.Currency.USD,
+ },
+ {
+ "bank_name": "Monzo",
+ "account_number": "123465",
+ "account_name": "SPACEX LLC",
+ "account_type": apideck_unify.AccountType.CREDIT_CARD,
+ "iban": "CH2989144532982975332",
+ "bic": "AUDSCHGGXXX",
+ "routing_number": "012345678",
+ "bsb_number": "062-001",
+ "branch_identifier": "001",
+ "bank_code": "BNH",
+ "currency": apideck_unify.Currency.USD,
+ },
+ ], notes="Some notes about this customer", tax_rate={
+ "id": "123456",
+ "rate": 10,
+ }, tax_number="US123945459", currency=apideck_unify.Currency.USD, account={
+ "id": "123456",
+ "nominal_code": "N091",
+ "code": "453",
+ }, parent={
+ "id": "12345",
+ "name": "Windsurf Shop",
+ }, status=apideck_unify.CustomerStatusStatus.ACTIVE, payment_method="cash", channel="email", row_version="1-12345", pass_through=[
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- ],
- }, service_id="salesforce")
+ },
+ ],
+ },
+ ])
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description | Example |
-| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
-| `customer` | [models.CustomerInput](../../models/customerinput.md) | :heavy_check_mark: | N/A | |
-| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
-| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
+| Parameter | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `display_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Display ID | EMP00101 |
+| `display_name` | *OptionalNullable[str]* | :heavy_minus_sign: | Display name | Windsurf Shop |
+| `company_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The name of the company. | SpaceX |
+| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 |
+| `title` | *OptionalNullable[str]* | :heavy_minus_sign: | The job title of the person. | CEO |
+| `first_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The first name of the person. | Elon |
+| `middle_name` | *OptionalNullable[str]* | :heavy_minus_sign: | Middle name of the person. | D. |
+| `last_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The last name of the person. | Musk |
+| `suffix` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | Jr. |
+| `individual` | *OptionalNullable[bool]* | :heavy_minus_sign: | Is this an individual or business customer | true |
+| `project` | *OptionalNullable[bool]* | :heavy_minus_sign: | If true, indicates this is a Project. | false |
+| `addresses` | List[[models.Address](../../models/address.md)] | :heavy_minus_sign: | N/A | |
+| `phone_numbers` | List[[models.PhoneNumber](../../models/phonenumber.md)] | :heavy_minus_sign: | N/A | |
+| `emails` | List[[models.Email](../../models/email.md)] | :heavy_minus_sign: | N/A | |
+| `websites` | List[[models.Website](../../models/website.md)] | :heavy_minus_sign: | N/A | |
+| `bank_accounts` | List[[models.BankAccount](../../models/bankaccount.md)] | :heavy_minus_sign: | N/A | |
+| `notes` | *OptionalNullable[str]* | :heavy_minus_sign: | Some notes about this customer | Some notes about this customer |
+| `tax_rate` | [Optional[models.LinkedTaxRateInput]](../../models/linkedtaxrateinput.md) | :heavy_minus_sign: | N/A | |
+| `tax_number` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | US123945459 |
+| `currency` | [OptionalNullable[models.Currency]](../../models/currency.md) | :heavy_minus_sign: | Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). | USD |
+| `account` | [OptionalNullable[models.LinkedLedgerAccountInput]](../../models/linkedledgeraccountinput.md) | :heavy_minus_sign: | N/A | |
+| `parent` | [OptionalNullable[models.LinkedParentCustomer]](../../models/linkedparentcustomer.md) | :heavy_minus_sign: | The parent customer this entity is linked to. | |
+| `status` | [OptionalNullable[models.CustomerStatusStatus]](../../models/customerstatusstatus.md) | :heavy_minus_sign: | Customer status | active |
+| `payment_method` | *OptionalNullable[str]* | :heavy_minus_sign: | Payment method used for the transaction, such as cash, credit card, bank transfer, or check | cash |
+| `channel` | *OptionalNullable[str]* | :heavy_minus_sign: | The channel through which the transaction is processed. | email |
+| `row_version` | *OptionalNullable[str]* | :heavy_minus_sign: | A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. | 1-12345 |
+| `pass_through` | List[[models.PassThroughBody](../../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -614,11 +613,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.accounting.customers.delete(id="", service_id="salesforce")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
diff --git a/docs/sdks/customfields/README.md b/docs/sdks/customfields/README.md
index 49cba71e..cd0bb4c8 100644
--- a/docs/sdks/customfields/README.md
+++ b/docs/sdks/customfields/README.md
@@ -23,11 +23,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.vault.custom_fields.list(unified_api="crm", service_id="pipedrive", resource="leads", resource_id="1234")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
diff --git a/docs/sdks/custommappingssdk/README.md b/docs/sdks/custommappingssdk/README.md
index f3ebd6ef..6648860f 100644
--- a/docs/sdks/custommappingssdk/README.md
+++ b/docs/sdks/custommappingssdk/README.md
@@ -22,11 +22,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.vault.custom_mappings.list(unified_api="crm", service_id="pipedrive")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
diff --git a/docs/sdks/departments/README.md b/docs/sdks/departments/README.md
index 6e0aedb9..f324a266 100644
--- a/docs/sdks/departments/README.md
+++ b/docs/sdks/departments/README.md
@@ -26,26 +26,29 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.accounting.departments.list(request={
- "service_id": "salesforce",
- "fields": "id,updated_at",
- "filter_": {
- "subsidiary": "1",
- },
+
+ res = apideck.accounting.departments.list(service_id="salesforce", fields="id,updated_at", filter_={
+ "subsidiary": "1",
})
- if res is not None:
- # handle response
- pass
+ while res is not None:
+ # Handle items
+
+ res = res.next()
```
### Parameters
-| Parameter | Type | Required | Description |
-| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
-| `request` | [models.AccountingDepartmentsAllRequest](../../models/accountingdepartmentsallrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
+| Parameter | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | |
+| `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | |
+| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: `fields=name,email,addresses.city`
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at |
+| `filter_` | [Optional[models.AccountingDepartmentsFilter]](../../models/accountingdepartmentsfilter.md) | :heavy_minus_sign: | Apply filters | {
"subsidiary": "1"
} |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -78,60 +81,58 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.accounting.departments.create(accounting_department={
- "parent_id": "12345",
- "name": "Sales",
- "status": apideck_unify.DepartmentStatus.ACTIVE,
- "subsidiaries": [
- {
- "name": "SpaceX",
- },
- ],
- "row_version": "1-12345",
- "pass_through": [
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+
+ res = apideck.accounting.departments.create(service_id="salesforce", parent_id="12345", name="Sales", status=apideck_unify.DepartmentStatus.ACTIVE, subsidiaries=[
+ {
+ "name": "SpaceX",
+ },
+ ], row_version="1-12345", pass_through=[
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ ],
+ },
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- ],
- }, service_id="salesforce")
+ },
+ ],
+ },
+ ])
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description | Example |
-| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| `accounting_department` | [models.AccountingDepartmentInput](../../models/accountingdepartmentinput.md) | :heavy_check_mark: | N/A | |
-| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
-| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
+| Parameter | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `parent_id` | *OptionalNullable[str]* | :heavy_minus_sign: | A unique identifier for an object. | 12345 |
+| `name` | *OptionalNullable[str]* | :heavy_minus_sign: | The name of the department. | Sales |
+| `status` | [Optional[models.DepartmentStatus]](../../models/departmentstatus.md) | :heavy_minus_sign: | Based on the status some functionality is enabled or disabled. | active |
+| `subsidiaries` | List[[models.SubsidiaryReferenceInput](../../models/subsidiaryreferenceinput.md)] | :heavy_minus_sign: | N/A | |
+| `row_version` | *OptionalNullable[str]* | :heavy_minus_sign: | A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. | 1-12345 |
+| `pass_through` | List[[models.PassThroughBody](../../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -163,11 +164,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.accounting.departments.get(id="", service_id="salesforce", fields="id,updated_at")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
@@ -212,83 +213,81 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.accounting.departments.update(id="", accounting_department={
- "parent_id": "12345",
- "name": "Sales",
- "status": apideck_unify.DepartmentStatus.ACTIVE,
- "subsidiaries": [
- {
- "name": "SpaceX",
- },
- {
- "name": "SpaceX",
- },
- {
- "name": "SpaceX",
- },
- ],
- "row_version": "1-12345",
- "pass_through": [
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+
+ res = apideck.accounting.departments.update(id="", service_id="salesforce", parent_id="12345", name="Sales", status=apideck_unify.DepartmentStatus.ACTIVE, subsidiaries=[
+ {
+ "name": "SpaceX",
+ },
+ {
+ "name": "SpaceX",
+ },
+ {
+ "name": "SpaceX",
+ },
+ ], row_version="1-12345", pass_through=[
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ ],
+ },
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- ],
- }, service_id="salesforce")
+ },
+ ],
+ },
+ ])
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description | Example |
-| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
-| `accounting_department` | [models.AccountingDepartmentInput](../../models/accountingdepartmentinput.md) | :heavy_check_mark: | N/A | |
-| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
-| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
+| Parameter | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `parent_id` | *OptionalNullable[str]* | :heavy_minus_sign: | A unique identifier for an object. | 12345 |
+| `name` | *OptionalNullable[str]* | :heavy_minus_sign: | The name of the department. | Sales |
+| `status` | [Optional[models.DepartmentStatus]](../../models/departmentstatus.md) | :heavy_minus_sign: | Based on the status some functionality is enabled or disabled. | active |
+| `subsidiaries` | List[[models.SubsidiaryReferenceInput](../../models/subsidiaryreferenceinput.md)] | :heavy_minus_sign: | N/A | |
+| `row_version` | *OptionalNullable[str]* | :heavy_minus_sign: | A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. | 1-12345 |
+| `pass_through` | List[[models.PassThroughBody](../../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -320,11 +319,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.accounting.departments.delete(id="", service_id="salesforce")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
diff --git a/docs/sdks/drivegroups/README.md b/docs/sdks/drivegroups/README.md
index 2deb2694..9a3e320c 100644
--- a/docs/sdks/drivegroups/README.md
+++ b/docs/sdks/drivegroups/README.md
@@ -26,29 +26,32 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.file_storage.drive_groups.list(request={
- "service_id": "salesforce",
- "filter_": {
- "parent_group_id": "1234",
- },
- "pass_through": {
- "search": "San Francisco",
- },
- "fields": "id,updated_at",
- })
- if res is not None:
- # handle response
- pass
+ res = apideck.file_storage.drive_groups.list(service_id="salesforce", filter_={
+ "parent_group_id": "1234",
+ }, pass_through={
+ "search": "San Francisco",
+ }, fields="id,updated_at")
+
+ while res is not None:
+ # Handle items
+
+ res = res.next()
```
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
-| `request` | [models.FileStorageDriveGroupsAllRequest](../../models/filestoragedrivegroupsallrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
+| Parameter | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | |
+| `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | |
+| `filter_` | [Optional[models.DriveGroupsFilter]](../../models/drivegroupsfilter.md) | :heavy_minus_sign: | Apply filters | |
+| `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} |
+| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: `fields=name,email,addresses.city`
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -80,49 +83,47 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.file_storage.drive_groups.create(drive_group={
- "name": "accounting",
- "display_name": "accounting",
- "description": "A description",
- "pass_through": [
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+
+ res = apideck.file_storage.drive_groups.create(name="accounting", service_id="salesforce", display_name="accounting", description="A description", pass_through=[
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- ],
- }, service_id="salesforce")
+ },
+ ],
+ },
+ ])
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description | Example |
-| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| `drive_group` | [models.DriveGroupInput](../../models/drivegroupinput.md) | :heavy_check_mark: | N/A | |
-| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
-| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
+| Parameter | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `name` | *str* | :heavy_check_mark: | The name of the drive group | accounting |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `display_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The display name of the drive group | accounting |
+| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | A description of the object. | A description |
+| `pass_through` | List[[models.PassThroughBody](../../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -154,11 +155,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.file_storage.drive_groups.get(id="", service_id="salesforce", fields="id,updated_at")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
@@ -202,92 +203,90 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.file_storage.drive_groups.update(id="", drive_group={
- "name": "accounting",
- "display_name": "accounting",
- "description": "A description",
- "pass_through": [
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+
+ res = apideck.file_storage.drive_groups.update(id="", name="accounting", service_id="salesforce", display_name="accounting", description="A description", pass_through=[
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ ],
+ },
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ ],
+ },
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- ],
- }, service_id="salesforce")
+ },
+ ],
+ },
+ ])
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description | Example |
-| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
-| `drive_group` | [models.DriveGroupInput](../../models/drivegroupinput.md) | :heavy_check_mark: | N/A | |
-| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
-| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
+| Parameter | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
+| `name` | *str* | :heavy_check_mark: | The name of the drive group | accounting |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `display_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The display name of the drive group | accounting |
+| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | A description of the object. | A description |
+| `pass_through` | List[[models.PassThroughBody](../../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -319,11 +318,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.file_storage.drive_groups.delete(id="", service_id="salesforce")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
diff --git a/docs/sdks/drives/README.md b/docs/sdks/drives/README.md
index cc1ab47c..18a25eb1 100644
--- a/docs/sdks/drives/README.md
+++ b/docs/sdks/drives/README.md
@@ -26,26 +26,29 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.file_storage.drives.list(request={
- "service_id": "salesforce",
- "filter_": {
- "group_id": "1234",
- },
- "fields": "id,updated_at",
- })
- if res is not None:
- # handle response
- pass
+ res = apideck.file_storage.drives.list(service_id="salesforce", filter_={
+ "group_id": "1234",
+ }, fields="id,updated_at")
+
+ while res is not None:
+ # Handle items
+
+ res = res.next()
```
### Parameters
-| Parameter | Type | Required | Description |
-| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
-| `request` | [models.FileStorageDrivesAllRequest](../../models/filestoragedrivesallrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
+| Parameter | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | |
+| `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | |
+| `filter_` | [Optional[models.DrivesFilter]](../../models/drivesfilter.md) | :heavy_minus_sign: | Apply filters | |
+| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: `fields=name,email,addresses.city`
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -77,48 +80,46 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.file_storage.drives.create(drive={
- "name": "Project Resources",
- "description": "A description",
- "pass_through": [
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+
+ res = apideck.file_storage.drives.create(name="Project Resources", service_id="salesforce", description="A description", pass_through=[
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- ],
- }, service_id="salesforce")
+ },
+ ],
+ },
+ ])
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description | Example |
-| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| `drive` | [models.DriveInput](../../models/driveinput.md) | :heavy_check_mark: | N/A | |
-| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
-| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
+| Parameter | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `name` | *str* | :heavy_check_mark: | The name of the drive | Project Resources |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | A description of the object. | A description |
+| `pass_through` | List[[models.PassThroughBody](../../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -150,11 +151,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.file_storage.drives.get(id="", service_id="salesforce", fields="id,updated_at")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
@@ -198,91 +199,89 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.file_storage.drives.update(id="", drive={
- "name": "Project Resources",
- "description": "A description",
- "pass_through": [
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+
+ res = apideck.file_storage.drives.update(id="", name="Project Resources", service_id="salesforce", description="A description", pass_through=[
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ ],
+ },
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ ],
+ },
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- ],
- }, service_id="salesforce")
+ },
+ ],
+ },
+ ])
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description | Example |
-| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
-| `drive` | [models.DriveInput](../../models/driveinput.md) | :heavy_check_mark: | N/A | |
-| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
-| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
+| Parameter | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
+| `name` | *str* | :heavy_check_mark: | The name of the drive | Project Resources |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | A description of the object. | A description |
+| `pass_through` | List[[models.PassThroughBody](../../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -314,11 +313,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.file_storage.drives.delete(id="", service_id="salesforce")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
diff --git a/docs/sdks/employeepayrolls/README.md b/docs/sdks/employeepayrolls/README.md
index 6396d6d5..61f3cddd 100644
--- a/docs/sdks/employeepayrolls/README.md
+++ b/docs/sdks/employeepayrolls/README.md
@@ -23,31 +23,30 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.hris.employee_payrolls.list(request={
- "employee_id": "",
- "service_id": "salesforce",
- "filter_": {
- "start_date": "2022-04-08",
- "end_date": "2022-04-21",
- },
- "pass_through": {
- "search": "San Francisco",
- },
- "fields": "id,updated_at",
- })
-
- if res is not None:
- # handle response
- pass
+
+ res = apideck.hris.employee_payrolls.list(employee_id="", service_id="salesforce", filter_={
+ "start_date": "2022-04-08",
+ "end_date": "2022-04-21",
+ }, pass_through={
+ "search": "San Francisco",
+ }, fields="id,updated_at")
+
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description |
-| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
-| `request` | [models.HrisEmployeePayrollsAllRequest](../../models/hrisemployeepayrollsallrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
+| Parameter | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `employee_id` | *str* | :heavy_check_mark: | ID of the employee you are acting upon. | |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `filter_` | [Optional[models.PayrollsFilter]](../../models/payrollsfilter.md) | :heavy_minus_sign: | Apply filters | {
"start_date": "2022-04-08",
"end_date": "2022-04-21"
} |
+| `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} |
+| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: `fields=name,email,addresses.city`
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -79,25 +78,24 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.hris.employee_payrolls.get(request={
- "payroll_id": "",
- "employee_id": "",
- "service_id": "salesforce",
- "fields": "id,updated_at",
- })
- if res is not None:
- # handle response
- pass
+ res = apideck.hris.employee_payrolls.get(payroll_id="", employee_id="", service_id="salesforce", fields="id,updated_at")
+
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description |
-| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
-| `request` | [models.HrisEmployeePayrollsOneRequest](../../models/hrisemployeepayrollsonerequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
+| Parameter | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `payroll_id` | *str* | :heavy_check_mark: | ID of the payroll you are acting upon. | |
+| `employee_id` | *str* | :heavy_check_mark: | ID of the employee you are acting upon. | |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: `fields=name,email,addresses.city`
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
diff --git a/docs/sdks/employees/README.md b/docs/sdks/employees/README.md
index 4b511ee5..1617e3f4 100644
--- a/docs/sdks/employees/README.md
+++ b/docs/sdks/employees/README.md
@@ -27,41 +27,44 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.hris.employees.list(request={
- "service_id": "salesforce",
- "filter_": {
- "company_id": "1234",
- "email": "elon@tesla.com",
- "first_name": "Elon",
- "title": "Manager",
- "last_name": "Musk",
- "manager_id": "1234",
- "employment_status": apideck_unify.EmployeesFilterEmploymentStatus.ACTIVE,
- "employee_number": "123456-AB",
- "department_id": "1234",
- },
- "sort": {
- "by": apideck_unify.EmployeesSortBy.CREATED_AT,
- "direction": apideck_unify.SortDirection.DESC,
- },
- "pass_through": {
- "search": "San Francisco",
- },
- "fields": "id,updated_at",
- })
- if res is not None:
- # handle response
- pass
+ res = apideck.hris.employees.list(service_id="salesforce", filter_={
+ "company_id": "1234",
+ "email": "elon@tesla.com",
+ "first_name": "Elon",
+ "title": "Manager",
+ "last_name": "Musk",
+ "manager_id": "1234",
+ "employment_status": apideck_unify.EmployeesFilterEmploymentStatus.ACTIVE,
+ "employee_number": "123456-AB",
+ "department_id": "1234",
+ }, sort={
+ "by": apideck_unify.EmployeesSortBy.CREATED_AT,
+ "direction": apideck_unify.SortDirection.DESC,
+ }, pass_through={
+ "search": "San Francisco",
+ }, fields="id,updated_at")
+
+ while res is not None:
+ # Handle items
+
+ res = res.next()
```
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
-| `request` | [models.HrisEmployeesAllRequest](../../models/hrisemployeesallrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
+| Parameter | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | |
+| `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | |
+| `filter_` | [Optional[models.EmployeesFilter]](../../models/employeesfilter.md) | :heavy_minus_sign: | Apply filters | {
"company_id": "1234",
"email": "elon@tesla.com",
"first_name": "Elon",
"last_name": "Musk",
"title": "Manager",
"manager_id": "1234",
"employment_status": "active",
"employee_number": "123456-AB",
"department_id": "1234"
} |
+| `sort` | [Optional[models.EmployeesSort]](../../models/employeessort.md) | :heavy_minus_sign: | Apply sorting | {
"by": "created_at",
"direction": "desc"
} |
+| `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} |
+| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: `fields=name,email,addresses.city`
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -95,151 +98,46 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.hris.employees.create(employee={
- "id": "12345",
+
+ res = apideck.hris.employees.create(service_id="salesforce", id="12345", first_name="Elon", last_name="Musk", middle_name="D.", display_name="Technoking", preferred_name="Elon Musk", initials="EM", salutation="Mr", title="CEO", marital_status="married", partner={
"first_name": "Elon",
"last_name": "Musk",
"middle_name": "D.",
- "display_name": "Technoking",
- "preferred_name": "Elon Musk",
+ "gender": apideck_unify.Gender.MALE,
"initials": "EM",
- "salutation": "Mr",
- "title": "CEO",
- "marital_status": "married",
- "partner": {
- "first_name": "Elon",
- "last_name": "Musk",
- "middle_name": "D.",
- "gender": apideck_unify.Gender.MALE,
- "initials": "EM",
- "birthday": dateutil.parser.parse("2000-08-12").date(),
- "deceased_on": dateutil.parser.parse("2000-08-12").date(),
- },
- "division": "Europe",
- "division_id": "12345",
- "department_id": "12345",
- "department_name": "12345",
- "team": {
- "id": "1234",
- "name": "Full Stack Engineers",
- },
- "company_id": "23456",
- "company_name": "SpaceX",
- "employment_start_date": "2021-10-26",
- "employment_end_date": "2028-10-26",
- "leaving_reason": apideck_unify.LeavingReason.RESIGNED,
- "employee_number": "123456-AB",
- "employment_status": apideck_unify.EmploymentStatus.ACTIVE,
- "ethnicity": "African American",
- "manager": {
- "id": "12345",
- "name": "Elon Musk",
- "first_name": "Elon",
- "last_name": "Musk",
- "email": "elon@musk.com",
- "employment_status": apideck_unify.EmploymentStatus.ACTIVE,
- },
- "direct_reports": [
- "a0d636c6-43b3-4bde-8c70-85b707d992f4",
- "a98lfd96-43b3-4bde-8c70-85b707d992e6",
- ],
- "social_security_number": "123456789",
"birthday": dateutil.parser.parse("2000-08-12").date(),
"deceased_on": dateutil.parser.parse("2000-08-12").date(),
- "country_of_birth": "US",
- "description": "A description",
- "gender": apideck_unify.Gender.MALE,
- "pronouns": "she,her",
- "preferred_language": "EN",
- "languages": [
- "EN",
- ],
- "nationalities": [
- "US",
- ],
- "photo_url": "https://unavatar.io/elon-musk",
- "timezone": "Europe/London",
- "source": "lever",
- "source_id": "12345",
- "record_url": "https://app.intercom.io/contacts/12345",
- "jobs": [
- {
- "title": "CEO",
- "role": "Sales",
- "start_date": dateutil.parser.parse("2020-08-12").date(),
- "end_date": dateutil.parser.parse("2020-08-12").date(),
- "compensation_rate": 72000,
- "currency": apideck_unify.Currency.USD,
- "payment_unit": apideck_unify.PaymentUnit.YEAR,
- "hired_at": dateutil.parser.parse("2020-08-12").date(),
- "is_primary": True,
- "is_manager": True,
- "status": apideck_unify.EmployeeJobStatus.ACTIVE,
- "location": {
- "id": "123",
- "type": apideck_unify.Type.PRIMARY,
- "string": "25 Spring Street, Blackburn, VIC 3130",
- "name": "HQ US",
- "line1": "Main street",
- "line2": "apt #",
- "line3": "Suite #",
- "line4": "delivery instructions",
- "street_number": "25",
- "city": "San Francisco",
- "state": "CA",
- "postal_code": "94104",
- "country": "US",
- "latitude": "40.759211",
- "longitude": "-73.984638",
- "county": "Santa Clara",
- "contact_name": "Elon Musk",
- "salutation": "Mr",
- "phone_number": "111-111-1111",
- "fax": "122-111-1111",
- "email": "elon@musk.com",
- "website": "https://elonmusk.com",
- "notes": "Address notes or delivery instructions.",
- "row_version": "1-12345",
- },
- },
- ],
- "compensations": [
- {
- "rate": 50,
- "payment_unit": apideck_unify.PaymentUnit.HOUR,
- "flsa_status": apideck_unify.FlsaStatus.NONEXEMPT,
- "effective_date": "2021-06-11",
- },
- ],
- "works_remote": True,
- "addresses": [
- {
- "id": "123",
- "type": apideck_unify.Type.PRIMARY,
- "string": "25 Spring Street, Blackburn, VIC 3130",
- "name": "HQ US",
- "line1": "Main street",
- "line2": "apt #",
- "line3": "Suite #",
- "line4": "delivery instructions",
- "street_number": "25",
- "city": "San Francisco",
- "state": "CA",
- "postal_code": "94104",
- "country": "US",
- "latitude": "40.759211",
- "longitude": "-73.984638",
- "county": "Santa Clara",
- "contact_name": "Elon Musk",
- "salutation": "Mr",
- "phone_number": "111-111-1111",
- "fax": "122-111-1111",
- "email": "elon@musk.com",
- "website": "https://elonmusk.com",
- "notes": "Address notes or delivery instructions.",
- "row_version": "1-12345",
- },
- {
+ }, division="Europe", division_id="12345", department_id="12345", department_name="12345", team={
+ "id": "1234",
+ "name": "Full Stack Engineers",
+ }, company_id="23456", company_name="SpaceX", employment_start_date="2021-10-26", employment_end_date="2028-10-26", leaving_reason=apideck_unify.LeavingReason.RESIGNED, employee_number="123456-AB", employment_status=apideck_unify.EmploymentStatus.ACTIVE, ethnicity="African American", manager={
+ "id": "12345",
+ "name": "Elon Musk",
+ "first_name": "Elon",
+ "last_name": "Musk",
+ "email": "elon@musk.com",
+ "employment_status": apideck_unify.EmploymentStatus.ACTIVE,
+ }, direct_reports=[
+ "a0d636c6-43b3-4bde-8c70-85b707d992f4",
+ "a98lfd96-43b3-4bde-8c70-85b707d992e6",
+ ], social_security_number="123456789", birthday=dateutil.parser.parse("2000-08-12").date(), deceased_on=dateutil.parser.parse("2000-08-12").date(), country_of_birth="US", description="A description", gender=apideck_unify.Gender.MALE, pronouns="she,her", preferred_language="EN", languages=[
+ "EN",
+ ], nationalities=[
+ "US",
+ ], photo_url="https://unavatar.io/elon-musk", timezone="Europe/London", source="lever", source_id="12345", record_url="https://app.intercom.io/contacts/12345", jobs=[
+ {
+ "title": "CEO",
+ "role": "Sales",
+ "start_date": dateutil.parser.parse("2020-08-12").date(),
+ "end_date": dateutil.parser.parse("2020-08-12").date(),
+ "compensation_rate": 72000,
+ "currency": apideck_unify.Currency.USD,
+ "payment_unit": apideck_unify.PaymentUnit.YEAR,
+ "hired_at": dateutil.parser.parse("2020-08-12").date(),
+ "is_primary": True,
+ "is_manager": True,
+ "status": apideck_unify.EmployeeJobStatus.ACTIVE,
+ "location": {
"id": "123",
"type": apideck_unify.Type.PRIMARY,
"string": "25 Spring Street, Blackburn, VIC 3130",
@@ -265,136 +163,241 @@ with Apideck(
"notes": "Address notes or delivery instructions.",
"row_version": "1-12345",
},
- ],
- "phone_numbers": [
- {
- "number": "111-111-1111",
- "id": "12345",
- "country_code": "1",
- "area_code": "323",
- "extension": "105",
- "type": apideck_unify.PhoneNumberType.PRIMARY,
- },
- ],
- "emails": [
- {
- "email": "elon@musk.com",
- "id": "123",
- "type": apideck_unify.EmailType.PRIMARY,
- },
- ],
- "custom_fields": [
- {
- "id": "2389328923893298",
- "name": "employee_level",
- "description": "Employee Level",
- "value": True,
- },
- ],
- "social_links": [
- {
- "url": "https://www.twitter.com/apideck",
- "id": "12345",
- "type": "twitter",
- },
- {
- "url": "https://www.twitter.com/apideck",
- "id": "12345",
- "type": "twitter",
- },
- {
- "url": "https://www.twitter.com/apideck",
- "id": "12345",
- "type": "twitter",
- },
- ],
- "bank_accounts": [
- {
- "bank_name": "Monzo",
- "account_number": "123465",
- "account_name": "SPACEX LLC",
- "account_type": apideck_unify.AccountType.CREDIT_CARD,
- "iban": "CH2989144532982975332",
- "bic": "AUDSCHGGXXX",
- "routing_number": "012345678",
- "bsb_number": "062-001",
- "branch_identifier": "001",
- "bank_code": "BNH",
- "currency": apideck_unify.Currency.USD,
- },
- {
- "bank_name": "Monzo",
- "account_number": "123465",
- "account_name": "SPACEX LLC",
- "account_type": apideck_unify.AccountType.CREDIT_CARD,
- "iban": "CH2989144532982975332",
- "bic": "AUDSCHGGXXX",
- "routing_number": "012345678",
- "bsb_number": "062-001",
- "branch_identifier": "001",
- "bank_code": "BNH",
- "currency": apideck_unify.Currency.USD,
- },
- {
- "bank_name": "Monzo",
- "account_number": "123465",
- "account_name": "SPACEX LLC",
- "account_type": apideck_unify.AccountType.CREDIT_CARD,
- "iban": "CH2989144532982975332",
- "bic": "AUDSCHGGXXX",
- "routing_number": "012345678",
- "bsb_number": "062-001",
- "branch_identifier": "001",
- "bank_code": "BNH",
- "currency": apideck_unify.Currency.USD,
- },
- ],
- "tax_code": "1111",
- "tax_id": "234-32-0000",
- "dietary_preference": "Veggie",
- "food_allergies": [
- "No allergies",
- ],
- "probation_period": {
- "start_date": dateutil.parser.parse("2021-10-01").date(),
- "end_date": dateutil.parser.parse("2021-11-28").date(),
},
- "tags": [
- "New",
- ],
- "row_version": "1-12345",
- "deleted": True,
- "pass_through": [
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ ], compensations=[
+ {
+ "rate": 50,
+ "payment_unit": apideck_unify.PaymentUnit.HOUR,
+ "flsa_status": apideck_unify.FlsaStatus.NONEXEMPT,
+ "effective_date": "2021-06-11",
+ },
+ ], works_remote=True, addresses=[
+ {
+ "id": "123",
+ "type": apideck_unify.Type.PRIMARY,
+ "string": "25 Spring Street, Blackburn, VIC 3130",
+ "name": "HQ US",
+ "line1": "Main street",
+ "line2": "apt #",
+ "line3": "Suite #",
+ "line4": "delivery instructions",
+ "street_number": "25",
+ "city": "San Francisco",
+ "state": "CA",
+ "postal_code": "94104",
+ "country": "US",
+ "latitude": "40.759211",
+ "longitude": "-73.984638",
+ "county": "Santa Clara",
+ "contact_name": "Elon Musk",
+ "salutation": "Mr",
+ "phone_number": "111-111-1111",
+ "fax": "122-111-1111",
+ "email": "elon@musk.com",
+ "website": "https://elonmusk.com",
+ "notes": "Address notes or delivery instructions.",
+ "row_version": "1-12345",
+ },
+ {
+ "id": "123",
+ "type": apideck_unify.Type.PRIMARY,
+ "string": "25 Spring Street, Blackburn, VIC 3130",
+ "name": "HQ US",
+ "line1": "Main street",
+ "line2": "apt #",
+ "line3": "Suite #",
+ "line4": "delivery instructions",
+ "street_number": "25",
+ "city": "San Francisco",
+ "state": "CA",
+ "postal_code": "94104",
+ "country": "US",
+ "latitude": "40.759211",
+ "longitude": "-73.984638",
+ "county": "Santa Clara",
+ "contact_name": "Elon Musk",
+ "salutation": "Mr",
+ "phone_number": "111-111-1111",
+ "fax": "122-111-1111",
+ "email": "elon@musk.com",
+ "website": "https://elonmusk.com",
+ "notes": "Address notes or delivery instructions.",
+ "row_version": "1-12345",
+ },
+ ], phone_numbers=[
+ {
+ "number": "111-111-1111",
+ "id": "12345",
+ "country_code": "1",
+ "area_code": "323",
+ "extension": "105",
+ "type": apideck_unify.PhoneNumberType.PRIMARY,
+ },
+ ], emails=[
+ {
+ "email": "elon@musk.com",
+ "id": "123",
+ "type": apideck_unify.EmailType.PRIMARY,
+ },
+ ], custom_fields=[
+ {
+ "id": "2389328923893298",
+ "name": "employee_level",
+ "description": "Employee Level",
+ "value": True,
+ },
+ ], social_links=[
+ {
+ "url": "https://www.twitter.com/apideck",
+ "id": "12345",
+ "type": "twitter",
+ },
+ {
+ "url": "https://www.twitter.com/apideck",
+ "id": "12345",
+ "type": "twitter",
+ },
+ {
+ "url": "https://www.twitter.com/apideck",
+ "id": "12345",
+ "type": "twitter",
+ },
+ ], bank_accounts=[
+ {
+ "bank_name": "Monzo",
+ "account_number": "123465",
+ "account_name": "SPACEX LLC",
+ "account_type": apideck_unify.AccountType.CREDIT_CARD,
+ "iban": "CH2989144532982975332",
+ "bic": "AUDSCHGGXXX",
+ "routing_number": "012345678",
+ "bsb_number": "062-001",
+ "branch_identifier": "001",
+ "bank_code": "BNH",
+ "currency": apideck_unify.Currency.USD,
+ },
+ {
+ "bank_name": "Monzo",
+ "account_number": "123465",
+ "account_name": "SPACEX LLC",
+ "account_type": apideck_unify.AccountType.CREDIT_CARD,
+ "iban": "CH2989144532982975332",
+ "bic": "AUDSCHGGXXX",
+ "routing_number": "012345678",
+ "bsb_number": "062-001",
+ "branch_identifier": "001",
+ "bank_code": "BNH",
+ "currency": apideck_unify.Currency.USD,
+ },
+ {
+ "bank_name": "Monzo",
+ "account_number": "123465",
+ "account_name": "SPACEX LLC",
+ "account_type": apideck_unify.AccountType.CREDIT_CARD,
+ "iban": "CH2989144532982975332",
+ "bic": "AUDSCHGGXXX",
+ "routing_number": "012345678",
+ "bsb_number": "062-001",
+ "branch_identifier": "001",
+ "bank_code": "BNH",
+ "currency": apideck_unify.Currency.USD,
+ },
+ ], tax_code="1111", tax_id="234-32-0000", dietary_preference="Veggie", food_allergies=[
+ "No allergies",
+ ], probation_period={
+ "start_date": dateutil.parser.parse("2021-10-01").date(),
+ "end_date": dateutil.parser.parse("2021-11-28").date(),
+ }, tags=[
+ "New",
+ ], row_version="1-12345", deleted=True, pass_through=[
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- ],
- }, service_id="salesforce")
+ },
+ ],
+ },
+ ])
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description | Example |
-| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| `employee` | [models.EmployeeInput](../../models/employeeinput.md) | :heavy_check_mark: | N/A | |
-| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
-| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
+| Parameter | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | A unique identifier for an object. | 12345 |
+| `first_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The first name of the person. | Elon |
+| `last_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The last name of the person. | Musk |
+| `middle_name` | *OptionalNullable[str]* | :heavy_minus_sign: | Middle name of the person. | D. |
+| `display_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The name used to display the employee, often a combination of their first and last names. | Technoking |
+| `preferred_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The name the employee prefers to be addressed by, which may be different from their legal name. | Elon Musk |
+| `initials` | *OptionalNullable[str]* | :heavy_minus_sign: | The initials of the person, usually derived from their first, middle, and last names. | EM |
+| `salutation` | *OptionalNullable[str]* | :heavy_minus_sign: | A formal salutation for the person. For example, 'Mr', 'Mrs' | Mr |
+| `title` | *OptionalNullable[str]* | :heavy_minus_sign: | The job title of the person. | CEO |
+| `marital_status` | *OptionalNullable[str]* | :heavy_minus_sign: | The marital status of the employee. | married |
+| `partner` | [Optional[models.PersonInput]](../../models/personinput.md) | :heavy_minus_sign: | N/A | |
+| `division` | *OptionalNullable[str]* | :heavy_minus_sign: | The division the person is currently in. Usually a collection of departments or teams or regions. | Europe |
+| `division_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Unique identifier of the division this employee belongs to. | 12345 |
+| `department` | *OptionalNullable[str]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.
The department the person is currently in. [Deprecated](https://developers.apideck.com/changelog) in favor of the dedicated department_id and department_name field. | R&D |
+| `department_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Unique identifier of the department ID this employee belongs to. | 12345 |
+| `department_name` | *OptionalNullable[str]* | :heavy_minus_sign: | Name of the department this employee belongs to. | 12345 |
+| `team` | [OptionalNullable[models.Team]](../../models/team.md) | :heavy_minus_sign: | The team the person is currently in. | |
+| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The unique identifier of the company. | 23456 |
+| `company_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The name of the company. | SpaceX |
+| `employment_start_date` | *OptionalNullable[str]* | :heavy_minus_sign: | A Start Date is the date that the employee started working at the company | 2021-10-26 |
+| `employment_end_date` | *OptionalNullable[str]* | :heavy_minus_sign: | An End Date is the date that the employee ended working at the company | 2028-10-26 |
+| `leaving_reason` | [OptionalNullable[models.LeavingReason]](../../models/leavingreason.md) | :heavy_minus_sign: | The reason because the employment ended. | resigned |
+| `employee_number` | *OptionalNullable[str]* | :heavy_minus_sign: | An Employee Number, Employee ID or Employee Code, is a unique number that has been assigned to each individual staff member within a company. | 123456-AB |
+| `employment_status` | [OptionalNullable[models.EmploymentStatus]](../../models/employmentstatus.md) | :heavy_minus_sign: | The employment status of the employee, indicating whether they are currently employed, inactive, terminated, or in another status. | active |
+| `employment_role` | [Optional[models.EmploymentRole]](../../models/employmentrole.md) | :heavy_minus_sign: | N/A | |
+| `ethnicity` | *OptionalNullable[str]* | :heavy_minus_sign: | The ethnicity of the employee | African American |
+| `manager` | [Optional[models.Manager]](../../models/manager.md) | :heavy_minus_sign: | N/A | |
+| `direct_reports` | List[*str*] | :heavy_minus_sign: | Direct reports is an array of ids that reflect the individuals in an organizational hierarchy who are directly supervised by this specific employee. | [
"a0d636c6-43b3-4bde-8c70-85b707d992f4",
"a98lfd96-43b3-4bde-8c70-85b707d992e6"
] |
+| `social_security_number` | *OptionalNullable[str]* | :heavy_minus_sign: | A unique identifier assigned by the government. This field is considered sensitive information and may be subject to special security and privacy restrictions. | 123456789 |
+| `birthday` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The date of birth of the person. | 2000-08-12 |
+| `deceased_on` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The date the person deceased. | 2000-08-12 |
+| `country_of_birth` | *OptionalNullable[str]* | :heavy_minus_sign: | Country code according to ISO 3166-1 alpha-2. | US |
+| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | A description of the object. | A description |
+| `gender` | [OptionalNullable[models.Gender]](../../models/gender.md) | :heavy_minus_sign: | The gender represents the gender identity of a person. | male |
+| `pronouns` | *OptionalNullable[str]* | :heavy_minus_sign: | The preferred pronouns of the person. | she,her |
+| `preferred_language` | *OptionalNullable[str]* | :heavy_minus_sign: | language code according to ISO 639-1. For the United States - EN | EN |
+| `languages` | List[*str*] | :heavy_minus_sign: | N/A | |
+| `nationalities` | List[*str*] | :heavy_minus_sign: | N/A | |
+| `photo_url` | *OptionalNullable[str]* | :heavy_minus_sign: | The URL of the photo of a person. | https://unavatar.io/elon-musk |
+| `timezone` | *OptionalNullable[str]* | :heavy_minus_sign: | The time zone related to the resource. The value is a string containing a standard time zone identifier, e.g. Europe/London. | Europe/London |
+| `source` | *OptionalNullable[str]* | :heavy_minus_sign: | When the employee is imported as a new hire, this field indicates what system (e.g. the name of the ATS) this employee was imported from. | lever |
+| `source_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Unique identifier of the employee in the system this employee was imported from (e.g. the ID in the ATS). | 12345 |
+| `record_url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | https://app.intercom.io/contacts/12345 |
+| `jobs` | List[[models.EmployeeJobInput](../../models/employeejobinput.md)] | :heavy_minus_sign: | N/A | |
+| `compensations` | List[[models.EmployeeCompensationInput](../../models/employeecompensationinput.md)] | :heavy_minus_sign: | N/A | |
+| `works_remote` | *OptionalNullable[bool]* | :heavy_minus_sign: | Indicates if the employee works from a remote location. | true |
+| `addresses` | List[[models.Address](../../models/address.md)] | :heavy_minus_sign: | N/A | |
+| `phone_numbers` | List[[models.PhoneNumber](../../models/phonenumber.md)] | :heavy_minus_sign: | N/A | |
+| `emails` | List[[models.Email](../../models/email.md)] | :heavy_minus_sign: | N/A | |
+| `custom_fields` | List[[models.CustomField](../../models/customfield.md)] | :heavy_minus_sign: | N/A | |
+| `social_links` | List[[models.SocialLink](../../models/sociallink.md)] | :heavy_minus_sign: | N/A | |
+| `bank_accounts` | List[[models.BankAccount](../../models/bankaccount.md)] | :heavy_minus_sign: | N/A | |
+| `tax_code` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 1111 |
+| `tax_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 234-32-0000 |
+| `dietary_preference` | *OptionalNullable[str]* | :heavy_minus_sign: | Indicate the employee's dietary preference. | Veggie |
+| `food_allergies` | List[*str*] | :heavy_minus_sign: | Indicate the employee's food allergies. | [
"No allergies"
] |
+| `probation_period` | [Optional[models.ProbationPeriod]](../../models/probationperiod.md) | :heavy_minus_sign: | N/A | |
+| `tags` | List[*str*] | :heavy_minus_sign: | N/A | [
"New"
] |
+| `row_version` | *OptionalNullable[str]* | :heavy_minus_sign: | A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. | 1-12345 |
+| `deleted` | *OptionalNullable[bool]* | :heavy_minus_sign: | Flag to indicate if the object is deleted. | true |
+| `pass_through` | List[[models.PassThroughBody](../../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -426,30 +429,29 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.hris.employees.get(request={
- "id": "",
- "service_id": "salesforce",
- "fields": "id,updated_at",
- "filter_": {
- "company_id": "1234",
- },
- "pass_through": {
- "search": "San Francisco",
- },
+
+ res = apideck.hris.employees.get(id="", service_id="salesforce", fields="id,updated_at", filter_={
+ "company_id": "1234",
+ }, pass_through={
+ "search": "San Francisco",
})
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
-| `request` | [models.HrisEmployeesOneRequest](../../models/hrisemployeesonerequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
+| Parameter | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: `fields=name,email,addresses.city`
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at |
+| `filter_` | [Optional[models.EmployeesOneFilter]](../../models/employeesonefilter.md) | :heavy_minus_sign: | Apply filters | {
"company_id": "1234"
} |
+| `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -483,203 +485,46 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.hris.employees.update(id="", employee={
- "id": "12345",
+
+ res = apideck.hris.employees.update(id_param="", service_id="salesforce", id="12345", first_name="Elon", last_name="Musk", middle_name="D.", display_name="Technoking", preferred_name="Elon Musk", initials="EM", salutation="Mr", title="CEO", marital_status="married", partner={
"first_name": "Elon",
"last_name": "Musk",
"middle_name": "D.",
- "display_name": "Technoking",
- "preferred_name": "Elon Musk",
+ "gender": apideck_unify.Gender.MALE,
"initials": "EM",
- "salutation": "Mr",
- "title": "CEO",
- "marital_status": "married",
- "partner": {
- "first_name": "Elon",
- "last_name": "Musk",
- "middle_name": "D.",
- "gender": apideck_unify.Gender.MALE,
- "initials": "EM",
- "birthday": dateutil.parser.parse("2000-08-12").date(),
- "deceased_on": dateutil.parser.parse("2000-08-12").date(),
- },
- "division": "Europe",
- "division_id": "12345",
- "department_id": "12345",
- "department_name": "12345",
- "team": {
- "id": "1234",
- "name": "Full Stack Engineers",
- },
- "company_id": "23456",
- "company_name": "SpaceX",
- "employment_start_date": "2021-10-26",
- "employment_end_date": "2028-10-26",
- "leaving_reason": apideck_unify.LeavingReason.RESIGNED,
- "employee_number": "123456-AB",
- "employment_status": apideck_unify.EmploymentStatus.ACTIVE,
- "ethnicity": "African American",
- "manager": {
- "id": "12345",
- "name": "Elon Musk",
- "first_name": "Elon",
- "last_name": "Musk",
- "email": "elon@musk.com",
- "employment_status": apideck_unify.EmploymentStatus.ACTIVE,
- },
- "direct_reports": [
- "a0d636c6-43b3-4bde-8c70-85b707d992f4",
- "a98lfd96-43b3-4bde-8c70-85b707d992e6",
- ],
- "social_security_number": "123456789",
"birthday": dateutil.parser.parse("2000-08-12").date(),
"deceased_on": dateutil.parser.parse("2000-08-12").date(),
- "country_of_birth": "US",
- "description": "A description",
- "gender": apideck_unify.Gender.MALE,
- "pronouns": "she,her",
- "preferred_language": "EN",
- "languages": [
- "EN",
- ],
- "nationalities": [
- "US",
- ],
- "photo_url": "https://unavatar.io/elon-musk",
- "timezone": "Europe/London",
- "source": "lever",
- "source_id": "12345",
- "record_url": "https://app.intercom.io/contacts/12345",
- "jobs": [
- {
- "title": "CEO",
- "role": "Sales",
- "start_date": dateutil.parser.parse("2020-08-12").date(),
- "end_date": dateutil.parser.parse("2020-08-12").date(),
- "compensation_rate": 72000,
- "currency": apideck_unify.Currency.USD,
- "payment_unit": apideck_unify.PaymentUnit.YEAR,
- "hired_at": dateutil.parser.parse("2020-08-12").date(),
- "is_primary": True,
- "is_manager": True,
- "status": apideck_unify.EmployeeJobStatus.ACTIVE,
- "location": {
- "id": "123",
- "type": apideck_unify.Type.PRIMARY,
- "string": "25 Spring Street, Blackburn, VIC 3130",
- "name": "HQ US",
- "line1": "Main street",
- "line2": "apt #",
- "line3": "Suite #",
- "line4": "delivery instructions",
- "street_number": "25",
- "city": "San Francisco",
- "state": "CA",
- "postal_code": "94104",
- "country": "US",
- "latitude": "40.759211",
- "longitude": "-73.984638",
- "county": "Santa Clara",
- "contact_name": "Elon Musk",
- "salutation": "Mr",
- "phone_number": "111-111-1111",
- "fax": "122-111-1111",
- "email": "elon@musk.com",
- "website": "https://elonmusk.com",
- "notes": "Address notes or delivery instructions.",
- "row_version": "1-12345",
- },
- },
- {
- "title": "CEO",
- "role": "Sales",
- "start_date": dateutil.parser.parse("2020-08-12").date(),
- "end_date": dateutil.parser.parse("2020-08-12").date(),
- "compensation_rate": 72000,
- "currency": apideck_unify.Currency.USD,
- "payment_unit": apideck_unify.PaymentUnit.YEAR,
- "hired_at": dateutil.parser.parse("2020-08-12").date(),
- "is_primary": True,
- "is_manager": True,
- "status": apideck_unify.EmployeeJobStatus.ACTIVE,
- "location": {
- "id": "123",
- "type": apideck_unify.Type.PRIMARY,
- "string": "25 Spring Street, Blackburn, VIC 3130",
- "name": "HQ US",
- "line1": "Main street",
- "line2": "apt #",
- "line3": "Suite #",
- "line4": "delivery instructions",
- "street_number": "25",
- "city": "San Francisco",
- "state": "CA",
- "postal_code": "94104",
- "country": "US",
- "latitude": "40.759211",
- "longitude": "-73.984638",
- "county": "Santa Clara",
- "contact_name": "Elon Musk",
- "salutation": "Mr",
- "phone_number": "111-111-1111",
- "fax": "122-111-1111",
- "email": "elon@musk.com",
- "website": "https://elonmusk.com",
- "notes": "Address notes or delivery instructions.",
- "row_version": "1-12345",
- },
- },
- {
- "title": "CEO",
- "role": "Sales",
- "start_date": dateutil.parser.parse("2020-08-12").date(),
- "end_date": dateutil.parser.parse("2020-08-12").date(),
- "compensation_rate": 72000,
- "currency": apideck_unify.Currency.USD,
- "payment_unit": apideck_unify.PaymentUnit.YEAR,
- "hired_at": dateutil.parser.parse("2020-08-12").date(),
- "is_primary": True,
- "is_manager": True,
- "status": apideck_unify.EmployeeJobStatus.ACTIVE,
- "location": {
- "id": "123",
- "type": apideck_unify.Type.PRIMARY,
- "string": "25 Spring Street, Blackburn, VIC 3130",
- "name": "HQ US",
- "line1": "Main street",
- "line2": "apt #",
- "line3": "Suite #",
- "line4": "delivery instructions",
- "street_number": "25",
- "city": "San Francisco",
- "state": "CA",
- "postal_code": "94104",
- "country": "US",
- "latitude": "40.759211",
- "longitude": "-73.984638",
- "county": "Santa Clara",
- "contact_name": "Elon Musk",
- "salutation": "Mr",
- "phone_number": "111-111-1111",
- "fax": "122-111-1111",
- "email": "elon@musk.com",
- "website": "https://elonmusk.com",
- "notes": "Address notes or delivery instructions.",
- "row_version": "1-12345",
- },
- },
- ],
- "compensations": [
- {
- "rate": 50,
- "payment_unit": apideck_unify.PaymentUnit.HOUR,
- "flsa_status": apideck_unify.FlsaStatus.NONEXEMPT,
- "effective_date": "2021-06-11",
- },
- ],
- "works_remote": True,
- "addresses": [
- {
+ }, division="Europe", division_id="12345", department_id="12345", department_name="12345", team={
+ "id": "1234",
+ "name": "Full Stack Engineers",
+ }, company_id="23456", company_name="SpaceX", employment_start_date="2021-10-26", employment_end_date="2028-10-26", leaving_reason=apideck_unify.LeavingReason.RESIGNED, employee_number="123456-AB", employment_status=apideck_unify.EmploymentStatus.ACTIVE, ethnicity="African American", manager={
+ "id": "12345",
+ "name": "Elon Musk",
+ "first_name": "Elon",
+ "last_name": "Musk",
+ "email": "elon@musk.com",
+ "employment_status": apideck_unify.EmploymentStatus.ACTIVE,
+ }, direct_reports=[
+ "a0d636c6-43b3-4bde-8c70-85b707d992f4",
+ "a98lfd96-43b3-4bde-8c70-85b707d992e6",
+ ], social_security_number="123456789", birthday=dateutil.parser.parse("2000-08-12").date(), deceased_on=dateutil.parser.parse("2000-08-12").date(), country_of_birth="US", description="A description", gender=apideck_unify.Gender.MALE, pronouns="she,her", preferred_language="EN", languages=[
+ "EN",
+ ], nationalities=[
+ "US",
+ ], photo_url="https://unavatar.io/elon-musk", timezone="Europe/London", source="lever", source_id="12345", record_url="https://app.intercom.io/contacts/12345", jobs=[
+ {
+ "title": "CEO",
+ "role": "Sales",
+ "start_date": dateutil.parser.parse("2020-08-12").date(),
+ "end_date": dateutil.parser.parse("2020-08-12").date(),
+ "compensation_rate": 72000,
+ "currency": apideck_unify.Currency.USD,
+ "payment_unit": apideck_unify.PaymentUnit.YEAR,
+ "hired_at": dateutil.parser.parse("2020-08-12").date(),
+ "is_primary": True,
+ "is_manager": True,
+ "status": apideck_unify.EmployeeJobStatus.ACTIVE,
+ "location": {
"id": "123",
"type": apideck_unify.Type.PRIMARY,
"string": "25 Spring Street, Blackburn, VIC 3130",
@@ -705,7 +550,20 @@ with Apideck(
"notes": "Address notes or delivery instructions.",
"row_version": "1-12345",
},
- {
+ },
+ {
+ "title": "CEO",
+ "role": "Sales",
+ "start_date": dateutil.parser.parse("2020-08-12").date(),
+ "end_date": dateutil.parser.parse("2020-08-12").date(),
+ "compensation_rate": 72000,
+ "currency": apideck_unify.Currency.USD,
+ "payment_unit": apideck_unify.PaymentUnit.YEAR,
+ "hired_at": dateutil.parser.parse("2020-08-12").date(),
+ "is_primary": True,
+ "is_manager": True,
+ "status": apideck_unify.EmployeeJobStatus.ACTIVE,
+ "location": {
"id": "123",
"type": apideck_unify.Type.PRIMARY,
"string": "25 Spring Street, Blackburn, VIC 3130",
@@ -731,127 +589,271 @@ with Apideck(
"notes": "Address notes or delivery instructions.",
"row_version": "1-12345",
},
- ],
- "phone_numbers": [
- {
- "number": "111-111-1111",
- "id": "12345",
- "country_code": "1",
- "area_code": "323",
- "extension": "105",
- "type": apideck_unify.PhoneNumberType.PRIMARY,
- },
- ],
- "emails": [
- {
- "email": "elon@musk.com",
- "id": "123",
- "type": apideck_unify.EmailType.PRIMARY,
- },
- {
- "email": "elon@musk.com",
+ },
+ {
+ "title": "CEO",
+ "role": "Sales",
+ "start_date": dateutil.parser.parse("2020-08-12").date(),
+ "end_date": dateutil.parser.parse("2020-08-12").date(),
+ "compensation_rate": 72000,
+ "currency": apideck_unify.Currency.USD,
+ "payment_unit": apideck_unify.PaymentUnit.YEAR,
+ "hired_at": dateutil.parser.parse("2020-08-12").date(),
+ "is_primary": True,
+ "is_manager": True,
+ "status": apideck_unify.EmployeeJobStatus.ACTIVE,
+ "location": {
"id": "123",
- "type": apideck_unify.EmailType.PRIMARY,
- },
- {
+ "type": apideck_unify.Type.PRIMARY,
+ "string": "25 Spring Street, Blackburn, VIC 3130",
+ "name": "HQ US",
+ "line1": "Main street",
+ "line2": "apt #",
+ "line3": "Suite #",
+ "line4": "delivery instructions",
+ "street_number": "25",
+ "city": "San Francisco",
+ "state": "CA",
+ "postal_code": "94104",
+ "country": "US",
+ "latitude": "40.759211",
+ "longitude": "-73.984638",
+ "county": "Santa Clara",
+ "contact_name": "Elon Musk",
+ "salutation": "Mr",
+ "phone_number": "111-111-1111",
+ "fax": "122-111-1111",
"email": "elon@musk.com",
- "id": "123",
- "type": apideck_unify.EmailType.PRIMARY,
- },
- ],
- "custom_fields": [
- {
- "id": "2389328923893298",
- "name": "employee_level",
- "description": "Employee Level",
- "value": True,
- },
- {
- "id": "2389328923893298",
- "name": "employee_level",
- "description": "Employee Level",
- "value": {},
- },
- ],
- "social_links": [
- {
- "url": "https://www.twitter.com/apideck",
- "id": "12345",
- "type": "twitter",
- },
- {
- "url": "https://www.twitter.com/apideck",
- "id": "12345",
- "type": "twitter",
- },
- {
- "url": "https://www.twitter.com/apideck",
- "id": "12345",
- "type": "twitter",
- },
- ],
- "bank_accounts": [
- {
- "bank_name": "Monzo",
- "account_number": "123465",
- "account_name": "SPACEX LLC",
- "account_type": apideck_unify.AccountType.CREDIT_CARD,
- "iban": "CH2989144532982975332",
- "bic": "AUDSCHGGXXX",
- "routing_number": "012345678",
- "bsb_number": "062-001",
- "branch_identifier": "001",
- "bank_code": "BNH",
- "currency": apideck_unify.Currency.USD,
+ "website": "https://elonmusk.com",
+ "notes": "Address notes or delivery instructions.",
+ "row_version": "1-12345",
},
- ],
- "tax_code": "1111",
- "tax_id": "234-32-0000",
- "dietary_preference": "Veggie",
- "food_allergies": [
- "No allergies",
- ],
- "probation_period": {
- "start_date": dateutil.parser.parse("2021-10-01").date(),
- "end_date": dateutil.parser.parse("2021-11-28").date(),
},
- "tags": [
- "New",
- ],
- "row_version": "1-12345",
- "deleted": True,
- "pass_through": [
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ ], compensations=[
+ {
+ "rate": 50,
+ "payment_unit": apideck_unify.PaymentUnit.HOUR,
+ "flsa_status": apideck_unify.FlsaStatus.NONEXEMPT,
+ "effective_date": "2021-06-11",
+ },
+ ], works_remote=True, addresses=[
+ {
+ "id": "123",
+ "type": apideck_unify.Type.PRIMARY,
+ "string": "25 Spring Street, Blackburn, VIC 3130",
+ "name": "HQ US",
+ "line1": "Main street",
+ "line2": "apt #",
+ "line3": "Suite #",
+ "line4": "delivery instructions",
+ "street_number": "25",
+ "city": "San Francisco",
+ "state": "CA",
+ "postal_code": "94104",
+ "country": "US",
+ "latitude": "40.759211",
+ "longitude": "-73.984638",
+ "county": "Santa Clara",
+ "contact_name": "Elon Musk",
+ "salutation": "Mr",
+ "phone_number": "111-111-1111",
+ "fax": "122-111-1111",
+ "email": "elon@musk.com",
+ "website": "https://elonmusk.com",
+ "notes": "Address notes or delivery instructions.",
+ "row_version": "1-12345",
+ },
+ {
+ "id": "123",
+ "type": apideck_unify.Type.PRIMARY,
+ "string": "25 Spring Street, Blackburn, VIC 3130",
+ "name": "HQ US",
+ "line1": "Main street",
+ "line2": "apt #",
+ "line3": "Suite #",
+ "line4": "delivery instructions",
+ "street_number": "25",
+ "city": "San Francisco",
+ "state": "CA",
+ "postal_code": "94104",
+ "country": "US",
+ "latitude": "40.759211",
+ "longitude": "-73.984638",
+ "county": "Santa Clara",
+ "contact_name": "Elon Musk",
+ "salutation": "Mr",
+ "phone_number": "111-111-1111",
+ "fax": "122-111-1111",
+ "email": "elon@musk.com",
+ "website": "https://elonmusk.com",
+ "notes": "Address notes or delivery instructions.",
+ "row_version": "1-12345",
+ },
+ ], phone_numbers=[
+ {
+ "number": "111-111-1111",
+ "id": "12345",
+ "country_code": "1",
+ "area_code": "323",
+ "extension": "105",
+ "type": apideck_unify.PhoneNumberType.PRIMARY,
+ },
+ ], emails=[
+ {
+ "email": "elon@musk.com",
+ "id": "123",
+ "type": apideck_unify.EmailType.PRIMARY,
+ },
+ {
+ "email": "elon@musk.com",
+ "id": "123",
+ "type": apideck_unify.EmailType.PRIMARY,
+ },
+ {
+ "email": "elon@musk.com",
+ "id": "123",
+ "type": apideck_unify.EmailType.PRIMARY,
+ },
+ ], custom_fields=[
+ {
+ "id": "2389328923893298",
+ "name": "employee_level",
+ "description": "Employee Level",
+ "value": True,
+ },
+ {
+ "id": "2389328923893298",
+ "name": "employee_level",
+ "description": "Employee Level",
+ "value": {},
+ },
+ ], social_links=[
+ {
+ "url": "https://www.twitter.com/apideck",
+ "id": "12345",
+ "type": "twitter",
+ },
+ {
+ "url": "https://www.twitter.com/apideck",
+ "id": "12345",
+ "type": "twitter",
+ },
+ {
+ "url": "https://www.twitter.com/apideck",
+ "id": "12345",
+ "type": "twitter",
+ },
+ ], bank_accounts=[
+ {
+ "bank_name": "Monzo",
+ "account_number": "123465",
+ "account_name": "SPACEX LLC",
+ "account_type": apideck_unify.AccountType.CREDIT_CARD,
+ "iban": "CH2989144532982975332",
+ "bic": "AUDSCHGGXXX",
+ "routing_number": "012345678",
+ "bsb_number": "062-001",
+ "branch_identifier": "001",
+ "bank_code": "BNH",
+ "currency": apideck_unify.Currency.USD,
+ },
+ ], tax_code="1111", tax_id="234-32-0000", dietary_preference="Veggie", food_allergies=[
+ "No allergies",
+ ], probation_period={
+ "start_date": dateutil.parser.parse("2021-10-01").date(),
+ "end_date": dateutil.parser.parse("2021-11-28").date(),
+ }, tags=[
+ "New",
+ ], row_version="1-12345", deleted=True, pass_through=[
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- ],
- }, service_id="salesforce")
+ },
+ ],
+ },
+ ])
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description | Example |
-| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
-| `employee` | [models.EmployeeInput](../../models/employeeinput.md) | :heavy_check_mark: | N/A | |
-| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
-| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
+| Parameter | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `id_param` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | A unique identifier for an object. | 12345 |
+| `first_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The first name of the person. | Elon |
+| `last_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The last name of the person. | Musk |
+| `middle_name` | *OptionalNullable[str]* | :heavy_minus_sign: | Middle name of the person. | D. |
+| `display_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The name used to display the employee, often a combination of their first and last names. | Technoking |
+| `preferred_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The name the employee prefers to be addressed by, which may be different from their legal name. | Elon Musk |
+| `initials` | *OptionalNullable[str]* | :heavy_minus_sign: | The initials of the person, usually derived from their first, middle, and last names. | EM |
+| `salutation` | *OptionalNullable[str]* | :heavy_minus_sign: | A formal salutation for the person. For example, 'Mr', 'Mrs' | Mr |
+| `title` | *OptionalNullable[str]* | :heavy_minus_sign: | The job title of the person. | CEO |
+| `marital_status` | *OptionalNullable[str]* | :heavy_minus_sign: | The marital status of the employee. | married |
+| `partner` | [Optional[models.PersonInput]](../../models/personinput.md) | :heavy_minus_sign: | N/A | |
+| `division` | *OptionalNullable[str]* | :heavy_minus_sign: | The division the person is currently in. Usually a collection of departments or teams or regions. | Europe |
+| `division_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Unique identifier of the division this employee belongs to. | 12345 |
+| `department` | *OptionalNullable[str]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.
The department the person is currently in. [Deprecated](https://developers.apideck.com/changelog) in favor of the dedicated department_id and department_name field. | R&D |
+| `department_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Unique identifier of the department ID this employee belongs to. | 12345 |
+| `department_name` | *OptionalNullable[str]* | :heavy_minus_sign: | Name of the department this employee belongs to. | 12345 |
+| `team` | [OptionalNullable[models.Team]](../../models/team.md) | :heavy_minus_sign: | The team the person is currently in. | |
+| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The unique identifier of the company. | 23456 |
+| `company_name` | *OptionalNullable[str]* | :heavy_minus_sign: | The name of the company. | SpaceX |
+| `employment_start_date` | *OptionalNullable[str]* | :heavy_minus_sign: | A Start Date is the date that the employee started working at the company | 2021-10-26 |
+| `employment_end_date` | *OptionalNullable[str]* | :heavy_minus_sign: | An End Date is the date that the employee ended working at the company | 2028-10-26 |
+| `leaving_reason` | [OptionalNullable[models.LeavingReason]](../../models/leavingreason.md) | :heavy_minus_sign: | The reason because the employment ended. | resigned |
+| `employee_number` | *OptionalNullable[str]* | :heavy_minus_sign: | An Employee Number, Employee ID or Employee Code, is a unique number that has been assigned to each individual staff member within a company. | 123456-AB |
+| `employment_status` | [OptionalNullable[models.EmploymentStatus]](../../models/employmentstatus.md) | :heavy_minus_sign: | The employment status of the employee, indicating whether they are currently employed, inactive, terminated, or in another status. | active |
+| `employment_role` | [Optional[models.EmploymentRole]](../../models/employmentrole.md) | :heavy_minus_sign: | N/A | |
+| `ethnicity` | *OptionalNullable[str]* | :heavy_minus_sign: | The ethnicity of the employee | African American |
+| `manager` | [Optional[models.Manager]](../../models/manager.md) | :heavy_minus_sign: | N/A | |
+| `direct_reports` | List[*str*] | :heavy_minus_sign: | Direct reports is an array of ids that reflect the individuals in an organizational hierarchy who are directly supervised by this specific employee. | [
"a0d636c6-43b3-4bde-8c70-85b707d992f4",
"a98lfd96-43b3-4bde-8c70-85b707d992e6"
] |
+| `social_security_number` | *OptionalNullable[str]* | :heavy_minus_sign: | A unique identifier assigned by the government. This field is considered sensitive information and may be subject to special security and privacy restrictions. | 123456789 |
+| `birthday` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The date of birth of the person. | 2000-08-12 |
+| `deceased_on` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The date the person deceased. | 2000-08-12 |
+| `country_of_birth` | *OptionalNullable[str]* | :heavy_minus_sign: | Country code according to ISO 3166-1 alpha-2. | US |
+| `description` | *OptionalNullable[str]* | :heavy_minus_sign: | A description of the object. | A description |
+| `gender` | [OptionalNullable[models.Gender]](../../models/gender.md) | :heavy_minus_sign: | The gender represents the gender identity of a person. | male |
+| `pronouns` | *OptionalNullable[str]* | :heavy_minus_sign: | The preferred pronouns of the person. | she,her |
+| `preferred_language` | *OptionalNullable[str]* | :heavy_minus_sign: | language code according to ISO 639-1. For the United States - EN | EN |
+| `languages` | List[*str*] | :heavy_minus_sign: | N/A | |
+| `nationalities` | List[*str*] | :heavy_minus_sign: | N/A | |
+| `photo_url` | *OptionalNullable[str]* | :heavy_minus_sign: | The URL of the photo of a person. | https://unavatar.io/elon-musk |
+| `timezone` | *OptionalNullable[str]* | :heavy_minus_sign: | The time zone related to the resource. The value is a string containing a standard time zone identifier, e.g. Europe/London. | Europe/London |
+| `source` | *OptionalNullable[str]* | :heavy_minus_sign: | When the employee is imported as a new hire, this field indicates what system (e.g. the name of the ATS) this employee was imported from. | lever |
+| `source_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Unique identifier of the employee in the system this employee was imported from (e.g. the ID in the ATS). | 12345 |
+| `record_url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | https://app.intercom.io/contacts/12345 |
+| `jobs` | List[[models.EmployeeJobInput](../../models/employeejobinput.md)] | :heavy_minus_sign: | N/A | |
+| `compensations` | List[[models.EmployeeCompensationInput](../../models/employeecompensationinput.md)] | :heavy_minus_sign: | N/A | |
+| `works_remote` | *OptionalNullable[bool]* | :heavy_minus_sign: | Indicates if the employee works from a remote location. | true |
+| `addresses` | List[[models.Address](../../models/address.md)] | :heavy_minus_sign: | N/A | |
+| `phone_numbers` | List[[models.PhoneNumber](../../models/phonenumber.md)] | :heavy_minus_sign: | N/A | |
+| `emails` | List[[models.Email](../../models/email.md)] | :heavy_minus_sign: | N/A | |
+| `custom_fields` | List[[models.CustomField](../../models/customfield.md)] | :heavy_minus_sign: | N/A | |
+| `social_links` | List[[models.SocialLink](../../models/sociallink.md)] | :heavy_minus_sign: | N/A | |
+| `bank_accounts` | List[[models.BankAccount](../../models/bankaccount.md)] | :heavy_minus_sign: | N/A | |
+| `tax_code` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 1111 |
+| `tax_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 234-32-0000 |
+| `dietary_preference` | *OptionalNullable[str]* | :heavy_minus_sign: | Indicate the employee's dietary preference. | Veggie |
+| `food_allergies` | List[*str*] | :heavy_minus_sign: | Indicate the employee's food allergies. | [
"No allergies"
] |
+| `probation_period` | [Optional[models.ProbationPeriod]](../../models/probationperiod.md) | :heavy_minus_sign: | N/A | |
+| `tags` | List[*str*] | :heavy_minus_sign: | N/A | [
"New"
] |
+| `row_version` | *OptionalNullable[str]* | :heavy_minus_sign: | A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. | 1-12345 |
+| `deleted` | *OptionalNullable[bool]* | :heavy_minus_sign: | Flag to indicate if the object is deleted. | true |
+| `pass_through` | List[[models.PassThroughBody](../../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -883,11 +885,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.hris.employees.delete(id="", service_id="salesforce")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
diff --git a/docs/sdks/employeeschedulessdk/README.md b/docs/sdks/employeeschedulessdk/README.md
index fc819231..4b7b5c69 100644
--- a/docs/sdks/employeeschedulessdk/README.md
+++ b/docs/sdks/employeeschedulessdk/README.md
@@ -22,27 +22,26 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.hris.employee_schedules.list(request={
- "employee_id": "",
- "service_id": "salesforce",
- "pass_through": {
- "search": "San Francisco",
- },
- "fields": "id,updated_at",
- })
-
- if res is not None:
- # handle response
- pass
+
+ res = apideck.hris.employee_schedules.list(employee_id="", service_id="salesforce", pass_through={
+ "search": "San Francisco",
+ }, fields="id,updated_at")
+
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description |
-| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
-| `request` | [models.HrisEmployeeSchedulesAllRequest](../../models/hrisemployeeschedulesallrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
+| Parameter | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `employee_id` | *str* | :heavy_check_mark: | ID of the employee you are acting upon. | |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} |
+| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: `fields=name,email,addresses.city`
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
diff --git a/docs/sdks/eventlogs/README.md b/docs/sdks/eventlogs/README.md
index 28034475..5bdcf987 100644
--- a/docs/sdks/eventlogs/README.md
+++ b/docs/sdks/eventlogs/README.md
@@ -22,6 +22,7 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.webhook.event_logs.list(filter_={
"exclude_apis": "vault,proxy",
"consumer_id": "test_user_id",
@@ -29,9 +30,10 @@ with Apideck(
"event_type": "vault.connection.callable",
})
- if res is not None:
- # handle response
- pass
+ while res is not None:
+ # Handle items
+
+ res = res.next()
```
diff --git a/docs/sdks/expenses/README.md b/docs/sdks/expenses/README.md
index 9baf2e22..6b6bcd84 100644
--- a/docs/sdks/expenses/README.md
+++ b/docs/sdks/expenses/README.md
@@ -26,11 +26,13 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.accounting.expenses.list(service_id="salesforce")
- if res is not None:
- # handle response
- pass
+ while res is not None:
+ # Handle items
+
+ res = res.next()
```
@@ -76,89 +78,87 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.accounting.expenses.create(expense={
- "transaction_date": dateutil.parser.isoparse("2021-05-01T12:00:00.000Z"),
- "account_id": "123456",
- "line_items": [
- {
- "total_amount": 275,
- "tracking_categories": [
- {
- "id": "123456",
- "name": "New York",
- },
- {
- "id": "123456",
- "name": "New York",
- },
- ],
- "account_id": "123456",
- "customer_id": "12345",
- "department_id": "12345",
- "location_id": "12345",
- "tax_rate": {
+
+ res = apideck.accounting.expenses.create(transaction_date=dateutil.parser.isoparse("2021-05-01T12:00:00.000Z"), account_id="123456", line_items=[
+ {
+ "total_amount": 275,
+ "tracking_categories": [
+ {
+ "id": "123456",
+ "name": "New York",
+ },
+ {
"id": "123456",
- "rate": 10,
+ "name": "New York",
},
- "description": "Travel US.",
- "billable": True,
+ ],
+ "account_id": "123456",
+ "customer_id": "12345",
+ "department_id": "12345",
+ "location_id": "12345",
+ "tax_rate": {
+ "id": "123456",
+ "rate": 10,
},
- ],
- "number": "OIT00546",
- "customer_id": "12345",
- "supplier_id": "12345",
- "company_id": "12345",
- "department_id": "12345",
- "payment_type": apideck_unify.ExpensePaymentType.CASH,
- "currency": apideck_unify.Currency.USD,
- "currency_rate": 0.69,
- "type": apideck_unify.ExpenseType.EXPENSE,
- "memo": "For travel expenses incurred on 2024-05-15",
- "tax_rate": {
- "id": "123456",
- "rate": 10,
+ "description": "Travel US.",
+ "billable": True,
},
- "total_amount": 275,
- "custom_fields": [
- {
- "id": "2389328923893298",
- "name": "employee_level",
- "description": "Employee Level",
- "value": "Uses Salesforce and Marketo",
- },
- ],
- "row_version": "1-12345",
- "pass_through": [
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ ], service_id="salesforce", number="OIT00546", customer_id="12345", supplier_id="12345", company_id="12345", department_id="12345", payment_type=apideck_unify.ExpensePaymentType.CASH, currency=apideck_unify.Currency.USD, currency_rate=0.69, type_=apideck_unify.ExpenseType.EXPENSE, memo="For travel expenses incurred on 2024-05-15", tax_rate={
+ "id": "123456",
+ "rate": 10,
+ }, total_amount=275, custom_fields=[
+ {
+ "id": "2389328923893298",
+ "name": "employee_level",
+ "description": "Employee Level",
+ "value": "Uses Salesforce and Marketo",
+ },
+ ], row_version="1-12345", pass_through=[
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- ],
- }, service_id="salesforce")
+ },
+ ],
+ },
+ ])
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description | Example |
-| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| `expense` | [models.ExpenseInput](../../models/expenseinput.md) | :heavy_check_mark: | N/A | |
-| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
-| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
+| Parameter | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `transaction_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD | 2021-05-01T12:00:00.000Z |
+| `account_id` | *str* | :heavy_check_mark: | The unique identifier for the ledger account that this expense should be credited to. | 123456 |
+| `line_items` | List[[models.ExpenseLineItemInput](../../models/expenselineiteminput.md)] | :heavy_check_mark: | Expense line items linked to this expense. | |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `number` | *OptionalNullable[str]* | :heavy_minus_sign: | Number. | OIT00546 |
+| `customer_id` | *Optional[str]* | :heavy_minus_sign: | The ID of the customer this entity is linked to. Used for expenses that should be marked as billable to customers. | 12345 |
+| `supplier_id` | *Optional[str]* | :heavy_minus_sign: | The ID of the supplier this entity is linked to. | 12345 |
+| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 |
+| `department_id` | *Optional[str]* | :heavy_minus_sign: | The ID of the department this expense is linked to. | 12345 |
+| `payment_type` | [OptionalNullable[models.ExpensePaymentType]](../../models/expensepaymenttype.md) | :heavy_minus_sign: | The type of payment for the expense. | cash |
+| `currency` | [OptionalNullable[models.Currency]](../../models/currency.md) | :heavy_minus_sign: | Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). | USD |
+| `currency_rate` | *OptionalNullable[float]* | :heavy_minus_sign: | Currency Exchange Rate at the time entity was recorded/generated. | 0.69 |
+| `type` | [OptionalNullable[models.ExpenseType]](../../models/expensetype.md) | :heavy_minus_sign: | The type of expense. | expense |
+| `memo` | *OptionalNullable[str]* | :heavy_minus_sign: | The memo of the expense. | For travel expenses incurred on 2024-05-15 |
+| `tax_rate` | [Optional[models.LinkedTaxRateInput]](../../models/linkedtaxrateinput.md) | :heavy_minus_sign: | N/A | |
+| `total_amount` | *OptionalNullable[float]* | :heavy_minus_sign: | The total amount of the expense line item. | 275 |
+| `custom_fields` | List[[models.CustomField](../../models/customfield.md)] | :heavy_minus_sign: | N/A | |
+| `row_version` | *OptionalNullable[str]* | :heavy_minus_sign: | A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. | 1-12345 |
+| `pass_through` | List[[models.PassThroughBody](../../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -190,11 +190,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.accounting.expenses.get(id="", service_id="salesforce")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
@@ -239,168 +239,166 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.accounting.expenses.update(id="", expense={
- "transaction_date": dateutil.parser.isoparse("2021-05-01T12:00:00.000Z"),
- "account_id": "123456",
- "line_items": [
- {
- "total_amount": 275,
- "tracking_categories": [
- {
- "id": "123456",
- "name": "New York",
- },
- {
- "id": "123456",
- "name": "New York",
- },
- ],
- "account_id": "123456",
- "customer_id": "12345",
- "department_id": "12345",
- "location_id": "12345",
- "tax_rate": {
+
+ res = apideck.accounting.expenses.update(id="", transaction_date=dateutil.parser.isoparse("2021-05-01T12:00:00.000Z"), account_id="123456", line_items=[
+ {
+ "total_amount": 275,
+ "tracking_categories": [
+ {
"id": "123456",
- "rate": 10,
+ "name": "New York",
},
- "description": "Travel US.",
- "billable": True,
- },
- {
- "total_amount": 275,
- "tracking_categories": [
- {
- "id": "123456",
- "name": "New York",
- },
- ],
- "account_id": "123456",
- "customer_id": "12345",
- "department_id": "12345",
- "location_id": "12345",
- "tax_rate": {
+ {
"id": "123456",
- "rate": 10,
+ "name": "New York",
},
- "description": "Travel US.",
- "billable": True,
+ ],
+ "account_id": "123456",
+ "customer_id": "12345",
+ "department_id": "12345",
+ "location_id": "12345",
+ "tax_rate": {
+ "id": "123456",
+ "rate": 10,
},
- {
- "total_amount": 275,
- "tracking_categories": [
- {
- "id": "123456",
- "name": "New York",
- },
- {
- "id": "123456",
- "name": "New York",
- },
- {
- "id": "123456",
- "name": "New York",
- },
- ],
- "account_id": "123456",
- "customer_id": "12345",
- "department_id": "12345",
- "location_id": "12345",
- "tax_rate": {
+ "description": "Travel US.",
+ "billable": True,
+ },
+ {
+ "total_amount": 275,
+ "tracking_categories": [
+ {
"id": "123456",
- "rate": 10,
+ "name": "New York",
},
- "description": "Travel US.",
- "billable": True,
+ ],
+ "account_id": "123456",
+ "customer_id": "12345",
+ "department_id": "12345",
+ "location_id": "12345",
+ "tax_rate": {
+ "id": "123456",
+ "rate": 10,
},
- ],
- "number": "OIT00546",
- "customer_id": "12345",
- "supplier_id": "12345",
- "company_id": "12345",
- "department_id": "12345",
- "payment_type": apideck_unify.ExpensePaymentType.CASH,
- "currency": apideck_unify.Currency.USD,
- "currency_rate": 0.69,
- "type": apideck_unify.ExpenseType.EXPENSE,
- "memo": "For travel expenses incurred on 2024-05-15",
- "tax_rate": {
- "id": "123456",
- "rate": 10,
+ "description": "Travel US.",
+ "billable": True,
},
- "total_amount": 275,
- "custom_fields": [
- {
- "id": "2389328923893298",
- "name": "employee_level",
- "description": "Employee Level",
- "value": True,
- },
- {
- "id": "2389328923893298",
- "name": "employee_level",
- "description": "Employee Level",
- "value": {},
+ {
+ "total_amount": 275,
+ "tracking_categories": [
+ {
+ "id": "123456",
+ "name": "New York",
+ },
+ {
+ "id": "123456",
+ "name": "New York",
+ },
+ {
+ "id": "123456",
+ "name": "New York",
+ },
+ ],
+ "account_id": "123456",
+ "customer_id": "12345",
+ "department_id": "12345",
+ "location_id": "12345",
+ "tax_rate": {
+ "id": "123456",
+ "rate": 10,
},
- ],
- "row_version": "1-12345",
- "pass_through": [
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ "description": "Travel US.",
+ "billable": True,
+ },
+ ], service_id="salesforce", number="OIT00546", customer_id="12345", supplier_id="12345", company_id="12345", department_id="12345", payment_type=apideck_unify.ExpensePaymentType.CASH, currency=apideck_unify.Currency.USD, currency_rate=0.69, type_=apideck_unify.ExpenseType.EXPENSE, memo="For travel expenses incurred on 2024-05-15", tax_rate={
+ "id": "123456",
+ "rate": 10,
+ }, total_amount=275, custom_fields=[
+ {
+ "id": "2389328923893298",
+ "name": "employee_level",
+ "description": "Employee Level",
+ "value": True,
+ },
+ {
+ "id": "2389328923893298",
+ "name": "employee_level",
+ "description": "Employee Level",
+ "value": {},
+ },
+ ], row_version="1-12345", pass_through=[
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ ],
+ },
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ ],
+ },
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- ],
- }, service_id="salesforce")
+ },
+ ],
+ },
+ ])
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description | Example |
-| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
-| `expense` | [models.ExpenseInput](../../models/expenseinput.md) | :heavy_check_mark: | N/A | |
-| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
-| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
+| Parameter | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `id` | *str* | :heavy_check_mark: | ID of the record you are acting upon. | |
+| `transaction_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date of the transaction - YYYY:MM::DDThh:mm:ss.sTZD | 2021-05-01T12:00:00.000Z |
+| `account_id` | *str* | :heavy_check_mark: | The unique identifier for the ledger account that this expense should be credited to. | 123456 |
+| `line_items` | List[[models.ExpenseLineItemInput](../../models/expenselineiteminput.md)] | :heavy_check_mark: | Expense line items linked to this expense. | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `number` | *OptionalNullable[str]* | :heavy_minus_sign: | Number. | OIT00546 |
+| `customer_id` | *Optional[str]* | :heavy_minus_sign: | The ID of the customer this entity is linked to. Used for expenses that should be marked as billable to customers. | 12345 |
+| `supplier_id` | *Optional[str]* | :heavy_minus_sign: | The ID of the supplier this entity is linked to. | 12345 |
+| `company_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The company or subsidiary id the transaction belongs to | 12345 |
+| `department_id` | *Optional[str]* | :heavy_minus_sign: | The ID of the department this expense is linked to. | 12345 |
+| `payment_type` | [OptionalNullable[models.ExpensePaymentType]](../../models/expensepaymenttype.md) | :heavy_minus_sign: | The type of payment for the expense. | cash |
+| `currency` | [OptionalNullable[models.Currency]](../../models/currency.md) | :heavy_minus_sign: | Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). | USD |
+| `currency_rate` | *OptionalNullable[float]* | :heavy_minus_sign: | Currency Exchange Rate at the time entity was recorded/generated. | 0.69 |
+| `type` | [OptionalNullable[models.ExpenseType]](../../models/expensetype.md) | :heavy_minus_sign: | The type of expense. | expense |
+| `memo` | *OptionalNullable[str]* | :heavy_minus_sign: | The memo of the expense. | For travel expenses incurred on 2024-05-15 |
+| `tax_rate` | [Optional[models.LinkedTaxRateInput]](../../models/linkedtaxrateinput.md) | :heavy_minus_sign: | N/A | |
+| `total_amount` | *OptionalNullable[float]* | :heavy_minus_sign: | The total amount of the expense line item. | 275 |
+| `custom_fields` | List[[models.CustomField](../../models/customfield.md)] | :heavy_minus_sign: | N/A | |
+| `row_version` | *OptionalNullable[str]* | :heavy_minus_sign: | A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. | 1-12345 |
+| `pass_through` | List[[models.PassThroughBody](../../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -432,11 +430,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.accounting.expenses.delete(id="", service_id="salesforce")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
diff --git a/docs/sdks/files/README.md b/docs/sdks/files/README.md
index e8ddef51..9bf2cfb6 100644
--- a/docs/sdks/files/README.md
+++ b/docs/sdks/files/README.md
@@ -29,35 +29,38 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.file_storage.files.list(request={
- "service_id": "salesforce",
- "filter_": {
- "drive_id": "1234",
- "folder_id": "root",
- "shared": True,
- },
- "sort": {
- "by": apideck_unify.FilesSortBy.UPDATED_AT,
- "direction": apideck_unify.SortDirection.DESC,
- },
- "pass_through": {
- "search": "San Francisco",
- },
- "fields": "id,updated_at",
- })
- if res is not None:
- # handle response
- pass
+ res = apideck.file_storage.files.list(service_id="salesforce", filter_={
+ "drive_id": "1234",
+ "folder_id": "root",
+ "shared": True,
+ }, sort={
+ "by": apideck_unify.FilesSortBy.UPDATED_AT,
+ "direction": apideck_unify.SortDirection.DESC,
+ }, pass_through={
+ "search": "San Francisco",
+ }, fields="id,updated_at")
+
+ while res is not None:
+ # Handle items
+
+ res = res.next()
```
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
-| `request` | [models.FileStorageFilesAllRequest](../../models/filestoragefilesallrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
+| Parameter | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | |
+| `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | |
+| `filter_` | [Optional[models.FilesFilter]](../../models/filesfilter.md) | :heavy_minus_sign: | Apply filters | |
+| `sort` | [Optional[models.FilesSort]](../../models/filessort.md) | :heavy_minus_sign: | Apply sorting | {
"by": "updated_at",
"direction": "desc"
} |
+| `pass_through` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} |
+| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: `fields=name,email,addresses.city`
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -89,34 +92,48 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.file_storage.files.search(request={
- "files_search": {
- "query": "logo jpg",
- },
- "service_id": "salesforce",
- "pass_through": {
- "search": "San Francisco",
- },
- "fields": "id,updated_at",
- "filter_": {
- "drive_id": "1234",
- "folder_id": "root",
- "shared": True,
+
+ res = apideck.file_storage.files.search(query="logo jpg", service_id="salesforce", pass_through_param={
+ "search": "San Francisco",
+ }, fields="id,updated_at", filter_={
+ "drive_id": "1234",
+ "folder_id": "root",
+ "shared": True,
+ }, drive_id="1234", pass_through=[
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
+ },
+ },
+ },
+ ],
},
- })
+ ])
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
### Parameters
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
-| `request` | [models.FileStorageFilesSearchRequest](../../models/filestoragefilessearchrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
+| Parameter | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `query` | *str* | :heavy_check_mark: | The query to search for. May match across multiple fields. | logo jpg |
+| `service_id` | *Optional[str]* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce |
+| `pass_through_param` | Dict[str, *Any*] | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} |
+| `fields` | *OptionalNullable[str]* | :heavy_minus_sign: | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: `fields=name,email,addresses.city`
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | id,updated_at |
+| `cursor` | *OptionalNullable[str]* | :heavy_minus_sign: | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | |
+| `limit` | *Optional[int]* | :heavy_minus_sign: | Number of results to return. Minimum 1, Maximum 200, Default 20 | |
+| `filter_` | [Optional[models.FilesFilter]](../../models/filesfilter.md) | :heavy_minus_sign: | Apply filters | |
+| `drive_id` | *Optional[str]* | :heavy_minus_sign: | ID of the drive to filter on | 1234 |
+| `pass_through` | List[[models.PassThroughBody](../../models/passthroughbody.md)] | :heavy_minus_sign: | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | |
+| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | |
### Response
@@ -148,11 +165,11 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
+
res = apideck.file_storage.files.get(id="", service_id="salesforce", fields="id,updated_at")
- if res is not None:
- # handle response
- pass
+ # Handle response
+ print(res)
```
@@ -196,92 +213,90 @@ with Apideck(
consumer_id="test-consumer",
app_id="dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
) as apideck:
- res = apideck.file_storage.files.update(id="", update_file_request={
- "name": "New Name.pdf",
- "description": "Renamed PDF Document",
- "parent_folder_id": "1234",
- "pass_through": [
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+
+ res = apideck.file_storage.files.update(id="", service_id="salesforce", name="New Name.pdf", description="Renamed PDF Document", parent_folder_id="1234", pass_through=[
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- {
- "service_id": "",
- "extend_paths": [
- {
- "path": "$.nested.property",
- "value": {
- "TaxClassificationRef": {
- "value": "EUC-99990201-V1-00020000",
- },
+ },
+ ],
+ },
+ {
+ "service_id": "",
+ "extend_paths": [
+ {
+ "path": "$.nested.property",
+ "value": {
+ "TaxClassificationRef": {
+ "value": "EUC-99990201-V1-00020000",
},
},
- ],
- },
- {
- "service_id": "