diff --git a/platform/.speakeasy/gen.lock b/platform/.speakeasy/gen.lock
deleted file mode 100755
index cb04fa99a..000000000
--- a/platform/.speakeasy/gen.lock
+++ /dev/null
@@ -1,3605 +0,0 @@
-lockVersion: 2.0.0
-id: 6a970e30-8d0a-42f0-a8ce-621dfe880a1d
-management:
- docChecksum: 06ba849c9ac83fe0fe9cc654586af59a
- docVersion: 3.0.0
- speakeasyVersion: 1.761.9
- generationVersion: 2.881.4
- releaseVersion: 6.2.1
- configChecksum: f460c0890a9b6f2407df1de9bfe1a247
- repoURL: https://github.com/codatio/client-sdk-typescript.git
- repoSubDirectory: platform
- installationURL: https://github.com/codatio/client-sdk-typescript
- published: true
-persistentEdits:
- generation_id: 1e5c2c34-5e88-4101-ad9a-0194c9f33fae
- pristine_commit_hash: 929ab8f40a3b964e741a74fda14eeb0adc7c0874
- pristine_tree_hash: 10ea2c757743203d3553b8644bca4898f993f699
-features:
- typescript:
- additionalDependencies: 0.1.0
- constsAndDefaults: 0.1.14
- core: 3.26.49
- defaultEnabledRetries: 0.1.0
- deprecations: 2.81.1
- enumUnions: 0.1.0
- envVarSecurityUsage: 0.1.2
- examples: 2.82.5
- globalSecurity: 2.82.16
- globalSecurityCallbacks: 0.1.0
- globalSecurityFlattening: 0.1.1
- globalServerURLs: 2.83.1
- groups: 2.81.3
- ignores: 2.81.1
- methodArguments: 0.1.2
- nameOverrides: 2.81.4
- nullables: 0.1.1
- responseFormat: 0.3.0
- retries: 2.83.0
- sdkHooks: 0.4.0
- serverEventsSentinels: 0.1.0
- webhooks: 1.5.1
-trackedFiles:
- .gitattributes:
- id: 24139dae6567
- last_write_checksum: sha1:26d16d8297b104945139da8c25bd38feeaad3e25
- pristine_git_object: 113eead5093c17d43a46159132885318f281a68a
- .npmignore:
- id: aa70c1f807c3
- last_write_checksum: sha1:6572da81f2e7a978ec29c22c2210bf461c5897b2
- pristine_git_object: 670ac0a62d7e568c9d44a14f5deafb8442a255d8
- FUNCTIONS.md:
- id: 21b9df02aaeb
- last_write_checksum: sha1:938315963767d45cd74bf194d14ac0a110dc2965
- pristine_git_object: 295b579ad6fb1e62cd81821e28650dc18cb7b8f0
- RUNTIMES.md:
- id: 620c490847b6
- last_write_checksum: sha1:e45b854f02c357cbcfdb8c3663000e8339e16505
- pristine_git_object: 27731c3b5ace66bedc454ed5acbe15075aacd3dc
- USAGE.md:
- id: 3aed33ce6e6f
- last_write_checksum: sha1:b19532df410763da1adc5ae7edb5a5b3f3db16e4
- pristine_git_object: 434db3b1e26fba453922476e77e5ed7268b24626
- docs/lib/utils/retryconfig.md:
- id: 0ce9707cb848
- last_write_checksum: sha1:bc4454e196fcd219f5a78da690375a884f5ed07b
- pristine_git_object: 08f95f4552349360b2c0b01802aa71ec3a55d2c2
- docs/sdk/models/errors/errormessage.md:
- id: 9affd825e395
- last_write_checksum: sha1:318d952d9d4cadb0a3aa6dd266f08bad46d75b92
- pristine_git_object: f1b3b9377518ab43aa43cadef91a2d464dad8426
- docs/sdk/models/operations/addproductrequest.md:
- id: 445f64158348
- last_write_checksum: sha1:c53ace7a460c3a019f30cc35508aef4cd4743577
- pristine_git_object: 7093782a3f4389fd2efbb8e10c7f3661a4518b02
- docs/sdk/models/operations/configurecustomdatatyperequest.md:
- id: 3e15eb135688
- last_write_checksum: sha1:90c101d9c8dabcdefaf3c6b855a035b26960c1c4
- pristine_git_object: 3f3137f1cd4974a1957cf035b0f3c77e36aa80cd
- docs/sdk/models/operations/configuresupplementaldatarequest.md:
- id: f35ee6b2ccf4
- last_write_checksum: sha1:8eb14c5dc9947c6e0bbcdb5f59935ae525a6a315
- pristine_git_object: e60f8ea7b1b15dc4201edc79391eb1452438e775
- docs/sdk/models/operations/createconnectionrequest.md:
- id: 43b13768fa3c
- last_write_checksum: sha1:d527b50efb352f598c4d69f75231da8f37db67ed
- pristine_git_object: 8869a9cc3b9776780d780de0b98c13c9c503e7e0
- docs/sdk/models/operations/createconnectionrequestbody.md:
- id: cd2a86f8a996
- last_write_checksum: sha1:5bd4e0660e8683e8966a8e7a9a9ccf089a02227a
- pristine_git_object: a21ed45874397071a4196affc6afc0088dc97d23
- docs/sdk/models/operations/datatype.md:
- id: 2e951d0d52d9
- last_write_checksum: sha1:71dbcf466842c4f37b2c1e0ad51c363e7f822f9a
- pristine_git_object: bec60751b1c7c4dedf07d6df4785adaefd044009
- docs/sdk/models/operations/deleteapikeyrequest.md:
- id: 1d303683cb56
- last_write_checksum: sha1:0c862e7505c67d2d8590e5c56e5297ec6712d4c6
- pristine_git_object: 1c8d9a20a97db7fafb4619853a83cc46b9950cad
- docs/sdk/models/operations/deletecompanyrequest.md:
- id: 01348357e18f
- last_write_checksum: sha1:6b651328480d25fe888e9ee14a3ccb443ed72ec8
- pristine_git_object: f156366c8e120394e8d95aca3158acb81ec32463
- docs/sdk/models/operations/deleteconnectionrequest.md:
- id: 70fe5fee5d10
- last_write_checksum: sha1:925caee541a969276cd31ab9d3ba728bc761a245
- pristine_git_object: 9ef310cfe9bce57b98cc0d48be3c5cb85c1510c0
- docs/sdk/models/operations/deletewebhookconsumerrequest.md:
- id: 7ec62156f262
- last_write_checksum: sha1:a8d86dc18ad01b308f77219519377b601bed329e
- pristine_git_object: 178d2dd30281e3b73ba752328e980bbc7da8744b
- docs/sdk/models/operations/getcompanyaccesstokenrequest.md:
- id: 092b4607f2a4
- last_write_checksum: sha1:a94c6812c78a62abb7c6ced3cb414f4c5d911cc3
- pristine_git_object: 620ef3ef66e0c83e46fe5a42332fddfdf21f1e4d
- docs/sdk/models/operations/getcompanydatastatusrequest.md:
- id: 5c881282abbd
- last_write_checksum: sha1:c7079f72d9f6b902dbe75c93780e07750e404625
- pristine_git_object: e9052affa459e2b76649edf9f2c9b6771b14e4e4
- docs/sdk/models/operations/getcompanypushhistoryrequest.md:
- id: 7b8e1c42f3cf
- last_write_checksum: sha1:66e71e875c8a260e3319c6b23ccd037b0eb78761
- pristine_git_object: 7644238a3466e3cb2b55c3c3c09c634ad60e3555
- docs/sdk/models/operations/getcompanyrequest.md:
- id: cb14d531f942
- last_write_checksum: sha1:a8af03ec33e4aa82e90183eb741e101edcfd7cf2
- pristine_git_object: 641698318b879d2c241b5bd0fc21c7c6635a2289
- docs/sdk/models/operations/getcompanysyncsettingsrequest.md:
- id: 5a59c39899f5
- last_write_checksum: sha1:dac54d4ffed0cc737eedc31d14bd76f517c36f6d
- pristine_git_object: 4291d93bdba292c2f6fe0aa789c8eecaba0b974d
- docs/sdk/models/operations/getconnectionmanagementaccesstokenrequest.md:
- id: bec09b9bbeb9
- last_write_checksum: sha1:ae5312ec4bd8ca597d4e44b8f465f26df9fe5b8b
- pristine_git_object: cee933bca1bc9ac515e6e078def70a3a0c79e590
- docs/sdk/models/operations/getconnectionrequest.md:
- id: 6545321b6497
- last_write_checksum: sha1:8ae49aa08a39c31b73c76e4aab1c9fdba44ae72c
- pristine_git_object: 8cf868420f0d02b2a78c71a827e70048ea26067a
- docs/sdk/models/operations/getcreateupdatemodeloptionsbydatatyperequest.md:
- id: 34cd225eea75
- last_write_checksum: sha1:934e9515ce0d876e8e079725b3ffc37acbc5a432
- pristine_git_object: c0d7bc4fadf444eae3b5e7f4235d48fe1ace6f64
- docs/sdk/models/operations/getcustomdatatypeconfigurationrequest.md:
- id: 092e794f3f06
- last_write_checksum: sha1:97ba33ac626d9e91c3cda9e7810eb950764904a2
- pristine_git_object: 51628b94efbb64c49c0e81cde90561bae89e3cd8
- docs/sdk/models/operations/getintegrationrequest.md:
- id: 1453744933b3
- last_write_checksum: sha1:f47aa9f5171efcebd1dd0444256382ffa7fca363
- pristine_git_object: d94506c861887bae0c7f7e57051adef1e0f5782e
- docs/sdk/models/operations/getintegrationsbrandingrequest.md:
- id: c7ad93018db8
- last_write_checksum: sha1:e8b4aeb2d45112e0d2135fa9f9e787696802b0c9
- pristine_git_object: 869ecc8642c3c7b0e9b1a0b02f0178970c378821
- docs/sdk/models/operations/getpulloperationrequest.md:
- id: 6d02e8f040db
- last_write_checksum: sha1:f158d96be19b03a89ed94c55b2192c0ac0e27e66
- pristine_git_object: 23baf909e4e24ce6727cd6d34f9805f6f7bbfb8c
- docs/sdk/models/operations/getpushoperationrequest.md:
- id: a2a83a8acbf9
- last_write_checksum: sha1:8637909089beacf0e4a15d60b1263acf257f5a87
- pristine_git_object: 1dbda6bc5bd7a745ba6d1de7133bd6be65d87771
- docs/sdk/models/operations/getreadvalidationresultsrequest.md:
- id: ac9cb76d2f36
- last_write_checksum: sha1:11c4ad3c36c7822687339c055f26b6f6049a34fc
- pristine_git_object: 5db180c1f3017c550c873d21e91a9afbbeaa258f
- docs/sdk/models/operations/getsupplementaldataconfigurationrequest.md:
- id: d6afb894fd54
- last_write_checksum: sha1:bcf61174d5288d4f2bd2309d0a38b808c3484ff4
- pristine_git_object: eb20d89bf6effc0c35b5c1381c841bd59e39c6b0
- docs/sdk/models/operations/listcompaniesrequest.md:
- id: 605dcf27a33d
- last_write_checksum: sha1:f38fe179f15bb13d24e8fc06bb7ee8017f1ca0e2
- pristine_git_object: fe713e6c9f3672386761071c981b4ae2de0c90e3
- docs/sdk/models/operations/listconnectionsrequest.md:
- id: 6b2aa79356a9
- last_write_checksum: sha1:57dca2a2d43c04ab8bfb50d3dd30854c4d0d4b59
- pristine_git_object: 2797ca8857b2f9ee0eaec9abb2f45c43d2efb2d4
- docs/sdk/models/operations/listcustomdatatyperecordsrequest.md:
- id: c5da7d74d016
- last_write_checksum: sha1:af704174eb388a3e948594f9c49901e4815a4e96
- pristine_git_object: 8cd37e0d2378b9925ba5c0440912786564a080e9
- docs/sdk/models/operations/listintegrationsrequest.md:
- id: 4dee9b567d0f
- last_write_checksum: sha1:2c57b4223d77b713f34de8d2467c312bfd2f6577
- pristine_git_object: 6cd2771d6df8b28c5412ae4c845d73ffe136bc13
- docs/sdk/models/operations/listpulloperationsrequest.md:
- id: d91fce013be3
- last_write_checksum: sha1:0a3adecb070097450ca28db22e18d2ff820a53a2
- pristine_git_object: f879acbb70f5a4aaea7bde4952cc54a4d821ff49
- docs/sdk/models/operations/pathparamdatatype.md:
- id: c63f9e2c649a
- last_write_checksum: sha1:06f343f03249d192bf6a10e51646d869a527fe28
- pristine_git_object: a5c62e402150a1b9abc5b7aac370ee098ef6b5a9
- docs/sdk/models/operations/refreshcompanydatarequest.md:
- id: 37c323b9ada7
- last_write_checksum: sha1:42cf70b57cd9069982c94aaad96b732ef8b25739
- pristine_git_object: 1db236eb8ffaafb975063ccabd290f748e7e461f
- docs/sdk/models/operations/refreshcustomdatatyperequest.md:
- id: e33c9b85e2d3
- last_write_checksum: sha1:e238deecd3ea9208748222f68999d2e61a7a1fe9
- pristine_git_object: 64838d6792b9fa53e1fb9706f38c60d439be9ef1
- docs/sdk/models/operations/refreshdatatyperequest.md:
- id: e47fb457a374
- last_write_checksum: sha1:909976b28a7b3e3054a85cec971ecfe356b2fffb
- pristine_git_object: db7d287200c8c9ca75b2defdf56aafd3990dfc24
- docs/sdk/models/operations/refreshproductdatarequest.md:
- id: 322d303f2a74
- last_write_checksum: sha1:4826c2cc888c595a1347668e529a0b8a74c273b7
- pristine_git_object: 8bf3e55207f3fc54e191109a5aab2a79db76e336
- docs/sdk/models/operations/refreshproductdatarequestbody.md:
- id: 81750b82e318
- last_write_checksum: sha1:66a1a79b6c8a4fb7c63fb150edbd87e62cc46c3b
- pristine_git_object: 6c390fd3ebbe1dc158c9eec103198a87fa451165
- docs/sdk/models/operations/removeproductrequest.md:
- id: cc26325329fe
- last_write_checksum: sha1:85c1a551f81f2bb351b83bd90401a68684e95560
- pristine_git_object: 33db4566d10e857a4a034f2c67d5767797480a6e
- docs/sdk/models/operations/replacecompanyrequest.md:
- id: 2f79da54c18c
- last_write_checksum: sha1:f1d07eb73d70d73d0a69a5da59c35d4ffa80522e
- pristine_git_object: 1b833476e66d646ca96faa53538bc205169c2630
- docs/sdk/models/operations/setcompanysyncsettingsrequest.md:
- id: 02cb332874fd
- last_write_checksum: sha1:e8607d18f95387ac94d1930d8c653466f1c121df
- pristine_git_object: 4d3e26372dea03737f12b90b88f408b9b7835e6d
- docs/sdk/models/operations/setcompanysyncsettingsrequestbody.md:
- id: 2119449d1038
- last_write_checksum: sha1:bd723e354e8fb0bb637655a33bdc9840a9e3b000
- pristine_git_object: 8604fc1c5847ac1304ce09301138280e433e3b5b
- docs/sdk/models/operations/unlinkconnectionrequest.md:
- id: 9f3addbe3925
- last_write_checksum: sha1:ebb71625963dca828e6d28137daf79387933b920
- pristine_git_object: acbfdf8e90a9a6b651c0e305d0dfe8524bb5067c
- docs/sdk/models/operations/updatecompanyrequest.md:
- id: 6501e66b32d2
- last_write_checksum: sha1:9c6312c756a7ce23caa32eac8681519bbd858cb5
- pristine_git_object: 6e565da9e8459b8d362708433a5d1835f06a7e5a
- docs/sdk/models/operations/updateconnectionauthorizationrequest.md:
- id: 0012a93268eb
- last_write_checksum: sha1:777b5e0d72385ff4896c0cdda96f077d47439a75
- pristine_git_object: 0cf08d05f97376d20346487ab8e1fdb764f46a1b
- docs/sdk/models/operations/updateprofilesyncsettingsrequestbody.md:
- id: bae25140b1c0
- last_write_checksum: sha1:b377607063f8cc37d1290bdf75290e7bb3bfb101
- pristine_git_object: 6f716e84746e9ffd6904488243f95c55a84ebe83
- docs/sdk/models/shared/apikeydetails.md:
- id: c591b3679024
- last_write_checksum: sha1:2570d13b16ce267dfe8885b16325aed8e12007a2
- pristine_git_object: d99ebeb3b61dd89918d42183e7383713d73ca927
- docs/sdk/models/shared/apikeys.md:
- id: b1360883844c
- last_write_checksum: sha1:c1dbe102d7a406137c1099d91f975661f2ce12c6
- pristine_git_object: 689ff589d015582de8302b28894821268e78f7d2
- docs/sdk/models/shared/branding.md:
- id: 3ea26472a0b3
- last_write_checksum: sha1:40180e9378502f0803b9b79e4765b2471a447b86
- pristine_git_object: 73e6a62d92ca0ba2965b4a65edd19e15966354a9
- docs/sdk/models/shared/brandingbutton.md:
- id: 46b878f55555
- last_write_checksum: sha1:9518b13dccd592012fe7d135c8e2a38dbc73244e
- pristine_git_object: 6ac2941c045f332b9683c3c85df007ad2d8ce6ed
- docs/sdk/models/shared/brandingimage.md:
- id: 2dbabfe29bd7
- last_write_checksum: sha1:2fa93d68330a76e17ea1f60fcbc2e5844e5c5aab
- pristine_git_object: 27131e90c3843100e9f0b967cd4ba030f36db3de
- docs/sdk/models/shared/brandinglogo.md:
- id: 3e8c57c4fa11
- last_write_checksum: sha1:03d0512fa97a0626c83f3b04f38867027e4a7d1f
- pristine_git_object: 25a2446de268d7538a63e1d1258d0dac34f6f96a
- docs/sdk/models/shared/clientratelimitwebhook.md:
- id: 2ad187176bc8
- last_write_checksum: sha1:ebd275556ea62a86059000f01bde2066499a2c18
- pristine_git_object: ef7ee9b1b2052fb4c2740bdb38cf820a60f299b8
- docs/sdk/models/shared/clientratelimitwebhookpayload.md:
- id: 455bfe8fe625
- last_write_checksum: sha1:10d4238db1b064db8a30273ca84e38010c178981
- pristine_git_object: 7441544a601b2b72878200607f1d76ae32947a1e
- docs/sdk/models/shared/companies.md:
- id: d934c193ecb6
- last_write_checksum: sha1:7ccac58b68a139518f5895fafb03ae49fbc59b66
- pristine_git_object: 013469d05fb95d96331d239a1e8e2384695d5bfc
- docs/sdk/models/shared/company.md:
- id: fb5206b144df
- last_write_checksum: sha1:f3780b6b057e19d4415c5f6ae3126516b8d3a537
- pristine_git_object: 02fcbcca268b1a4e3f2801e962e16a71cadebc4c
- docs/sdk/models/shared/companyaccesstoken.md:
- id: 094c5ef713ca
- last_write_checksum: sha1:851d3ebb747dd553e90f64c68c7d0d16214ba791
- pristine_git_object: 411ab1ac5d68d8afa2a24500dcd45f99e7cc5e09
- docs/sdk/models/shared/companydetails.md:
- id: 3dc092ebb5e0
- last_write_checksum: sha1:574542307741cb0dd38c74a82f9a9dafad00ec25
- pristine_git_object: 68e95c243e87888ddbac4d1d1b48b50ce7ea4f68
- docs/sdk/models/shared/companyreference.md:
- id: eb83cae3df56
- last_write_checksum: sha1:9626066fcdc1ed3ffb8db6f78603017bd75c34f4
- pristine_git_object: dbaa750ce18b51ed406449b50c6e6c652215e235
- docs/sdk/models/shared/companyreferencelinks.md:
- id: bdd0ee48a65d
- last_write_checksum: sha1:d99d1208890f69ea5855194f41e073fe396824ce
- pristine_git_object: e9689a8c2bfc6358a000b5fd12a967e40d467383
- docs/sdk/models/shared/companyrequestbody.md:
- id: 3f3dfd0aa865
- last_write_checksum: sha1:9b5dce735ebb189ab07e4f6f2fd30ad338589c45
- pristine_git_object: d5a14f87c45783fffed56e250b82e44715ef6d75
- docs/sdk/models/shared/companysyncsettings.md:
- id: 6e8f8e12b09d
- last_write_checksum: sha1:5c2d31143eb0abadcb73d52aa9d1447d4d4cc30c
- pristine_git_object: 39762790f300336e3f1a8786d3791f5e855dd957
- docs/sdk/models/shared/companyupdaterequest.md:
- id: cef525a660f4
- last_write_checksum: sha1:441a113bc2bad87a2f8f15f14c20425bc341847c
- pristine_git_object: 24e3e56cfb9477f8b9c5b91befda7b5e10067c69
- docs/sdk/models/shared/companywebhook.md:
- id: d93ac665d3ba
- last_write_checksum: sha1:741d008a03cf95928a315d553e079b6f75e41573
- pristine_git_object: 0d565c3cbf0efa3788ae64f8ee58d45c0c170f9d
- docs/sdk/models/shared/connection.md:
- id: 1c171381dd82
- last_write_checksum: sha1:a0c116fa2b5c9798d341b1d2633c10ee5a0be549
- pristine_git_object: b4fb763afe063b6ac8faee90944e7d92eb07071a
- docs/sdk/models/shared/connectionmanagementaccesstoken.md:
- id: 234d6aa44c90
- last_write_checksum: sha1:1ec26712a46c827f8bfef96985d9dcce3404b6f4
- pristine_git_object: a9b78e98db582fd0b5332718dbbf3cc3816fd3d9
- docs/sdk/models/shared/connectionmanagementallowedorigins.md:
- id: e8ca3620728f
- last_write_checksum: sha1:fcb7dc7a3006b5bccdb240b97f4b4384fdac3a1f
- pristine_git_object: b0d9b8c4e87729541601828bed3938d5ac92a4d5
- docs/sdk/models/shared/connections.md:
- id: c39072f6f8dc
- last_write_checksum: sha1:1935700b6a8efdd439462e1b3bb40453b2b5c8a0
- pristine_git_object: e6ab70132c0200f64980a3ae47cf798651145c69
- docs/sdk/models/shared/connectionwebhook.md:
- id: bdcd5563b0ad
- last_write_checksum: sha1:dbdab2081ab2efac1a36e3f62f7242b14402a96c
- pristine_git_object: 520672a2308fffdcd800ace2ef96078dcfa505c4
- docs/sdk/models/shared/connectionwebhookpayload.md:
- id: ed86887e7a96
- last_write_checksum: sha1:4435a8c9c2e1c0f1ab8873ad9f7a5dfd56284553
- pristine_git_object: 687c1c7ce8aa04241e53ef91c6613d368e85f81c
- docs/sdk/models/shared/content.md:
- id: 639d69d2341a
- last_write_checksum: sha1:9f01abb46a4f113614db0c4d8887b407bdc7508d
- pristine_git_object: 3e7b1bfc5f3a9e9379c6f6a603781cb4d7d30e2f
- docs/sdk/models/shared/createapikey.md:
- id: 01063fac8ce2
- last_write_checksum: sha1:e3606133c1b5053243e91e508e3274bc9f9a0839
- pristine_git_object: c0d0681cf54a312b8c96f33dcd4f56aecaeca40b
- docs/sdk/models/shared/customdatatypeconfiguration.md:
- id: 3a00f216b3b5
- last_write_checksum: sha1:74f6f26426e5e1e54884b44a8388ab8a1e231d71
- pristine_git_object: 614eb3e83e2b7d26e8e6dc7343bfefc52d25a644
- docs/sdk/models/shared/customdatatyperecord.md:
- id: 63a028e7008d
- last_write_checksum: sha1:ef63c1b499b62ca70d2e51205aec554d69dfb360
- pristine_git_object: 83a43afdf1becc02fa60c1628d85575108e3204b
- docs/sdk/models/shared/customdatatyperecords.md:
- id: 06740a950e02
- last_write_checksum: sha1:c284230ae0d74c1caff3efda136c6f43ced33dfa
- pristine_git_object: 931a6ae0eab05ae75a5c01907af5a78995e04718
- docs/sdk/models/shared/dataconnectionerror.md:
- id: 993cf6eb3364
- last_write_checksum: sha1:8289c89e62f7aadf9097d24dbb93b54ae906719d
- pristine_git_object: dd554f4eed3adb5652f74cf72cd6887b4561deea
- docs/sdk/models/shared/dataconnectionstatus.md:
- id: fd14e3dc6ca5
- last_write_checksum: sha1:157f827089b77cf2639a507a01066cac0bf69949
- pristine_git_object: 85c311a381eafcaeb07d06947b0607a8d3c15077
- docs/sdk/models/shared/datasetstatus.md:
- id: 13ee7a38a328
- last_write_checksum: sha1:7775a66037140c3f0a0a60247c7a0e8930d102fb
- pristine_git_object: 13df9de5d4d521cd30b4d8364b8e4402047a894d
- docs/sdk/models/shared/datastatus.md:
- id: cb4795d3f294
- last_write_checksum: sha1:5e466cbf6103fe3d4a83de916c5489c22d05e686
- pristine_git_object: 13d6b66b52f856bf02aa1f971183e8b84891ab04
- docs/sdk/models/shared/datastatuses.md:
- id: ec6ac9d4f6cc
- last_write_checksum: sha1:dc020ee1d4a741e82b663f10b17ded9cb62a455b
- pristine_git_object: 6d1e7bb23a51d1c76d208ecd9eb93baece905d1a
- docs/sdk/models/shared/datatype.md:
- id: 0338d85c906d
- last_write_checksum: sha1:80987fcaf2e06cf12337840bb4b9bf3db8dbd027
- pristine_git_object: 08150e774c04579ecc7fa4d309687265994d40d6
- docs/sdk/models/shared/datatypefeature.md:
- id: b7f230c48a58
- last_write_checksum: sha1:a20ca632329813508051576666d8d2c9334360e6
- pristine_git_object: 36ab7bf33b29fa315e26530b1b6568741ea776f1
- docs/sdk/models/shared/datatypereadsummary.md:
- id: 5cdac300f1b0
- last_write_checksum: sha1:c3774e2ef3de8bda886948cc87b3f1853e426b30
- pristine_git_object: 80c8f08770566927d870afb5b6199953d0bc23c1
- docs/sdk/models/shared/datatypes.md:
- id: 673024637a09
- last_write_checksum: sha1:9941d0049e2a35613eb091ef904f370ffe017056
- pristine_git_object: 02ef4d2029c2f9b632266369f2f2430b0f6f4e33
- docs/sdk/models/shared/datatypewritewebhook.md:
- id: d180d7dc0fab
- last_write_checksum: sha1:1f37bc604a5593cfd800185c1c8b68249e23c293
- pristine_git_object: 917940babe3a09ebae52c005c89981dccb19d9fe
- docs/sdk/models/shared/datatypewritewebhookpayload.md:
- id: 52690d53389d
- last_write_checksum: sha1:246f5c9e148a42c049173dad200397cbdec78920
- pristine_git_object: e3f3be19fc845cdc1b752414e254e1078e6a8a6f
- docs/sdk/models/shared/datatypewritewebhookrecord.md:
- id: fb94a0fc6195
- last_write_checksum: sha1:d0a4f19d07729ec318341fa2600a8a944afb0681
- pristine_git_object: 95e308b9e96cc0eb11ae620b864214750444111a
- docs/sdk/models/shared/errormessage.md:
- id: e0c030bde2a1
- last_write_checksum: sha1:1b2a3432758237f5b0b9d363e380f5f7d5b22c6e
- pristine_git_object: cb492cfd12bde4cdf2b254822f521f32591bfc2e
- docs/sdk/models/shared/errorstatus.md:
- id: d836c01e48c6
- last_write_checksum: sha1:205c94b7b43cd50b079dbb11a13736997336da69
- pristine_git_object: b4c58ebaced7cae086371cca9b8cc9dba626edf9
- docs/sdk/models/shared/errorvalidation.md:
- id: a1197fba13d0
- last_write_checksum: sha1:99f6c9b9c7cef6d55bb56c81b2e1f404b93f61be
- pristine_git_object: 8de2da74ea7a1613bc756dd5d9e3e0ac916671f2
- docs/sdk/models/shared/errorvalidationitem.md:
- id: dbec2a990008
- last_write_checksum: sha1:0312766ea0960d9896f8fadd8946f6312fa0ace2
- pristine_git_object: a777a327343f71181cb249f6fabaec32e88dd2b5
- docs/sdk/models/shared/featurestate.md:
- id: eba861fb6837
- last_write_checksum: sha1:030ff9d69cddb0f84a2d69e4e8899b5090cc1857
- pristine_git_object: bed9284e972cd209297bcf0af0755063bc791c72
- docs/sdk/models/shared/featuretype.md:
- id: e33f5e834736
- last_write_checksum: sha1:f07128b3ad8ee87dcb514938d143c84abd32e539
- pristine_git_object: 68ad73a8805f468afee9cc319878971bae4f5817
- docs/sdk/models/shared/halref.md:
- id: 140248af964e
- last_write_checksum: sha1:208df808950a3db6779bc93a8ca89e94a4da49ee
- pristine_git_object: e764a29bf8fbde82ee3449529c6745844e5d4677
- docs/sdk/models/shared/imagereference.md:
- id: 9adb58f7138e
- last_write_checksum: sha1:21ff1b8c6f84766df32cb2dc1ce158ed9b9186eb
- pristine_git_object: d1646ee8e754c73678e213a9367445f7a968cf49
- docs/sdk/models/shared/integration.md:
- id: 024440ffaed0
- last_write_checksum: sha1:e34209435dc12b3cc1554e9c873af8e7382dce77
- pristine_git_object: cdf6eff3f8549c4a9f2d348b101ec9724ef5cc7b
- docs/sdk/models/shared/integrations.md:
- id: de72eaf18510
- last_write_checksum: sha1:dea9aae1f987ab2bc9ca6d0de830f02bea8e5b8e
- pristine_git_object: ae7d91bc8ed2e31ebd38f09fdcfeb3371b93187f
- docs/sdk/models/shared/issue.md:
- id: 588b36b37bcf
- last_write_checksum: sha1:98725cec6e100dc55c037ab3b7173f7c4a8a16bd
- pristine_git_object: 0e7948ed77b34379a1b4900f707cea98d79063a1
- docs/sdk/models/shared/issuelinks.md:
- id: cfc1bca25fbe
- last_write_checksum: sha1:be03245c93620c042d6e99fda03724d3e9271494
- pristine_git_object: d648c6caf114a537d94f7cf1aab9ee3fd702d393
- docs/sdk/models/shared/links.md:
- id: fa66a5b5f260
- last_write_checksum: sha1:33d2c450025f12062570c5dcd38bb3f1f904f7a6
- pristine_git_object: 876d190ccb96f750a200edad6cd68eedaf07c46d
- docs/sdk/models/shared/modifieddate.md:
- id: bc37adae01e3
- last_write_checksum: sha1:20164de03e441328ac64a71791ab43002f6eeb58
- pristine_git_object: 488e53ecf59d25c12ad667cc5ca02837c6c96d3c
- docs/sdk/models/shared/profile.md:
- id: f1de6c9e5064
- last_write_checksum: sha1:4907e9aefb82fb8dafd975baad1f53c2a99b1237
- pristine_git_object: 5d85ae547f5aafb2d0d067e894539dba896e6894
- docs/sdk/models/shared/pulloperation.md:
- id: dcbd4e59dc15
- last_write_checksum: sha1:66a5004b05fe312c856dc38b819d779a9a441031
- pristine_git_object: f2f6a7610961133cfd5a79252704994272ac2c74
- docs/sdk/models/shared/pulloperations.md:
- id: d7ead2cdeffc
- last_write_checksum: sha1:3d889573fb4727717c321be61ce3c2a2f748dbe6
- pristine_git_object: 31cd22223d4730be0fdc79e49d5225f2d99f820c
- docs/sdk/models/shared/pushchangetype.md:
- id: 53824528b4ac
- last_write_checksum: sha1:238480969a94eb31ac1635c6769420fc4b7fa694
- pristine_git_object: da6c98fa68496fa5d45b7dbdad8d64790f88973d
- docs/sdk/models/shared/pushfieldvalidation.md:
- id: be50fc267930
- last_write_checksum: sha1:99db395285b358699c388ae5792eb1d7b3176079
- pristine_git_object: 98172ed93966ba32ece01c1f9cd4c1f434b10f99
- docs/sdk/models/shared/pushoperation.md:
- id: 862ef21ffa69
- last_write_checksum: sha1:93a02f81d83e3095a3034084934917e08787f140
- pristine_git_object: b50671be39ec7a3e0ad80f5be976afef8842a574
- docs/sdk/models/shared/pushoperationchange.md:
- id: be046171d3af
- last_write_checksum: sha1:63a940dba36ce6ce969b5e3cdcefe615821b3680
- pristine_git_object: 083b16dc3757be6bea8f0125a135afabbb8807d8
- docs/sdk/models/shared/pushoperationref.md:
- id: 41359c8937dc
- last_write_checksum: sha1:d283f5b9bf6c298661a81ee4ad5f522edead3f48
- pristine_git_object: 28e8772a89feff22bb33bda7314bdd62f4cb9d17
- docs/sdk/models/shared/pushoperations.md:
- id: 7efd8c6374e2
- last_write_checksum: sha1:5436afdc5c5f43a162b9c6207648a4a98b4b2ab5
- pristine_git_object: b9c08aa7fed9f96dfe1d0ce743a1ed0046735df8
- docs/sdk/models/shared/pushoperationstatus.md:
- id: c01cab5bc311
- last_write_checksum: sha1:8efd91f5e27739181e21cd4c5672207a9b1eecef
- pristine_git_object: c75d37cdeff10f706f5d93685e4f7f68f3089ce6
- docs/sdk/models/shared/pushoption.md:
- id: 28a9b11a0d39
- last_write_checksum: sha1:b6461f89ab78096c1171e023bafa3090dba4409e
- pristine_git_object: a91aa10320b8b6fcafe01b8853bc26bf43d4fcd8
- docs/sdk/models/shared/pushoptionchoice.md:
- id: 3dc25ab7bea6
- last_write_checksum: sha1:243a758370a36bd4d728dbe66a2a07a6b7601a7e
- pristine_git_object: 4240342e831d5b30cdbde288f09b5862dc514d5c
- docs/sdk/models/shared/pushoptionproperty.md:
- id: 06f73d448642
- last_write_checksum: sha1:67797dfbffe1f840eebdb75020e4fec42890aa7f
- pristine_git_object: 220725e19c90619e803cfad895be5bb23d0a64ec
- docs/sdk/models/shared/pushoptiontype.md:
- id: cc1fc9e23267
- last_write_checksum: sha1:3bed5b66260860709143d814815700a385263d87
- pristine_git_object: f96bd53eaa406a73bd3bc4933d6615bb870c232b
- docs/sdk/models/shared/pushvalidationinfo.md:
- id: 10ddca1b4793
- last_write_checksum: sha1:e5cc51b70173ae084f9153f94c128d126506b125
- pristine_git_object: 976ca04d3b3a142d573fd4490a2a15dcd6380a43
- docs/sdk/models/shared/readcompletedwebhook.md:
- id: a91e8b0fc864
- last_write_checksum: sha1:f80de9771f8a9050c770f572333937d153b18372
- pristine_git_object: cb71ac729c19a3a2d61965b2d8d55da295ef898d
- docs/sdk/models/shared/readcompletedwebhookpayload.md:
- id: 361b1e8834fa
- last_write_checksum: sha1:aff751dff2b8d9219ff60039b222fcc4c02f3e0d
- pristine_git_object: fb29e779be729bb81c57dbcc8d3ebdf1eb457b88
- docs/sdk/models/shared/schemadatatype.md:
- id: f1b5bb65132f
- last_write_checksum: sha1:156d97e699ef61cbc015aba9c37f6e57e5f2f4be
- pristine_git_object: 54ebf76d23669cd6ac17c928ac34d128a3b9ce3d
- docs/sdk/models/shared/security.md:
- id: 972729c50a07
- last_write_checksum: sha1:356159109a395a1daae36128b407a7373522fc3d
- pristine_git_object: 570497a1fc4290d4510fb4a5bf627186fb65d267
- docs/sdk/models/shared/sourcetype.md:
- id: 3ec91bdaf5e7
- last_write_checksum: sha1:9866e22a38a480017ba801015ab19c1133d2428e
- pristine_git_object: 8ec02b1fdb471dc90f9cc6ce374aacb6cf0a4deb
- docs/sdk/models/shared/status.md:
- id: d40dc096aca1
- last_write_checksum: sha1:f59a86180e429186a65b21b656bfabf8599d2c1b
- pristine_git_object: 7a98b6153c2c0f1923c99528f2ecf80c340ec9a9
- docs/sdk/models/shared/supplementaldataconfiguration.md:
- id: a2be088fae1f
- last_write_checksum: sha1:08b565c03dc49c9a9d56f3d74b0c0d4feecee733
- pristine_git_object: 8abb9c9fdbc8f5b6fcee3d53f7f2809a27ea5263
- docs/sdk/models/shared/supplementaldatasourceconfiguration.md:
- id: fb61fe0736b5
- last_write_checksum: sha1:59e93ccdeb1b2c661bda16577a03956764a25804
- pristine_git_object: 0fc38e7d6857fc4b855b0e04a7fa825486538981
- docs/sdk/models/shared/supportedfeature.md:
- id: 80b81ff8d229
- last_write_checksum: sha1:6a33f4686e45331f1bed94b7d606f123ea0f3921
- pristine_git_object: 98c35c9534ca3c5c6300814a5963bd80ecdc2785
- docs/sdk/models/shared/syncsetting.md:
- id: de6c0111a7ac
- last_write_checksum: sha1:28ef9aff02625a63e99e98d6e65303cd8bde563a
- pristine_git_object: d6ab3f02ae69e634f26106e04b042ef1defb30c7
- docs/sdk/models/shared/syncsettings.md:
- id: f1326b04ca35
- last_write_checksum: sha1:4a7e12d36fcfbb7cccab388a8e906bf581fb1116
- pristine_git_object: cc2b1d5ad764582c4e34354ced489be2e0425531
- docs/sdk/models/shared/updateconnectionstatus.md:
- id: e4f42de631a0
- last_write_checksum: sha1:299bcd3555827fc7462dd0e2947fde8ef111b175
- pristine_git_object: 3dfce0901018137200f4d837ee50c8fa1043a7c3
- docs/sdk/models/shared/validation.md:
- id: b9ffd70ca98d
- last_write_checksum: sha1:ebdbc0f2d5c6d5cf49c7776d83f622179e8528b3
- pristine_git_object: ffa69ff195a1cac3338aa5863a7a5f4de14e41b1
- docs/sdk/models/shared/validationitem.md:
- id: 4e3848a26890
- last_write_checksum: sha1:3f674e7e2e415d9c9ad8aee0a375a3daffc7152c
- pristine_git_object: 0e9a8c316debcf005b9bf3db92a87b5e1000fe44
- docs/sdk/models/shared/validationitem1.md:
- id: 1983da62972c
- last_write_checksum: sha1:bb7c84e22f61c339c1838eb16a0e654a0dfba411
- pristine_git_object: 42624d40e02de8d0a8e48fa0c3f8ec07f74c5190
- docs/sdk/models/shared/validationresult.md:
- id: 6a4471c9e7fd
- last_write_checksum: sha1:fc1dae970cfab4a3bff714d6ffaab5c13d0afb85
- pristine_git_object: 97150b68b97af56aaf6d0412d33fb44e4e8a4585
- docs/sdk/models/shared/webhookconsumer.md:
- id: fcd8160251db
- last_write_checksum: sha1:39d8d6262e3bfcf3c1a023f1037ae90fae135a40
- pristine_git_object: 73b39475984877dd253b3ef5c841c5bf33fc80ab
- docs/sdk/models/shared/webhookconsumerprototype.md:
- id: e5978a5127b2
- last_write_checksum: sha1:c7ff6af1533e26ffb8a8aa8ec49ee886bb5ff359
- pristine_git_object: c193effb3852490de42017a7ee77b49c63d3a48b
- docs/sdk/models/shared/webhookconsumers.md:
- id: ef422dd75135
- last_write_checksum: sha1:b13b969dce035fcd12f4dea2e63c2cd81c0bc6c0
- pristine_git_object: 55769a98692d5fbf9075ac7aff8f2e72f47aa60d
- docs/sdk/models/shared/writestatus.md:
- id: d3e63098fe46
- last_write_checksum: sha1:2fe60dd8faa9ccaeca2bbdbde4e2ede7135b4e18
- pristine_git_object: df9cbc79764e9223bc4a251ff0aca56bf41d4c2f
- docs/sdk/models/shared/writetype.md:
- id: 1c5eac249c35
- last_write_checksum: sha1:7c0585f0f4000d80981b257a32eb8501d4441d46
- pristine_git_object: 0a3c6740cf2a913cbd3202417095c29b3db99147
- docs/sdks/companies/README.md:
- id: 67e8a49afa67
- last_write_checksum: sha1:35ad7d67eac9e0640780fed30e99919767d72465
- pristine_git_object: b1ac040b3242891564461094f27c32bf76130a8b
- docs/sdks/connectionmanagement/README.md:
- id: 28637ecb04a2
- last_write_checksum: sha1:f4e4af8f14c246d29115d5b7851f868474ba1767
- pristine_git_object: 9f645690bb4441ac8411bb5744bbdcf6fae4c04e
- docs/sdks/connections/README.md:
- id: 3ef8931411ea
- last_write_checksum: sha1:7b99c7668f087d7ad34be10e35b0dd387b742c58
- pristine_git_object: bc0ad2ca30ec0357eb24b5180bfd6fdf34b0f543
- docs/sdks/cors/README.md:
- id: efba34c5ce3d
- last_write_checksum: sha1:21b06a033356ad8a3915e9471c2e3f76c38217e7
- pristine_git_object: 7cc250dae4045b8e0b1decbeeec39bf6111f4778
- docs/sdks/customdatatype/README.md:
- id: 66e977ac654b
- last_write_checksum: sha1:eb055da894f7993c86c68b406b5595b237e54d70
- pristine_git_object: 3eaa58ef5414e1c8dce2a3f1ea83e2f5cf11d8d0
- docs/sdks/integrations/README.md:
- id: 7b29664808c0
- last_write_checksum: sha1:ff661975f2228738071860d47dcd7f9d9e45d039
- pristine_git_object: e922543c4597315fbcce04b2a392a9afa55566ca
- docs/sdks/pushdata/README.md:
- id: f9e77a7e3bd5
- last_write_checksum: sha1:d00b25c17c153d7bea26e6f4fc596011e1242226
- pristine_git_object: 00231222f80488f23ebc330eb478d51d9b0a3ccf
- docs/sdks/readdata/README.md:
- id: 40d4a395f200
- last_write_checksum: sha1:821a2f9ccb09bc2e72f2b2f14894175b881baa4b
- pristine_git_object: 79d62c9506cee9476f1e1f4841ade5d5795736b6
- docs/sdks/refreshdata/README.md:
- id: e4f24d03068b
- last_write_checksum: sha1:9fc3f86707306cc9d06da0169c421eb085b6cd49
- pristine_git_object: 73a47f90dc894216927cb881e6b372f20e260d59
- docs/sdks/settings/README.md:
- id: ffd4dbcfc0ce
- last_write_checksum: sha1:5a1c1bd0bd6b295dd5892c25ed718c230c4080d3
- pristine_git_object: 75b5f21677e77127990fc5901d05836e50c44e15
- docs/sdks/supplementaldata/README.md:
- id: 225f3e45f483
- last_write_checksum: sha1:e72f8eb2fa7cd94fbe7e97a639eb047b4e761994
- pristine_git_object: 8be9e1527e13ed1687346c389551dc26fd9a4b64
- docs/sdks/webhooks/README.md:
- id: e21b32d786a4
- last_write_checksum: sha1:f7f28ada794f74c3bf799e91915dcda3ca7daf6a
- pristine_git_object: a7d2a14f969906d65ec06749aaa976f7c467a5b1
- eslint.config.mjs:
- id: 461c8d07f6da
- last_write_checksum: sha1:9398f326377fe47f67af2df6eb6370750c0790b4
- pristine_git_object: 67bccfec985be20a00970d90155752832dd47135
- examples/.env.template:
- id: 52cbe5afed92
- last_write_checksum: sha1:22b92d275a1bcc55b1817f7d6121a6dcaa04a438
- pristine_git_object: ef7de0a9fe7d5cd221e5e46474fe5108c3ec7d7a
- examples/README.md:
- id: 9d0f69d6e677
- last_write_checksum: sha1:0d6635aa770207277c500c23c36f1515af3076d1
- pristine_git_object: 1d3dca6dac74eba4976ff5eb9748f4febc782dc5
- examples/companiesList.example.ts:
- id: 21346a1a073c
- last_write_checksum: sha1:c8c35129d4cf53bc5d21604b2d4f003b5ff091d6
- pristine_git_object: 648bee2857610123a7c18212e8ba9ba8138c58ee
- examples/package.json:
- id: c1d7b0ec8e7e
- last_write_checksum: sha1:4031d8d0f85ef573ddb8feb0738fe9f4c60fb46b
- pristine_git_object: 5dc8c25718e9c3667d8095c7d068cbbcc4f03bf1
- jsr.json:
- id: 7f6ab7767282
- last_write_checksum: sha1:c0a5343d5c855f069d8af938762419f6cfbdb064
- pristine_git_object: a06825c1dd042d965b20e8c422817df0a0948fab
- package.json:
- id: 7030d0b2f71b
- last_write_checksum: sha1:dd497a0dc1648f13fc46570b8733e5b3e5e6cf61
- pristine_git_object: 57d35bf9d43a1017669ea1b11175b8b16d20f1d3
- src/core.ts:
- id: f431fdbcd144
- last_write_checksum: sha1:9744ded3fe595398f8cf7c12fd4f17a418f65f2f
- pristine_git_object: dee072a47bfb28f90396e818ed5deffc2004e87d
- src/funcs/companiesAddProduct.ts:
- id: b3b72701ac79
- last_write_checksum: sha1:325ec94d5a692fc6417c95fd76d0e8380177370d
- pristine_git_object: 4bb693769ec7c8a0f4eed2ed573d3a70f9d39102
- src/funcs/companiesCreate.ts:
- id: becfb79b6222
- last_write_checksum: sha1:73b90d94715f58fac88f9f3fad8780f86ad8741f
- pristine_git_object: 274b8d339c1e1fb5b1de5e3ff6b3a22fbf53752a
- src/funcs/companiesDelete.ts:
- id: d4b8d3c15935
- last_write_checksum: sha1:8e49c458cbc4eeeaafab9571fa119e3dfc93b02c
- pristine_git_object: 64e2354140ca0d8687db066c6fe26c234e20a95f
- src/funcs/companiesGet.ts:
- id: 497c5e9320c2
- last_write_checksum: sha1:f72ad393158bc2f1398e8c44b9dfd2fe2f0b2e83
- pristine_git_object: f764cdc1795793db9a4add0a5f3a6ceda98cc5ef
- src/funcs/companiesGetAccessToken.ts:
- id: 9fd96bcbf643
- last_write_checksum: sha1:bbe97d868aac62d43a56053ce4fd32ddc6655f04
- pristine_git_object: 3850551a493bb590216ccf9f90f718bd67cabe2e
- src/funcs/companiesGetCompanySyncSettings.ts:
- id: 0312a9f237f1
- last_write_checksum: sha1:db859a12c27e20649e3a87f7a5964c5850bc1ea2
- pristine_git_object: dcf62f317887601eff89ab9885b731c25218f4b5
- src/funcs/companiesList.ts:
- id: c57fb769a99c
- last_write_checksum: sha1:51d749cce902e3b0387bfef61f2cf152fa56e66a
- pristine_git_object: d746453e09b0d8473bdf216c7664a47812000b7b
- src/funcs/companiesRefreshProductData.ts:
- id: 44fe2ea6742f
- last_write_checksum: sha1:f2a9c12d5d0dfc35b1fe17754a5ab43950bb57f2
- pristine_git_object: a27cf9149b655ac41a27fef0897a1229452fac63
- src/funcs/companiesRemoveProduct.ts:
- id: 210f26acb85c
- last_write_checksum: sha1:a91ff5cb28a0dc92e4302a079d11a6b173c7b390
- pristine_git_object: 41f892c79b1824b5c0fe6e2b358cf9988d68a83c
- src/funcs/companiesReplace.ts:
- id: c141cb91cc73
- last_write_checksum: sha1:cdd4282084b26fec5d8ee7704520b2dd1125d5c2
- pristine_git_object: dd5f90a3fdd9b8248b4c5da48312b4716c25f310
- src/funcs/companiesSetCompanySyncSettings.ts:
- id: e6304c1f4cf8
- last_write_checksum: sha1:2fdede2b83faecc9e938fcfa249444f5acae981f
- pristine_git_object: 5d72c86a64836569d289d453db6a2bf3bc52f605
- src/funcs/companiesUpdate.ts:
- id: e3d7bd676c21
- last_write_checksum: sha1:0a877e40852e88b7931f9d54b146b5ce96599438
- pristine_git_object: d62c51598bd2a016452c6c12f82e2d1c9d1b196a
- src/funcs/connectionManagementGet.ts:
- id: 9eb0e0f22fde
- last_write_checksum: sha1:e404430d2938596f2bf485068155379c832f4929
- pristine_git_object: f027fc777311fbb9a9de59964054461f7bf53d62
- src/funcs/connectionsCreate.ts:
- id: 0423cc2d060b
- last_write_checksum: sha1:e57c13d575b18fea61d74c39b094ba2938a843db
- pristine_git_object: c9b0b221bc0bdf845d0fd950e468d51d6fde638d
- src/funcs/connectionsDelete.ts:
- id: f33b14b4a39d
- last_write_checksum: sha1:61ddf4d0dbcb1cf150c7e08768e0f4f6850d29b4
- pristine_git_object: 2999349000a22b6716b7f24a9947d74c7ae68a72
- src/funcs/connectionsGet.ts:
- id: 6a1b6227b285
- last_write_checksum: sha1:f91146e0e7774bb046f2cc89734cc6cd2726449b
- pristine_git_object: 5a72755edbd6c2f253059b020662df88356ba3ca
- src/funcs/connectionsList.ts:
- id: ca36cb8b50d3
- last_write_checksum: sha1:3ed61a242f4d133ecb973200fc29214d28a3df16
- pristine_git_object: 4df8cda66019bce3c88e60b917a2544e4fa67cf6
- src/funcs/connectionsUnlink.ts:
- id: 0ff9d29a8016
- last_write_checksum: sha1:3f695ee3e9aed2801c689a3d57f0665133a1c072
- pristine_git_object: 25deda12005c245475955308c87e4548c2162cb5
- src/funcs/connectionsUpdateAuthorization.ts:
- id: ea3363f5f9d1
- last_write_checksum: sha1:75d1c25f481c02613f1e79a16744344d35be016b
- pristine_git_object: 8b80d8ab751841f9d4a8395fbab9b9cb9cdeb453
- src/funcs/corsGet.ts:
- id: d31eb3b61079
- last_write_checksum: sha1:2f8c53d08af17aaea3fc525cccae43846e3e2ef2
- pristine_git_object: 68e859302153c7bbf9b134ac2edc75a541e94f25
- src/funcs/corsSet.ts:
- id: 38f524286e09
- last_write_checksum: sha1:5806f58763954d372438c6e4790aaca81d35dbb7
- pristine_git_object: 5037527df578a1e7aebc420e7c910d390258f50d
- src/funcs/customDataTypeConfigure.ts:
- id: a8893a3acc96
- last_write_checksum: sha1:3c1f66d700abb821ac2c09c83f241c091335e1f1
- pristine_git_object: b22b80f8187c65cfac73fc830f5dbca2b65c38ed
- src/funcs/customDataTypeGetConfiguration.ts:
- id: 94629e039cc9
- last_write_checksum: sha1:a784a2e1bd53ac682d641b7b617ec9f4223a0c67
- pristine_git_object: 8cd5b199b2bb077e4503d23b5fbe98a4a90caefb
- src/funcs/customDataTypeList.ts:
- id: f7e6dd149e4f
- last_write_checksum: sha1:185cd48497611eb8138634d732563524d02bd006
- pristine_git_object: 83bc7150889cc19b85decfaae13d846843ca7ae1
- src/funcs/customDataTypeRefresh.ts:
- id: 3dc9879f360e
- last_write_checksum: sha1:d5900cdcb8d222de1fb88150e9c957576b8cb160
- pristine_git_object: 71b3728a4e621d65082af1d4b5821e6af05d71f0
- src/funcs/integrationsGet.ts:
- id: b6b0e31a5b00
- last_write_checksum: sha1:fcfc5ea97c2514568ff27b87ba809b84b7a9d27a
- pristine_git_object: af1459141ef41d04f06c05ec0cf48a9d29716e63
- src/funcs/integrationsGetBranding.ts:
- id: 8c0f1bcb75a0
- last_write_checksum: sha1:b1f96fc5d77acb5dad0f645d8fbc68faf71bb541
- pristine_git_object: 6a251d15e7651a957feae35115670928957aadbc
- src/funcs/integrationsList.ts:
- id: fcbba304389f
- last_write_checksum: sha1:7cdae8ff0058739a874d21ecc7b8535f65de718f
- pristine_git_object: acd0e0a45a5b036c019581bed6b55cf2b9189783
- src/funcs/pushDataGetModelOptions.ts:
- id: fe4a3486eb78
- last_write_checksum: sha1:192bf6ca7a76192fbad5032e0b41056009415422
- pristine_git_object: 13f18b844206c71481610fb310675f738c47907b
- src/funcs/pushDataGetOperation.ts:
- id: f1de0499fdae
- last_write_checksum: sha1:d743589dd1477dd616f4ab6191c0e1cd1252e809
- pristine_git_object: 23fa87087432d04f35020583452e92eb3541b98d
- src/funcs/pushDataListOperations.ts:
- id: 68a4457f3769
- last_write_checksum: sha1:cab4390c464ca0934daf391a2d2135df67de8d3e
- pristine_git_object: 0d0871181331831b30c432e858d05d5ac33e5515
- src/funcs/readDataGetValidationResults.ts:
- id: a763967449b6
- last_write_checksum: sha1:42332e3b50827eef30c053802552e4c334bf34b3
- pristine_git_object: b669f6d6c742430426c02db7c762826e61f68129
- src/funcs/refreshDataAll.ts:
- id: 7753ed62dca8
- last_write_checksum: sha1:6739e4490fcf44654dfb78133e5f5e348fee80ea
- pristine_git_object: 8199dd6e745193500bccd6d213a1c86d8097a535
- src/funcs/refreshDataByDataType.ts:
- id: 396cf059f37a
- last_write_checksum: sha1:dfd207088675aae067642d9952a4752b8a0235ed
- pristine_git_object: 891959ef12d0a3af5fc3fd259d89fb2219057874
- src/funcs/refreshDataGet.ts:
- id: 8986cedc7f4f
- last_write_checksum: sha1:3dbc07e50004e77ec6eb1134cb245003ef549d55
- pristine_git_object: c87e650e4cef6c9ff498545d1583646e8a8e50d8
- src/funcs/refreshDataGetPullOperation.ts:
- id: 8b6d65052a82
- last_write_checksum: sha1:d2f918ac94c77df97a4544129f69e1eb8fd76b6d
- pristine_git_object: ee36f9d08b5ecb7c79a7fafcc0844615230a85ee
- src/funcs/refreshDataListPullOperations.ts:
- id: 8a8e27bfa08d
- last_write_checksum: sha1:62e35e44e90d820233e650db456e0aaee1f4d8ff
- pristine_git_object: b4cf03ed172c78236ba21e720300bafe9875c69f
- src/funcs/settingsCreateApiKey.ts:
- id: fa32333732a4
- last_write_checksum: sha1:16d2df1252f4a4747f9937f9c9322b886470e3de
- pristine_git_object: 8adc1a069862bcea0b94506ed32bcc219ea698f0
- src/funcs/settingsDeleteApiKey.ts:
- id: 6d2edbff42e3
- last_write_checksum: sha1:3bd047a876ea6d746b8b37418e6e61d580c2a578
- pristine_git_object: 4a93b629185bbae7ce46928a7dccaebb9166854b
- src/funcs/settingsGet.ts:
- id: 2543278c0bee
- last_write_checksum: sha1:1fecd073e1a32b32ac2ddb428043a627ef362cc2
- pristine_git_object: a30519f0e5226dd1612a9c17fd5bf4b91fb0a6e7
- src/funcs/settingsGetProfile.ts:
- id: 454f8eb0280e
- last_write_checksum: sha1:4ffdf2c8f325c230b9cede6746ad0e9958afe1b8
- pristine_git_object: 0ac5dd61b83c35ccdfbbaed15d6b2bb6c31bc722
- src/funcs/settingsGetSyncSettings.ts:
- id: 39ea3774ba93
- last_write_checksum: sha1:d7fe980057583c6bbbee590276b20ac8f9ac084a
- pristine_git_object: fc49221e1075fd3fe86f3eb7cac1498d5ffc21d2
- src/funcs/settingsListApiKeys.ts:
- id: be3d7398bed0
- last_write_checksum: sha1:127af218ed8bdbd86a1d867b60823bb75fc5aebb
- pristine_git_object: d33d507c9fb4b218399fb1a50e200012c94e0cce
- src/funcs/settingsSet.ts:
- id: a85ecf9d80ca
- last_write_checksum: sha1:f0779de840116e77855133254e6b89492a54b422
- pristine_git_object: 2f036b3cfca2c9d1339582ed47c8f396f7a5aba9
- src/funcs/settingsUpdateProfile.ts:
- id: 3f1a8a41a125
- last_write_checksum: sha1:2019ab372555cf64c2ece22bcbd71ee89d2c8429
- pristine_git_object: 26a841a1a5dd166d9877bc143b53caa2b485df6a
- src/funcs/settingsUpdateSyncSettings.ts:
- id: a1dd684393dc
- last_write_checksum: sha1:0f2a901f2adfd33da377dbdb0738b27dc668a91d
- pristine_git_object: 764ed9e5277c204e58fafe0679e42d29e0bda555
- src/funcs/supplementalDataConfigure.ts:
- id: 4a8451d88b34
- last_write_checksum: sha1:8a344b435a9dce01c1f84fce7ceaea99a89e2638
- pristine_git_object: 7bdc561de5aed542cfc3da46d1ccc5622fe5730a
- src/funcs/supplementalDataGetConfiguration.ts:
- id: 25d74eb1540d
- last_write_checksum: sha1:f9e5ad113350c8f29d09d96a0ac2d684bf4f913f
- pristine_git_object: 9e464a0a75de1ff12bb574a5d8eb4e1bdca5c6b0
- src/funcs/validateWebhook.ts:
- id: f3ebc1bebb84
- last_write_checksum: sha1:a69b4ed9c001056dca4762f9f9208451a685ed76
- pristine_git_object: 02c1297b448f2c2779574e2372277913f93562f2
- src/funcs/webhooksCreateConsumer.ts:
- id: d756d12323be
- last_write_checksum: sha1:81bc59392d140c215a9c0a30acc09f659fc6c369
- pristine_git_object: 184ebe2aeae2e3fe9cb95ac12fbd470684c48e9f
- src/funcs/webhooksDeleteConsumer.ts:
- id: 62595c2f5815
- last_write_checksum: sha1:239d8a288f7fbb8080b6ee8e85d08838ca646863
- pristine_git_object: 7923eeba40515d82712686a060978e331f404328
- src/funcs/webhooksListConsumers.ts:
- id: 3aea0e6c36a9
- last_write_checksum: sha1:f79bdb1683a099c66c06bf535c64064dca60a335
- pristine_git_object: acad565e252f1c183be7e127528ca754e8d2d147
- src/hooks/hooks.ts:
- id: a2463fc6f69b
- last_write_checksum: sha1:9a569ea8f3177ddcdfe6cd903feaf5c2d2c36a9a
- pristine_git_object: d34c88497fb1cfb22a725e52b4c218f36d0b5c8e
- src/hooks/index.ts:
- id: 5f2dab62b520
- last_write_checksum: sha1:1a11c073a6cd792932218e1d4ed36b8567bad8ef
- pristine_git_object: f60ec7acd76141a71d78008c5a362eb0236d8335
- src/hooks/types.ts:
- id: 2a02d86ec24f
- last_write_checksum: sha1:a2145ca7943102b61791b4b067fb593f221349b3
- pristine_git_object: 494395f66d0a6de6f6cd8b1dc918557843158c1d
- src/index.ts:
- id: c5fb850250c7
- last_write_checksum: sha1:35c9cde3ae14b18b3f893a1afe8b6c44f8760f24
- pristine_git_object: dbcba164a0082e3bb8c43cf21fa7f8ffb9d35dfc
- src/lib/base64.ts:
- id: "598522066688"
- last_write_checksum: sha1:b0b12ddbd8625efb47c0e955a18641aeb10c6532
- pristine_git_object: 0aebd8b0a4867e35cb3348fc52921c3c0b4725b7
- src/lib/config.ts:
- id: 320761608fb3
- last_write_checksum: sha1:143e475811a58b2b47433624e49b4a4d9e6ce150
- pristine_git_object: abccc40d2aba0ae4bbccfd0f7b3ab431b19a691a
- src/lib/dlv.ts:
- id: b1988214835a
- last_write_checksum: sha1:1dd3e3fbb4550c4bf31f5ef997faff355d6f3250
- pristine_git_object: e81091f5e536f82739f71379b1fddc2d147c49e2
- src/lib/encodings.ts:
- id: 3bd8ead98afd
- last_write_checksum: sha1:d47614c415b37e092965c34cb668562195701004
- pristine_git_object: 2791d25bc4f7cf6eec17a65f899851e225fa3deb
- src/lib/files.ts:
- id: e5efa54fcb95
- last_write_checksum: sha1:795c14026405d547bfc47012f7ad9666e530fa7f
- pristine_git_object: 6ca6b37d35a12448da176ee2517cc036db12c81c
- src/lib/http.ts:
- id: 63a80782d37e
- last_write_checksum: sha1:797cbf16d3c7c4d62d3ba0eedb08617524938457
- pristine_git_object: 13cf1fd7894a89f727b8d2db2ad24313a94f68c7
- src/lib/is-plain-object.ts:
- id: b9862591096a
- last_write_checksum: sha1:df687f25a9590b6fd95d39df41a652ae3fd4e517
- pristine_git_object: 61070d3d7c7e5e95b1ed7e7ea21869eb0767db77
- src/lib/logger.ts:
- id: 7ee7741a02bf
- last_write_checksum: sha1:0ec9d3a2a34c362746b767e4f9a746c055d57a7b
- pristine_git_object: d181f2937d4128afbe9b0327e0f81d1fa9c877b7
- src/lib/matchers.ts:
- id: d54b2253b719
- last_write_checksum: sha1:4775ae173392e86f356bb1ffd0d16f3c2d7b0d54
- pristine_git_object: b096d6f201a8f1b24dea405dc0cb1c75efdf4c97
- src/lib/primitives.ts:
- id: 74859f750b28
- last_write_checksum: sha1:987869fc54790b9c22e9182099103d6aa7c67016
- pristine_git_object: d21f1dc49affa4e6d324bdd60811b470fdfa7eb6
- src/lib/retries.ts:
- id: b24a69d15639
- last_write_checksum: sha1:f3da74dffcbe2756c69393f8600205aa1dc06e68
- pristine_git_object: e3ce9aba72150fc3c18f3105d39b21aba809377b
- src/lib/schemas.ts:
- id: deb4b531fae1
- last_write_checksum: sha1:b8517a14d3043f488f44e3b10ddd6cabdd22242f
- pristine_git_object: dc2510e330727b01894e4d3954ea92a62c962e5d
- src/lib/sdks.ts:
- id: 8a6d91f1218d
- last_write_checksum: sha1:fe94d4c4f88fbe0d549e5d0411b2aa9cfdf740eb
- pristine_git_object: cef4177db76f7c16ed5e1907f58d9cc861e0fd12
- src/lib/security.ts:
- id: 0502afa7922e
- last_write_checksum: sha1:808e939964cd1393080c8b6428dabf33f746bae5
- pristine_git_object: 3da8e733b499dfb3c174dab84751a95ebc42324a
- src/lib/url.ts:
- id: b0057e24ed76
- last_write_checksum: sha1:3bceadd74bf0b31adf13eb06b7531077c3e07d65
- pristine_git_object: 79e7ce660b3732053e3adcbb5a4cdeb51496e8aa
- src/sdk/companies.ts:
- id: 7d7df3fca5ca
- last_write_checksum: sha1:8c7d8cec65c48ce3ec6b16dfc5dda76a5d6bc11a
- pristine_git_object: e42a57991bebb6ecf8515d5207f9172eae167d89
- src/sdk/connectionmanagement.ts:
- id: bd681627a514
- last_write_checksum: sha1:cf55c3456423ee3bc32ab8771882ee088a9c03bb
- pristine_git_object: c1537290b6b94d9f4d782dcbf7370fff2e54c1a2
- src/sdk/connections.ts:
- id: 5992fff3b5cd
- last_write_checksum: sha1:2c9aa0fdd196278e3e03c3d9261d809d3138971b
- pristine_git_object: 75de8c36f59d86b67f5f5af0659a7b0d370e1431
- src/sdk/cors.ts:
- id: f2948a28f086
- last_write_checksum: sha1:24a286826d922b4f30e5f8445ef213b26963545e
- pristine_git_object: c8b6f473538e9c8b7b887911d16a3a9af553099f
- src/sdk/customdatatype.ts:
- id: 9d6a718df1c7
- last_write_checksum: sha1:b752b2e2550a1903e488381e26c31f3ec053eb04
- pristine_git_object: da886b98424b7e40c8a2b2dc66e5c11f7d83ef38
- src/sdk/index.ts:
- id: a857902a703f
- last_write_checksum: sha1:ed6d64f2a6135349aa8498b8d8cff9ba85c7fb8f
- pristine_git_object: ecac2264817bb369ff2dbf0f0e9029807e67ff77
- src/sdk/integrations.ts:
- id: eafed585af5a
- last_write_checksum: sha1:49fd333cb5f64438f12f0988cba79ce2b568b9f9
- pristine_git_object: ebfab9c5a78703d444acb4c77be95635fbd3b899
- src/sdk/models/errors/codatplatformerror.ts:
- id: 9e608117fc24
- last_write_checksum: sha1:d8a38b5fdd3a2448260304dae512c68b4976571c
- pristine_git_object: 32dfeae30de2b7b8a6304e6460de62c851d59d57
- src/sdk/models/errors/errormessage.ts:
- id: 2bc5b9b70870
- last_write_checksum: sha1:bce40db996dde91f322ee1ead448fb1dddcdbdbd
- pristine_git_object: 6ad9c7a285f95fbbb7018abb1ec796d4dd096762
- src/sdk/models/errors/httpclienterrors.ts:
- id: 7be0894f205a
- last_write_checksum: sha1:994ced121c54fecd0af038ccfb7855fbfd3868ec
- pristine_git_object: b34f612124c797c2a1106b9735708f679a90b74f
- src/sdk/models/errors/index.ts:
- id: 017ae2dc215b
- last_write_checksum: sha1:69b4a738ee5a785c8b92203e81d9889283ea7cdf
- pristine_git_object: 709731241921a50d588abadb31701638fa85bcd5
- src/sdk/models/errors/responsevalidationerror.ts:
- id: 0b76670204e7
- last_write_checksum: sha1:7033fb87290848ab13c06c576d174b3e40918b0c
- pristine_git_object: e98a5961af2fbd8fe7b942ea6c2a82eac10a01f4
- src/sdk/models/errors/sdkerror.ts:
- id: c231fdf3b914
- last_write_checksum: sha1:e631c07233e6e280fb3604313a57e8bcbe81c120
- pristine_git_object: e272fee5e17df35d2c0a07dd2164316d23bb21ae
- src/sdk/models/errors/sdkvalidationerror.ts:
- id: 7c8a11e099b9
- last_write_checksum: sha1:a69da17627bcc32b820544608f3400423ea53f26
- pristine_git_object: 6826e1208a5d7b7d310535d18909646522bf0fbd
- src/sdk/models/operations/addproduct.ts:
- id: 7b6273a1cbd7
- last_write_checksum: sha1:758ddc45ab6ed58f8d85eef72e2cc277bf58d73e
- pristine_git_object: e40c51754735b4949ef3be1842a70b607245ff21
- src/sdk/models/operations/configurecustomdatatype.ts:
- id: 6dee9e978933
- last_write_checksum: sha1:abbee5731df9e4b690b41535e23f535759a70a7a
- pristine_git_object: 11307f880b2ada43db7ad220bbf0d7bfebacf956
- src/sdk/models/operations/configuresupplementaldata.ts:
- id: 1dc3739fbb01
- last_write_checksum: sha1:51891beaf5e044d407ed09bd6c8c589c8c623cb5
- pristine_git_object: d17dc21bd887787768a46876c86b6d96625fdd6d
- src/sdk/models/operations/createconnection.ts:
- id: fd864cebfe91
- last_write_checksum: sha1:67abdd42c0f4b8669b59225b4cf97763bd0cca4c
- pristine_git_object: dc5bcac12be709864c1f9a57ab0591899995abeb
- src/sdk/models/operations/deleteapikey.ts:
- id: 85933bdc0c0b
- last_write_checksum: sha1:d06dccd9fc9b6e41481f060e634f07fe2392e73e
- pristine_git_object: bdfb45a4d055ee07316914c4d1866e04e48a1de9
- src/sdk/models/operations/deletecompany.ts:
- id: feff26e831a7
- last_write_checksum: sha1:3c6c30970b77ef97770f4a9fed7866b08bfd1ad0
- pristine_git_object: dbe555534894ed6e7f64cf4f034fff5fb58ddedb
- src/sdk/models/operations/deleteconnection.ts:
- id: 918aad3d3a4a
- last_write_checksum: sha1:47fa476012d016921380a863c5457ef7babdd186
- pristine_git_object: 83f75997084050b7c35824dc9e065e81e3677b69
- src/sdk/models/operations/deletewebhookconsumer.ts:
- id: 04489804ec02
- last_write_checksum: sha1:ddc36df343efddf1f02b9ccd675d92fff65e6c89
- pristine_git_object: 630c1122a68be97cba7e282286438c1b95e7186e
- src/sdk/models/operations/getcompany.ts:
- id: 4bef19281ada
- last_write_checksum: sha1:3c30540e6bcdad8e8a51c616dc9e9b21934890ca
- pristine_git_object: 77734decc381321230c2bfb8f340633b2064f315
- src/sdk/models/operations/getcompanyaccesstoken.ts:
- id: 2d5fc9dd3264
- last_write_checksum: sha1:c0fe9828a6d274e8e301d5b5f1c468eef4220ef4
- pristine_git_object: 6b76f47f238c15e4c80683a6f3081dd5c275a47a
- src/sdk/models/operations/getcompanydatastatus.ts:
- id: 9f2ea820adc7
- last_write_checksum: sha1:788da94c2f3cdc65f4e84695b4db4443b58a6309
- pristine_git_object: f9953a2495666cd149558099cf160494e7ec7d45
- src/sdk/models/operations/getcompanypushhistory.ts:
- id: a33d380d0de7
- last_write_checksum: sha1:b800301bf317bd44ee2807b1b9f6543de7aaca6e
- pristine_git_object: 0e34ee5b0e3b9adf0f5410f96bad03405b9d2d40
- src/sdk/models/operations/getcompanysyncsettings.ts:
- id: fa689d9a66c9
- last_write_checksum: sha1:2cd4ad37a1f90188beeefadb9509c5fc06714d4c
- pristine_git_object: 6fabd765dd60f0c9396c1336b6af0785f055a329
- src/sdk/models/operations/getconnection.ts:
- id: e6be8d1eab2c
- last_write_checksum: sha1:94309b857129d317a91f50bae1e58ab670779062
- pristine_git_object: 126d23b8515e33d0e3c796e642e68ee0f74a6e00
- src/sdk/models/operations/getconnectionmanagementaccesstoken.ts:
- id: dd152a787019
- last_write_checksum: sha1:703b4a9c2acd713edd22b89d2cbb5bebfbbfcbb3
- pristine_git_object: d77a4d7f6b8646744694c317be303c5027843fd8
- src/sdk/models/operations/getcreateupdatemodeloptionsbydatatype.ts:
- id: 3dc29f7d62c2
- last_write_checksum: sha1:b693039c6a1779e0929ca83e8ebfcc4c47459e93
- pristine_git_object: 2c1cd46ce3e96d80db4cbeed7757f4de67d70aa4
- src/sdk/models/operations/getcustomdatatypeconfiguration.ts:
- id: 164bd493023f
- last_write_checksum: sha1:2a3afa6313a5c1e496fa3335b5a8618bd85bd231
- pristine_git_object: 31b20d15bfeeb8474396939de29b1bfac937d6a6
- src/sdk/models/operations/getintegration.ts:
- id: cf6290064741
- last_write_checksum: sha1:8c63dec5ff140ecf64263bff70bf9a2b0878767c
- pristine_git_object: f7b44cad11383a302ec83a7270d0ca4a855b4b88
- src/sdk/models/operations/getintegrationsbranding.ts:
- id: 900634656c56
- last_write_checksum: sha1:0b556cfc8222d4280b38b0d24944fdb7b1919638
- pristine_git_object: 7ea6273d97c6b956be3dad11f8dc98e8537c476e
- src/sdk/models/operations/getpulloperation.ts:
- id: 72377e8b61d4
- last_write_checksum: sha1:0a0b81f1f3c3e124585a2be4e7325117c1d059cc
- pristine_git_object: 2df9079da61727da96e0e5e57f9ba0f006c66aaf
- src/sdk/models/operations/getpushoperation.ts:
- id: 8b4e8573095d
- last_write_checksum: sha1:e1cc048f6fff1b438aeb09e26ddd44e37f49b8e2
- pristine_git_object: 3a950624c21d3161701867af7743651708053b6f
- src/sdk/models/operations/getreadvalidationresults.ts:
- id: 6b52970753c6
- last_write_checksum: sha1:f471d8ab6d1bad92873530b3ce39b014a4fb999c
- pristine_git_object: 68933c193bab7da9ec662c724039d13e912fef16
- src/sdk/models/operations/getsupplementaldataconfiguration.ts:
- id: eeca37a43b5f
- last_write_checksum: sha1:fd8eb90862e63e89e4c7d87a6b5bb88457c5336c
- pristine_git_object: 06a087af28b97436dc09b83fb3e969c1bf88b17c
- src/sdk/models/operations/index.ts:
- id: b2864d0519d7
- last_write_checksum: sha1:02643a07b38a8f37231f37c6f919255a13da8546
- pristine_git_object: 182d597cb3b0da34eb8835bc8134b84c072f81ad
- src/sdk/models/operations/listcompanies.ts:
- id: bd514f2d5c1c
- last_write_checksum: sha1:1487d8f67d5a1c439e6581e854213aa1a386b9f3
- pristine_git_object: 837a6aae587e8a038402fbcedcd4fcc1873136ba
- src/sdk/models/operations/listconnections.ts:
- id: 5797f5b9be29
- last_write_checksum: sha1:0e709e410d2b500143f63d78e8eaa9ce4c810a6d
- pristine_git_object: d1be0d9421b3b0d768650208abc91adcf7a9b721
- src/sdk/models/operations/listcustomdatatyperecords.ts:
- id: 2be2700efbd9
- last_write_checksum: sha1:947003c92c9a26aed81fd69c32e22b9493f28407
- pristine_git_object: 19ec7d32a28d7fe4a34932be9e8ac893b161ce4d
- src/sdk/models/operations/listintegrations.ts:
- id: 1afa5fb27034
- last_write_checksum: sha1:7c7f044ba21504b85046dddac2adc9ce8e2ded51
- pristine_git_object: 01ba5000f839749caefaec759794fecace9a89bb
- src/sdk/models/operations/listpulloperations.ts:
- id: 2f2dc545b414
- last_write_checksum: sha1:07db30cc5a51f31a8b19823b0248e852b13949d4
- pristine_git_object: d12f7bd86d6d9180c2042db5b65d5858f3d0c770
- src/sdk/models/operations/refreshcompanydata.ts:
- id: 7e6ad22e681f
- last_write_checksum: sha1:676da2d40c22653abd9e2d0254f315f217f542e3
- pristine_git_object: 43671cece963c234d63f965424d20458c74886a5
- src/sdk/models/operations/refreshcustomdatatype.ts:
- id: 6a765c40d824
- last_write_checksum: sha1:ec8e21c91faec54307cf17ead36837afd803fccd
- pristine_git_object: 410d11966320ae7ba5fc8a5e4bad219c41fb09b4
- src/sdk/models/operations/refreshdatatype.ts:
- id: 3b0dec3e2d72
- last_write_checksum: sha1:a5f4a4d5b4cfa37eac057247ac89126b897d70cf
- pristine_git_object: 021dcc185ec76da15170d033acbfea3e1eaf46d7
- src/sdk/models/operations/refreshproductdata.ts:
- id: a37d77b445e8
- last_write_checksum: sha1:23ee4b9539df38c3dced3b0007622cf9ae9c0ae4
- pristine_git_object: 8636ba5256a0963ae52b4564c3eb2bc67179af17
- src/sdk/models/operations/removeproduct.ts:
- id: 951b89a13593
- last_write_checksum: sha1:86b080da2f29c8ce4d67b97fd73d42ddb8516edd
- pristine_git_object: 2cba04535aa6d16a97d0eb943b0a728ec81f37ec
- src/sdk/models/operations/replacecompany.ts:
- id: 15f9deaaf7eb
- last_write_checksum: sha1:dd56621b0a190db2faed25c4f3f8ccc58c20210e
- pristine_git_object: 5ee35551d47caea122b4f502f81b95691cc291ef
- src/sdk/models/operations/setcompanysyncsettings.ts:
- id: fec1b3c2f40f
- last_write_checksum: sha1:477165acccccb36fa266d8bf88853077ef96e5d9
- pristine_git_object: a966402d8450ea46056f5f7fb3f25bc4d3757e4b
- src/sdk/models/operations/unlinkconnection.ts:
- id: 91e6d25ecd14
- last_write_checksum: sha1:a3ad7d24e44b8b56c90ad37a9b79732acb70ce2a
- pristine_git_object: 87a6113ed42d79a4152aa95598e5b61ad8a429d8
- src/sdk/models/operations/updatecompany.ts:
- id: dbafb9e0f8d9
- last_write_checksum: sha1:937aaa5e965aae942c6550456dbe3c37b5d2b280
- pristine_git_object: 37ead4428659b0b2409ad7f6cf54515e544e23ec
- src/sdk/models/operations/updateconnectionauthorization.ts:
- id: 2c4472e5ddb0
- last_write_checksum: sha1:62ad20780544fa53b0863212b08c421b5761d213
- pristine_git_object: b196a24aa3216d9b99b6e21f4de7a7d466c8c08e
- src/sdk/models/operations/updateprofilesyncsettings.ts:
- id: bbf8e3bdae19
- last_write_checksum: sha1:55ebcafe6ac2751263da3482a145ff2654434cd2
- pristine_git_object: 0f33ccee6149c1f8a3002b3cbf0807b552a88662
- src/sdk/models/shared/apikeydetails.ts:
- id: 1c9f50f56745
- last_write_checksum: sha1:b6817bb3eab58d8615394b542ff1a3743084c1af
- pristine_git_object: f72afdc77637ca631937198b426cb43eb2115902
- src/sdk/models/shared/apikeys.ts:
- id: 6fbc438fcaa6
- last_write_checksum: sha1:efd675db5c8e570937419938cf7a0d31b36cfc10
- pristine_git_object: 3985195f86e7522f608633e17021bba54c27a9f4
- src/sdk/models/shared/branding.ts:
- id: f5bd09a43ef3
- last_write_checksum: sha1:c8b0798c68dd1ddfab93282538d46eb5d2d569f8
- pristine_git_object: f38d7663728cca147c4a1313db917cab2701cc60
- src/sdk/models/shared/brandingbutton.ts:
- id: d1209d045d4e
- last_write_checksum: sha1:4df996baab06a5747becc8ebb653c06940ff736c
- pristine_git_object: 1f9a4dfada88aef2b351a9c8bb0ad43b3b60269d
- src/sdk/models/shared/brandingimage.ts:
- id: 99ecd631b992
- last_write_checksum: sha1:5ee6ca5892b005daae02660d83f95a165074aff3
- pristine_git_object: 5ca98b079a0a96001ccfdd7e8a3162ddaeda84ab
- src/sdk/models/shared/brandinglogo.ts:
- id: 1a42433a17a0
- last_write_checksum: sha1:60b9d50fb4ff59f938f794ff55992ec92a40dc10
- pristine_git_object: 1a8fe7ee8b76eb34824148b67e2d799589cd01ad
- src/sdk/models/shared/clientratelimitwebhook.ts:
- id: c691f6d7f890
- last_write_checksum: sha1:873cdc12f8278470e382ae879c4bb2eb17f7f029
- pristine_git_object: cdc40c0b87eb15c3725596b713a38dec90aa9083
- src/sdk/models/shared/clientratelimitwebhookpayload.ts:
- id: d068d62c8d39
- last_write_checksum: sha1:e9a21951c06c14ff5a39fd7379cd1c3bafc314d1
- pristine_git_object: 72605d6242434c3e2be999f0006634d5a193e129
- src/sdk/models/shared/companies.ts:
- id: a4b81f9ba7c8
- last_write_checksum: sha1:81432b885d166aad72ebfcdf5b25eb9c822545b4
- pristine_git_object: 0f308542ebb67c7b1d3262721bbe236d1176ef3c
- src/sdk/models/shared/company.ts:
- id: 8f41ac6a5b4f
- last_write_checksum: sha1:db581f1815189c40f98da9b60de6d329bd07a873
- pristine_git_object: e48fca2fb2e59ab159cb06516f76996ed74f595b
- src/sdk/models/shared/companyaccesstoken.ts:
- id: de9d8c6237e5
- last_write_checksum: sha1:8bbef263606dc3c3a1981ba4f21ffc2d9bb74ae6
- pristine_git_object: 456b2749690603ad7beb11af880bbc444140633c
- src/sdk/models/shared/companydetails.ts:
- id: 9ecf68722fba
- last_write_checksum: sha1:4936e5767c2c315a3f7fec2ef05d2c6341d9d337
- pristine_git_object: bf84c6f436b420bab17f2faa8b5773f191dd499d
- src/sdk/models/shared/companyreference.ts:
- id: f80ee466bdc7
- last_write_checksum: sha1:a13593197e2c55252dac28abfd5493a76a400e5b
- pristine_git_object: e40af5e267211b26d0d3b0296484b7450c485126
- src/sdk/models/shared/companyrequestbody.ts:
- id: 9e2dd8b2247d
- last_write_checksum: sha1:a3027f00426e9affb8b7f8d930db63b89c197607
- pristine_git_object: 5e438635a0842512ed8dd3a9ee464187ed7ff3fe
- src/sdk/models/shared/companysyncsettings.ts:
- id: 9ac302f7af54
- last_write_checksum: sha1:607ed50418c4d3e5a4672b68d58a9dc98e052980
- pristine_git_object: be0e794a8f1ec084c0b0d80c05fee8470869d031
- src/sdk/models/shared/companyupdaterequest.ts:
- id: 9a4400207ec8
- last_write_checksum: sha1:371f7f83676f4130f9885c506c8184c53e202390
- pristine_git_object: 442b7a78cb3fde01477e7bb5cec5626c06a9a58b
- src/sdk/models/shared/companywebhook.ts:
- id: 84c27c4ca6e6
- last_write_checksum: sha1:f7e6934a9c94099f4685cbe340bddba898600baf
- pristine_git_object: 08dcc2eeb592e8c7c8dfd56e30f93d6658be6831
- src/sdk/models/shared/connection.ts:
- id: 18ea99cdadfb
- last_write_checksum: sha1:e4da7791a747d34add6b5844b576e92887f7b2b1
- pristine_git_object: d0a2d40ab34a0cf002030b3262868565d0440ccb
- src/sdk/models/shared/connectionmanagementaccesstoken.ts:
- id: 3523a921aaf9
- last_write_checksum: sha1:4e7936ea1723de05717404632eba593a3e1c2c20
- pristine_git_object: a2ca34fd46a2fce86eaa14b5efc62cf9dbac1815
- src/sdk/models/shared/connectionmanagementallowedorigins.ts:
- id: eac9cbef4f45
- last_write_checksum: sha1:5ada69b5a7d717b75a49776e92a6abf142da7e09
- pristine_git_object: 0d85f18015125b0efcffdb6a270cc2aee26cee23
- src/sdk/models/shared/connections.ts:
- id: 221acd1ae99a
- last_write_checksum: sha1:ef2d949a3163430d3095303bf231c18b7dc93c9c
- pristine_git_object: 1278d54c36183c06f6113dd14c25f115be7a6465
- src/sdk/models/shared/connectionwebhook.ts:
- id: fea4929e3c54
- last_write_checksum: sha1:40e294cc6743aeabcb6faddc1fa2a8f93ba31b0b
- pristine_git_object: e44a554396cd23fbfcec0f3f54235b7a55e0a864
- src/sdk/models/shared/connectionwebhookpayload.ts:
- id: eb3ffbfb1804
- last_write_checksum: sha1:46e08960b22539759c63d2803d9a4ff55ad7d0ee
- pristine_git_object: 58b5ad4a22c28a833661ddab016b3436987ce5ef
- src/sdk/models/shared/createapikey.ts:
- id: 34ab87e02e3a
- last_write_checksum: sha1:e71549b28f56f6fef30af12bd405a101a50fb183
- pristine_git_object: fa84f952d870af990e95430c1ebb2d03072178f4
- src/sdk/models/shared/customdatatypeconfiguration.ts:
- id: 4af247b2aa20
- last_write_checksum: sha1:eb832cd98711ad452f836612c2dc64466e28f390
- pristine_git_object: 543e120d38c0fef12b7c9b9da5043b1f6fec7c76
- src/sdk/models/shared/customdatatyperecord.ts:
- id: 3688d59e2c49
- last_write_checksum: sha1:8295b26ad42162b821cab3efe8f7e626bb9958c3
- pristine_git_object: 4fa035c5b14e0e323e33208cc68565e068c0cf93
- src/sdk/models/shared/customdatatyperecords.ts:
- id: 11de9714cbd1
- last_write_checksum: sha1:ac62d71305180eca4b1e5e3b4cd32fc88739be40
- pristine_git_object: df5741d181d8e817ede8f6252576042c83626902
- src/sdk/models/shared/dataconnectionerror.ts:
- id: c94cddffcec9
- last_write_checksum: sha1:3b20f4e77cd912194221f095626d86c19330de38
- pristine_git_object: 90c1570e915435a100436d5686ba256cfab51f25
- src/sdk/models/shared/dataconnectionstatus.ts:
- id: 506ff77d012f
- last_write_checksum: sha1:6ab2241aa8830aafaeb937d48e97918a68b9dac7
- pristine_git_object: 88889c800a39f393c9445929bbd2150fc6daf7ca
- src/sdk/models/shared/datastatus.ts:
- id: 4f56e78a99e5
- last_write_checksum: sha1:eba6dba549c86bfcde0d6bcc81c5d74a1d19fd00
- pristine_git_object: 431478c2d5b04d59350c804a78382def3f19baed
- src/sdk/models/shared/datastatuses.ts:
- id: 0e054f9e6cf2
- last_write_checksum: sha1:2a79cadad0bb195ebca8b628e03aaa5ddeacadf1
- pristine_git_object: 784b3c07a6199c1f437237991300636b87ee9641
- src/sdk/models/shared/datatype.ts:
- id: 24637063ef68
- last_write_checksum: sha1:4172c0dbe0be3092c548bc34244872155b984eba
- pristine_git_object: 172647cea15cb7603d50fc8384eaab83f9848d77
- src/sdk/models/shared/datatypefeature.ts:
- id: 8cb05182908f
- last_write_checksum: sha1:4c414a6c4e2cc0d3fe24d9ee74bf71ff0ae07dbc
- pristine_git_object: 34f56f1d68cfdc28adc30cef7b5e1339e49ce743
- src/sdk/models/shared/datatypereadsummary.ts:
- id: 7c5a43ff74bb
- last_write_checksum: sha1:8293d150875c1575208a3480bc37ced9406a9dc5
- pristine_git_object: d7e90ce7fbc7c5421e24123790064d234a9e115d
- src/sdk/models/shared/datatypewritewebhook.ts:
- id: f0b58d6a5be4
- last_write_checksum: sha1:ccc8b7535f7e25acf389e631ac8bab0e27d5bdf8
- pristine_git_object: e7bb1bc436bb0c5263051c02796b85cf6531fbf9
- src/sdk/models/shared/datatypewritewebhookpayload.ts:
- id: d5730ae40ec2
- last_write_checksum: sha1:6e3154745247baedd7b35f9bf0d28a52665831c3
- pristine_git_object: 401fdaa3d7f0b9cdbfe88ded0b66d13400a05761
- src/sdk/models/shared/datatypewritewebhookrecord.ts:
- id: 678a2d36de3d
- last_write_checksum: sha1:2d408bc148c0ea510543f586edd97792e21a00ae
- pristine_git_object: 9170a229da9ad7ead869f5c5a6ce7a9b89d8b5b6
- src/sdk/models/shared/errormessage.ts:
- id: a9e0750a72b9
- last_write_checksum: sha1:c0eb6aab7917336041906e6033a843e7975eae00
- pristine_git_object: f052946a0ef9ad1c67e6b363cb733af1349dd327
- src/sdk/models/shared/errorvalidation.ts:
- id: 7595eed057da
- last_write_checksum: sha1:b7f44c1f99c9de84a9177a6fba2f76704a894a48
- pristine_git_object: dc97b86b1b0a47cc49cc6ce168bbf2dc7362a7d4
- src/sdk/models/shared/errorvalidationitem.ts:
- id: 0fbe584c7194
- last_write_checksum: sha1:ea42d03e55f11719c38dc24ffdd5d982be3b1ce3
- pristine_git_object: cd21ec230bfad899a805264c87467c3a1762e9bc
- src/sdk/models/shared/featurestate.ts:
- id: 1865c1ee6a9f
- last_write_checksum: sha1:02c87c4936c9d5de026922ed94dea15fb4f5a5f6
- pristine_git_object: 66d26abb5f63dc311d178851c8fc428e431f4803
- src/sdk/models/shared/featuretype.ts:
- id: 70889c99b55a
- last_write_checksum: sha1:2be23866daee46b07515f504393822adf0e92be9
- pristine_git_object: 18b7077bfde6a2127da1f026f329132d8eb46408
- src/sdk/models/shared/halref.ts:
- id: 1c4609be4603
- last_write_checksum: sha1:b64b146493fe3613970c549edffd33e58402662a
- pristine_git_object: 921d594fb96fe80f20787e9118d3def4a9e2d53c
- src/sdk/models/shared/imagereference.ts:
- id: 2d106eaf17d6
- last_write_checksum: sha1:686cc920964e25f58608aad1c97bdd5fb5b8e824
- pristine_git_object: e850fa584610a3ba9ca28b02fff560379872e118
- src/sdk/models/shared/index.ts:
- id: e97e906e3c14
- last_write_checksum: sha1:9a38f102ced52fa6fdc2e870fdbeda00acc56302
- pristine_git_object: e36e825f73a93581803b1f8c7905d3b5f3ea8e26
- src/sdk/models/shared/integration.ts:
- id: 7dddee0366e4
- last_write_checksum: sha1:5eb645e9bab9d5a567a52b9ef227570a1b119f77
- pristine_git_object: 0642629ea3c5734b7af80f6acb33f9a7741f88f2
- src/sdk/models/shared/integrations.ts:
- id: 0118f3d420a6
- last_write_checksum: sha1:89f927eccdaf516b5bea0df9c01b08fd27cafcb0
- pristine_git_object: 133f44898c691be5c36629cf925a7cc39d0b38e2
- src/sdk/models/shared/issue.ts:
- id: 03d66f3fd292
- last_write_checksum: sha1:37871dde943c8056008039dcbebcb75e60a6c01a
- pristine_git_object: 802f59bd6209b0bb1e270518f5fb00b2ab5d3527
- src/sdk/models/shared/links.ts:
- id: 5c9b3efadf74
- last_write_checksum: sha1:453659d4b39a592c99b3b459eb9f44055f4c4195
- pristine_git_object: 751d7d00e4248ebfd0d28dadcc799607e058635b
- src/sdk/models/shared/profile.ts:
- id: bf70848a6e46
- last_write_checksum: sha1:e8b4c02bd082f30e00eee26efeeb7f9f0e7a3dc3
- pristine_git_object: 661ad01673948df7b7290fa6e99f3ec0cc950625
- src/sdk/models/shared/pulloperation.ts:
- id: 1c7a111bf82e
- last_write_checksum: sha1:e82d9cd137c0d78465d050b4d8b1a368b31eb6e2
- pristine_git_object: 39375036856ebf027357ff9e00321f4a91f2f806
- src/sdk/models/shared/pulloperations.ts:
- id: b51faf4dfd99
- last_write_checksum: sha1:869f7219c72b210af77791cdf5d866c6e39788a8
- pristine_git_object: 475158a0012b764dc1b95440b859651810d0bc07
- src/sdk/models/shared/pushchangetype.ts:
- id: cf67386a1d21
- last_write_checksum: sha1:455bd6b2ebf2a0aeee8a914030cc903e9fb12b47
- pristine_git_object: 42040ea23eda83d8cb202d9f3239f5a7c62f4bd2
- src/sdk/models/shared/pushfieldvalidation.ts:
- id: 8d8e835e5634
- last_write_checksum: sha1:c377b5bd6ef9fd9ab4e480b3e7e9e2a974a741a8
- pristine_git_object: 15fc3a0f565d8c493fb5461a56309ecadbdd69b2
- src/sdk/models/shared/pushoperation.ts:
- id: b6592db339e9
- last_write_checksum: sha1:96d6c00dc8a56e64e4430b54f79446ef89a0601c
- pristine_git_object: 470b4a2d4afd9205740a70286893f98e91e9637f
- src/sdk/models/shared/pushoperationchange.ts:
- id: 137f5337781d
- last_write_checksum: sha1:c4fcd4f27955e10750e151667bb4ed7b1ecf29f9
- pristine_git_object: 5d771700a367ef509098146f474f10136fe3a577
- src/sdk/models/shared/pushoperationref.ts:
- id: 61a311ce2153
- last_write_checksum: sha1:5a308570d299cf4068a5413fcb49296460fd5c79
- pristine_git_object: 9f851e4bac3b7c6a5cda84532fe579e5145896a9
- src/sdk/models/shared/pushoperations.ts:
- id: b0489702427e
- last_write_checksum: sha1:df0ddbf54bebf12f184c59ce0b7f9cdf5df010c9
- pristine_git_object: 35c08c7262eaf602936441cf831b2d63aafe9faf
- src/sdk/models/shared/pushoperationstatus.ts:
- id: 4d9d57d9f800
- last_write_checksum: sha1:7de289ab7d0d5365eae9fe17aed4caddaed26622
- pristine_git_object: 133e3b65f122ffae8912b5ca2a3e91c190c97ddf
- src/sdk/models/shared/pushoption.ts:
- id: 7b36845bb057
- last_write_checksum: sha1:e6da3557367628a63dd0789986bda82a2ac1c8a9
- pristine_git_object: af6a0a0a363f287ee7bc1e6a19bd87942579dfa7
- src/sdk/models/shared/pushoptionchoice.ts:
- id: 4f9141171f1d
- last_write_checksum: sha1:a254424966daf3d5185d1b272d0f2214424dce0f
- pristine_git_object: 315b39f913390a0e7a4785a7d1c7f21693c7ca9d
- src/sdk/models/shared/pushoptionproperty.ts:
- id: 27745de0e67f
- last_write_checksum: sha1:dd3f7838ac5ff9f5edc531b7bddc809dac397111
- pristine_git_object: 0100bc7b68eb80d19a298dc7276202c9faf85575
- src/sdk/models/shared/pushoptiontype.ts:
- id: 4f2314173517
- last_write_checksum: sha1:795906b3ad06204f1dcc551385d5bb849607f61a
- pristine_git_object: 298c02e2ea74d44d765eebcb7cc7b1054226aed7
- src/sdk/models/shared/pushvalidationinfo.ts:
- id: c3bac2e0d020
- last_write_checksum: sha1:233611708647ac824c46a354d05fc0f3b87cdbe3
- pristine_git_object: 3479adce121324a58a8bb938a974762be7f3cae0
- src/sdk/models/shared/readcompletedwebhook.ts:
- id: bb5dae662057
- last_write_checksum: sha1:b420f45f8193aaab305f86a623b9f206229fe1ea
- pristine_git_object: 027874fb9a13ab5afe1544d6d0e6ca8972094862
- src/sdk/models/shared/readcompletedwebhookpayload.ts:
- id: c65ec8710324
- last_write_checksum: sha1:daa57d2f1566c4312fa587ae06840f60b4ead41e
- pristine_git_object: 59408a5414dd84e59f06e0b9a36b4d85ea8f811b
- src/sdk/models/shared/schemadatatype.ts:
- id: 2847a75ea971
- last_write_checksum: sha1:0be7e582186ba9ceafb92d67a5b15fe07bf32328
- pristine_git_object: 159529f4629668ece0eaf287f0b97f8b1dff365b
- src/sdk/models/shared/security.ts:
- id: 4a9790ed1c2f
- last_write_checksum: sha1:1b51b365245ab2a0f5f5a06b90093bceb61fc084
- pristine_git_object: 675eaa5827f48cff71e28d1627f8d65a74e10623
- src/sdk/models/shared/sourcetype.ts:
- id: 522d862efe5c
- last_write_checksum: sha1:56c5b8a222327b6776331951eafb7ead0f1d8ec1
- pristine_git_object: 4ff7925e44d6013880a8211f7f02ab75ba80082e
- src/sdk/models/shared/status.ts:
- id: 1ab31ee187e8
- last_write_checksum: sha1:34533ee05804f1ffb0ff75d67eb7555498b9b5e5
- pristine_git_object: 17744c5740abf3e47c2e43c806c75374563baa46
- src/sdk/models/shared/supplementaldataconfiguration.ts:
- id: 1f33c24128a4
- last_write_checksum: sha1:1b052f3127437bb1f71d258505ff06229512b101
- pristine_git_object: 6fd3b46d07832b274a50cd5e8b7a7d1964ddf457
- src/sdk/models/shared/supportedfeature.ts:
- id: ec149f73a775
- last_write_checksum: sha1:3d7dd27f3de05c616ae28a12fb97873cd27fa047
- pristine_git_object: ea7140848ebb90edc68d97f8bec078aadf7cd741
- src/sdk/models/shared/syncsetting.ts:
- id: 9a20c15a8263
- last_write_checksum: sha1:80576250d71375083359e5a895ec9834390bbe58
- pristine_git_object: 614d3c459e82627df26c759b31be651419209088
- src/sdk/models/shared/syncsettings.ts:
- id: 5e5c7634139e
- last_write_checksum: sha1:0e80c7e4840fc5eeeb940a65d2e5e8fcff77f275
- pristine_git_object: f7c1a35d25beac00185da988520783b5ad1a0f2b
- src/sdk/models/shared/updateconnectionstatus.ts:
- id: d8f8e9089cae
- last_write_checksum: sha1:036e90813d47b95106afe75b518d258336bd7087
- pristine_git_object: e66d22eb4e5b8deba2ffcbd7f94b41f071618872
- src/sdk/models/shared/validation.ts:
- id: e4418d9ed08e
- last_write_checksum: sha1:af7e0ddf2db647404ee4178091fce0330db1e853
- pristine_git_object: 809d8b74ca10dbc58d07e62222e46ec0de5724d2
- src/sdk/models/shared/validationitem.ts:
- id: 0e34cb6ff62f
- last_write_checksum: sha1:fffb5da843c14ff12da16393c3e8752127fa7b92
- pristine_git_object: 09e03fea67a5feeec58ce6198d6d210da05b42b2
- src/sdk/models/shared/validationitem1.ts:
- id: 81e1759a553f
- last_write_checksum: sha1:689622b34e80b0edd1b7c6dfb6bb6112e4cc7b71
- pristine_git_object: f500a416484034db44e71caeb1da77e869dbea29
- src/sdk/models/shared/validationresult.ts:
- id: c36cee082674
- last_write_checksum: sha1:325ef4b2bc2a305253966b408e4f070e58eaf61e
- pristine_git_object: 87fbfde5b3772e40bc4d2d5af7403c05bd58ba51
- src/sdk/models/shared/webhookconsumer.ts:
- id: a52de18c25f9
- last_write_checksum: sha1:63c94053bb925bae32bcc8570831a20a0aa1fbe9
- pristine_git_object: 518c26d46ee1b06e7dad736215a84af24c31dcf7
- src/sdk/models/shared/webhookconsumerprototype.ts:
- id: bc32d77e4ba9
- last_write_checksum: sha1:62370518beb14b1a868c5af4c6f7ef6d6fd5f161
- pristine_git_object: 3eab8c6dc58437e7336d60021c28d54435f3c20d
- src/sdk/models/shared/webhookconsumers.ts:
- id: 617bc356300e
- last_write_checksum: sha1:e07cf3b12edbf54511dafa22e1e11d7028edcd4a
- pristine_git_object: 33ccbcc26fc577a26b8919fbffc1cecaf6af61cd
- src/sdk/models/shared/writestatus.ts:
- id: e7d1d168ef5b
- last_write_checksum: sha1:656e34d522241a9d4339c464c51dfd1ee1cf0454
- pristine_git_object: cc22560ab21e0a498f4e1f57ca5bae1910b8cb12
- src/sdk/models/shared/writetype.ts:
- id: aa93730d7cbc
- last_write_checksum: sha1:14e7d3d9b52b92ff5db9ff59d9ec388a74783474
- pristine_git_object: 3a434bc59292adea4d7f3df2d38e61bc9cc954ae
- src/sdk/pushdata.ts:
- id: f6018aed8810
- last_write_checksum: sha1:841972fe8e555c6eb913442370a7508bed4c1f78
- pristine_git_object: 834136f0f69b6c3ff664981c4c7e0afabbdaa2ab
- src/sdk/readdata.ts:
- id: 51b3defb9287
- last_write_checksum: sha1:6b22721985a327ed41ef9c47edd3f677d39b53b6
- pristine_git_object: 40b4bdc567445808396f469ecb208af61398b4fe
- src/sdk/refreshdata.ts:
- id: 452a807bda18
- last_write_checksum: sha1:59326c5f2340787da7508b0de54fd411cb5cc8fa
- pristine_git_object: a660ec4b29c1e3cc13c5c891bd3513ed152127a2
- src/sdk/sdk.ts:
- id: 784571af2f69
- last_write_checksum: sha1:8d02e5b8c1257ec6fc64df49d45321552d047f0f
- pristine_git_object: a10fea4aafefdc12e94c33a9c3f05f2a5b8a3e65
- src/sdk/settings.ts:
- id: b7e993b8acd3
- last_write_checksum: sha1:3ee45176da127a85c6d49fcf0710d58a67bc48ae
- pristine_git_object: 0619d443305d0a7f7318c1ba55d9df03ef04cc47
- src/sdk/supplementaldata.ts:
- id: 3a3a0a282011
- last_write_checksum: sha1:96c90a9ef93929ab7b547ed6fb30a8e23071446b
- pristine_git_object: 71664963ae2c2be2cb7bdf9a69182b6586dd2af3
- src/sdk/types/async.ts:
- id: 966026768b05
- last_write_checksum: sha1:3ff07b3feaf390ec1aeb18ff938e139c6c4a9585
- pristine_git_object: 689dba5de50e8769e5f3bb913e3f42a146d15bc1
- src/sdk/types/blobs.ts:
- id: 1def31341768
- last_write_checksum: sha1:cf45d78916671cb6345a11c97c633c64402bc27c
- pristine_git_object: cce2892d4f573a120ef3907db90ab15f5979cfda
- src/sdk/types/constdatetime.ts:
- id: 7e64cb450e63
- last_write_checksum: sha1:dfaaf9adfaf49808bd4c9dea0039f21b7088d9c0
- pristine_git_object: fe62144eaf6a2054fc8ca9a98466e70f41b5434d
- src/sdk/types/enums.ts:
- id: 2ac17fb928cd
- last_write_checksum: sha1:ee590453d2c87e33e89c633d37ee46907eca0e58
- pristine_git_object: aba0ffd2a3308a31e516d83b52823d80aa65a8f9
- src/sdk/types/fp.ts:
- id: d9ec77b9460c
- last_write_checksum: sha1:d24994d58f37a1ca106847fcc6d2e976c6f1c093
- pristine_git_object: ccbe51eac69dfb0da5131f14fd753c4b47c1d527
- src/sdk/types/index.ts:
- id: 8c869d66c5f3
- last_write_checksum: sha1:25820e050c332015aaff5b5de2bbec51c3edd3ad
- pristine_git_object: 8249564b4af12e95d783f3ad39f37f88346b6d09
- src/sdk/types/operations.ts:
- id: c5e9c75d4266
- last_write_checksum: sha1:c49e724cfb1259296381cb57bc0fcdd2eae45865
- pristine_git_object: beb81e10f0b9eee2ed398a853fe6f737b743f818
- src/sdk/types/rfcdate.ts:
- id: fc969c92a7c1
- last_write_checksum: sha1:8e5f382e02fe21c2f2e24deb1b7bbf8cddd3dd16
- pristine_git_object: c79b3f53a3dd922aa2ace5a4191c8652cf9a8e89
- src/sdk/types/streams.ts:
- id: e556b428e8dc
- last_write_checksum: sha1:cc9ced2dd34a76c3a1bd7784ccda1cc3b37ab9a9
- pristine_git_object: a0163e7a99cea88f21d0ad4ce3af1c720180ee20
- src/sdk/types/unrecognized.ts:
- id: 690d294a1973
- last_write_checksum: sha1:d33ac686528492f4cdc0dbf81ed343b4afe020fe
- pristine_git_object: b7a2a13f3dff50663429df24ae2f55b647ff1084
- src/sdk/types/webhooks.ts:
- id: 0f676e5e22a7
- last_write_checksum: sha1:dbce0cb417bcdcfcae0827fa045ee93ccab1c2c8
- pristine_git_object: 9510d20c09d8dd689f6e37254030de22e997f3cc
- src/sdk/webhooks.ts:
- id: e879e17d0532
- last_write_checksum: sha1:fde07174ca3b2c7b824da03e507e349ba6eb6034
- pristine_git_object: ec04917d0f776693597eea91bff10baf229e7b48
- tsconfig.json:
- id: 61ebb9fd6e8c
- last_write_checksum: sha1:79dc1550d921fefec69f8632ed3b24dad41ca2f6
- pristine_git_object: 76110f883cac40bb04fb2f376cd69ea8c8d6d215
-examples:
- company.created:
- Company created:
- requestBody:
- application/json: {"id": "ba29118f-5406-4e59-b05c-ba307ca38d01", "eventType": "company.created", "generatedDate": "2024-08-08T17:10:34.015Z", "payload": {"id": "0498e921-9b53-4396-a412-4f2f5983b0a2", "name": "Bank of Dave", "description": "Requested a loan for refurb.", "redirect": "https://link.codat.io/company/0498e921-9b53-4396-a412-4f2f5983b0a2", "lastSync": "2022-01-01T12:00:00.000Z", "created": "2022-01-01T12:00:00.000Z", "tags": {"customerRegion": "us", "uid": "335a086e-8563-4b03-94e3-39544225ecb6"}}}
- company.deleted:
- Company deleted:
- requestBody:
- application/json: {"id": "ba29118f-5406-4e59-b05c-ba307ca38d01", "eventType": "company.deleted", "generatedDate": "2024-08-08T17:10:34.015Z", "payload": {"id": "0498e921-9b53-4396-a412-4f2f5983b0a2", "name": "Bank of Dave", "description": "Requested a loan for refurb.", "redirect": "https://link.codat.io/company/0498e921-9b53-4396-a412-4f2f5983b0a2", "lastSync": "2022-01-01T12:00:00.000Z", "created": "2022-01-01T12:00:00.000Z", "tags": {"customerRegion": "uk", "uid": "f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c"}}}
- connection.created:
- Connection created:
- requestBody:
- application/json: {"id": "ba29118f-5406-4e59-b05c-ba307ca38d01", "eventType": "connection.created", "generatedDate": "2024-08-08T17:10:34.015Z", "payload": {"referenceCompany": {"id": "0498e921-9b53-4396-a412-4f2f5983b0a2", "name": "Bank of Dave", "description": "internal_id_mxO7rLfo", "links": {"portal": "https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/summary"}, "tags": {"customerRegion": "us", "uid": "335a086e-8563-4b03-94e3-39544225ecb6"}}, "connection": {"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "sourceType": "Banking", "platformName": "Basiq", "linkUrl": "https://link-api.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start", "status": "PendingAuth", "lastSync": "2022-10-27T10:22:43.646Z", "created": "2022-10-27T09:53:29Z"}}}
- connection.connected:
- Connection connected:
- requestBody:
- application/json: {"id": "ba29118f-5406-4e59-b05c-ba307ca38d01", "eventType": "connection.connected", "generatedDate": "2024-08-08T17:10:34.015Z", "payload": {"referenceCompany": {"id": "0498e921-9b53-4396-a412-4f2f5983b0a2", "name": "Bank of Dave", "description": "internal_id_mxO7rLfo", "links": {"portal": "https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/summary"}, "tags": {"customerRegion": "us", "uid": "335a086e-8563-4b03-94e3-39544225ecb6"}}, "connection": {"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "sourceType": "Banking", "platformName": "Basiq", "linkUrl": "https://link-api.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start", "status": "Linked", "lastSync": "2022-10-27T10:22:43.646Z", "created": "2022-10-27T09:53:29Z"}}}
- connection.failed:
- Connection failed:
- requestBody:
- application/json: {"id": "ba29118f-5406-4e59-b05c-ba307ca38d01", "eventType": "connection.failed", "generatedDate": "2024-08-08T17:10:34.015Z", "payload": {"referenceCompany": {"id": "0498e921-9b53-4396-a412-4f2f5983b0a2", "name": "Bank of Dave", "description": "internal_id_mxO7rLfo", "links": {"portal": "https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/summary"}, "tags": {"customerRegion": "us", "uid": "335a086e-8563-4b03-94e3-39544225ecb6"}}, "connection": {"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "sourceType": "Banking", "platformName": "Basiq", "linkUrl": "https://link-api.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start", "status": "PendingAuth", "created": "2022-10-27T09:53:29Z", "dataConnectionErrors": [{"statusCode": "403", "statusText": "User cancelled linking", "errorMessage": "User cancelled", "erroredOnUtc": "2022-10-27T09:53:29Z", "status": "Active"}]}}}
- connection.disconnected:
- Unlinked:
- requestBody:
- application/json: {"id": "ba29118f-5406-4e59-b05c-ba307ca38d01", "eventType": "connection.disconnected", "generatedDate": "2024-08-08T17:10:34.015Z", "payload": {"referenceCompany": {"id": "0498e921-9b53-4396-a412-4f2f5983b0a2", "name": "Bank of Dave", "description": "internal_id_mxO7rLfo", "links": {"portal": "https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/summary"}, "tags": {"customerRegion": "us", "uid": "335a086e-8563-4b03-94e3-39544225ecb6"}}, "connection": {"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "sourceType": "Banking", "platformName": "Basiq", "linkUrl": "https://link-api.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start", "status": "Unlinked", "lastSync": "2022-10-27T10:22:43.646Z", "created": "2022-10-27T09:53:29Z"}}}
- De-authorized:
- requestBody:
- application/json: {"id": "ba29118f-5406-4e59-b05c-ba307ca38d01", "eventType": "connection.disconnected", "generatedDate": "2024-08-08T17:10:34.015Z", "payload": {"referenceCompany": {"id": "0498e921-9b53-4396-a412-4f2f5983b0a2", "name": "Bank of Dave", "description": "internal_id_mxO7rLfo", "links": {"portal": "https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/summary"}, "tags": {"customerRegion": "us", "uid": "335a086e-8563-4b03-94e3-39544225ecb6"}}, "connection": {"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "sourceType": "Banking", "platformName": "Basiq", "linkUrl": "https://link-api.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start", "status": "Deauthorized", "lastSync": "2022-10-27T10:22:43.646Z", "created": "2022-10-27T09:53:29Z", "dataConnectionErrors": [{"statusCode": "401", "statusText": "The integration de-authorized access to the connection.", "errorMessage": "The integration de-authorized access to the connection.", "erroredOnUtc": "2022-12-27T09:53:29Z", "status": "Active"}]}}}
- connection.reconnected:
- Reconnected:
- requestBody:
- application/json: {"id": "ba29118f-5406-4e59-b05c-ba307ca38d01", "eventType": "connection.reconnected", "generatedDate": "2024-08-08T17:10:34.015Z", "payload": {"referenceCompany": {"id": "0498e921-9b53-4396-a412-4f2f5983b0a2", "name": "Bank of Dave", "description": "internal_id_mxO7rLfo", "links": {"portal": "https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/summary"}, "tags": {"customerRegion": "us", "uid": "335a086e-8563-4b03-94e3-39544225ecb6"}}, "connection": {"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "sourceType": "Banking", "platformName": "Basiq", "linkUrl": "https://link-api.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start", "status": "Linked", "lastSync": "2022-10-27T10:22:43.646Z", "created": "2022-10-27T09:53:29Z"}}}
- connection.deleted:
- Deleted:
- requestBody:
- application/json: {"id": "ba29118f-5406-4e59-b05c-ba307ca38d01", "eventType": "connection.deleted", "generatedDate": "2024-08-08T17:10:34.015Z", "payload": {"referenceCompany": {"id": "0498e921-9b53-4396-a412-4f2f5983b0a2", "name": "Bank of Dave", "description": "internal_id_mxO7rLfo", "links": {"portal": "https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/summary"}, "tags": {"customerRegion": "us", "uid": "335a086e-8563-4b03-94e3-39544225ecb6"}}, "connection": {"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "sourceType": "Banking", "platformName": "Basiq", "linkUrl": "https://link-api.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start", "status": "Linked", "lastSync": "2022-10-27T10:22:43.646Z", "created": "2022-10-27T09:53:29Z"}}}
- read.completed:
- Read completed:
- requestBody:
- application/json: {"id": "743ec94a-8aa4-44bb-8bd4-e1855ee0e74b", "eventType": "read.completed", "generatedDate": "2022-10-23T00:00:00Z", "payload": {"referenceCompany": {"id": "0498e921-9b53-4396-a412-4f2f5983b0a2", "name": "Toft stores", "description": "Requested early access to the new financing scheme.", "links": {"portal": "https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/summary"}}, "modifiedFromDate": "2022-10-23T00:00:00Z", "dataTypes": [{"connectionId": "2e9d2c44-f675-40ba-8049-353bfcb5e171", "dataType": "invoices", "recordsModified": false, "status": "Complete"}]}}
- read.completed.initial:
- Initial:
- requestBody:
- application/json: {"id": "743ec94a-8aa4-44bb-8bd4-e1855ee0e74b", "eventType": "read.completed.initial", "generatedDate": "2022-10-23T00:00:00Z", "payload": {"referenceCompany": {"id": "0498e921-9b53-4396-a412-4f2f5983b0a2", "name": "Toft stores", "description": "Requested early access to the new financing scheme.", "links": {"portal": "https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/summary"}}, "modifiedFromDate": "2022-10-23T00:00:00Z", "dataTypes": [{"connectionId": "2e9d2c44-f675-40ba-8049-353bfcb5e171", "dataType": "invoices", "recordsModified": false, "status": "Complete"}]}}
- '{dataType}.write.successful':
- Record:
- requestBody:
- application/json: {"id": "bae71d36-ff47-420a-b4a6-f8c9ddf41140", "eventType": "{dataType}.write.successful", "generatedDate": "2023-05-03T10:00:23Z", "payload": {"id": "a9367074-b5c3-42c4-9be4-be129f43577e", "type": "Create", "referenceCompany": {"id": "70af3071-65d9-4ec3-b3cb-5283e8d55dac", "name": "Toft stores", "description": "cust_1MtJUT2eZvKYlo2CNaw2HvEv"}, "connectionId": "12571faf-0898-47e7-afdd-0fe9eb0a9bf5", "requestedOnDate": "2023-05-03T10:00:00Z", "completedOnDate": "2023-05-03T10:00:23Z", "status": "Success", "record": {"id": "bil_1Nispe2eZvKYlo2Cd31jOCgZ"}}}
- Attachment:
- requestBody:
- application/json: {"id": "bae71d36-ff47-420a-b4a6-f8c9ddf41140", "eventType": "{dataType}.write.successful", "generatedDate": "2023-05-03T10:00:23Z", "payload": {"id": "a9367074-b5c3-42c4-9be4-be129f43577e", "type": "UploadAttachment", "referenceCompany": {"id": "70af3071-65d9-4ec3-b3cb-5283e8d55dac", "name": "Toft stores", "description": "cust_1MtJUT2eZvKYlo2CNaw2HvEv"}, "connectionId": "12571faf-0898-47e7-afdd-0fe9eb0a9bf5", "requestedOnDate": "2023-05-03T10:00:00Z", "completedOnDate": "2023-05-03T10:00:23Z", "status": "Success", "record": {"id": "bil_1Nispe2eZvKYlo2Cd31jOCgZ"}, "attachmentId": "att_1AZtxr2eZvKYlo2CJDX8whov"}}
- '{dataType}.write.unsuccessful':
- Record:
- requestBody:
- application/json: {"id": "bae71d36-ff47-420a-b4a6-f8c9ddf41140", "eventType": "{dataType}.write.unsuccessful", "generatedDate": "2023-05-03T10:00:23Z", "payload": {"id": "a9367074-b5c3-42c4-9be4-be129f43577e", "type": "Update", "referenceCompany": {"id": "70af3071-65d9-4ec3-b3cb-5283e8d55dac", "name": "Toft stores", "description": "cust_1MtJUT2eZvKYlo2CNaw2HvEv"}, "connectionId": "12571faf-0898-47e7-afdd-0fe9eb0a9bf5", "requestedOnDate": "2023-05-03T10:00:00Z", "completedOnDate": "2023-05-03T10:00:23Z", "status": "Failed"}}
- Record timed out:
- requestBody:
- application/json: {"id": "bae71d36-ff47-420a-b4a6-f8c9ddf41140", "eventType": "{dataType}.write.unsuccessful", "generatedDate": "2023-05-03T10:00:23Z", "payload": {"id": "a9367074-b5c3-42c4-9be4-be129f43577e", "type": "Delete", "referenceCompany": {"id": "70af3071-65d9-4ec3-b3cb-5283e8d55dac", "name": "Toft stores", "description": "cust_1MtJUT2eZvKYlo2CNaw2HvEv"}, "connectionId": "12571faf-0898-47e7-afdd-0fe9eb0a9bf5", "requestedOnDate": "2023-05-03T10:00:00Z", "completedOnDate": "2023-05-03T10:00:23Z", "status": "TimedOut"}}
- Attachment:
- requestBody:
- application/json: {"id": "bae71d36-ff47-420a-b4a6-f8c9ddf41140", "eventType": "{dataType}.write.unsuccessful", "generatedDate": "2023-05-03T10:00:23Z", "payload": {"id": "a9367074-b5c3-42c4-9be4-be129f43577e", "type": "UploadAttachment", "referenceCompany": {"id": "70af3071-65d9-4ec3-b3cb-5283e8d55dac", "name": "Toft stores", "description": "cust_1MtJUT2eZvKYlo2CNaw2HvEv"}, "connectionId": "12571faf-0898-47e7-afdd-0fe9eb0a9bf5", "requestedOnDate": "2023-05-03T10:00:00Z", "completedOnDate": "2023-05-03T10:00:23Z", "status": "TimedOut", "record": {"id": "bil_1Nispe2eZvKYlo2Cd31jOCgZ"}}}
- client.rateLimit.reached:
- Reached:
- requestBody:
- application/json: {"id": "743ec94a-8aa4-44bb-8bd4-e1855ee0e74b", "eventType": "client.rateLimit.reached", "generatedDate": "2024-09-01T00:00:00Z", "payload": {"dailyQuota": 12000, "quotaRemaining": 0, "expiryDate": "2024-09-01T12:14:14Z"}}
- client.rateLimit.reset:
- Reset:
- requestBody:
- application/json: {"id": "743ec94a-8aa4-44bb-8bd4-e1855ee0e74b", "eventType": "client.rateLimit.reset", "generatedDate": "2024-09-01T00:00:00Z", "payload": {"dailyQuota": 12000, "quotaRemaining": 11993, "expiryDate": "2024-09-01T23:59:99Z"}}
- list-companies:
- "":
- parameters:
- query:
- page: 1
- pageSize: 100
- query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee"
- orderBy: "-modifiedDate"
- tags: "region=uk && team=invoice-finance"
- responses:
- "200":
- application/json: {"pageNumber": 1, "pageSize": 10, "totalResults": 1, "_links": {"self": {"href": "/companies/{id}/data/{dataType}"}, "current": {"href": "/companies/{id}/data/{dataType}?page=1&pageSize=10"}}}
- "400":
- application/json: {}
- "500":
- application/json: {}
- One company:
- parameters:
- query:
- page: 1
- pageSize: 100
- query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee"
- orderBy: "-modifiedDate"
- tags: "region=uk && team=invoice-finance"
- responses:
- "200":
- application/json: {"results": [{"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "My Test Company", "description": "My Test Company make testing software", "redirect": "https://link.codat.io/company/3fa85f64-5717-4562-b3fc-2c963f66afa6", "lastSync": "2022-01-01T12:30:00.000Z", "created": "2022-01-01T11:30:00Z", "createdByUserName": "Mike Smith", "products": ["spend-insights", "lending", "expenses-v1", "commerce"], "referenceSubsidiaryCompanies": [], "dataConnections": [{"id": "51baa045-4836-4317-a42e-3542e991e581", "integrationId": "1c312d69-e638-46d4-ad31-72e6c3ba8390", "integrationKey": "vjms", "sourceId": "396c3158-5dd7-481b-a7c4-a795ca31792b", "sourceType": "Accounting", "platformName": "Pandle", "linkUrl": "https://link-api.codat.io/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/connections/51baa045-4836-4317-a42e-3542e991e581/start", "status": "Linked", "lastSync": "2022-01-01T12:30:00.000Z", "created": "2022-01-01T11:30:00Z"}]}], "pageNumber": 1, "pageSize": 100, "totalResults": 1, "_links": {"self": {"href": "/companies"}, "current": {"href": "/companies?page=1&pageSize=100"}}}
- List of Companies:
- parameters:
- query:
- page: 1
- pageSize: 100
- query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee"
- orderBy: "-modifiedDate"
- tags: "region=uk && team=invoice-finance"
- responses:
- "200":
- application/json: {"results": [{"id": "d1568dde-adf6-11ed-afa1-0242ac120002", "name": "Technicalium", "description": "Technology services, including web and app design and development", "redirect": "https://link.codat.io/company/d1568dde-adf6-11ed-afa1-0242ac120002", "lastSync": "2022-01-01T12:30:00.000Z", "created": "2022-01-01T11:30:00Z", "createdByUserName": "Joe Bloggs", "products": ["spend-insights", "lending", "payables-v2"], "referenceSubsidiaryCompanies": [], "dataConnections": [{"id": "51baa045-4836-4317-a42e-3542e991e581", "integrationId": "1c312d69-e638-46d4-ad31-72e6c3ba8390", "integrationKey": "vjms", "sourceId": "396c3158-5dd7-481b-a7c4-a795ca31792b", "sourceType": "Accounting", "platformName": "Pandle", "linkUrl": "https://link-api.codat.io/companies/d1568dde-adf6-11ed-afa1-0242ac120002/connections/51baa045-4836-4317-a42e-3542e991e581/start", "status": "Linked", "lastSync": "2022-01-01T12:30:00.000Z", "created": "2022-01-01T11:30:00Z"}]}, {"id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "name": "Toft stores", "redirect": "https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0", "created": "2022-11-10T10:45:18Z", "createdByUserName": "Dan Tzabar", "products": ["spend-insights"], "referenceSubsidiaryCompanies": [{"id": "c8d3af58-7011-47ce-b3f2-89faf300ef6d", "name": "Toft stores UK", "links": {"portal": "https://app.codat.io/companies/c8d3af58-7011-47ce-b3f2-89faf300ef6d/summary"}}, {"id": "db94eddc-9212-4568-9b5c-3eab0e325913", "name": "Toft stores US", "links": {"portal": "https://app.codat.io/companies/db94eddc-9212-4568-9b5c-3eab0e325913/summary"}}], "dataConnections": []}, {"id": "c8d3af58-7011-47ce-b3f2-89faf300ef6d", "name": "Toft stores UK", "redirect": "https://link.codat.io/company/c8d3af58-7011-47ce-b3f2-89faf300ef6d", "created": "2022-11-10T10:45:18Z", "createdByUserName": "Dan Tzabar", "products": ["lending", "spend-insights", "payables"], "referenceParentCompany": {"id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "name": "Toft stores", "links": {"portal": "https://app.codat.io/companies/ab12c58d-a678-4ebf-a159-ae99e1807bd0/summary"}}, "referenceSubsidiaryCompanies": [], "dataConnections": [{"id": "d5ab61b7-1ad0-46fd-9f9f-b6761047941e", "integrationId": "cc750323-5a47-4f28-8d8e-30fbbf2ce137", "integrationKey": "akxx", "sourceId": "9815b998-024d-4415-a40b-89903b2cad6f", "sourceType": "Accounting", "platformName": "Oracle NetSuite", "linkUrl": "https://link-api.codat.io/companies/c8d3af58-7011-47ce-b3f2-89faf300ef6d/connections/d5ab61b7-1ad0-46fd-9f9f-b6761047941e/start", "status": "Linked", "lastSync": "2022-01-01T12:30:00.000Z", "created": "2022-01-01T11:30:00Z"}]}, {"id": "db94eddc-9212-4568-9b5c-3eab0e325913", "name": "Toft stores US", "redirect": "https://link.codat.io/company/db94eddc-9212-4568-9b5c-3eab0e325913", "created": "2022-11-10T10:45:18Z", "createdByUserName": "Dan Tzabar", "products": ["spend-insights"], "referenceParentCompany": {"id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "name": "Toft stores", "links": {"portal": "https://app.codat.io/companies/ab12c58d-a678-4ebf-a159-ae99e1807bd0/summary"}}, "referenceSubsidiaryCompanies": [], "dataConnections": [{"id": "1e5c8c9e-27fd-4ba9-9a2a-d02ba65bc2fb", "integrationId": "cc750323-5a47-4f28-8d8e-30fbbf2ce137", "integrationKey": "akxx", "sourceId": "9815b998-024d-4415-a40b-89903b2cad6f", "sourceType": "Accounting", "platformName": "Oracle NetSuite", "linkUrl": "https://link-api.codat.io/companies/db94eddc-9212-4568-9b5c-3eab0e325913/connections/1e5c8c9e-27fd-4ba9-9a2a-d02ba65bc2fb/start", "status": "Linked", "lastSync": "2022-01-01T12:30:00.000Z", "created": "2022-01-01T11:30:00Z"}]}], "pageNumber": 1, "pageSize": 100, "totalResults": 3, "_links": {"self": {"href": "/companies"}, "current": {"href": "/companies?page=1&pageSize=100"}}}
- Malformed query:
- parameters:
- query:
- page: 1
- pageSize: 100
- query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee"
- orderBy: "-modifiedDate"
- tags: "region=uk && team=invoice-finance"
- responses:
- "400":
- application/json: {"statusCode": 400, "service": "ClientsApi", "error": "Error parsing query - Malformed query.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 400, "service": "ClientsApi", "error": "Error parsing query - Malformed query.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- Unresolved property:
- parameters:
- query:
- page: 1
- pageSize: 100
- query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee"
- orderBy: "-modifiedDate"
- tags: "region=uk && team=invoice-finance"
- responses:
- "400":
- application/json: {"statusCode": 400, "service": "PullApi", "error": "Error parsing query - Could not resolve property isCompleted on Dataset", "correlationId": "98457fb9956b7f9b4b2fd4f6e23bb5c8", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 400, "service": "PullApi", "error": "Error parsing query - Could not resolve property isCompleted on Dataset", "correlationId": "98457fb9956b7f9b4b2fd4f6e23bb5c8", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- speakeasy-default-list-companies:
- parameters:
- query:
- page: 1
- pageSize: 100
- query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee"
- orderBy: "-modifiedDate"
- tags: "region=uk && team=invoice-finance"
- responses:
- "200":
- application/json: {"pageNumber": 1, "pageSize": 10, "totalResults": 1, "_links": {"self": {"href": "/companies/{id}/data/{dataType}"}, "current": {"href": "/companies/{id}/data/{dataType}?page=1&pageSize=10"}}}
- "400":
- application/json: {}
- "500":
- application/json: {}
- create-company:
- With no description:
- requestBody:
- application/json: {"name": "Technicalium"}
- responses:
- "200":
- application/json: {"id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "name": "Technicalium", "description": "", "redirect": "https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0", "created": "2022-11-10T10:45:18.1950523Z", "createdByUserName": "Dan Tzabar", "products": ["spend-insights"], "referenceSubsidiaryCompanies": [], "dataConnections": []}
- With a description:
- requestBody:
- application/json: {"name": "Technicalium", "description": "Technology services, including web and app design and development"}
- responses:
- "200":
- application/json: {"id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "name": "Technicalium", "description": "Technology services, including web and app design and development", "redirect": "https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0", "created": "2022-11-10T10:45:18.1950523Z", "createdByUserName": "Dan Tzabar", "products": ["spend-insights"], "referenceSubsidiaryCompanies": [], "dataConnections": []}
- With a tag:
- requestBody:
- application/json: {"name": "Bank of Dave", "description": "Requested early access to the new financing scheme."}
- responses:
- "200":
- application/json: {"id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "name": "Technicalium", "description": "", "redirect": "https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0", "created": "2022-11-10T10:45:18.1950523Z", "createdByUserName": "Dan Tzabar", "products": ["spend-insights"], "tags": {"region": "us"}, "referenceSubsidiaryCompanies": [], "dataConnections": []}
- Malformed query:
- requestBody:
- application/json: {"name": "Bank of Dave", "description": "Requested early access to the new financing scheme."}
- responses:
- "400":
- application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- get-company:
- Simple company:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- responses:
- "200":
- application/json: {"id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "name": "Toft stores holdings", "description": "", "redirect": "https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0", "created": "2022-11-10T10:45:18Z", "createdByUserName": "Dan Tzabar", "products": ["spend-insights", "lending", "expenses-v1", "commerce"], "referenceSubsidiaryCompanies": [], "dataConnections": []}
- Parent multi-entity company:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- responses:
- "200":
- application/json: {"id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "name": "Toft stores", "description": "", "redirect": "https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0", "created": "2022-11-10T10:45:18Z", "createdByUserName": "Dan Tzabar", "products": ["spend-insights", "lending", "expenses-v1", "commerce"], "referenceSubsidiaryCompanies": [{"id": "c8d3af58-7011-47ce-b3f2-89faf300ef6d", "name": "Toft stores UK", "links": {"portal": "https://app.codat.io/companies/c8d3af58-7011-47ce-b3f2-89faf300ef6d/summary"}}, {"id": "db94eddc-9212-4568-9b5c-3eab0e325913", "name": "Toft stores US", "links": {"portal": "https://app.codat.io/companies/db94eddc-9212-4568-9b5c-3eab0e325913/summary"}}], "dataConnections": []}
- Subsidiary multi-entity company:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- responses:
- "200":
- application/json: {"id": "c8d3af58-7011-47ce-b3f2-89faf300ef6d", "name": "Toft stores UK", "description": "", "redirect": "https://link.codat.io/company/c8d3af58-7011-47ce-b3f2-89faf300ef6d", "created": "2022-11-10T10:45:18Z", "createdByUserName": "Dan Tzabar", "products": ["spend-insights", "lending", "expenses-v1", "commerce"], "referenceParentCompany": {"id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "name": "Toft stores", "links": {"portal": "https://app.codat.io/companies/ab12c58d-a678-4ebf-a159-ae99e1807bd0/summary"}}, "referenceSubsidiaryCompanies": [], "dataConnections": [{"id": "d5ab61b7-1ad0-46fd-9f9f-b6761047941e", "integrationId": "cc750323-5a47-4f28-8d8e-30fbbf2ce137", "integrationKey": "akxx", "sourceId": "9815b998-024d-4415-a40b-89903b2cad6f", "sourceType": "Accounting", "platformName": "Oracle NetSuite", "linkUrl": "https://link-api.codat.io/companies/c8d3af58-7011-47ce-b3f2-89faf300ef6d/connections/d5ab61b7-1ad0-46fd-9f9f-b6761047941e/start", "status": "Linked", "lastSync": "2022-01-01T12:30:00.000Z", "created": "2022-01-01T11:30:00Z"}]}
- Unauthorized:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- responses:
- "401":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- delete-company:
- Unauthorized:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- responses:
- "401":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- speakeasy-default-delete-company:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- responses:
- "401":
- application/json: {}
- "500":
- application/json: {}
- replace-company:
- Update name:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- requestBody:
- application/json: {"name": "New Name"}
- responses:
- "200":
- application/json: {"id": "0498e921-9b53-4396-a412-4f2f5983b0a2", "name": "string", "redirect": "https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739", "lastSync": "2022-01-01T12:00:00.000Z", "created": "2022-01-01T12:00:00.000Z", "createdByUserName": "string", "products": ["spend-insights", "lending"], "tags": {"region": "us", "uid": "f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c"}, "dataConnections": [{"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "sourceType": "Banking", "platformName": "Basiq", "linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start", "status": "Linked", "lastSync": "2022-10-27T10:22:43.6464237Z", "created": "2022-10-27T09:53:29Z"}]}
- "401":
- application/json: {}
- "500":
- application/json: {}
- Update description:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- requestBody:
- application/json: {"name": "Same name", "description": "Additional documents required"}
- responses:
- "200":
- application/json: {"id": "0498e921-9b53-4396-a412-4f2f5983b0a2", "name": "string", "redirect": "https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739", "lastSync": "2022-01-01T12:00:00.000Z", "created": "2022-01-01T12:00:00.000Z", "createdByUserName": "string", "products": ["spend-insights", "lending"], "tags": {"region": "us", "uid": "f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c"}, "dataConnections": [{"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "sourceType": "Banking", "platformName": "Basiq", "linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start", "status": "Linked", "lastSync": "2022-10-27T10:22:43.6464237Z", "created": "2022-10-27T09:53:29Z"}]}
- "401":
- application/json: {}
- "500":
- application/json: {}
- Unauthorized:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- requestBody:
- application/json: {"name": "Bank of Dave", "description": "Requested early access to the new financing scheme."}
- responses:
- "401":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- speakeasy-default-replace-company:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- requestBody:
- application/json: {"name": "Bank of Dave", "description": "Requested early access to the new financing scheme."}
- responses:
- "200":
- application/json: {"id": "0498e921-9b53-4396-a412-4f2f5983b0a2", "name": "string", "redirect": "https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739", "lastSync": "2022-01-01T12:00:00.000Z", "created": "2022-01-01T12:00:00.000Z", "createdByUserName": "string", "products": ["spend-insights", "lending"], "tags": {"region": "us", "uid": "f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c"}, "dataConnections": [{"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "sourceType": "Banking", "platformName": "Basiq", "linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start", "status": "Linked", "lastSync": "2022-10-27T10:22:43.6464237Z", "created": "2022-10-27T09:53:29Z"}]}
- "401":
- application/json: {}
- "500":
- application/json: {}
- update-company:
- Update tags:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- requestBody:
- application/json: {"tags": {"refrence": "new reference"}}
- responses:
- "200":
- application/json: {"id": "0498e921-9b53-4396-a412-4f2f5983b0a2", "name": "string", "redirect": "https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739", "lastSync": "2022-01-01T12:00:00.000Z", "created": "2022-01-01T12:00:00.000Z", "createdByUserName": "string", "products": ["spend-insights", "lending"], "tags": {"region": "us", "uid": "f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c"}, "dataConnections": [{"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "sourceType": "Banking", "platformName": "Basiq", "linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start", "status": "Linked", "lastSync": "2022-10-27T10:22:43.6464237Z", "created": "2022-10-27T09:53:29Z"}]}
- "401":
- application/json: {}
- "500":
- application/json: {}
- Update name:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- requestBody:
- application/json: {"name": "New Name"}
- responses:
- "200":
- application/json: {"id": "0498e921-9b53-4396-a412-4f2f5983b0a2", "name": "string", "redirect": "https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739", "lastSync": "2022-01-01T12:00:00.000Z", "created": "2022-01-01T12:00:00.000Z", "createdByUserName": "string", "products": ["spend-insights", "lending"], "tags": {"region": "us", "uid": "f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c"}, "dataConnections": [{"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "sourceType": "Banking", "platformName": "Basiq", "linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start", "status": "Linked", "lastSync": "2022-10-27T10:22:43.6464237Z", "created": "2022-10-27T09:53:29Z"}]}
- "401":
- application/json: {}
- "500":
- application/json: {}
- Unauthorized:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- requestBody:
- application/json: {"name": "Bank of Dave", "description": "Requested early access to the new financing scheme."}
- responses:
- "401":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- speakeasy-default-update-company:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- requestBody:
- application/json: {"name": "Bank of Dave", "description": "Requested early access to the new financing scheme."}
- responses:
- "200":
- application/json: {"id": "0498e921-9b53-4396-a412-4f2f5983b0a2", "name": "string", "redirect": "https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739", "lastSync": "2022-01-01T12:00:00.000Z", "created": "2022-01-01T12:00:00.000Z", "createdByUserName": "string", "products": ["spend-insights", "lending"], "tags": {"region": "us", "uid": "f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c"}, "dataConnections": [{"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "sourceType": "Banking", "platformName": "Basiq", "linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start", "status": "Linked", "lastSync": "2022-10-27T10:22:43.6464237Z", "created": "2022-10-27T09:53:29Z"}]}
- "401":
- application/json: {}
- "500":
- application/json: {}
- add-product:
- Unauthorized:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- productIdentifier: "bank-feeds"
- responses:
- "401":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- speakeasy-default-add-product:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- productIdentifier: "bank-feeds"
- responses:
- "401":
- application/json: {}
- "500":
- application/json: {}
- remove-product:
- Unauthorized:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- productIdentifier: "bank-feeds"
- responses:
- "401":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- speakeasy-default-remove-product:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- productIdentifier: "bank-feeds"
- responses:
- "401":
- application/json: {}
- "500":
- application/json: {}
- refresh-product-data:
- Standard product not supported:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- productIdentifier: "bank-feeds"
- responses:
- "400":
- application/json: {"statusCode": 400, "service": "PublicApi", "error": "Bank Feeds doesn't support data refreshing. For more information, refer to your solution’s documentation [here](https://docs.codat.io).", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 400, "service": "PublicApi", "error": "Bank Feeds doesn't support data refreshing. For more information, refer to your solution’s documentation [here](https://docs.codat.io).", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- Read in progress:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- productIdentifier: "bank-feeds"
- responses:
- "400":
- application/json: {"statusCode": 400, "service": "PublicApi", "error": "Data cannot be refreshed while a read operation is in progress. Allow the read to complete before attempting to refresh.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 400, "service": "PublicApi", "error": "Data cannot be refreshed while a read operation is in progress. Allow the read to complete before attempting to refresh.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- Filter specific data types:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- productIdentifier: "bank-feeds"
- requestBody:
- application/json: {"dataTypes": ["invoices", "payments"]}
- responses:
- "400":
- application/json: {}
- "500":
- application/json: {}
- speakeasy-default-refresh-product-data:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- productIdentifier: "bank-feeds"
- responses:
- "400":
- application/json: {}
- "500":
- application/json: {}
- get-company-access-token:
- Simple company:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- responses:
- "200":
- application/json: {"expiresIn": 86400, "accessToken": "string", "tokenType": "Bearer"}
- Unauthorized:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- responses:
- "401":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- list-connections:
- "":
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- query:
- page: 1
- pageSize: 100
- query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee"
- orderBy: "-modifiedDate"
- responses:
- "200":
- application/json: {"pageNumber": 1, "pageSize": 10, "totalResults": 1, "_links": {"self": {"href": "/companies/{id}/data/{dataType}"}, "current": {"href": "/companies/{id}/data/{dataType}?page=1&pageSize=10"}}}
- "400":
- application/json: {}
- "500":
- application/json: {}
- Connections:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- query:
- page: 1
- pageSize: 100
- query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee"
- orderBy: "-modifiedDate"
- responses:
- "200":
- application/json: {"results": [{"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "sourceType": "Banking", "platformName": "Basiq", "linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start", "status": "Linked", "lastSync": "2022-10-27T10:22:43.6464237Z", "created": "2022-10-27T09:53:29Z"}], "pageNumber": 0, "pageSize": 0, "totalResults": 0, "_links": {"self": {"href": "string"}, "current": {"href": "string"}, "next": {"href": "string"}, "previous": {"href": "string"}}}
- Malformed query:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- query:
- page: 1
- pageSize: 100
- query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee"
- orderBy: "-modifiedDate"
- responses:
- "400":
- application/json: {"statusCode": 400, "service": "ClientsApi", "error": "Error parsing query - Malformed query.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 400, "service": "ClientsApi", "error": "Error parsing query - Malformed query.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- Unresolved property:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- query:
- page: 1
- pageSize: 100
- query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee"
- orderBy: "-modifiedDate"
- responses:
- "400":
- application/json: {"statusCode": 400, "service": "PullApi", "error": "Error parsing query - Could not resolve property isCompleted on Dataset", "correlationId": "98457fb9956b7f9b4b2fd4f6e23bb5c8", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 400, "service": "PullApi", "error": "Error parsing query - Could not resolve property isCompleted on Dataset", "correlationId": "98457fb9956b7f9b4b2fd4f6e23bb5c8", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- speakeasy-default-list-connections:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- query:
- page: 1
- pageSize: 100
- query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee"
- orderBy: "-modifiedDate"
- responses:
- "200":
- application/json: {"pageNumber": 1, "pageSize": 10, "totalResults": 1, "_links": {"self": {"href": "/companies/{id}/data/{dataType}"}, "current": {"href": "/companies/{id}/data/{dataType}?page=1&pageSize=10"}}}
- "400":
- application/json: {}
- "500":
- application/json: {}
- create-connection:
- Connection:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- requestBody:
- application/json: {"platformKey": "gbol"}
- responses:
- "200":
- application/json: {"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "sourceType": "Banking", "platformName": "Basiq", "linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start", "status": "Linked", "lastSync": "2022-10-27T10:22:43.6464237Z", "created": "2022-10-27T09:53:29Z"}
- Unauthorized:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- requestBody:
- application/json: {"platformKey": "gbol"}
- responses:
- "401":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- get-connection:
- Connection:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171"
- responses:
- "200":
- application/json: {"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "sourceType": "Banking", "platformName": "Basiq", "linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start", "status": "Linked", "lastSync": "2022-10-27T10:22:43.6464237Z", "created": "2022-10-27T09:53:29Z"}
- Unauthorized:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171"
- responses:
- "401":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- delete-connection:
- Unauthorized:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171"
- responses:
- "401":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- speakeasy-default-delete-connection:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171"
- responses:
- "401":
- application/json: {}
- "500":
- application/json: {}
- unlink-connection:
- Example:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171"
- requestBody:
- application/json: {"status": "Unlinked"}
- responses:
- "200":
- application/json: {"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "sourceType": "Banking", "platformName": "Basiq", "linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start", "status": "Linked", "lastSync": "2022-10-27T10:22:43.6464237Z", "created": "2022-10-27T09:53:29Z"}
- "401":
- application/json: {}
- "500":
- application/json: {}
- Unauthorized:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171"
- responses:
- "401":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- speakeasy-default-unlink-connection:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171"
- responses:
- "200":
- application/json: {"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "sourceType": "Banking", "platformName": "Basiq", "linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start", "status": "Linked", "lastSync": "2022-10-27T10:22:43.6464237Z", "created": "2022-10-27T09:53:29Z"}
- "401":
- application/json: {}
- "500":
- application/json: {}
- update-connection-authorization:
- Unauthorized:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171"
- responses:
- "401":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- speakeasy-default-update-connection-authorization:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171"
- responses:
- "200":
- application/json: {"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "sourceType": "Banking", "platformName": "Basiq", "linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start", "status": "Linked", "lastSync": "2022-10-27T10:22:43.6464237Z", "created": "2022-10-27T09:53:29Z"}
- "401":
- application/json: {}
- "500":
- application/json: {}
- get-connection-management-access-token:
- Access token:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- responses:
- "200":
- application/json: {"accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"}
- Unauthorized:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- responses:
- "401":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- get-connection-management-cors-settings:
- Allowed origins:
- responses:
- "200":
- application/json: {"allowedOrigins": ["https://www.bank-of-dave.com"]}
- Unauthorized:
- responses:
- "401":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- set-connection-management-cors-settings:
- Allowed origins:
- requestBody:
- application/json: {"allowedOrigins": ["https://www.bank-of-dave.com"]}
- responses:
- "200":
- application/json: {"allowedOrigins": ["https://www.bank-of-dave.com"]}
- Unauthorized:
- requestBody:
- application/json: {"allowedOrigins": ["https://www.bank-of-dave.com"]}
- responses:
- "401":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- get-cors-settings:
- Allowed origins:
- responses:
- "200":
- application/json: {"allowedOrigins": ["https://www.bank-of-dave.com"]}
- Unauthorized:
- responses:
- "401":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- set-cors-settings:
- Allowed origins:
- requestBody:
- application/json: {"allowedOrigins": ["https://www.bank-of-dave.com"]}
- responses:
- "200":
- application/json: {"allowedOrigins": ["https://www.bank-of-dave.com"]}
- Unauthorized:
- requestBody:
- application/json: {"allowedOrigins": ["https://www.bank-of-dave.com"]}
- responses:
- "401":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- get-profile:
- Unauthorized:
- responses:
- "401":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- speakeasy-default-get-profile:
- responses:
- "200":
- application/json: {"name": "Bob's Burgers", "logoUrl": "https://client-images.codat.io/logo/042399f5-d104-4f38-9ce8-cac3524f4e88_5806cb1f-7342-4c0e-a0a8-99bfbc47b0ff.png", "iconUrl": "https://client-images.codat.io/icon/042399f5-d104-4f38-9ce8-cac3524f4e88_3f5623af-d992-4c22-bc08-e58c520a8526.ico", "redirectUrl": "https://bobs-burgers.{countrySuffix}/{companyId}", "whiteListUrls": ["https://bobs-burgers.com", "https://bobs-burgers.co.uk"], "confirmCompanyName": true}
- "401":
- application/json: {}
- "500":
- application/json: {}
- update-profile:
- Unauthorized:
- requestBody:
- application/json: {"name": "Bob's Burgers", "logoUrl": "https://client-images.codat.io/logo/042399f5-d104-4f38-9ce8-cac3524f4e88_5806cb1f-7342-4c0e-a0a8-99bfbc47b0ff.png", "iconUrl": "https://client-images.codat.io/icon/042399f5-d104-4f38-9ce8-cac3524f4e88_3f5623af-d992-4c22-bc08-e58c520a8526.ico", "redirectUrl": "https://bobs-burgers.{countrySuffix}/{companyId}", "whiteListUrls": ["https://bobs-burgers.com", "https://bobs-burgers.co.uk"], "confirmCompanyName": true}
- responses:
- "401":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- speakeasy-default-update-profile:
- requestBody:
- application/json: {"name": "Bob's Burgers", "logoUrl": "https://client-images.codat.io/logo/042399f5-d104-4f38-9ce8-cac3524f4e88_5806cb1f-7342-4c0e-a0a8-99bfbc47b0ff.png", "iconUrl": "https://client-images.codat.io/icon/042399f5-d104-4f38-9ce8-cac3524f4e88_3f5623af-d992-4c22-bc08-e58c520a8526.ico", "redirectUrl": "https://bobs-burgers.{countrySuffix}/{companyId}", "whiteListUrls": ["https://bobs-burgers.com", "https://bobs-burgers.co.uk"], "confirmCompanyName": true}
- responses:
- "200":
- application/json: {"name": "Bob's Burgers", "logoUrl": "https://client-images.codat.io/logo/042399f5-d104-4f38-9ce8-cac3524f4e88_5806cb1f-7342-4c0e-a0a8-99bfbc47b0ff.png", "iconUrl": "https://client-images.codat.io/icon/042399f5-d104-4f38-9ce8-cac3524f4e88_3f5623af-d992-4c22-bc08-e58c520a8526.ico", "redirectUrl": "https://bobs-burgers.{countrySuffix}/{companyId}", "whiteListUrls": ["https://bobs-burgers.com", "https://bobs-burgers.co.uk"], "confirmCompanyName": true}
- "401":
- application/json: {}
- "500":
- application/json: {}
- get-profile-syncSettings:
- Example:
- responses:
- "200":
- application/json: {"clientId": "367f7975-267b-439b-90c6-a6040ee680f3", "settings": [{"dataType": "invoices", "fetchOnFirstLink": true, "syncSchedule": 24, "syncOrder": 0, "syncFromUtc": "2020-01-01T12:00:00.000Z", "syncFromWindow": 24, "monthsToSync": 24, "isLocked": true}], "overridesDefaults": true}
- Unauthorized:
- responses:
- "401":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- update-profile-syncSettings:
- Unauthorized:
- requestBody:
- application/json: {"clientId": "9807ce3e-cfa5-4370-b4f2-09c282b1598b", "settings": [{"dataType": "invoices", "fetchOnFirstLink": true, "syncSchedule": 24, "syncOrder": 0, "syncFromUtc": "2020-01-01T12:00:00.000Z", "syncFromWindow": 24, "monthsToSync": 24, "isLocked": true}], "overridesDefaults": true}
- responses:
- "401":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- speakeasy-default-update-profile-sync-settings:
- requestBody:
- application/json: {"clientId": "9807ce3e-cfa5-4370-b4f2-09c282b1598b", "settings": [{"dataType": "invoices", "fetchOnFirstLink": true, "syncSchedule": 24, "syncOrder": 0, "syncFromUtc": "2020-01-01T12:00:00.000Z", "syncFromWindow": 24, "monthsToSync": 24, "isLocked": true}], "overridesDefaults": true}
- responses:
- "401":
- application/json: {}
- "500":
- application/json: {}
- list-api-keys:
- Example:
- responses:
- "200":
- application/json: {"results": [{"id": "0498e921-9b53-4396-a412-4f2f5983b0a2", "apiKey": "ztHQGvnC4XN2CgUhaDWEG4ySLUJqWjp7zkbZkGHd", "createdDate": "2022-04-11T13:49:37Z"}, {"id": "c438836a-61fe-443f-8a19-24cc18be21e4", "name": "azure-invoice-finance-processor", "apiKey": "ztHQGvnC4XN2CgUhaDWEG4ySLUJqWjp7zkbZkGHd", "createdDate": "2022-04-23T09:43:48Z"}]}
- Unauthorized:
- responses:
- "401":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- create-api-key:
- Create API key with name:
- requestBody:
- application/json: {"name": "azure-invoice-finance-processor"}
- responses:
- "201":
- application/json: {"id": "e288a972-b402-4b21-93f9-b5335ae5679c", "name": "azure-invoice-finance-processor", "apiKey": "ztHQGvnC4XN2CgUhaDWEG4ySLUJqWjp7zkbZkGHd", "createdDate": "2022-10-23T00:00:00Z"}
- "400":
- application/json: {}
- "500":
- application/json: {}
- API key details:
- requestBody:
- application/json: {"name": "azure-invoice-finance-processor"}
- responses:
- "201":
- application/json: {"id": "0498e921-9b53-4396-a412-4f2f5983b0a2", "apiKey": "ztHQGvnC4XN2CgUhaDWEG4ySLUJqWjp7zkbZkGHd", "createdDate": "2022-04-11T13:49:37Z"}
- API key details with name:
- requestBody:
- application/json: {"name": "azure-invoice-finance-processor"}
- responses:
- "201":
- application/json: {"id": "0498e921-9b53-4396-a412-4f2f5983b0a2", "name": "azure-invoice-finance-processor", "apiKey": "ztHQGvnC4XN2CgUhaDWEG4ySLUJqWjp7zkbZkGHd", "createdDate": "2022-04-11T13:49:37Z"}
- Max length for name reached:
- requestBody:
- application/json: {"name": "azure-invoice-finance-processor"}
- responses:
- "400":
- application/json: {"statusCode": 400, "service": "PublicApi", "error": "Max string length (50) for `name` reached.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 400, "service": "PublicApi", "error": "Max string length (50) for `name` reached.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- delete-api-key:
- Conflict:
- parameters:
- path:
- apiKeyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- responses:
- "204":
- application/json: {"statusCode": 429, "service": "PublicApi", "error": "You have made too many requests in a given amount of time; please retry later.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "401":
- application/json: {"statusCode": 429, "service": "PublicApi", "error": "You have made too many requests in a given amount of time; please retry later.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 429, "service": "PublicApi", "error": "You have made too many requests in a given amount of time; please retry later.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- refresh-company-data:
- Malformed query:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- responses:
- "400":
- application/json: {"statusCode": 400, "service": "ClientsApi", "error": "Error parsing query - Malformed query.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 400, "service": "ClientsApi", "error": "Error parsing query - Malformed query.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- Unresolved property:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- responses:
- "400":
- application/json: {"statusCode": 400, "service": "PullApi", "error": "Error parsing query - Could not resolve property isCompleted on Dataset", "correlationId": "98457fb9956b7f9b4b2fd4f6e23bb5c8", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 400, "service": "PullApi", "error": "Error parsing query - Could not resolve property isCompleted on Dataset", "correlationId": "98457fb9956b7f9b4b2fd4f6e23bb5c8", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- speakeasy-default-refresh-company-data:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- responses:
- "400":
- application/json: {}
- "500":
- application/json: {}
- refresh-data-type:
- Malformed query:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- dataType: "invoices"
- responses:
- "400":
- application/json: {"statusCode": 400, "service": "ClientsApi", "error": "Error parsing query - Malformed query.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 400, "service": "ClientsApi", "error": "Error parsing query - Malformed query.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- Unresolved property:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- dataType: "invoices"
- responses:
- "400":
- application/json: {"statusCode": 400, "service": "PullApi", "error": "Error parsing query - Could not resolve property isCompleted on Dataset", "correlationId": "98457fb9956b7f9b4b2fd4f6e23bb5c8", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 400, "service": "PullApi", "error": "Error parsing query - Could not resolve property isCompleted on Dataset", "correlationId": "98457fb9956b7f9b4b2fd4f6e23bb5c8", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- speakeasy-default-refresh-data-type:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- dataType: "invoices"
- responses:
- "200":
- application/json: {"id": "97d60846-f07a-4d42-b5a0-0bdcc6ebf56b", "companyId": "4645bd78-8988-45bc-ac9e-67ba5df6e4e5", "connectionId": "51baa045-4836-4317-a42e-3542e991e581", "dataType": "invoices", "status": "Initial", "statusDescription": "Paused until 2022-10-23T00:00:00.000Z", "requested": "2022-11-14T11:18:37.2798351Z", "progress": 10, "isCompleted": false, "isErrored": false}
- "400":
- application/json: {}
- "500":
- application/json: {}
- get-company-data-status:
- Example:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- responses:
- "200":
- application/json: {"accountTransactions": {"dataType": "accountTransactions", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f"}, "balanceSheet": {"dataType": "balanceSheet", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f"}, "bankAccounts": {"dataType": "bankAccounts", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f"}, "bankTransactions": {"dataType": "bankTransactions", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f"}, "billCreditNotes": {"dataType": "billCreditNotes", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f"}, "billPayments": {"dataType": "billPayments", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f"}, "bills": {"dataType": "bills", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f"}, "cashFlowStatement": {"dataType": "cashFlowStatement", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f"}, "chartOfAccounts": {"dataType": "chartOfAccounts", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f"}, "company": {"dataType": "company", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f"}, "creditNotes": {"dataType": "creditNotes", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f"}, "customers": {"dataType": "customers", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f"}, "directCosts": {"dataType": "directCosts", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f"}, "directIncomes": {"dataType": "directIncomes", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f"}, "invoices": {"dataType": "invoices", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f"}, "itemReceipts": {"dataType": "itemReceipts", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f"}, "items": {"dataType": "items", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f"}, "journalEntries": {"dataType": "journalEntries", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f"}, "journals": {"dataType": "journals", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f"}, "paymentMethods": {"dataType": "paymentMethods", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f"}, "payments": {"dataType": "payments", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f"}, "profitAndLoss": {"dataType": "profitAndLoss", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f"}, "purchaseOrders": {"dataType": "purchaseOrders", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f"}, "salesOrders": {"dataType": "salesOrders", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f"}, "suppliers": {"dataType": "suppliers", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f"}, "taxRates": {"dataType": "taxRates", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f"}, "trackingCategories": {"dataType": "trackingCategories", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f"}, "transfers": {"dataType": "transfers", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f"}, "banking-accountBalances": {"dataType": "banking-accountBalances", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f"}, "banking-accounts": {"dataType": "banking-accounts", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f"}, "banking-transactionCategories": {"dataType": "banking-transactionCategories", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f"}, "banking-transactions": {"dataType": "banking-transactions", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f"}, "commerce-companyInfo": {"dataType": "commerce-companyInfo", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f"}, "commerce-customers": {"dataType": "commerce-customers", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f"}, "commerce-disputes": {"dataType": "commerce-disputes", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f"}, "commerce-locations": {"dataType": "commerce-locations", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f"}, "commerce-orders": {"dataType": "commerce-orders", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f"}, "commerce-paymentMethods": {"dataType": "commerce-paymentMethods", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f"}, "commerce-payments": {"dataType": "commerce-payments", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f"}, "commerce-productCategories": {"dataType": "commerce-productCategories", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f"}, "commerce-products": {"dataType": "commerce-products", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f"}, "commerce-taxComponents": {"dataType": "commerce-taxComponents", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f"}, "commerce-transactions": {"dataType": "commerce-transactions", "lastSuccessfulSync": "2022-01-01T00:00:00.000Z", "currentStatus": "Complete", "latestSyncId": "d03b6979-eb3b-447a-a27a-13cf457a9f48", "latestSuccessfulSyncId": "6883bba8-514d-423f-ba7f-c38285a80b7f"}}
- Unauthorized:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- responses:
- "401":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- list-pull-operations:
- "":
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- query:
- page: 1
- pageSize: 100
- query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee"
- orderBy: "-modifiedDate"
- responses:
- "200":
- application/json: {"pageNumber": 1, "pageSize": 10, "totalResults": 1, "_links": {"self": {"href": "/companies/{id}/data/{dataType}"}, "current": {"href": "/companies/{id}/data/{dataType}?page=1&pageSize=10"}}}
- "400":
- application/json: {}
- "500":
- application/json: {}
- Example:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- query:
- page: 1
- pageSize: 100
- query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee"
- orderBy: "-modifiedDate"
- responses:
- "200":
- application/json: {"results": [{"id": "97d60846-f07a-4d42-b5a0-0bdcc6ebf56b", "companyId": "4645bd78-8988-45bc-ac9e-67ba5df6e4e5", "connectionId": "51baa045-4836-4317-a42e-3542e991e581", "dataType": "invoices", "status": "Initial", "requested": "2022-11-14T11:18:37.2798351Z", "progress": 10, "isCompleted": false, "isErrored": false}], "pageNumber": 0, "pageSize": 0, "totalResults": 0, "_links": {"self": {"href": "/companies/17129e41-5389-4f10-ac06-e0a37e47d177/data/history"}, "current": {"href": "/companies/17129e41-5389-4f10-ac06-e0a37e47d177/data/history?page=1&pageSize=2"}, "next": {"href": "/companies/17129e41-5389-4f10-ac06-e0a37e47d177/data/history?page=2&pageSize=2"}}}
- Malformed query:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- query:
- page: 1
- pageSize: 100
- query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee"
- orderBy: "-modifiedDate"
- responses:
- "400":
- application/json: {"statusCode": 400, "service": "ClientsApi", "error": "Error parsing query - Malformed query.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 400, "service": "ClientsApi", "error": "Error parsing query - Malformed query.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- Unresolved property:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- query:
- page: 1
- pageSize: 100
- query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee"
- orderBy: "-modifiedDate"
- responses:
- "400":
- application/json: {"statusCode": 400, "service": "PullApi", "error": "Error parsing query - Could not resolve property isCompleted on Dataset", "correlationId": "98457fb9956b7f9b4b2fd4f6e23bb5c8", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 400, "service": "PullApi", "error": "Error parsing query - Could not resolve property isCompleted on Dataset", "correlationId": "98457fb9956b7f9b4b2fd4f6e23bb5c8", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- speakeasy-default-list-pull-operations:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- query:
- page: 1
- pageSize: 100
- query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee"
- orderBy: "-modifiedDate"
- responses:
- "200":
- application/json: {"pageNumber": 1, "pageSize": 10, "totalResults": 1, "_links": {"self": {"href": "/companies/{id}/data/{dataType}"}, "current": {"href": "/companies/{id}/data/{dataType}?page=1&pageSize=10"}}}
- "400":
- application/json: {}
- "500":
- application/json: {}
- get-pull-operation:
- Unauthorized:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- datasetId: "fa5f3e86-bd80-49b8-853c-5fbba4b201f5"
- responses:
- "401":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- speakeasy-default-get-pull-operation:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- datasetId: "fa5f3e86-bd80-49b8-853c-5fbba4b201f5"
- responses:
- "200":
- application/json: {"id": "97d60846-f07a-4d42-b5a0-0bdcc6ebf56b", "companyId": "4645bd78-8988-45bc-ac9e-67ba5df6e4e5", "connectionId": "51baa045-4836-4317-a42e-3542e991e581", "dataType": "invoices", "status": "Initial", "statusDescription": "Paused until 2022-10-23T00:00:00.000Z", "requested": "2022-11-14T11:18:37.2798351Z", "progress": 10, "isCompleted": false, "isErrored": false}
- "401":
- application/json: {}
- "500":
- application/json: {}
- list-webhook-consumers:
- Webhook consumers:
- responses:
- "200":
- application/json: {"results": [{"id": "12571faf-0898-47e7-afdd-0fe9eb0a9bf5", "url": "https://example.com/webhoook-consumers/sync-complete", "disabled": false, "eventTypes": ["DataSyncCompleted"]}, {"id": "ca3cac86-7925-4759-abc2-96405780fdfa", "url": "https://example.com/webhoook-consumers/dataset-changed", "disabled": true, "eventTypes": ["DatasetDataChanged"]}]}
- Malformed query:
- responses:
- "400":
- application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- create-webhook-consumer:
- Subscribe consumer to one or more event types:
- requestBody:
- application/json: {"url": "https://example.com/webhoook-consumer", "disabled": false, "eventTypes": ["DataSyncCompleted", "Dataset data changed"]}
- responses:
- "201":
- application/json: {"id": "12571faf-0898-47e7-afdd-0fe9eb0a9bf5", "url": "https://example.com/webhoook-consumer", "disabled": false, "eventTypes": ["DataSyncCompleted", "DatasetDataChanged"]}
- Subscribe consumer with disabled endpoint:
- requestBody:
- application/json: {"url": "https://example.com/webhoook-consumer", "disabled": true, "eventTypes": ["DataSyncCompleted"]}
- responses:
- "201":
- application/json: {"id": "12571faf-0898-47e7-afdd-0fe9eb0a9bf5", "url": "https://example.com/webhoook-consumer", "disabled": true, "eventTypes": ["DataSyncCompleted"]}
- Malformed query:
- responses:
- "400":
- application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- delete-webhook-consumer:
- Unauthorized:
- parameters:
- path:
- webhookId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- responses:
- "401":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- speakeasy-default-delete-webhook-consumer:
- parameters:
- path:
- webhookId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- responses:
- "401":
- application/json: {}
- "500":
- application/json: {}
- list-integrations:
- "":
- parameters:
- query:
- page: 1
- pageSize: 100
- query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee"
- orderBy: "-modifiedDate"
- responses:
- "200":
- application/json: {"pageNumber": 1, "pageSize": 10, "totalResults": 1, "_links": {"self": {"href": "/companies/{id}/data/{dataType}"}, "current": {"href": "/companies/{id}/data/{dataType}?page=1&pageSize=10"}}}
- "400":
- application/json: {}
- "500":
- application/json: {}
- Malformed query:
- parameters:
- query:
- page: 1
- pageSize: 100
- query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee"
- orderBy: "-modifiedDate"
- responses:
- "400":
- application/json: {"statusCode": 400, "service": "ClientsApi", "error": "Error parsing query - Malformed query.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 400, "service": "ClientsApi", "error": "Error parsing query - Malformed query.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- Unresolved property:
- parameters:
- query:
- page: 1
- pageSize: 100
- query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee"
- orderBy: "-modifiedDate"
- responses:
- "400":
- application/json: {"statusCode": 400, "service": "PullApi", "error": "Error parsing query - Could not resolve property isCompleted on Dataset", "correlationId": "98457fb9956b7f9b4b2fd4f6e23bb5c8", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 400, "service": "PullApi", "error": "Error parsing query - Could not resolve property isCompleted on Dataset", "correlationId": "98457fb9956b7f9b4b2fd4f6e23bb5c8", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- speakeasy-default-list-integrations:
- parameters:
- query:
- page: 1
- pageSize: 100
- query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee"
- orderBy: "-modifiedDate"
- responses:
- "200":
- application/json: {"pageNumber": 1, "pageSize": 10, "totalResults": 1, "_links": {"self": {"href": "/companies/{id}/data/{dataType}"}, "current": {"href": "/companies/{id}/data/{dataType}?page=1&pageSize=10"}}}
- "400":
- application/json: {}
- "500":
- application/json: {}
- get-integration:
- Unauthorized:
- parameters:
- path:
- platformKey: "gbol"
- responses:
- "401":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- speakeasy-default-get-integration:
- parameters:
- path:
- platformKey: "gbol"
- responses:
- "200":
- application/json: {"key": "gbol", "logoUrl": "http://example.com", "name": "Xero", "enabled": true, "sourceId": "accounting", "sourceType": "Commerce", "integrationId": "497a18ca-284e-40c0-985d-f72be35d468e", "isOfflineConnector": true, "isBeta": true, "dataProvidedBy": "string", "datatypeFeatures": [{"supportedFeatures": [{"featureType": "UploadAttachment", "featureState": "Deprecated"}]}]}
- "401":
- application/json: {}
- "500":
- application/json: {}
- get-integrations-branding:
- Unauthorized:
- parameters:
- path:
- platformKey: "gbol"
- responses:
- "401":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- speakeasy-default-get-integrations-branding:
- parameters:
- path:
- platformKey: "gbol"
- responses:
- "200":
- application/json: {"logo": {"full": {"image": {"src": "https://static.codat.io/public/officialLogos/Full/8A156A5A-39CB-4F9D-856E-76EF9B9A9607.png", "alt": "xero full icon"}}, "square": {"image": {"src": "https://static.codat.io/public/officialLogos/Square/8A156A5A-39CB-4F9D-856E-76EF9B2W3607.png", "alt": "xero square icon"}}}, "button": {"default": {"image": {"src": "https://static.codat.io/public/officialButtons/Full/8A156A5A-39CB-4F9D-856E-76EF9Q7A9607.png", "alt": "xero default button icon"}}, "hover": {"image": {"src": "https://static.codat.io/public/officialLogos/Full/8A156A5A-39CB-4F9D-856E-76EF9B9A9607.png", "alt": "xero hover button icon"}}}, "sourceId": "35b92968-9851-4095-ad60-395c95cbcba4"}
- "401":
- application/json: {}
- "500":
- application/json: {}
- get-read-validation-results:
- Validation result:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- datasetId: "0812af6e-436a-491f-9056-db91cb961ad3"
- responses:
- "200":
- application/json: {"errors": [{"ruleId": "accounting-bill-030", "itemId": "fc2f2d1a-ff4d-40c6-a7fb-4bd7d04f4008", "message": "A bill's lines summed (69.99) should be the same as TotalAmount (70.00).", "validatorName": "BillValidator"}], "warnings": [{"ruleId": "accounting-bill-032", "itemId": "1d3979e5-7c28-432e-b562-04e9013c1ea0", "message": "A bill's lines sub total amount summed (3201.20) should be the same as SubTotal (3201.25)", "validatorName": "BillValidator"}]}
- Unauthorized:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- datasetId: "8c3ae743-3699-413e-8c9b-56e1b4de25b7"
- responses:
- "401":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- get-create-update-model-options-by-data-type:
- Unauthorized:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171"
- dataType: "invoices"
- responses:
- "401":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- speakeasy-default-get-create-update-model-options-by-data-type:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171"
- dataType: "invoices"
- responses:
- "200":
- application/json: {"type": "Array", "displayName": "Zackary.Gleason", "required": false}
- "401":
- application/json: {}
- "500":
- application/json: {}
- get-company-push-history:
- "":
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- query:
- page: 1
- pageSize: 100
- query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee"
- orderBy: "-modifiedDate"
- responses:
- "200":
- application/json: {"pageNumber": 1, "pageSize": 10, "totalResults": 1, "_links": {"self": {"href": "/companies/{id}/data/{dataType}"}, "current": {"href": "/companies/{id}/data/{dataType}?page=1&pageSize=10"}}}
- "400":
- application/json: {}
- "500":
- application/json: {}
- Malformed query:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- query:
- page: 1
- pageSize: 100
- query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee"
- orderBy: "-modifiedDate"
- responses:
- "400":
- application/json: {"statusCode": 400, "service": "ClientsApi", "error": "Error parsing query - Malformed query.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 400, "service": "ClientsApi", "error": "Error parsing query - Malformed query.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- Unresolved property:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- query:
- page: 1
- pageSize: 100
- query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee"
- orderBy: "-modifiedDate"
- responses:
- "400":
- application/json: {"statusCode": 400, "service": "PullApi", "error": "Error parsing query - Could not resolve property isCompleted on Dataset", "correlationId": "98457fb9956b7f9b4b2fd4f6e23bb5c8", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 400, "service": "PullApi", "error": "Error parsing query - Could not resolve property isCompleted on Dataset", "correlationId": "98457fb9956b7f9b4b2fd4f6e23bb5c8", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- speakeasy-default-get-company-push-history:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- query:
- page: 1
- pageSize: 100
- query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee"
- orderBy: "-modifiedDate"
- responses:
- "200":
- application/json: {"pageNumber": 1, "pageSize": 10, "totalResults": 1, "_links": {"self": {"href": "/companies/{id}/data/{dataType}"}, "current": {"href": "/companies/{id}/data/{dataType}?page=1&pageSize=10"}}}
- "400":
- application/json: {}
- "500":
- application/json: {}
- get-push-operation:
- Unauthorized:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- pushOperationKey: "660e8684-c0fb-4468-9e2a-b2e3b115d747"
- responses:
- "401":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- speakeasy-default-get-push-operation:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- pushOperationKey: "660e8684-c0fb-4468-9e2a-b2e3b115d747"
- responses:
- "200":
- application/json: {"changes": [{"recordRef": {"dataType": "invoices"}}], "dataType": "invoices", "companyId": "8a210b68-6988-11ed-a1eb-0242ac120002", "pushOperationKey": "6946e360-00fe-46e7-a6f8-4a3be88f2b5d", "dataConnectionKey": "2e9d2c44-f675-40ba-8049-353bfcb5e171", "requestedOnUtc": "2022-10-23T00:00:00Z", "completedOnUtc": "2022-10-23T00:00:00Z", "status": "TimedOut", "statusCode": 80736}
- "401":
- application/json: {}
- "500":
- application/json: {}
- configure-supplemental-data:
- Xero - Accounts:
- parameters:
- path:
- platformKey: "gbol"
- dataType: "invoices"
- requestBody:
- application/json: {}
- responses:
- "401":
- application/json: {}
- "500":
- application/json: {}
- Xero - Invoices:
- parameters:
- path:
- platformKey: "gbol"
- dataType: "invoices"
- requestBody:
- application/json: {}
- responses:
- "401":
- application/json: {}
- "500":
- application/json: {}
- Xero - Items:
- parameters:
- path:
- platformKey: "gbol"
- dataType: "invoices"
- requestBody:
- application/json: {}
- responses:
- "401":
- application/json: {}
- "500":
- application/json: {}
- Xero - Contacts:
- parameters:
- path:
- platformKey: "gbol"
- dataType: "invoices"
- requestBody:
- application/json: {}
- responses:
- "401":
- application/json: {}
- "500":
- application/json: {}
- Xero - Tax rates:
- parameters:
- path:
- platformKey: "gbol"
- dataType: "invoices"
- requestBody:
- application/json: {}
- responses:
- "401":
- application/json: {}
- "500":
- application/json: {}
- QBO - Customers:
- parameters:
- path:
- platformKey: "gbol"
- dataType: "invoices"
- requestBody:
- application/json: {}
- responses:
- "401":
- application/json: {}
- "500":
- application/json: {}
- QBO - Invoices:
- parameters:
- path:
- platformKey: "gbol"
- dataType: "invoices"
- requestBody:
- application/json: {}
- responses:
- "401":
- application/json: {}
- "500":
- application/json: {}
- Unauthorized:
- parameters:
- path:
- platformKey: "gbol"
- dataType: "invoices"
- requestBody:
- application/json: {"supplementalDataConfig": {"orders-supplemental-data": {"dataSource": "/orders", "pullData": {"orderNumber": "order_num"}, "pushData": {"orderNumber": "order_num"}}}}
- responses:
- "401":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- speakeasy-default-configure-supplemental-data:
- parameters:
- path:
- platformKey: "gbol"
- dataType: "invoices"
- requestBody:
- application/json: {"supplementalDataConfig": {"orders-supplemental-data": {"dataSource": "/orders", "pullData": {"orderNumber": "order_num"}, "pushData": {"orderNumber": "order_num"}}}}
- responses:
- "401":
- application/json: {}
- "500":
- application/json: {}
- get-supplemental-data-configuration:
- Unauthorized:
- parameters:
- path:
- platformKey: "gbol"
- dataType: "invoices"
- responses:
- "401":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- speakeasy-default-get-supplemental-data-configuration:
- parameters:
- path:
- platformKey: "gbol"
- dataType: "invoices"
- responses:
- "200":
- application/json: {"supplementalDataConfig": {"orders-supplemental-data": {"dataSource": "/orders", "pullData": {"orderNumber": "order_num"}, "pushData": {"orderNumber": "order_num"}}}}
- "401":
- application/json: {}
- "500":
- application/json: {}
- configure-custom-data-type:
- Dynamics 365 Business Central:
- parameters:
- path:
- platformKey: "gbol"
- customDataIdentifier: "DynamicsPurchaseOrders"
- requestBody:
- application/json: {"dataSource": "api/purchaseOrders", "requiredData": {"currency": "$[*].currencyCode", "number": "$[*].number", "date": "$[*].orderDate", "totalexvat": "$[*].totalAmountExcludingTax", "totaltax": "$[*].totalTaxAmount", "vendor": "$[*].number"}, "keyBy": ["$[*].id"], "sourceModifiedDate": ["$[*].lastModifiedDateTime"]}
- responses:
- "200":
- application/json: {"dataSource": "api/purchaseOrders", "requiredData": {"currency": "$[*].currencyCode", "number": "$[*].number", "date": "$[*].orderDate", "totalexvat": "$[*].totalAmountExcludingTax", "totaltax": "$[*].totalTaxAmount", "vendor": "$[*].number"}, "keyBy": ["$[*].id"], "sourceModifiedDate": ["$[*].lastModifiedDateTime"]}
- Xero Simple Record:
- parameters:
- path:
- platformKey: "gbol"
- customDataIdentifier: "DynamicsPurchaseOrders"
- requestBody:
- application/json: {"dataSource": "/api.xro/2.0/Accounts", "requiredData": {"code": "$.Code", "accountId": "$.AccountID", "type": "$.Type", "SysAcc": "$.SystemAccount"}, "keyBy": ["$.AccountID"]}
- responses:
- "200":
- application/json: {"dataSource": "/api.xro/2.0/Accounts", "requiredData": {"code": "$.Code", "accountId": "$.AccountID", "type": "$.Type", "SysAcc": "$.SystemAccount"}, "keyBy": ["$.AccountID"]}
- Xero Mapping Arrays:
- parameters:
- path:
- platformKey: "gbol"
- customDataIdentifier: "DynamicsPurchaseOrders"
- requestBody:
- application/json: {"dataSource": "/api.xro/2.0/Invoices", "requiredData": {"invNumber": "$.InvoiceNumber", "type": "$.Type", "InvoiceID": "$.InvoiceID", "lines": "$.LineItems[*]"}, "keyBy": ["$.InvoiceID"], "sourceModifiedDate": ["$.UpdatedDateUTC"]}
- responses:
- "200":
- application/json: {"dataSource": "/api.xro/2.0/Invoices", "requiredData": {"invNumber": "$.InvoiceNumber", "type": "$.Type", "InvoiceID": "$.InvoiceID", "lines": "$.LineItems[*]"}, "keyBy": ["$.InvoiceID"], "sourceModifiedDate": ["$.UpdatedDateUTC"]}
- QuickBooks Online:
- parameters:
- path:
- platformKey: "gbol"
- customDataIdentifier: "DynamicsPurchaseOrders"
- requestBody:
- application/json: {"dataSource": "/query?query=select * from Account", "requiredData": {"id": "$.Id", "Currentbal": "$.CurrentBalance", "SubAcc": "$.SubAccount"}, "keyBy": ["$.Id"], "sourceModifiedDate": ["$.time"]}
- responses:
- "200":
- application/json: {"dataSource": "/query?query=select * from Account", "requiredData": {"id": "$.Id", "Currentbal": "$.CurrentBalance", "SubAcc": "$.SubAccount"}, "keyBy": ["$.Id"], "sourceModifiedDate": ["$.time"]}
- Unauthorized:
- parameters:
- path:
- platformKey: "gbol"
- customDataIdentifier: "DynamicsPurchaseOrders"
- requestBody:
- application/json: {"dataSource": "api/purchaseOrders?$filter=currencyCode eq 'NOK'", "requiredData": {"currencyCode": "$[*].currencyCode", "id": "$[*].id", "number": "$[*].number", "orderDate": "$[*].orderDate", "totalAmountExcludingTax": "$[*].totalAmountExcludingTax", "totalTaxAmount": "$[*].totalTaxAmount", "vendorName": "$[*].number"}, "keyBy": ["$[*].id"], "sourceModifiedDate": ["$[*].lastModifiedDateTime"]}
- responses:
- "401":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- get-custom-data-type-configuration:
- Unauthorized:
- parameters:
- path:
- platformKey: "gbol"
- customDataIdentifier: "DynamicsPurchaseOrders"
- responses:
- "401":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- speakeasy-default-get-custom-data-type-configuration:
- parameters:
- path:
- platformKey: "gbol"
- customDataIdentifier: "DynamicsPurchaseOrders"
- responses:
- "200":
- application/json: {"results": [{"modifiedDate": {"modifiedDate": "2022-10-23T00:00:00Z"}}]}
- "401":
- application/json: {}
- "500":
- application/json: {}
- refresh-custom-data-type:
- Unauthorized:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171"
- customDataIdentifier: "DynamicsPurchaseOrders"
- responses:
- "401":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- speakeasy-default-refresh-custom-data-type:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171"
- customDataIdentifier: "DynamicsPurchaseOrders"
- responses:
- "200":
- application/json: {"id": "97d60846-f07a-4d42-b5a0-0bdcc6ebf56b", "companyId": "4645bd78-8988-45bc-ac9e-67ba5df6e4e5", "connectionId": "51baa045-4836-4317-a42e-3542e991e581", "dataType": "invoices", "status": "Initial", "statusDescription": "Paused until 2022-10-23T00:00:00.000Z", "requested": "2022-11-14T11:18:37.2798351Z", "progress": 10, "isCompleted": false, "isErrored": false}
- "401":
- application/json: {}
- "500":
- application/json: {}
- list-custom-data-type-records:
- Malformed query:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171"
- customDataIdentifier: "DynamicsPurchaseOrders"
- query:
- page: 1
- pageSize: 100
- responses:
- "400":
- application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- speakeasy-default-list-custom-data-type-records:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171"
- customDataIdentifier: "DynamicsPurchaseOrders"
- query:
- page: 1
- pageSize: 100
- responses:
- "200":
- application/json: {"results": [{"modifiedDate": {"modifiedDate": "2022-10-23T00:00:00Z"}}]}
- "400":
- application/json: {}
- "500":
- application/json: {}
- get-company-syncSettings:
- Example:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- responses:
- "200":
- application/json: {"companyId": "8a210b68-6988-11ed-a1eb-0242ac120002", "settings": [{"dataType": "invoices", "fetchOnFirstLink": true, "syncSchedule": 24, "syncOrder": 0, "syncFromUtc": "2020-01-01T12:00:00.000Z", "syncFromWindow": 24, "monthsToSync": 24, "isLocked": true}], "overridesDefaults": true}
- Unauthorized:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- responses:
- "401":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 401, "service": "PublicApi", "error": "Unauthorized", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- set-company-syncSettings:
- Malformed query:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- requestBody:
- application/json: {"companyId": "8a210b68-6988-11ed-a1eb-0242ac120002", "settings": [{"dataType": "invoices", "fetchOnFirstLink": true, "syncSchedule": 24, "syncOrder": 0, "syncFromUtc": "2020-01-01T12:00:00.000Z", "syncFromWindow": 24, "monthsToSync": 24, "isLocked": true}], "overridesDefaults": true}
- responses:
- "400":
- application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- "500":
- application/json: {"statusCode": 400, "service": "PublicApi", "error": "Error processing request - not valid.", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "canBeRetried": "Unknown", "detailedErrorCode": 0}
- speakeasy-default-set-company-sync-settings:
- parameters:
- path:
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002"
- requestBody:
- application/json: {"companyId": "8a210b68-6988-11ed-a1eb-0242ac120002", "settings": [{"dataType": "invoices", "fetchOnFirstLink": true, "syncSchedule": 24, "syncOrder": 0, "syncFromUtc": "2020-01-01T12:00:00.000Z", "syncFromWindow": 24, "monthsToSync": 24, "isLocked": true}], "overridesDefaults": true}
- responses:
- "400":
- application/json: {}
- "500":
- application/json: {}
-examplesVersion: 1.0.2
-generatedTests: {}
-releaseNotes: |
- ## Typescript SDK Changes:
- * `codatplatform.companies.list()`: `response.results[].dataConnections[].integrationKey` **Changed**
- * `codatplatform.companies.create()`: `response.dataConnections[].integrationKey` **Changed**
- * `codatplatform.companies.get()`: `response.dataConnections[].integrationKey` **Changed**
- * `codatplatform.companies.replace()`: `response.dataConnections[].integrationKey` **Changed**
- * `codatplatform.companies.update()`: `response.dataConnections[].integrationKey` **Changed**
- * `codatplatform.connections.list()`: `response.results[].integrationKey` **Changed**
- * `codatplatform.connections.create()`: `response.integrationKey` **Changed**
- * `codatplatform.connections.get()`: `response.integrationKey` **Changed**
- * `codatplatform.connections.unlink()`: `response.integrationKey` **Changed**
- * `codatplatform.connections.updateAuthorization()`: `response.integrationKey` **Changed**
-generatedFiles:
- - .gitattributes
- - .npmignore
- - FUNCTIONS.md
- - RUNTIMES.md
- - USAGE.md
- - docs/lib/utils/retryconfig.md
- - docs/sdk/models/errors/errormessage.md
- - docs/sdk/models/operations/addproductrequest.md
- - docs/sdk/models/operations/configurecustomdatatyperequest.md
- - docs/sdk/models/operations/configuresupplementaldatarequest.md
- - docs/sdk/models/operations/createconnectionrequest.md
- - docs/sdk/models/operations/createconnectionrequestbody.md
- - docs/sdk/models/operations/datatype.md
- - docs/sdk/models/operations/deleteapikeyrequest.md
- - docs/sdk/models/operations/deletecompanyrequest.md
- - docs/sdk/models/operations/deleteconnectionrequest.md
- - docs/sdk/models/operations/deletewebhookconsumerrequest.md
- - docs/sdk/models/operations/getcompanyaccesstokenrequest.md
- - docs/sdk/models/operations/getcompanydatastatusrequest.md
- - docs/sdk/models/operations/getcompanypushhistoryrequest.md
- - docs/sdk/models/operations/getcompanyrequest.md
- - docs/sdk/models/operations/getconnectionmanagementaccesstokenrequest.md
- - docs/sdk/models/operations/getconnectionrequest.md
- - docs/sdk/models/operations/getcreateupdatemodeloptionsbydatatyperequest.md
- - docs/sdk/models/operations/getcustomdatatypeconfigurationrequest.md
- - docs/sdk/models/operations/getintegrationrequest.md
- - docs/sdk/models/operations/getintegrationsbrandingrequest.md
- - docs/sdk/models/operations/getpulloperationrequest.md
- - docs/sdk/models/operations/getpushoperationrequest.md
- - docs/sdk/models/operations/getreadvalidationresultsrequest.md
- - docs/sdk/models/operations/getsupplementaldataconfigurationrequest.md
- - docs/sdk/models/operations/listcompaniesrequest.md
- - docs/sdk/models/operations/listconnectionsrequest.md
- - docs/sdk/models/operations/listcustomdatatyperecordsrequest.md
- - docs/sdk/models/operations/listintegrationsrequest.md
- - docs/sdk/models/operations/listpulloperationsrequest.md
- - docs/sdk/models/operations/pathparamdatatype.md
- - docs/sdk/models/operations/refreshcompanydatarequest.md
- - docs/sdk/models/operations/refreshcustomdatatyperequest.md
- - docs/sdk/models/operations/refreshdatatyperequest.md
- - docs/sdk/models/operations/refreshproductdatarequest.md
- - docs/sdk/models/operations/removeproductrequest.md
- - docs/sdk/models/operations/replacecompanyrequest.md
- - docs/sdk/models/operations/unlinkconnectionrequest.md
- - docs/sdk/models/operations/updatecompanyrequest.md
- - docs/sdk/models/operations/updateconnectionauthorizationrequest.md
- - docs/sdk/models/operations/updateprofilesyncsettingsrequestbody.md
- - docs/sdk/models/shared/apikeydetails.md
- - docs/sdk/models/shared/apikeys.md
- - docs/sdk/models/shared/branding.md
- - docs/sdk/models/shared/brandingbutton.md
- - docs/sdk/models/shared/brandingimage.md
- - docs/sdk/models/shared/brandinglogo.md
- - docs/sdk/models/shared/clientratelimitwebhook.md
- - docs/sdk/models/shared/clientratelimitwebhookpayload.md
- - docs/sdk/models/shared/companies.md
- - docs/sdk/models/shared/company.md
- - docs/sdk/models/shared/companyaccesstoken.md
- - docs/sdk/models/shared/companydetails.md
- - docs/sdk/models/shared/companyreference.md
- - docs/sdk/models/shared/companyreferencelinks.md
- - docs/sdk/models/shared/companyrequestbody.md
- - docs/sdk/models/shared/companyupdaterequest.md
- - docs/sdk/models/shared/companywebhook.md
- - docs/sdk/models/shared/connection.md
- - docs/sdk/models/shared/connectionmanagementaccesstoken.md
- - docs/sdk/models/shared/connectionmanagementallowedorigins.md
- - docs/sdk/models/shared/connections.md
- - docs/sdk/models/shared/connectionwebhook.md
- - docs/sdk/models/shared/connectionwebhookpayload.md
- - docs/sdk/models/shared/content.md
- - docs/sdk/models/shared/createapikey.md
- - docs/sdk/models/shared/customdatatypeconfiguration.md
- - docs/sdk/models/shared/customdatatyperecord.md
- - docs/sdk/models/shared/customdatatyperecords.md
- - docs/sdk/models/shared/dataconnectionerror.md
- - docs/sdk/models/shared/dataconnectionstatus.md
- - docs/sdk/models/shared/datasetstatus.md
- - docs/sdk/models/shared/datastatus.md
- - docs/sdk/models/shared/datastatuses.md
- - docs/sdk/models/shared/datatype.md
- - docs/sdk/models/shared/datatypefeature.md
- - docs/sdk/models/shared/datatypereadsummary.md
- - docs/sdk/models/shared/datatypes.md
- - docs/sdk/models/shared/datatypewritewebhook.md
- - docs/sdk/models/shared/datatypewritewebhookpayload.md
- - docs/sdk/models/shared/datatypewritewebhookrecord.md
- - docs/sdk/models/shared/errormessage.md
- - docs/sdk/models/shared/errorstatus.md
- - docs/sdk/models/shared/errorvalidation.md
- - docs/sdk/models/shared/errorvalidationitem.md
- - docs/sdk/models/shared/featurestate.md
- - docs/sdk/models/shared/featuretype.md
- - docs/sdk/models/shared/halref.md
- - docs/sdk/models/shared/imagereference.md
- - docs/sdk/models/shared/integration.md
- - docs/sdk/models/shared/integrations.md
- - docs/sdk/models/shared/links.md
- - docs/sdk/models/shared/modifieddate.md
- - docs/sdk/models/shared/profile.md
- - docs/sdk/models/shared/pulloperation.md
- - docs/sdk/models/shared/pulloperations.md
- - docs/sdk/models/shared/pushchangetype.md
- - docs/sdk/models/shared/pushfieldvalidation.md
- - docs/sdk/models/shared/pushoperation.md
- - docs/sdk/models/shared/pushoperationchange.md
- - docs/sdk/models/shared/pushoperationref.md
- - docs/sdk/models/shared/pushoperations.md
- - docs/sdk/models/shared/pushoperationstatus.md
- - docs/sdk/models/shared/pushoption.md
- - docs/sdk/models/shared/pushoptionchoice.md
- - docs/sdk/models/shared/pushoptionproperty.md
- - docs/sdk/models/shared/pushoptiontype.md
- - docs/sdk/models/shared/pushvalidationinfo.md
- - docs/sdk/models/shared/readcompletedwebhook.md
- - docs/sdk/models/shared/readcompletedwebhookpayload.md
- - docs/sdk/models/shared/security.md
- - docs/sdk/models/shared/sourcetype.md
- - docs/sdk/models/shared/status.md
- - docs/sdk/models/shared/supplementaldataconfiguration.md
- - docs/sdk/models/shared/supplementaldatasourceconfiguration.md
- - docs/sdk/models/shared/supportedfeature.md
- - docs/sdk/models/shared/syncsetting.md
- - docs/sdk/models/shared/syncsettings.md
- - docs/sdk/models/shared/updateconnectionstatus.md
- - docs/sdk/models/shared/validation.md
- - docs/sdk/models/shared/validationitem.md
- - docs/sdk/models/shared/validationitem1.md
- - docs/sdk/models/shared/validationresult.md
- - docs/sdk/models/shared/webhookconsumer.md
- - docs/sdk/models/shared/webhookconsumerprototype.md
- - docs/sdk/models/shared/webhookconsumers.md
- - docs/sdk/models/shared/writestatus.md
- - docs/sdk/models/shared/writetype.md
- - docs/sdks/codatplatform/README.md
- - docs/sdks/companies/README.md
- - docs/sdks/connectionmanagement/README.md
- - docs/sdks/connections/README.md
- - docs/sdks/cors/README.md
- - docs/sdks/customdatatype/README.md
- - docs/sdks/integrations/README.md
- - docs/sdks/pushdata/README.md
- - docs/sdks/readdata/README.md
- - docs/sdks/refreshdata/README.md
- - docs/sdks/settings/README.md
- - docs/sdks/supplementaldata/README.md
- - docs/sdks/webhooks/README.md
- - eslint.config.mjs
- - jsr.json
- - package.json
- - src/core.ts
- - src/funcs/companiesAddProduct.ts
- - src/funcs/companiesCreate.ts
- - src/funcs/companiesDelete.ts
- - src/funcs/companiesGet.ts
- - src/funcs/companiesGetAccessToken.ts
- - src/funcs/companiesList.ts
- - src/funcs/companiesRefreshProductData.ts
- - src/funcs/companiesRemoveProduct.ts
- - src/funcs/companiesReplace.ts
- - src/funcs/companiesUpdate.ts
- - src/funcs/connectionManagementGet.ts
- - src/funcs/connectionsCreate.ts
- - src/funcs/connectionsDelete.ts
- - src/funcs/connectionsGet.ts
- - src/funcs/connectionsList.ts
- - src/funcs/connectionsUnlink.ts
- - src/funcs/connectionsUpdateAuthorization.ts
- - src/funcs/corsGet.ts
- - src/funcs/corsSet.ts
- - src/funcs/customDataTypeConfigure.ts
- - src/funcs/customDataTypeGetConfiguration.ts
- - src/funcs/customDataTypeList.ts
- - src/funcs/customDataTypeRefresh.ts
- - src/funcs/integrationsGet.ts
- - src/funcs/integrationsGetBranding.ts
- - src/funcs/integrationsList.ts
- - src/funcs/pushDataGetModelOptions.ts
- - src/funcs/pushDataGetOperation.ts
- - src/funcs/pushDataListOperations.ts
- - src/funcs/readDataGetValidationResults.ts
- - src/funcs/refreshDataAll.ts
- - src/funcs/refreshDataByDataType.ts
- - src/funcs/refreshDataGet.ts
- - src/funcs/refreshDataGetPullOperation.ts
- - src/funcs/refreshDataListPullOperations.ts
- - src/funcs/settingsCreateApiKey.ts
- - src/funcs/settingsDeleteApiKey.ts
- - src/funcs/settingsGet.ts
- - src/funcs/settingsGetProfile.ts
- - src/funcs/settingsGetSyncSettings.ts
- - src/funcs/settingsListApiKeys.ts
- - src/funcs/settingsSet.ts
- - src/funcs/settingsUpdateProfile.ts
- - src/funcs/settingsUpdateSyncSettings.ts
- - src/funcs/supplementalDataConfigure.ts
- - src/funcs/supplementalDataGetConfiguration.ts
- - src/funcs/webhooksCreateConsumer.ts
- - src/funcs/webhooksDeleteConsumer.ts
- - src/funcs/webhooksListConsumers.ts
- - src/hooks/hooks.ts
- - src/hooks/index.ts
- - src/hooks/types.ts
- - src/index.ts
- - src/lib/base64.ts
- - src/lib/config.ts
- - src/lib/dlv.ts
- - src/lib/encodings.ts
- - src/lib/files.ts
- - src/lib/http.ts
- - src/lib/is-plain-object.ts
- - src/lib/logger.ts
- - src/lib/matchers.ts
- - src/lib/primitives.ts
- - src/lib/retries.ts
- - src/lib/schemas.ts
- - src/lib/sdks.ts
- - src/lib/security.ts
- - src/lib/url.ts
- - src/mcp-server/build.mts
- - src/mcp-server/cli.ts
- - src/mcp-server/cli/start/command.ts
- - src/mcp-server/cli/start/impl.ts
- - src/mcp-server/console-logger.ts
- - src/mcp-server/extensions.ts
- - src/mcp-server/mcp-server.ts
- - src/mcp-server/prompts.ts
- - src/mcp-server/resources.ts
- - src/mcp-server/scopes.ts
- - src/mcp-server/server.ts
- - src/mcp-server/shared.ts
- - src/mcp-server/tools.ts
- - src/mcp-server/tools/companiesAddProduct.ts
- - src/mcp-server/tools/companiesCreate.ts
- - src/mcp-server/tools/companiesDelete.ts
- - src/mcp-server/tools/companiesGet.ts
- - src/mcp-server/tools/companiesGetAccessToken.ts
- - src/mcp-server/tools/companiesList.ts
- - src/mcp-server/tools/companiesRefreshProductData.ts
- - src/mcp-server/tools/companiesRemoveProduct.ts
- - src/mcp-server/tools/companiesReplace.ts
- - src/mcp-server/tools/companiesUpdate.ts
- - src/mcp-server/tools/connectionManagementGet.ts
- - src/mcp-server/tools/connectionsCreate.ts
- - src/mcp-server/tools/connectionsDelete.ts
- - src/mcp-server/tools/connectionsGet.ts
- - src/mcp-server/tools/connectionsList.ts
- - src/mcp-server/tools/connectionsUnlink.ts
- - src/mcp-server/tools/connectionsUpdateAuthorization.ts
- - src/mcp-server/tools/corsGet.ts
- - src/mcp-server/tools/corsSet.ts
- - src/mcp-server/tools/customDataTypeConfigure.ts
- - src/mcp-server/tools/customDataTypeGetConfiguration.ts
- - src/mcp-server/tools/customDataTypeList.ts
- - src/mcp-server/tools/customDataTypeRefresh.ts
- - src/mcp-server/tools/integrationsGet.ts
- - src/mcp-server/tools/integrationsGetBranding.ts
- - src/mcp-server/tools/integrationsList.ts
- - src/mcp-server/tools/pushDataGetModelOptions.ts
- - src/mcp-server/tools/pushDataGetOperation.ts
- - src/mcp-server/tools/pushDataListOperations.ts
- - src/mcp-server/tools/readDataGetValidationResults.ts
- - src/mcp-server/tools/refreshDataAll.ts
- - src/mcp-server/tools/refreshDataByDataType.ts
- - src/mcp-server/tools/refreshDataGet.ts
- - src/mcp-server/tools/refreshDataGetPullOperation.ts
- - src/mcp-server/tools/refreshDataListPullOperations.ts
- - src/mcp-server/tools/settingsCreateApiKey.ts
- - src/mcp-server/tools/settingsDeleteApiKey.ts
- - src/mcp-server/tools/settingsGet.ts
- - src/mcp-server/tools/settingsGetProfile.ts
- - src/mcp-server/tools/settingsGetSyncSettings.ts
- - src/mcp-server/tools/settingsListApiKeys.ts
- - src/mcp-server/tools/settingsSet.ts
- - src/mcp-server/tools/settingsUpdateProfile.ts
- - src/mcp-server/tools/settingsUpdateSyncSettings.ts
- - src/mcp-server/tools/supplementalDataConfigure.ts
- - src/mcp-server/tools/supplementalDataGetConfiguration.ts
- - src/mcp-server/tools/webhooksCreateConsumer.ts
- - src/mcp-server/tools/webhooksDeleteConsumer.ts
- - src/mcp-server/tools/webhooksListConsumers.ts
- - src/sdk/companies.ts
- - src/sdk/connectionmanagement.ts
- - src/sdk/connections.ts
- - src/sdk/cors.ts
- - src/sdk/customdatatype.ts
- - src/sdk/index.ts
- - src/sdk/integrations.ts
- - src/sdk/models/errors/errormessage.ts
- - src/sdk/models/errors/httpclienterrors.ts
- - src/sdk/models/errors/index.ts
- - src/sdk/models/errors/sdkerror.ts
- - src/sdk/models/errors/sdkvalidationerror.ts
- - src/sdk/models/operations/addproduct.ts
- - src/sdk/models/operations/configurecustomdatatype.ts
- - src/sdk/models/operations/configuresupplementaldata.ts
- - src/sdk/models/operations/createconnection.ts
- - src/sdk/models/operations/deleteapikey.ts
- - src/sdk/models/operations/deletecompany.ts
- - src/sdk/models/operations/deleteconnection.ts
- - src/sdk/models/operations/deletewebhookconsumer.ts
- - src/sdk/models/operations/getcompany.ts
- - src/sdk/models/operations/getcompanyaccesstoken.ts
- - src/sdk/models/operations/getcompanydatastatus.ts
- - src/sdk/models/operations/getcompanypushhistory.ts
- - src/sdk/models/operations/getconnection.ts
- - src/sdk/models/operations/getconnectionmanagementaccesstoken.ts
- - src/sdk/models/operations/getcreateupdatemodeloptionsbydatatype.ts
- - src/sdk/models/operations/getcustomdatatypeconfiguration.ts
- - src/sdk/models/operations/getintegration.ts
- - src/sdk/models/operations/getintegrationsbranding.ts
- - src/sdk/models/operations/getpulloperation.ts
- - src/sdk/models/operations/getpushoperation.ts
- - src/sdk/models/operations/getreadvalidationresults.ts
- - src/sdk/models/operations/getsupplementaldataconfiguration.ts
- - src/sdk/models/operations/index.ts
- - src/sdk/models/operations/listcompanies.ts
- - src/sdk/models/operations/listconnections.ts
- - src/sdk/models/operations/listcustomdatatyperecords.ts
- - src/sdk/models/operations/listintegrations.ts
- - src/sdk/models/operations/listpulloperations.ts
- - src/sdk/models/operations/refreshcompanydata.ts
- - src/sdk/models/operations/refreshcustomdatatype.ts
- - src/sdk/models/operations/refreshdatatype.ts
- - src/sdk/models/operations/refreshproductdata.ts
- - src/sdk/models/operations/removeproduct.ts
- - src/sdk/models/operations/replacecompany.ts
- - src/sdk/models/operations/unlinkconnection.ts
- - src/sdk/models/operations/updatecompany.ts
- - src/sdk/models/operations/updateconnectionauthorization.ts
- - src/sdk/models/operations/updateprofilesyncsettings.ts
- - src/sdk/models/shared/apikeydetails.ts
- - src/sdk/models/shared/apikeys.ts
- - src/sdk/models/shared/branding.ts
- - src/sdk/models/shared/brandingbutton.ts
- - src/sdk/models/shared/brandingimage.ts
- - src/sdk/models/shared/brandinglogo.ts
- - src/sdk/models/shared/clientratelimitwebhook.ts
- - src/sdk/models/shared/clientratelimitwebhookpayload.ts
- - src/sdk/models/shared/companies.ts
- - src/sdk/models/shared/company.ts
- - src/sdk/models/shared/companyaccesstoken.ts
- - src/sdk/models/shared/companydetails.ts
- - src/sdk/models/shared/companyreference.ts
- - src/sdk/models/shared/companyrequestbody.ts
- - src/sdk/models/shared/companyupdaterequest.ts
- - src/sdk/models/shared/companywebhook.ts
- - src/sdk/models/shared/connection.ts
- - src/sdk/models/shared/connectionmanagementaccesstoken.ts
- - src/sdk/models/shared/connectionmanagementallowedorigins.ts
- - src/sdk/models/shared/connections.ts
- - src/sdk/models/shared/connectionwebhook.ts
- - src/sdk/models/shared/connectionwebhookpayload.ts
- - src/sdk/models/shared/createapikey.ts
- - src/sdk/models/shared/customdatatypeconfiguration.ts
- - src/sdk/models/shared/customdatatyperecord.ts
- - src/sdk/models/shared/customdatatyperecords.ts
- - src/sdk/models/shared/dataconnectionerror.ts
- - src/sdk/models/shared/dataconnectionstatus.ts
- - src/sdk/models/shared/datastatus.ts
- - src/sdk/models/shared/datastatuses.ts
- - src/sdk/models/shared/datatype.ts
- - src/sdk/models/shared/datatypefeature.ts
- - src/sdk/models/shared/datatypereadsummary.ts
- - src/sdk/models/shared/datatypewritewebhook.ts
- - src/sdk/models/shared/datatypewritewebhookpayload.ts
- - src/sdk/models/shared/datatypewritewebhookrecord.ts
- - src/sdk/models/shared/errormessage.ts
- - src/sdk/models/shared/errorvalidation.ts
- - src/sdk/models/shared/errorvalidationitem.ts
- - src/sdk/models/shared/featurestate.ts
- - src/sdk/models/shared/featuretype.ts
- - src/sdk/models/shared/halref.ts
- - src/sdk/models/shared/imagereference.ts
- - src/sdk/models/shared/index.ts
- - src/sdk/models/shared/integration.ts
- - src/sdk/models/shared/integrations.ts
- - src/sdk/models/shared/links.ts
- - src/sdk/models/shared/profile.ts
- - src/sdk/models/shared/pulloperation.ts
- - src/sdk/models/shared/pulloperations.ts
- - src/sdk/models/shared/pushchangetype.ts
- - src/sdk/models/shared/pushfieldvalidation.ts
- - src/sdk/models/shared/pushoperation.ts
- - src/sdk/models/shared/pushoperationchange.ts
- - src/sdk/models/shared/pushoperationref.ts
- - src/sdk/models/shared/pushoperations.ts
- - src/sdk/models/shared/pushoperationstatus.ts
- - src/sdk/models/shared/pushoption.ts
- - src/sdk/models/shared/pushoptionchoice.ts
- - src/sdk/models/shared/pushoptionproperty.ts
- - src/sdk/models/shared/pushoptiontype.ts
- - src/sdk/models/shared/pushvalidationinfo.ts
- - src/sdk/models/shared/readcompletedwebhook.ts
- - src/sdk/models/shared/readcompletedwebhookpayload.ts
- - src/sdk/models/shared/security.ts
- - src/sdk/models/shared/sourcetype.ts
- - src/sdk/models/shared/status.ts
- - src/sdk/models/shared/supplementaldataconfiguration.ts
- - src/sdk/models/shared/supportedfeature.ts
- - src/sdk/models/shared/syncsetting.ts
- - src/sdk/models/shared/syncsettings.ts
- - src/sdk/models/shared/updateconnectionstatus.ts
- - src/sdk/models/shared/validation.ts
- - src/sdk/models/shared/validationitem.ts
- - src/sdk/models/shared/validationitem1.ts
- - src/sdk/models/shared/validationresult.ts
- - src/sdk/models/shared/webhookconsumer.ts
- - src/sdk/models/shared/webhookconsumerprototype.ts
- - src/sdk/models/shared/webhookconsumers.ts
- - src/sdk/models/shared/writestatus.ts
- - src/sdk/models/shared/writetype.ts
- - src/sdk/pushdata.ts
- - src/sdk/readdata.ts
- - src/sdk/refreshdata.ts
- - src/sdk/sdk.ts
- - src/sdk/settings.ts
- - src/sdk/supplementaldata.ts
- - src/sdk/types/async.ts
- - src/sdk/types/blobs.ts
- - src/sdk/types/constdatetime.ts
- - src/sdk/types/enums.ts
- - src/sdk/types/fp.ts
- - src/sdk/types/index.ts
- - src/sdk/types/operations.ts
- - src/sdk/types/rfcdate.ts
- - src/sdk/types/streams.ts
- - src/sdk/types/webhooks.ts
- - src/sdk/webhooks.ts
- - tsconfig.json
diff --git a/platform/.speakeasy/gen.yaml b/platform/.speakeasy/gen.yaml
deleted file mode 100644
index 47ab6a27d..000000000
--- a/platform/.speakeasy/gen.yaml
+++ /dev/null
@@ -1,90 +0,0 @@
-configVersion: 2.0.0
-generation:
- sdkClassName: CodatPlatform
- maintainOpenAPIOrder: true
- usageSnippets:
- optionalPropertyRendering: withExample
- sdkInitStyle: constructor
- useClassNamesForArrayFields: true
- fixes:
- nameResolutionDec2023: true
- nameResolutionFeb2025: false
- parameterOrderingFeb2024: true
- requestResponseComponentNamesFeb2024: true
- securityFeb2025: false
- sharedErrorComponentsApr2025: false
- sharedNestedComponentsJan2026: false
- nameOverrideFeb2026: false
- auth:
- oAuth2ClientCredentialsEnabled: false
- oAuth2PasswordEnabled: false
- hoistGlobalSecurity: true
- schemas:
- allOfMergeStrategy: shallowMerge
- requestBodyFieldName: ""
- versioningStrategy: automatic
- persistentEdits: {}
- tests:
- generateTests: true
- generateNewTests: false
- skipResponseBodyAssertions: false
-typescript:
- version: 6.2.1
- acceptHeaderEnum: true
- additionalDependencies:
- dependencies: {}
- devDependencies: {}
- peerDependencies: {}
- additionalPackageJSON: {}
- additionalScripts: {}
- alwaysIncludeInboundAndOutbound: false
- author: Codat
- baseErrorName: CodatPlatformError
- clientServerStatusCodesAsErrors: true
- constFieldsAlwaysOptional: false
- defaultErrorName: SDKError
- description: Manage the building blocks of Codat, including companies, connections, and more.
- enableCustomCodeRegions: false
- enableMCPServer: false
- enableReactQuery: false
- enumFormat: union
- exportZodModelNamespace: false
- fixEnumNameSanitization: false
- flatAdditionalProperties: false
- flattenGlobalSecurity: true
- flatteningOrder: body-first
- formStringArrayEncodeMode: encoded-string
- forwardCompatibleEnumsByDefault: false
- forwardCompatibleUnionsByDefault: "false"
- generateExamples: true
- imports:
- option: openapi
- paths:
- callbacks: sdk/models/callbacks
- errors: sdk/models/errors
- operations: sdk/models/operations
- shared: sdk/models/shared
- webhooks: sdk/models/webhooks
- inferUnionDiscriminators: true
- inputModelSuffix: input
- jsonpath: legacy
- laxMode: strict
- legacyFileNaming: true
- maxMethodParams: 0
- methodArguments: infer-optional-args
- modelPropertyCasing: camel
- moduleFormat: commonjs
- multipartArrayFormat: legacy
- outputModelSuffix: output
- packageName: '@codat/platform'
- preApplyUnionDiscriminators: true
- preserveModelFieldNames: false
- responseFormat: flat
- sseFlatResponse: false
- templateVersion: v2
- unionStrategy: left-to-right
- usageSDKInitImports: []
- useIndexModules: true
- useOxlint: false
- useTsgo: false
- zodVersion: v3
diff --git a/platform/RELEASES.md b/platform/RELEASES.md
index 197a72368..a684f074a 100644
--- a/platform/RELEASES.md
+++ b/platform/RELEASES.md
@@ -234,4 +234,14 @@ Based on:
### Generated
- [typescript v6.2.1] platform
### Releases
-- [NPM v6.2.1] https://www.npmjs.com/package/@codat/platform/v/6.2.1 - platform
\ No newline at end of file
+- [NPM v6.2.1] https://www.npmjs.com/package/@codat/platform/v/6.2.1 - platform
+
+## 2026-08-05 19:30:19
+### Changes
+Based on:
+- OpenAPI Doc 3.0.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Platform.yaml
+- codat sdk-codegen 1b5626f25df09d713121c5e8a048d9b44b3b7178 https://github.com/codat-spikes/sdk-codegen
+### Generated
+- [typescript v6.2.2] platform
+### Releases
+- [NPM v6.2.2] https://www.npmjs.com/package/@codat/platform/v/6.2.2 - platform
diff --git a/platform/USAGE.md b/platform/USAGE.md
index 434db3b1e..23ea46d80 100644
--- a/platform/USAGE.md
+++ b/platform/USAGE.md
@@ -1,22 +1,21 @@
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.companies.list({
- query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
- orderBy: "-modifiedDate",
- tags: "region=uk && team=invoice-finance",
- });
-
- console.log(result);
-}
-
-run();
-
-```
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.companies.list({
+ query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
+ orderBy: "-modifiedDate",
+ tags: "region=uk && team=invoice-finance",
+ });
+
+ console.log(result);
+}
+
+run();
+```
\ No newline at end of file
diff --git a/platform/docs/lib/utils/retryconfig.md b/platform/docs/lib/utils/retryconfig.md
index 08f95f455..69da01b9f 100644
--- a/platform/docs/lib/utils/retryconfig.md
+++ b/platform/docs/lib/utils/retryconfig.md
@@ -1,24 +1,24 @@
-# RetryConfig
-
-Allows customizing the default retry configuration. It is only permitted in methods that accept retry policies.
-
-## Fields
-
-| Name | Type | Description | Example |
-| ------------------------- | ----------------------------------- | ------------------------------------------------------------------------------------------ | ----------- |
-| `strategy` | `"backoff" | "none"` | The retry strategy to use. | `"backoff"` |
-| `backoff` | [BackoffStrategy](#backoffstrategy) | When strategy is "backoff", this configurates for the backoff parameters. | |
-| `retryConnectionErrors` | `*boolean*` | When strategy is "backoff", this determines whether or not to retry on connection errors. | `true` |
-
-## BackoffStrategy
-
-The backoff strategy allows retrying a request with an exponential backoff between each retry.
-
-### Fields
-
-| Name | Type | Description | Example |
-| ------------------ | ------------ | ----------------------------------------- | -------- |
-| `initialInterval` | `*number*` | The initial interval in milliseconds. | `500` |
-| `maxInterval` | `*number*` | The maximum interval in milliseconds. | `60000` |
-| `exponent` | `*number*` | The exponent to use for the backoff. | `1.5` |
+# RetryConfig
+
+Allows customizing the default retry configuration. It is only permitted in methods that accept retry policies.
+
+## Fields
+
+| Name | Type | Description | Example |
+| ------------------------- | ----------------------------------- | ------------------------------------------------------------------------------------------ | ----------- |
+| `strategy` | `"backoff" | "none"` | The retry strategy to use. | `"backoff"` |
+| `backoff` | [BackoffStrategy](#backoffstrategy) | When strategy is "backoff", this configurates for the backoff parameters. | |
+| `retryConnectionErrors` | `*boolean*` | When strategy is "backoff", this determines whether or not to retry on connection errors. | `true` |
+
+## BackoffStrategy
+
+The backoff strategy allows retrying a request with an exponential backoff between each retry.
+
+### Fields
+
+| Name | Type | Description | Example |
+| ------------------ | ------------ | ----------------------------------------- | -------- |
+| `initialInterval` | `*number*` | The initial interval in milliseconds. | `500` |
+| `maxInterval` | `*number*` | The maximum interval in milliseconds. | `60000` |
+| `exponent` | `*number*` | The exponent to use for the backoff. | `1.5` |
| `maxElapsedTime` | `*number*` | The maximum elapsed time in milliseconds. | `300000` |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/errors/errormessage.md b/platform/docs/sdk/models/errors/errormessage.md
index f1b3b9377..94109f18f 100644
--- a/platform/docs/sdk/models/errors/errormessage.md
+++ b/platform/docs/sdk/models/errors/errormessage.md
@@ -1,23 +1,21 @@
-# ErrorMessage
-
-Your `query` parameter was not correctly formed
-
-## Example Usage
-
-```typescript
-import { ErrorMessage } from "@codat/platform/sdk/models/errors";
-
-// No examples available for this model
-```
-
-## Fields
-
-| Field | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `statusCode` | *number* | :heavy_minus_sign: | The HTTP status code returned by the error. |
-| `service` | *string* | :heavy_minus_sign: | Codat's service the returned the error. |
-| `error` | *string* | :heavy_minus_sign: | A brief description of the error. |
-| `correlationId` | *string* | :heavy_minus_sign: | Unique identifier used to propagate to all downstream services and determine the source of the error. |
-| `validation` | [shared.ErrorValidation](../../../sdk/models/shared/errorvalidation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made. If an operation has failed because of validation errors, they will be detailed here. |
-| `canBeRetried` | *string* | :heavy_minus_sign: | `True` if the error occurred transiently and can be retried. |
+# ErrorMessage
+
+## Example Usage
+
+```typescript
+import { ErrorMessage } from "@codat/platform/sdk/models/errors";
+
+// No examples available for this model
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `statusCode` | *number* | :heavy_minus_sign: | The HTTP status code returned by the error. |
+| `service` | *string* | :heavy_minus_sign: | Codat's service the returned the error. |
+| `error` | *string* | :heavy_minus_sign: | A brief description of the error. |
+| `correlationId` | *string* | :heavy_minus_sign: | Unique identifier used to propagate to all downstream services and determine the source of the error. |
+| `validation` | [shared.ErrorValidation](../../../sdk/models/shared/errorvalidation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made. If an operation has failed because of validation errors, they will be detailed here. |
+| `canBeRetried` | *string* | :heavy_minus_sign: | `True` if the error occurred transiently and can be retried. |
| `detailedErrorCode` | *number* | :heavy_minus_sign: | Machine readable error code used to automate processes based on the code returned. |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/operations/addproductrequest.md b/platform/docs/sdk/models/operations/addproductrequest.md
index 7093782a3..1cbb751b5 100644
--- a/platform/docs/sdk/models/operations/addproductrequest.md
+++ b/platform/docs/sdk/models/operations/addproductrequest.md
@@ -1,19 +1,19 @@
-# AddProductRequest
-
-## Example Usage
-
-```typescript
-import { AddProductRequest } from "@codat/platform/sdk/models/operations";
-
-let value: AddProductRequest = {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- productIdentifier: "bank-feeds",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
-| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
+# AddProductRequest
+
+## Example Usage
+
+```typescript
+import { AddProductRequest } from "@codat/platform/sdk/models/operations";
+
+let value: AddProductRequest = {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ productIdentifier: "bank-feeds",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
+| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
| `productIdentifier` | *string* | :heavy_check_mark: | Human-readable product identifier for a product. | **Example 1:** bank-feeds
**Example 2:** lending
**Example 3:** payables
**Example 4:** expenses |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/operations/configurecustomdatatyperequest.md b/platform/docs/sdk/models/operations/configurecustomdatatyperequest.md
index 3f3137f1c..f1b2118aa 100644
--- a/platform/docs/sdk/models/operations/configurecustomdatatyperequest.md
+++ b/platform/docs/sdk/models/operations/configurecustomdatatyperequest.md
@@ -1,20 +1,20 @@
-# ConfigureCustomDataTypeRequest
-
-## Example Usage
-
-```typescript
-import { ConfigureCustomDataTypeRequest } from "@codat/platform/sdk/models/operations";
-
-let value: ConfigureCustomDataTypeRequest = {
- platformKey: "gbol",
- customDataIdentifier: "DynamicsPurchaseOrders",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `platformKey` | *string* | :heavy_check_mark: | A unique 4-letter key to represent a platform in each integration. | gbol |
-| `customDataIdentifier` | *string* | :heavy_check_mark: | Unique identifier for a custom data type. | DynamicsPurchaseOrders |
+# ConfigureCustomDataTypeRequest
+
+## Example Usage
+
+```typescript
+import { ConfigureCustomDataTypeRequest } from "@codat/platform/sdk/models/operations";
+
+let value: ConfigureCustomDataTypeRequest = {
+ platformKey: "gbol",
+ customDataIdentifier: "DynamicsPurchaseOrders",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `platformKey` | *string* | :heavy_check_mark: | A unique 4-letter key to represent a platform in each integration. | gbol |
+| `customDataIdentifier` | *string* | :heavy_check_mark: | Unique identifier for a custom data type. | DynamicsPurchaseOrders |
| `customDataTypeConfiguration` | [shared.CustomDataTypeConfiguration](../../../sdk/models/shared/customdatatypeconfiguration.md) | :heavy_minus_sign: | Custom data type configuration for the specified platform. | {
"dataSource": "api/purchaseOrders?$filter=currencyCode eq 'NOK'",
"requiredData": {
"currencyCode": "$[*].currencyCode",
"id": "$[*].id",
"number": "$[*].number",
"orderDate": "$[*].orderDate",
"totalAmountExcludingTax": "$[*].totalAmountExcludingTax",
"totalTaxAmount": "$[*].totalTaxAmount",
"vendorName": "$[*].number"
},
"keyBy": [
"$[*].id"
],
"sourceModifiedDate": [
"$[*].lastModifiedDateTime"
]
} |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/operations/configuresupplementaldatarequest.md b/platform/docs/sdk/models/operations/configuresupplementaldatarequest.md
index e60f8ea7b..7a3d7eb45 100644
--- a/platform/docs/sdk/models/operations/configuresupplementaldatarequest.md
+++ b/platform/docs/sdk/models/operations/configuresupplementaldatarequest.md
@@ -1,20 +1,20 @@
-# ConfigureSupplementalDataRequest
-
-## Example Usage
-
-```typescript
-import { ConfigureSupplementalDataRequest } from "@codat/platform/sdk/models/operations";
-
-let value: ConfigureSupplementalDataRequest = {
- platformKey: "gbol",
- dataType: "invoices",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `platformKey` | *string* | :heavy_check_mark: | A unique 4-letter key to represent a platform in each integration. | gbol |
-| `dataType` | [operations.DataType](../../../sdk/models/operations/datatype.md) | :heavy_check_mark: | Supported supplemental data data type. | invoices |
+# ConfigureSupplementalDataRequest
+
+## Example Usage
+
+```typescript
+import { ConfigureSupplementalDataRequest } from "@codat/platform/sdk/models/operations";
+
+let value: ConfigureSupplementalDataRequest = {
+ platformKey: "gbol",
+ dataType: "invoices",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `platformKey` | *string* | :heavy_check_mark: | A unique 4-letter key to represent a platform in each integration. | gbol |
+| `dataType` | [shared.DataType](../../../sdk/models/shared/datatype.md) | :heavy_check_mark: | Supported supplemental data data type. | invoices |
| `supplementalDataConfiguration` | [shared.SupplementalDataConfiguration](../../../sdk/models/shared/supplementaldataconfiguration.md) | :heavy_minus_sign: | The configuration for the specified platform and data type. | {
"supplementalDataConfig": {
"orders-supplemental-data": {
"dataSource": "/orders",
"pullData": {
"orderNumber": "order_num"
},
"pushData": {
"orderNumber": "order_num"
}
}
}
} |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/operations/createconnectionrequest.md b/platform/docs/sdk/models/operations/createconnectionrequest.md
index 8869a9cc3..5b1d13b89 100644
--- a/platform/docs/sdk/models/operations/createconnectionrequest.md
+++ b/platform/docs/sdk/models/operations/createconnectionrequest.md
@@ -1,18 +1,18 @@
-# CreateConnectionRequest
-
-## Example Usage
-
-```typescript
-import { CreateConnectionRequest } from "@codat/platform/sdk/models/operations";
-
-let value: CreateConnectionRequest = {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
-| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
+# CreateConnectionRequest
+
+## Example Usage
+
+```typescript
+import { CreateConnectionRequest } from "@codat/platform/sdk/models/operations";
+
+let value: CreateConnectionRequest = {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
+| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
| `requestBody` | [operations.CreateConnectionRequestBody](../../../sdk/models/operations/createconnectionrequestbody.md) | :heavy_minus_sign: | N/A | |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/operations/createconnectionrequestbody.md b/platform/docs/sdk/models/operations/createconnectionrequestbody.md
index a21ed4587..0b2b594a4 100644
--- a/platform/docs/sdk/models/operations/createconnectionrequestbody.md
+++ b/platform/docs/sdk/models/operations/createconnectionrequestbody.md
@@ -1,17 +1,17 @@
-# CreateConnectionRequestBody
-
-## Example Usage
-
-```typescript
-import { CreateConnectionRequestBody } from "@codat/platform/sdk/models/operations";
-
-let value: CreateConnectionRequestBody = {
- platformKey: "gbol",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+# CreateConnectionRequestBody
+
+## Example Usage
+
+```typescript
+import { CreateConnectionRequestBody } from "@codat/platform/sdk/models/operations";
+
+let value: CreateConnectionRequestBody = {
+ platformKey: "gbol",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `platformKey` | *string* | :heavy_minus_sign: | A unique 4-letter key to represent a platform in each integration. View [accounting](https://docs.codat.io/integrations/accounting/overview#platform-keys), [banking](https://docs.codat.io/integrations/banking/overview#platform-keys), and [commerce](https://docs.codat.io/integrations/commerce/overview#platform-keys) platform keys. | gbol |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/operations/datatype.md b/platform/docs/sdk/models/operations/datatype.md
index bec60751b..5322a40a0 100644
--- a/platform/docs/sdk/models/operations/datatype.md
+++ b/platform/docs/sdk/models/operations/datatype.md
@@ -1,17 +1,17 @@
-# DataType
-
-Data types that support supplemental data
-
-## Example Usage
-
-```typescript
-import { DataType } from "@codat/platform/sdk/models/operations";
-
-let value: DataType = "invoices";
-```
-
-## Values
-
-```typescript
-"chartOfAccounts" | "bills" | "company" | "creditNotes" | "customers" | "invoices" | "items" | "journalEntries" | "suppliers" | "taxRates" | "commerce-companyInfo" | "commerce-customers" | "commerce-disputes" | "commerce-locations" | "commerce-orders" | "commerce-payments" | "commerce-paymentMethods" | "commerce-products" | "commerce-productCategories" | "commerce-taxComponents" | "commerce-transactions"
+# DataType
+
+Available data types
+
+## Example Usage
+
+```typescript
+import { DataType } from "@codat/platform/sdk/models/operations";
+
+let value: DataType = "accountTransactions";
+```
+
+## Values
+
+```typescript
+"accountTransactions" | "balanceSheet" | "bankAccounts" | "bankTransactions" | "billCreditNotes" | "billPayments" | "bills" | "cashFlowStatement" | "chartOfAccounts" | "company" | "creditNotes" | "customers" | "directCosts" | "directIncomes" | "invoices" | "itemReceipts" | "items" | "journalEntries" | "journals" | "paymentMethods" | "payments" | "profitAndLoss" | "purchaseOrders" | "salesOrders" | "suppliers" | "taxRates" | "trackingCategories" | "transfers" | "banking-accountBalances" | "banking-accounts" | "banking-transactionCategories" | "banking-transactions" | "commerce-companyInfo" | "commerce-customers" | "commerce-disputes" | "commerce-locations" | "commerce-orders" | "commerce-paymentMethods" | "commerce-payments" | "commerce-productCategories" | "commerce-products" | "commerce-taxComponents" | "commerce-transactions"
```
\ No newline at end of file
diff --git a/platform/docs/sdk/models/operations/deleteapikeyrequest.md b/platform/docs/sdk/models/operations/deleteapikeyrequest.md
index 1c8d9a20a..a1d870e7a 100644
--- a/platform/docs/sdk/models/operations/deleteapikeyrequest.md
+++ b/platform/docs/sdk/models/operations/deleteapikeyrequest.md
@@ -1,17 +1,17 @@
-# DeleteApiKeyRequest
-
-## Example Usage
-
-```typescript
-import { DeleteApiKeyRequest } from "@codat/platform/sdk/models/operations";
-
-let value: DeleteApiKeyRequest = {
- apiKeyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
+# DeleteApiKeyRequest
+
+## Example Usage
+
+```typescript
+import { DeleteApiKeyRequest } from "@codat/platform/sdk/models/operations";
+
+let value: DeleteApiKeyRequest = {
+ apiKeyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
| `apiKeyId` | *string* | :heavy_check_mark: | Unique identifier for api key. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/operations/deletecompanyrequest.md b/platform/docs/sdk/models/operations/deletecompanyrequest.md
index f156366c8..82d090d1b 100644
--- a/platform/docs/sdk/models/operations/deletecompanyrequest.md
+++ b/platform/docs/sdk/models/operations/deletecompanyrequest.md
@@ -1,17 +1,17 @@
-# DeleteCompanyRequest
-
-## Example Usage
-
-```typescript
-import { DeleteCompanyRequest } from "@codat/platform/sdk/models/operations";
-
-let value: DeleteCompanyRequest = {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
+# DeleteCompanyRequest
+
+## Example Usage
+
+```typescript
+import { DeleteCompanyRequest } from "@codat/platform/sdk/models/operations";
+
+let value: DeleteCompanyRequest = {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/operations/deleteconnectionrequest.md b/platform/docs/sdk/models/operations/deleteconnectionrequest.md
index 9ef310cfe..8fa6f85b2 100644
--- a/platform/docs/sdk/models/operations/deleteconnectionrequest.md
+++ b/platform/docs/sdk/models/operations/deleteconnectionrequest.md
@@ -1,19 +1,19 @@
-# DeleteConnectionRequest
-
-## Example Usage
-
-```typescript
-import { DeleteConnectionRequest } from "@codat/platform/sdk/models/operations";
-
-let value: DeleteConnectionRequest = {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
-| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
+# DeleteConnectionRequest
+
+## Example Usage
+
+```typescript
+import { DeleteConnectionRequest } from "@codat/platform/sdk/models/operations";
+
+let value: DeleteConnectionRequest = {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
+| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
| `connectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/operations/deletewebhookconsumerrequest.md b/platform/docs/sdk/models/operations/deletewebhookconsumerrequest.md
index 178d2dd30..d3874002c 100644
--- a/platform/docs/sdk/models/operations/deletewebhookconsumerrequest.md
+++ b/platform/docs/sdk/models/operations/deletewebhookconsumerrequest.md
@@ -1,17 +1,17 @@
-# DeleteWebhookConsumerRequest
-
-## Example Usage
-
-```typescript
-import { DeleteWebhookConsumerRequest } from "@codat/platform/sdk/models/operations";
-
-let value: DeleteWebhookConsumerRequest = {
- webhookId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- |
+# DeleteWebhookConsumerRequest
+
+## Example Usage
+
+```typescript
+import { DeleteWebhookConsumerRequest } from "@codat/platform/sdk/models/operations";
+
+let value: DeleteWebhookConsumerRequest = {
+ webhookId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- |
| `webhookId` | *string* | :heavy_check_mark: | Unique identifier for the webhook consumer. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/operations/getcompanyaccesstokenrequest.md b/platform/docs/sdk/models/operations/getcompanyaccesstokenrequest.md
index 620ef3ef6..0e398a944 100644
--- a/platform/docs/sdk/models/operations/getcompanyaccesstokenrequest.md
+++ b/platform/docs/sdk/models/operations/getcompanyaccesstokenrequest.md
@@ -1,17 +1,17 @@
-# GetCompanyAccessTokenRequest
-
-## Example Usage
-
-```typescript
-import { GetCompanyAccessTokenRequest } from "@codat/platform/sdk/models/operations";
-
-let value: GetCompanyAccessTokenRequest = {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
+# GetCompanyAccessTokenRequest
+
+## Example Usage
+
+```typescript
+import { GetCompanyAccessTokenRequest } from "@codat/platform/sdk/models/operations";
+
+let value: GetCompanyAccessTokenRequest = {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/operations/getcompanydatastatusrequest.md b/platform/docs/sdk/models/operations/getcompanydatastatusrequest.md
index e9052affa..1a1df1c25 100644
--- a/platform/docs/sdk/models/operations/getcompanydatastatusrequest.md
+++ b/platform/docs/sdk/models/operations/getcompanydatastatusrequest.md
@@ -1,17 +1,17 @@
-# GetCompanyDataStatusRequest
-
-## Example Usage
-
-```typescript
-import { GetCompanyDataStatusRequest } from "@codat/platform/sdk/models/operations";
-
-let value: GetCompanyDataStatusRequest = {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
+# GetCompanyDataStatusRequest
+
+## Example Usage
+
+```typescript
+import { GetCompanyDataStatusRequest } from "@codat/platform/sdk/models/operations";
+
+let value: GetCompanyDataStatusRequest = {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/operations/getcompanypushhistoryrequest.md b/platform/docs/sdk/models/operations/getcompanypushhistoryrequest.md
index 7644238a3..e869a48c0 100644
--- a/platform/docs/sdk/models/operations/getcompanypushhistoryrequest.md
+++ b/platform/docs/sdk/models/operations/getcompanypushhistoryrequest.md
@@ -1,23 +1,23 @@
-# GetCompanyPushHistoryRequest
-
-## Example Usage
-
-```typescript
-import { GetCompanyPushHistoryRequest } from "@codat/platform/sdk/models/operations";
-
-let value: GetCompanyPushHistoryRequest = {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
- orderBy: "-modifiedDate",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
-| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
-| `page` | *number* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 |
-| `pageSize` | *number* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 |
-| `query` | *string* | :heavy_minus_sign: | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). | id=e3334455-1aed-4e71-ab43-6bccf12092ee |
+# GetCompanyPushHistoryRequest
+
+## Example Usage
+
+```typescript
+import { GetCompanyPushHistoryRequest } from "@codat/platform/sdk/models/operations";
+
+let value: GetCompanyPushHistoryRequest = {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
+ orderBy: "-modifiedDate",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
+| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
+| `page` | *number* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 |
+| `pageSize` | *number* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 |
+| `query` | *string* | :heavy_minus_sign: | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). | id=e3334455-1aed-4e71-ab43-6bccf12092ee |
| `orderBy` | *string* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/operations/getcompanyrequest.md b/platform/docs/sdk/models/operations/getcompanyrequest.md
index 641698318..d8eb831b0 100644
--- a/platform/docs/sdk/models/operations/getcompanyrequest.md
+++ b/platform/docs/sdk/models/operations/getcompanyrequest.md
@@ -1,17 +1,17 @@
-# GetCompanyRequest
-
-## Example Usage
-
-```typescript
-import { GetCompanyRequest } from "@codat/platform/sdk/models/operations";
-
-let value: GetCompanyRequest = {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
+# GetCompanyRequest
+
+## Example Usage
+
+```typescript
+import { GetCompanyRequest } from "@codat/platform/sdk/models/operations";
+
+let value: GetCompanyRequest = {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/operations/getcompanysyncsettingsrequest.md b/platform/docs/sdk/models/operations/getcompanysyncsettingsrequest.md
index 4291d93bd..52f6ab266 100644
--- a/platform/docs/sdk/models/operations/getcompanysyncsettingsrequest.md
+++ b/platform/docs/sdk/models/operations/getcompanysyncsettingsrequest.md
@@ -1,17 +1,17 @@
-# GetCompanySyncSettingsRequest
-
-## Example Usage
-
-```typescript
-import { GetCompanySyncSettingsRequest } from "@codat/platform/sdk/models/operations";
-
-let value: GetCompanySyncSettingsRequest = {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
+# GetCompanySyncSettingsRequest
+
+## Example Usage
+
+```typescript
+import { GetCompanySyncSettingsRequest } from "@codat/platform/sdk/models/operations";
+
+let value: GetCompanySyncSettingsRequest = {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/operations/getconnectionmanagementaccesstokenrequest.md b/platform/docs/sdk/models/operations/getconnectionmanagementaccesstokenrequest.md
index cee933bca..9452fd880 100644
--- a/platform/docs/sdk/models/operations/getconnectionmanagementaccesstokenrequest.md
+++ b/platform/docs/sdk/models/operations/getconnectionmanagementaccesstokenrequest.md
@@ -1,17 +1,17 @@
-# GetConnectionManagementAccessTokenRequest
-
-## Example Usage
-
-```typescript
-import { GetConnectionManagementAccessTokenRequest } from "@codat/platform/sdk/models/operations";
-
-let value: GetConnectionManagementAccessTokenRequest = {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
+# GetConnectionManagementAccessTokenRequest
+
+## Example Usage
+
+```typescript
+import { GetConnectionManagementAccessTokenRequest } from "@codat/platform/sdk/models/operations";
+
+let value: GetConnectionManagementAccessTokenRequest = {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/operations/getconnectionrequest.md b/platform/docs/sdk/models/operations/getconnectionrequest.md
index 8cf868420..84b2909de 100644
--- a/platform/docs/sdk/models/operations/getconnectionrequest.md
+++ b/platform/docs/sdk/models/operations/getconnectionrequest.md
@@ -1,19 +1,19 @@
-# GetConnectionRequest
-
-## Example Usage
-
-```typescript
-import { GetConnectionRequest } from "@codat/platform/sdk/models/operations";
-
-let value: GetConnectionRequest = {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
-| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
+# GetConnectionRequest
+
+## Example Usage
+
+```typescript
+import { GetConnectionRequest } from "@codat/platform/sdk/models/operations";
+
+let value: GetConnectionRequest = {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
+| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
| `connectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/operations/getcreateupdatemodeloptionsbydatatyperequest.md b/platform/docs/sdk/models/operations/getcreateupdatemodeloptionsbydatatyperequest.md
index c0d7bc4fa..8f8feed7c 100644
--- a/platform/docs/sdk/models/operations/getcreateupdatemodeloptionsbydatatyperequest.md
+++ b/platform/docs/sdk/models/operations/getcreateupdatemodeloptionsbydatatyperequest.md
@@ -1,21 +1,21 @@
-# GetCreateUpdateModelOptionsByDataTypeRequest
-
-## Example Usage
-
-```typescript
-import { GetCreateUpdateModelOptionsByDataTypeRequest } from "@codat/platform/sdk/models/operations";
-
-let value: GetCreateUpdateModelOptionsByDataTypeRequest = {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
- dataType: "invoices",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
-| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
-| `connectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 |
+# GetCreateUpdateModelOptionsByDataTypeRequest
+
+## Example Usage
+
+```typescript
+import { GetCreateUpdateModelOptionsByDataTypeRequest } from "@codat/platform/sdk/models/operations";
+
+let value: GetCreateUpdateModelOptionsByDataTypeRequest = {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+ dataType: "invoices",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
+| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
+| `connectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 |
| `dataType` | [shared.SchemaDataType](../../../sdk/models/shared/schemadatatype.md) | :heavy_check_mark: | The key of a Codat data type. | invoices |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/operations/getcustomdatatypeconfigurationrequest.md b/platform/docs/sdk/models/operations/getcustomdatatypeconfigurationrequest.md
index 51628b94e..473c58c02 100644
--- a/platform/docs/sdk/models/operations/getcustomdatatypeconfigurationrequest.md
+++ b/platform/docs/sdk/models/operations/getcustomdatatypeconfigurationrequest.md
@@ -1,19 +1,19 @@
-# GetCustomDataTypeConfigurationRequest
-
-## Example Usage
-
-```typescript
-import { GetCustomDataTypeConfigurationRequest } from "@codat/platform/sdk/models/operations";
-
-let value: GetCustomDataTypeConfigurationRequest = {
- platformKey: "gbol",
- customDataIdentifier: "DynamicsPurchaseOrders",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
-| `platformKey` | *string* | :heavy_check_mark: | A unique 4-letter key to represent a platform in each integration. | gbol |
+# GetCustomDataTypeConfigurationRequest
+
+## Example Usage
+
+```typescript
+import { GetCustomDataTypeConfigurationRequest } from "@codat/platform/sdk/models/operations";
+
+let value: GetCustomDataTypeConfigurationRequest = {
+ platformKey: "gbol",
+ customDataIdentifier: "DynamicsPurchaseOrders",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
+| `platformKey` | *string* | :heavy_check_mark: | A unique 4-letter key to represent a platform in each integration. | gbol |
| `customDataIdentifier` | *string* | :heavy_check_mark: | Unique identifier for a custom data type. | DynamicsPurchaseOrders |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/operations/getintegrationrequest.md b/platform/docs/sdk/models/operations/getintegrationrequest.md
index d94506c86..097e2495b 100644
--- a/platform/docs/sdk/models/operations/getintegrationrequest.md
+++ b/platform/docs/sdk/models/operations/getintegrationrequest.md
@@ -1,17 +1,17 @@
-# GetIntegrationRequest
-
-## Example Usage
-
-```typescript
-import { GetIntegrationRequest } from "@codat/platform/sdk/models/operations";
-
-let value: GetIntegrationRequest = {
- platformKey: "gbol",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
+# GetIntegrationRequest
+
+## Example Usage
+
+```typescript
+import { GetIntegrationRequest } from "@codat/platform/sdk/models/operations";
+
+let value: GetIntegrationRequest = {
+ platformKey: "gbol",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| `platformKey` | *string* | :heavy_check_mark: | A unique 4-letter key to represent a platform in each integration. | gbol |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/operations/getintegrationsbrandingrequest.md b/platform/docs/sdk/models/operations/getintegrationsbrandingrequest.md
index 869ecc864..4baa33066 100644
--- a/platform/docs/sdk/models/operations/getintegrationsbrandingrequest.md
+++ b/platform/docs/sdk/models/operations/getintegrationsbrandingrequest.md
@@ -1,17 +1,17 @@
-# GetIntegrationsBrandingRequest
-
-## Example Usage
-
-```typescript
-import { GetIntegrationsBrandingRequest } from "@codat/platform/sdk/models/operations";
-
-let value: GetIntegrationsBrandingRequest = {
- platformKey: "gbol",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
+# GetIntegrationsBrandingRequest
+
+## Example Usage
+
+```typescript
+import { GetIntegrationsBrandingRequest } from "@codat/platform/sdk/models/operations";
+
+let value: GetIntegrationsBrandingRequest = {
+ platformKey: "gbol",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| `platformKey` | *string* | :heavy_check_mark: | A unique 4-letter key to represent a platform in each integration. | gbol |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/operations/getpulloperationrequest.md b/platform/docs/sdk/models/operations/getpulloperationrequest.md
index 23baf909e..2c8dace77 100644
--- a/platform/docs/sdk/models/operations/getpulloperationrequest.md
+++ b/platform/docs/sdk/models/operations/getpulloperationrequest.md
@@ -1,19 +1,18 @@
-# GetPullOperationRequest
-
-## Example Usage
-
-```typescript
-import { GetPullOperationRequest } from "@codat/platform/sdk/models/operations";
-
-let value: GetPullOperationRequest = {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- datasetId: "2e524c49-3726-44e5-9563-576172cc15aa",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
-| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
+# GetPullOperationRequest
+
+## Example Usage
+
+```typescript
+import { GetPullOperationRequest } from "@codat/platform/sdk/models/operations";
+
+let value: GetPullOperationRequest = {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
+| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
| `datasetId` | *string* | :heavy_check_mark: | Unique identifier for the dataset that completed its sync. | |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/operations/getpushoperationrequest.md b/platform/docs/sdk/models/operations/getpushoperationrequest.md
index 1dbda6bc5..7d3677de1 100644
--- a/platform/docs/sdk/models/operations/getpushoperationrequest.md
+++ b/platform/docs/sdk/models/operations/getpushoperationrequest.md
@@ -1,19 +1,18 @@
-# GetPushOperationRequest
-
-## Example Usage
-
-```typescript
-import { GetPushOperationRequest } from "@codat/platform/sdk/models/operations";
-
-let value: GetPushOperationRequest = {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- pushOperationKey: "14a4a880-31a4-4db5-88cb-40c00b392985",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
-| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
+# GetPushOperationRequest
+
+## Example Usage
+
+```typescript
+import { GetPushOperationRequest } from "@codat/platform/sdk/models/operations";
+
+let value: GetPushOperationRequest = {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
+| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
| `pushOperationKey` | *string* | :heavy_check_mark: | Push operation key. | |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/operations/getreadvalidationresultsrequest.md b/platform/docs/sdk/models/operations/getreadvalidationresultsrequest.md
index 5db180c1f..1882f053d 100644
--- a/platform/docs/sdk/models/operations/getreadvalidationresultsrequest.md
+++ b/platform/docs/sdk/models/operations/getreadvalidationresultsrequest.md
@@ -1,19 +1,18 @@
-# GetReadValidationResultsRequest
-
-## Example Usage
-
-```typescript
-import { GetReadValidationResultsRequest } from "@codat/platform/sdk/models/operations";
-
-let value: GetReadValidationResultsRequest = {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- datasetId: "1de8e25b-3163-4226-821d-24f258b2878d",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
-| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
+# GetReadValidationResultsRequest
+
+## Example Usage
+
+```typescript
+import { GetReadValidationResultsRequest } from "@codat/platform/sdk/models/operations";
+
+let value: GetReadValidationResultsRequest = {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
+| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
| `datasetId` | *string* | :heavy_check_mark: | Unique identifier for the dataset that completed its sync. | |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/operations/getsupplementaldataconfigurationrequest.md b/platform/docs/sdk/models/operations/getsupplementaldataconfigurationrequest.md
index eb20d89bf..dd35fdc2c 100644
--- a/platform/docs/sdk/models/operations/getsupplementaldataconfigurationrequest.md
+++ b/platform/docs/sdk/models/operations/getsupplementaldataconfigurationrequest.md
@@ -1,19 +1,19 @@
-# GetSupplementalDataConfigurationRequest
-
-## Example Usage
-
-```typescript
-import { GetSupplementalDataConfigurationRequest } from "@codat/platform/sdk/models/operations";
-
-let value: GetSupplementalDataConfigurationRequest = {
- platformKey: "gbol",
- dataType: "invoices",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
-| `platformKey` | *string* | :heavy_check_mark: | A unique 4-letter key to represent a platform in each integration. | gbol |
+# GetSupplementalDataConfigurationRequest
+
+## Example Usage
+
+```typescript
+import { GetSupplementalDataConfigurationRequest } from "@codat/platform/sdk/models/operations";
+
+let value: GetSupplementalDataConfigurationRequest = {
+ platformKey: "gbol",
+ dataType: "invoices",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
+| `platformKey` | *string* | :heavy_check_mark: | A unique 4-letter key to represent a platform in each integration. | gbol |
| `dataType` | [operations.PathParamDataType](../../../sdk/models/operations/pathparamdatatype.md) | :heavy_check_mark: | Supported supplemental data data type. | invoices |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/operations/listcompaniesrequest.md b/platform/docs/sdk/models/operations/listcompaniesrequest.md
index fe713e6c9..5185a5605 100644
--- a/platform/docs/sdk/models/operations/listcompaniesrequest.md
+++ b/platform/docs/sdk/models/operations/listcompaniesrequest.md
@@ -1,23 +1,23 @@
-# ListCompaniesRequest
-
-## Example Usage
-
-```typescript
-import { ListCompaniesRequest } from "@codat/platform/sdk/models/operations";
-
-let value: ListCompaniesRequest = {
- query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
- orderBy: "-modifiedDate",
- tags: "region=uk && team=invoice-finance",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `page` | *number* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 |
-| `pageSize` | *number* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 |
-| `query` | *string* | :heavy_minus_sign: | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). | id=e3334455-1aed-4e71-ab43-6bccf12092ee |
-| `orderBy` | *string* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate |
+# ListCompaniesRequest
+
+## Example Usage
+
+```typescript
+import { ListCompaniesRequest } from "@codat/platform/sdk/models/operations";
+
+let value: ListCompaniesRequest = {
+ query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
+ orderBy: "-modifiedDate",
+ tags: "region=uk && team=invoice-finance",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `page` | *number* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 |
+| `pageSize` | *number* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 |
+| `query` | *string* | :heavy_minus_sign: | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). | id=e3334455-1aed-4e71-ab43-6bccf12092ee |
+| `orderBy` | *string* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate |
| `tags` | *string* | :heavy_minus_sign: | Filter companies by tags using the "equals" (=), "not equals" (!=), and "contains" (~) operators with [Codat’s query language](https://docs.codat.io/using-the-api/querying). | region=uk && team=invoice-finance |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/operations/listconnectionsrequest.md b/platform/docs/sdk/models/operations/listconnectionsrequest.md
index 2797ca885..b234577eb 100644
--- a/platform/docs/sdk/models/operations/listconnectionsrequest.md
+++ b/platform/docs/sdk/models/operations/listconnectionsrequest.md
@@ -1,23 +1,23 @@
-# ListConnectionsRequest
-
-## Example Usage
-
-```typescript
-import { ListConnectionsRequest } from "@codat/platform/sdk/models/operations";
-
-let value: ListConnectionsRequest = {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
- orderBy: "-modifiedDate",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
-| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
-| `page` | *number* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 |
-| `pageSize` | *number* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 |
-| `query` | *string* | :heavy_minus_sign: | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). | id=e3334455-1aed-4e71-ab43-6bccf12092ee |
+# ListConnectionsRequest
+
+## Example Usage
+
+```typescript
+import { ListConnectionsRequest } from "@codat/platform/sdk/models/operations";
+
+let value: ListConnectionsRequest = {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
+ orderBy: "-modifiedDate",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
+| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
+| `page` | *number* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 |
+| `pageSize` | *number* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 |
+| `query` | *string* | :heavy_minus_sign: | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). | id=e3334455-1aed-4e71-ab43-6bccf12092ee |
| `orderBy` | *string* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/operations/listcustomdatatyperecordsrequest.md b/platform/docs/sdk/models/operations/listcustomdatatyperecordsrequest.md
index 8cd37e0d2..c8311b455 100644
--- a/platform/docs/sdk/models/operations/listcustomdatatyperecordsrequest.md
+++ b/platform/docs/sdk/models/operations/listcustomdatatyperecordsrequest.md
@@ -1,23 +1,23 @@
-# ListCustomDataTypeRecordsRequest
-
-## Example Usage
-
-```typescript
-import { ListCustomDataTypeRecordsRequest } from "@codat/platform/sdk/models/operations";
-
-let value: ListCustomDataTypeRecordsRequest = {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
- customDataIdentifier: "DynamicsPurchaseOrders",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
-| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
-| `connectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 |
-| `customDataIdentifier` | *string* | :heavy_check_mark: | Unique identifier for a custom data type. | DynamicsPurchaseOrders |
-| `page` | *number* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 |
+# ListCustomDataTypeRecordsRequest
+
+## Example Usage
+
+```typescript
+import { ListCustomDataTypeRecordsRequest } from "@codat/platform/sdk/models/operations";
+
+let value: ListCustomDataTypeRecordsRequest = {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+ customDataIdentifier: "DynamicsPurchaseOrders",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
+| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
+| `connectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 |
+| `customDataIdentifier` | *string* | :heavy_check_mark: | Unique identifier for a custom data type. | DynamicsPurchaseOrders |
+| `page` | *number* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 |
| `pageSize` | *number* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/operations/listintegrationsrequest.md b/platform/docs/sdk/models/operations/listintegrationsrequest.md
index 6cd2771d6..044d710ff 100644
--- a/platform/docs/sdk/models/operations/listintegrationsrequest.md
+++ b/platform/docs/sdk/models/operations/listintegrationsrequest.md
@@ -1,21 +1,21 @@
-# ListIntegrationsRequest
-
-## Example Usage
-
-```typescript
-import { ListIntegrationsRequest } from "@codat/platform/sdk/models/operations";
-
-let value: ListIntegrationsRequest = {
- query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
- orderBy: "-modifiedDate",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
-| `page` | *number* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 |
-| `pageSize` | *number* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 |
-| `query` | *string* | :heavy_minus_sign: | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). | id=e3334455-1aed-4e71-ab43-6bccf12092ee |
+# ListIntegrationsRequest
+
+## Example Usage
+
+```typescript
+import { ListIntegrationsRequest } from "@codat/platform/sdk/models/operations";
+
+let value: ListIntegrationsRequest = {
+ query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
+ orderBy: "-modifiedDate",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
+| `page` | *number* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 |
+| `pageSize` | *number* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 |
+| `query` | *string* | :heavy_minus_sign: | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). | id=e3334455-1aed-4e71-ab43-6bccf12092ee |
| `orderBy` | *string* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/operations/listpulloperationsrequest.md b/platform/docs/sdk/models/operations/listpulloperationsrequest.md
index f879acbb7..b0af810de 100644
--- a/platform/docs/sdk/models/operations/listpulloperationsrequest.md
+++ b/platform/docs/sdk/models/operations/listpulloperationsrequest.md
@@ -1,23 +1,23 @@
-# ListPullOperationsRequest
-
-## Example Usage
-
-```typescript
-import { ListPullOperationsRequest } from "@codat/platform/sdk/models/operations";
-
-let value: ListPullOperationsRequest = {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
- orderBy: "-modifiedDate",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
-| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
-| `page` | *number* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 |
-| `pageSize` | *number* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 |
-| `query` | *string* | :heavy_minus_sign: | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). | id=e3334455-1aed-4e71-ab43-6bccf12092ee |
+# ListPullOperationsRequest
+
+## Example Usage
+
+```typescript
+import { ListPullOperationsRequest } from "@codat/platform/sdk/models/operations";
+
+let value: ListPullOperationsRequest = {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
+ orderBy: "-modifiedDate",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
+| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
+| `page` | *number* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 |
+| `pageSize` | *number* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 |
+| `query` | *string* | :heavy_minus_sign: | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). | id=e3334455-1aed-4e71-ab43-6bccf12092ee |
| `orderBy` | *string* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/operations/pathparamdatatype.md b/platform/docs/sdk/models/operations/pathparamdatatype.md
index a5c62e402..695ff1a18 100644
--- a/platform/docs/sdk/models/operations/pathparamdatatype.md
+++ b/platform/docs/sdk/models/operations/pathparamdatatype.md
@@ -1,17 +1,15 @@
-# PathParamDataType
-
-Data types that support supplemental data
-
-## Example Usage
-
-```typescript
-import { PathParamDataType } from "@codat/platform/sdk/models/operations";
-
-let value: PathParamDataType = "invoices";
-```
-
-## Values
-
-```typescript
-"chartOfAccounts" | "bills" | "company" | "creditNotes" | "customers" | "invoices" | "items" | "journalEntries" | "suppliers" | "taxRates" | "commerce-companyInfo" | "commerce-customers" | "commerce-disputes" | "commerce-locations" | "commerce-orders" | "commerce-payments" | "commerce-paymentMethods" | "commerce-products" | "commerce-productCategories" | "commerce-taxComponents" | "commerce-transactions"
+# PathParamDataType
+
+## Example Usage
+
+```typescript
+import { PathParamDataType } from "@codat/platform/sdk/models/operations";
+
+let value: PathParamDataType = "";
+```
+
+## Values
+
+```typescript
+
```
\ No newline at end of file
diff --git a/platform/docs/sdk/models/operations/refreshcompanydatarequest.md b/platform/docs/sdk/models/operations/refreshcompanydatarequest.md
index 1db236eb8..1e7648f65 100644
--- a/platform/docs/sdk/models/operations/refreshcompanydatarequest.md
+++ b/platform/docs/sdk/models/operations/refreshcompanydatarequest.md
@@ -1,17 +1,17 @@
-# RefreshCompanyDataRequest
-
-## Example Usage
-
-```typescript
-import { RefreshCompanyDataRequest } from "@codat/platform/sdk/models/operations";
-
-let value: RefreshCompanyDataRequest = {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
+# RefreshCompanyDataRequest
+
+## Example Usage
+
+```typescript
+import { RefreshCompanyDataRequest } from "@codat/platform/sdk/models/operations";
+
+let value: RefreshCompanyDataRequest = {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/operations/refreshcustomdatatyperequest.md b/platform/docs/sdk/models/operations/refreshcustomdatatyperequest.md
index 64838d679..9845b19ec 100644
--- a/platform/docs/sdk/models/operations/refreshcustomdatatyperequest.md
+++ b/platform/docs/sdk/models/operations/refreshcustomdatatyperequest.md
@@ -1,21 +1,21 @@
-# RefreshCustomDataTypeRequest
-
-## Example Usage
-
-```typescript
-import { RefreshCustomDataTypeRequest } from "@codat/platform/sdk/models/operations";
-
-let value: RefreshCustomDataTypeRequest = {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
- customDataIdentifier: "DynamicsPurchaseOrders",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
-| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
-| `connectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 |
+# RefreshCustomDataTypeRequest
+
+## Example Usage
+
+```typescript
+import { RefreshCustomDataTypeRequest } from "@codat/platform/sdk/models/operations";
+
+let value: RefreshCustomDataTypeRequest = {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+ customDataIdentifier: "DynamicsPurchaseOrders",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
+| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
+| `connectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 |
| `customDataIdentifier` | *string* | :heavy_check_mark: | Unique identifier for a custom data type. | DynamicsPurchaseOrders |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/operations/refreshdatatyperequest.md b/platform/docs/sdk/models/operations/refreshdatatyperequest.md
index db7d28720..7b30935a5 100644
--- a/platform/docs/sdk/models/operations/refreshdatatyperequest.md
+++ b/platform/docs/sdk/models/operations/refreshdatatyperequest.md
@@ -1,20 +1,20 @@
-# RefreshDataTypeRequest
-
-## Example Usage
-
-```typescript
-import { RefreshDataTypeRequest } from "@codat/platform/sdk/models/operations";
-
-let value: RefreshDataTypeRequest = {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- dataType: "invoices",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
-| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
-| `dataType` | [shared.SchemaDataType](../../../sdk/models/shared/schemadatatype.md) | :heavy_check_mark: | The key of a Codat data type. | invoices |
+# RefreshDataTypeRequest
+
+## Example Usage
+
+```typescript
+import { RefreshDataTypeRequest } from "@codat/platform/sdk/models/operations";
+
+let value: RefreshDataTypeRequest = {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ dataType: "invoices",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
+| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
+| `dataType` | [shared.SchemaDataType](../../../sdk/models/shared/schemadatatype.md) | :heavy_check_mark: | The key of a Codat data type. | invoices |
| `connectionId` | *string* | :heavy_minus_sign: | Optionally, provide a data connection id to only queue pull operations on that connection. | |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/operations/refreshproductdatarequest.md b/platform/docs/sdk/models/operations/refreshproductdatarequest.md
index 8bf3e5520..f09b5a276 100644
--- a/platform/docs/sdk/models/operations/refreshproductdatarequest.md
+++ b/platform/docs/sdk/models/operations/refreshproductdatarequest.md
@@ -1,20 +1,20 @@
-# RefreshProductDataRequest
-
-## Example Usage
-
-```typescript
-import { RefreshProductDataRequest } from "@codat/platform/sdk/models/operations";
-
-let value: RefreshProductDataRequest = {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- productIdentifier: "bank-feeds",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
-| `productIdentifier` | *string* | :heavy_check_mark: | Human-readable product identifier for a product. | **Example 1:** bank-feeds
**Example 2:** lending
**Example 3:** payables
**Example 4:** expenses |
+# RefreshProductDataRequest
+
+## Example Usage
+
+```typescript
+import { RefreshProductDataRequest } from "@codat/platform/sdk/models/operations";
+
+let value: RefreshProductDataRequest = {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ productIdentifier: "bank-feeds",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
+| `productIdentifier` | *string* | :heavy_check_mark: | Human-readable product identifier for a product. | **Example 1:** bank-feeds
**Example 2:** lending
**Example 3:** payables
**Example 4:** expenses |
| `requestBody` | [operations.RefreshProductDataRequestBody](../../../sdk/models/operations/refreshproductdatarequestbody.md) | :heavy_minus_sign: | Optionally specify one or more data types to refresh for the given custom product. If omitted, the product's scheduled refresh is triggered as usual. When provided, each data type must be valid for the specified product. | |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/operations/refreshproductdatarequestbody.md b/platform/docs/sdk/models/operations/refreshproductdatarequestbody.md
index 6c390fd3e..ad6add90b 100644
--- a/platform/docs/sdk/models/operations/refreshproductdatarequestbody.md
+++ b/platform/docs/sdk/models/operations/refreshproductdatarequestbody.md
@@ -1,17 +1,17 @@
-# RefreshProductDataRequestBody
-
-Optionally specify one or more data types to refresh for the given custom product. If omitted, the product's scheduled refresh is triggered as usual. When provided, each data type must be valid for the specified product.
-
-## Example Usage
-
-```typescript
-import { RefreshProductDataRequestBody } from "@codat/platform/sdk/models/operations";
-
-let value: RefreshProductDataRequestBody = {};
-```
-
-## Fields
-
-| Field | Type | Required | Description |
-| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- |
+# RefreshProductDataRequestBody
+
+Optionally specify one or more data types to refresh for the given custom product. If omitted, the product's scheduled refresh is triggered as usual. When provided, each data type must be valid for the specified product.
+
+## Example Usage
+
+```typescript
+import { RefreshProductDataRequestBody } from "@codat/platform/sdk/models/operations";
+
+let value: RefreshProductDataRequestBody = {};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- |
| `dataTypes` | *string*[] | :heavy_minus_sign: | One or more data types to refresh for the product. |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/operations/removeproductrequest.md b/platform/docs/sdk/models/operations/removeproductrequest.md
index 33db4566d..bf91f6fd5 100644
--- a/platform/docs/sdk/models/operations/removeproductrequest.md
+++ b/platform/docs/sdk/models/operations/removeproductrequest.md
@@ -1,19 +1,19 @@
-# RemoveProductRequest
-
-## Example Usage
-
-```typescript
-import { RemoveProductRequest } from "@codat/platform/sdk/models/operations";
-
-let value: RemoveProductRequest = {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- productIdentifier: "bank-feeds",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
-| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
+# RemoveProductRequest
+
+## Example Usage
+
+```typescript
+import { RemoveProductRequest } from "@codat/platform/sdk/models/operations";
+
+let value: RemoveProductRequest = {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ productIdentifier: "bank-feeds",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
+| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
| `productIdentifier` | *string* | :heavy_check_mark: | Human-readable product identifier for a product. | **Example 1:** bank-feeds
**Example 2:** lending
**Example 3:** payables
**Example 4:** expenses |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/operations/replacecompanyrequest.md b/platform/docs/sdk/models/operations/replacecompanyrequest.md
index 1b833476e..00a2d3269 100644
--- a/platform/docs/sdk/models/operations/replacecompanyrequest.md
+++ b/platform/docs/sdk/models/operations/replacecompanyrequest.md
@@ -1,18 +1,18 @@
-# ReplaceCompanyRequest
-
-## Example Usage
-
-```typescript
-import { ReplaceCompanyRequest } from "@codat/platform/sdk/models/operations";
-
-let value: ReplaceCompanyRequest = {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
-| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
+# ReplaceCompanyRequest
+
+## Example Usage
+
+```typescript
+import { ReplaceCompanyRequest } from "@codat/platform/sdk/models/operations";
+
+let value: ReplaceCompanyRequest = {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
+| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
| `companyRequestBody` | [shared.CompanyRequestBody](../../../sdk/models/shared/companyrequestbody.md) | :heavy_minus_sign: | N/A | |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/operations/setcompanysyncsettingsrequest.md b/platform/docs/sdk/models/operations/setcompanysyncsettingsrequest.md
index 4d3e26372..0625296fb 100644
--- a/platform/docs/sdk/models/operations/setcompanysyncsettingsrequest.md
+++ b/platform/docs/sdk/models/operations/setcompanysyncsettingsrequest.md
@@ -1,18 +1,18 @@
-# SetCompanySyncSettingsRequest
-
-## Example Usage
-
-```typescript
-import { SetCompanySyncSettingsRequest } from "@codat/platform/sdk/models/operations";
-
-let value: SetCompanySyncSettingsRequest = {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
+# SetCompanySyncSettingsRequest
+
+## Example Usage
+
+```typescript
+import { SetCompanySyncSettingsRequest } from "@codat/platform/sdk/models/operations";
+
+let value: SetCompanySyncSettingsRequest = {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
| `requestBody` | [operations.SetCompanySyncSettingsRequestBody](../../../sdk/models/operations/setcompanysyncsettingsrequestbody.md) | :heavy_minus_sign: | Include a `syncSetting` object for each data type.
`syncFromWindow`, `syncFromUTC` & `monthsToSync` only need to be included if you wish to set a value for them. | |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/operations/setcompanysyncsettingsrequestbody.md b/platform/docs/sdk/models/operations/setcompanysyncsettingsrequestbody.md
index 8604fc1c5..0faef8866 100644
--- a/platform/docs/sdk/models/operations/setcompanysyncsettingsrequestbody.md
+++ b/platform/docs/sdk/models/operations/setcompanysyncsettingsrequestbody.md
@@ -1,34 +1,34 @@
-# SetCompanySyncSettingsRequestBody
-
-Include a `syncSetting` object for each data type.
-`syncFromWindow`, `syncFromUTC` & `monthsToSync` only need to be included if you wish to set a value for them.
-
-## Example Usage
-
-```typescript
-import { SetCompanySyncSettingsRequestBody } from "@codat/platform/sdk/models/operations";
-
-let value: SetCompanySyncSettingsRequestBody = {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- settings: [
- {
- dataType: "invoices",
- fetchOnFirstLink: true,
- syncSchedule: 24,
- syncOrder: 0,
- syncFromUtc: "2020-01-01T12:00:00.000Z",
- syncFromWindow: 24,
- monthsToSync: 24,
- isLocked: true,
- },
- ],
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
-| `companyId` | *string* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
-| `settings` | [shared.SyncSetting](../../../sdk/models/shared/syncsetting.md)[] | :heavy_check_mark: | N/A | |
+# SetCompanySyncSettingsRequestBody
+
+Include a `syncSetting` object for each data type.
+`syncFromWindow`, `syncFromUTC` & `monthsToSync` only need to be included if you wish to set a value for them.
+
+## Example Usage
+
+```typescript
+import { SetCompanySyncSettingsRequestBody } from "@codat/platform/sdk/models/operations";
+
+let value: SetCompanySyncSettingsRequestBody = {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ settings: [
+ {
+ dataType: "invoices",
+ fetchOnFirstLink: true,
+ syncSchedule: 24,
+ syncOrder: 0,
+ syncFromUtc: "2020-01-01T12:00:00.000Z",
+ syncFromWindow: 24,
+ monthsToSync: 24,
+ isLocked: true,
+ },
+ ],
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
+| `companyId` | *string* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
+| `settings` | [shared.SyncSetting](../../../sdk/models/shared/syncsetting.md)[] | :heavy_check_mark: | N/A | |
| `overridesDefaults` | *boolean* | :heavy_minus_sign: | Set to `True` if you want to override default [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings). | |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/operations/unlinkconnectionrequest.md b/platform/docs/sdk/models/operations/unlinkconnectionrequest.md
index acbfdf8e9..c4f316259 100644
--- a/platform/docs/sdk/models/operations/unlinkconnectionrequest.md
+++ b/platform/docs/sdk/models/operations/unlinkconnectionrequest.md
@@ -1,20 +1,20 @@
-# UnlinkConnectionRequest
-
-## Example Usage
-
-```typescript
-import { UnlinkConnectionRequest } from "@codat/platform/sdk/models/operations";
-
-let value: UnlinkConnectionRequest = {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
-| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
-| `connectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 |
+# UnlinkConnectionRequest
+
+## Example Usage
+
+```typescript
+import { UnlinkConnectionRequest } from "@codat/platform/sdk/models/operations";
+
+let value: UnlinkConnectionRequest = {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
+| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
+| `connectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 |
| `updateConnectionStatus` | [shared.UpdateConnectionStatus](../../../sdk/models/shared/updateconnectionstatus.md) | :heavy_minus_sign: | N/A | |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/operations/updatecompanyrequest.md b/platform/docs/sdk/models/operations/updatecompanyrequest.md
index 6e565da9e..653c760e6 100644
--- a/platform/docs/sdk/models/operations/updatecompanyrequest.md
+++ b/platform/docs/sdk/models/operations/updatecompanyrequest.md
@@ -1,18 +1,18 @@
-# UpdateCompanyRequest
-
-## Example Usage
-
-```typescript
-import { UpdateCompanyRequest } from "@codat/platform/sdk/models/operations";
-
-let value: UpdateCompanyRequest = {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
-| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
+# UpdateCompanyRequest
+
+## Example Usage
+
+```typescript
+import { UpdateCompanyRequest } from "@codat/platform/sdk/models/operations";
+
+let value: UpdateCompanyRequest = {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
+| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
| `companyUpdateRequest` | [shared.CompanyUpdateRequest](../../../sdk/models/shared/companyupdaterequest.md) | :heavy_minus_sign: | N/A | |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/operations/updateconnectionauthorizationrequest.md b/platform/docs/sdk/models/operations/updateconnectionauthorizationrequest.md
index 0cf08d05f..9a8398fa3 100644
--- a/platform/docs/sdk/models/operations/updateconnectionauthorizationrequest.md
+++ b/platform/docs/sdk/models/operations/updateconnectionauthorizationrequest.md
@@ -1,20 +1,20 @@
-# UpdateConnectionAuthorizationRequest
-
-## Example Usage
-
-```typescript
-import { UpdateConnectionAuthorizationRequest } from "@codat/platform/sdk/models/operations";
-
-let value: UpdateConnectionAuthorizationRequest = {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
-| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
-| `connectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 |
-| `requestBody` | Record | :heavy_minus_sign: | N/A | |
\ No newline at end of file
+# UpdateConnectionAuthorizationRequest
+
+## Example Usage
+
+```typescript
+import { UpdateConnectionAuthorizationRequest } from "@codat/platform/sdk/models/operations";
+
+let value: UpdateConnectionAuthorizationRequest = {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
+| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
+| `connectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 |
+| `requestBody` | *any* | :heavy_minus_sign: | N/A | |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/operations/updateprofilesyncsettingsrequestbody.md b/platform/docs/sdk/models/operations/updateprofilesyncsettingsrequestbody.md
index 6f716e847..7ea5f0498 100644
--- a/platform/docs/sdk/models/operations/updateprofilesyncsettingsrequestbody.md
+++ b/platform/docs/sdk/models/operations/updateprofilesyncsettingsrequestbody.md
@@ -1,34 +1,34 @@
-# UpdateProfileSyncSettingsRequestBody
-
-Include a `syncSetting` object for each data type.
-`syncFromWindow`, `syncFromUTC` & `monthsToSync` only need to be included if you wish to set a value for them.
-
-## Example Usage
-
-```typescript
-import { UpdateProfileSyncSettingsRequestBody } from "@codat/platform/sdk/models/operations";
-
-let value: UpdateProfileSyncSettingsRequestBody = {
- clientId: "eb0cba37-2d9a-4e1d-b267-f39dcdd04b92",
- settings: [
- {
- dataType: "invoices",
- fetchOnFirstLink: true,
- syncSchedule: 24,
- syncOrder: 0,
- syncFromUtc: "2020-01-01T12:00:00.000Z",
- syncFromWindow: 24,
- monthsToSync: 24,
- isLocked: true,
- },
- ],
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description |
-| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
-| `clientId` | *string* | :heavy_check_mark: | Unique identifier for your client in Codat. |
-| `settings` | [shared.SyncSetting](../../../sdk/models/shared/syncsetting.md)[] | :heavy_check_mark: | N/A |
+# UpdateProfileSyncSettingsRequestBody
+
+Include a `syncSetting` object for each data type.
+`syncFromWindow`, `syncFromUTC` & `monthsToSync` only need to be included if you wish to set a value for them.
+
+## Example Usage
+
+```typescript
+import { UpdateProfileSyncSettingsRequestBody } from "@codat/platform/sdk/models/operations";
+
+let value: UpdateProfileSyncSettingsRequestBody = {
+ clientId: "string",
+ settings: [
+ {
+ dataType: "invoices",
+ fetchOnFirstLink: true,
+ syncSchedule: 24,
+ syncOrder: 0,
+ syncFromUtc: "2020-01-01T12:00:00.000Z",
+ syncFromWindow: 24,
+ monthsToSync: 24,
+ isLocked: true,
+ },
+ ],
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
+| `clientId` | *string* | :heavy_check_mark: | Unique identifier for your client in Codat. |
+| `settings` | [shared.SyncSetting](../../../sdk/models/shared/syncsetting.md)[] | :heavy_check_mark: | N/A |
| `overridesDefaults` | *boolean* | :heavy_minus_sign: | Set to `True` if you want to override default [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings). |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/apikeydetails.md b/platform/docs/sdk/models/shared/apikeydetails.md
index d99ebeb3b..defcd85b4 100644
--- a/platform/docs/sdk/models/shared/apikeydetails.md
+++ b/platform/docs/sdk/models/shared/apikeydetails.md
@@ -1,25 +1,25 @@
-# ApiKeyDetails
-
-Details of the API key.
-
-## Example Usage
-
-```typescript
-import { ApiKeyDetails } from "@codat/platform/sdk/models/shared";
-
-let value: ApiKeyDetails = {
- id: "e288a972-b402-4b21-93f9-b5335ae5679c",
- name: "azure-invoice-finance-processor",
- apiKey: "ztHQGvnC4XN2CgUhaDWEG4ySLUJqWjp7zkbZkGHd",
- createdDate: "2022-10-23T00:00:00Z",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `id` | *string* | :heavy_minus_sign: | Unique identifier for the API key. | e288a972-b402-4b21-93f9-b5335ae5679c |
-| `name` | *string* | :heavy_minus_sign: | A meaningful name assigned to the API key. | azure-invoice-finance-processor |
-| `apiKey` | *string* | :heavy_minus_sign: | The API key value used to make authenticated http requests. | ztHQGvnC4XN2CgUhaDWEG4ySLUJqWjp7zkbZkGHd |
+# ApiKeyDetails
+
+Details of the API key.
+
+## Example Usage
+
+```typescript
+import { ApiKeyDetails } from "@codat/platform/sdk/models/shared";
+
+let value: ApiKeyDetails = {
+ id: "e288a972-b402-4b21-93f9-b5335ae5679c",
+ name: "azure-invoice-finance-processor",
+ apiKey: "ztHQGvnC4XN2CgUhaDWEG4ySLUJqWjp7zkbZkGHd",
+ createdDate: "2022-10-23T00:00:00Z",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `id` | *string* | :heavy_minus_sign: | Unique identifier for the API key. | e288a972-b402-4b21-93f9-b5335ae5679c |
+| `name` | *string* | :heavy_minus_sign: | A meaningful name assigned to the API key. | azure-invoice-finance-processor |
+| `apiKey` | *string* | :heavy_minus_sign: | The API key value used to make authenticated http requests. | ztHQGvnC4XN2CgUhaDWEG4ySLUJqWjp7zkbZkGHd |
| `createdDate` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/apikeys.md b/platform/docs/sdk/models/shared/apikeys.md
index 689ff589d..7f341cd60 100644
--- a/platform/docs/sdk/models/shared/apikeys.md
+++ b/platform/docs/sdk/models/shared/apikeys.md
@@ -1,24 +1,15 @@
-# ApiKeys
-
-## Example Usage
-
-```typescript
-import { ApiKeys } from "@codat/platform/sdk/models/shared";
-
-let value: ApiKeys = {
- results: [
- {
- id: "e288a972-b402-4b21-93f9-b5335ae5679c",
- name: "azure-invoice-finance-processor",
- apiKey: "ztHQGvnC4XN2CgUhaDWEG4ySLUJqWjp7zkbZkGHd",
- createdDate: "2022-10-23T00:00:00Z",
- },
- ],
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description |
-| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
+# ApiKeys
+
+## Example Usage
+
+```typescript
+import { ApiKeys } from "@codat/platform/sdk/models/shared";
+
+let value: ApiKeys = {};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `results` | [shared.ApiKeyDetails](../../../sdk/models/shared/apikeydetails.md)[] | :heavy_minus_sign: | N/A |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/branding.md b/platform/docs/sdk/models/shared/branding.md
index 73e6a62d9..2ab65d0a5 100644
--- a/platform/docs/sdk/models/shared/branding.md
+++ b/platform/docs/sdk/models/shared/branding.md
@@ -1,51 +1,47 @@
-# Branding
-
-## Example Usage
-
-```typescript
-import { Branding } from "@codat/platform/sdk/models/shared";
-
-let value: Branding = {
- logo: {
- full: {
- image: {
- src:
- "https://static.codat.io/public/officialLogos/Full/8A156A5A-39CB-4F9D-856E-76EF9B9A9607.png",
- alt: "xero full icon",
- },
- },
- square: {
- image: {
- src:
- "https://static.codat.io/public/officialLogos/Square/8A156A5A-39CB-4F9D-856E-76EF9B2W3607.png",
- alt: "xero square icon",
- },
- },
- },
- button: {
- default: {
- image: {
- src:
- "https://static.codat.io/public/officialButtons/Full/8A156A5A-39CB-4F9D-856E-76EF9Q7A9607.png",
- alt: "xero default button icon",
- },
- },
- hover: {
- image: {
- src:
- "https://static.codat.io/public/officialLogos/Full/8A156A5A-39CB-4F9D-856E-76EF9B9A9607.png",
- alt: "xero hover button icon",
- },
- },
- },
- sourceId: "35b92968-9851-4095-ad60-395c95cbcba4",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `logo` | [shared.BrandingLogo](../../../sdk/models/shared/brandinglogo.md) | :heavy_minus_sign: | Logo branding references. | |
-| `button` | [shared.BrandingButton](../../../sdk/models/shared/brandingbutton.md) | :heavy_minus_sign: | Button branding references. | |
+# Branding
+
+## Example Usage
+
+```typescript
+import { Branding } from "@codat/platform/sdk/models/shared";
+
+let value: Branding = {
+ logo: {
+ full: {
+ image: {
+ src: "https://static.codat.io/public/officialLogos/Full/8A156A5A-39CB-4F9D-856E-76EF9B9A9607.png",
+ alt: "xero full icon",
+ },
+ },
+ square: {
+ image: {
+ src: "https://static.codat.io/public/officialLogos/Square/8A156A5A-39CB-4F9D-856E-76EF9B2W3607.png",
+ alt: "xero square icon",
+ },
+ },
+ },
+ button: {
+ default: {
+ image: {
+ src: "https://static.codat.io/public/officialButtons/Full/8A156A5A-39CB-4F9D-856E-76EF9Q7A9607.png",
+ alt: "xero default button icon",
+ },
+ },
+ hover: {
+ image: {
+ src: "https://static.codat.io/public/officialLogos/Full/8A156A5A-39CB-4F9D-856E-76EF9B9A9607.png",
+ alt: "xero hover button icon",
+ },
+ },
+ },
+ sourceId: "35b92968-9851-4095-ad60-395c95cbcba4",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `logo` | [shared.BrandingLogo](../../../sdk/models/shared/brandinglogo.md) | :heavy_minus_sign: | Logo branding references. | |
+| `button` | [shared.BrandingButton](../../../sdk/models/shared/brandingbutton.md) | :heavy_minus_sign: | Button branding references. | |
| `sourceId` | *string* | :heavy_minus_sign: | A source-specific ID used to distinguish between different sources originating from the same data connection. In general, a data connection is a single data source. However, for TrueLayer, `sourceId` is associated with a specific bank and has a many-to-one relationship with the `integrationId`. | 35b92968-9851-4095-ad60-395c95cbcba4 |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/brandingbutton.md b/platform/docs/sdk/models/shared/brandingbutton.md
index 6ac2941c0..9ac8bf55d 100644
--- a/platform/docs/sdk/models/shared/brandingbutton.md
+++ b/platform/docs/sdk/models/shared/brandingbutton.md
@@ -1,18 +1,18 @@
-# BrandingButton
-
-Button branding references.
-
-## Example Usage
-
-```typescript
-import { BrandingButton } from "@codat/platform/sdk/models/shared";
-
-let value: BrandingButton = {};
-```
-
-## Fields
-
-| Field | Type | Required | Description |
-| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
-| `default` | [shared.BrandingImage](../../../sdk/models/shared/brandingimage.md) | :heavy_minus_sign: | N/A |
+# BrandingButton
+
+Button branding references.
+
+## Example Usage
+
+```typescript
+import { BrandingButton } from "@codat/platform/sdk/models/shared";
+
+let value: BrandingButton = {};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
+| `default` | [shared.BrandingImage](../../../sdk/models/shared/brandingimage.md) | :heavy_minus_sign: | N/A |
| `hover` | [shared.BrandingImage](../../../sdk/models/shared/brandingimage.md) | :heavy_minus_sign: | N/A |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/brandingimage.md b/platform/docs/sdk/models/shared/brandingimage.md
index 27131e90c..a219bbef1 100644
--- a/platform/docs/sdk/models/shared/brandingimage.md
+++ b/platform/docs/sdk/models/shared/brandingimage.md
@@ -1,15 +1,15 @@
-# BrandingImage
-
-## Example Usage
-
-```typescript
-import { BrandingImage } from "@codat/platform/sdk/models/shared";
-
-let value: BrandingImage = {};
-```
-
-## Fields
-
-| Field | Type | Required | Description |
-| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
+# BrandingImage
+
+## Example Usage
+
+```typescript
+import { BrandingImage } from "@codat/platform/sdk/models/shared";
+
+let value: BrandingImage = {};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `image` | [shared.ImageReference](../../../sdk/models/shared/imagereference.md) | :heavy_minus_sign: | Image reference. |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/brandinglogo.md b/platform/docs/sdk/models/shared/brandinglogo.md
index 25a2446de..4e8a9b05c 100644
--- a/platform/docs/sdk/models/shared/brandinglogo.md
+++ b/platform/docs/sdk/models/shared/brandinglogo.md
@@ -1,18 +1,18 @@
-# BrandingLogo
-
-Logo branding references.
-
-## Example Usage
-
-```typescript
-import { BrandingLogo } from "@codat/platform/sdk/models/shared";
-
-let value: BrandingLogo = {};
-```
-
-## Fields
-
-| Field | Type | Required | Description |
-| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
-| `full` | [shared.BrandingImage](../../../sdk/models/shared/brandingimage.md) | :heavy_minus_sign: | N/A |
+# BrandingLogo
+
+Logo branding references.
+
+## Example Usage
+
+```typescript
+import { BrandingLogo } from "@codat/platform/sdk/models/shared";
+
+let value: BrandingLogo = {};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
+| `full` | [shared.BrandingImage](../../../sdk/models/shared/brandingimage.md) | :heavy_minus_sign: | N/A |
| `square` | [shared.BrandingImage](../../../sdk/models/shared/brandingimage.md) | :heavy_minus_sign: | N/A |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/clientratelimitwebhook.md b/platform/docs/sdk/models/shared/clientratelimitwebhook.md
index ef7ee9b1b..c11fc7d3a 100644
--- a/platform/docs/sdk/models/shared/clientratelimitwebhook.md
+++ b/platform/docs/sdk/models/shared/clientratelimitwebhook.md
@@ -1,25 +1,22 @@
-# ClientRateLimitWebhook
-
-## Example Usage
-
-```typescript
-import { ClientRateLimitWebhook } from "@codat/platform/sdk/models/shared";
-
-let value: ClientRateLimitWebhook = {
- id: "743ec94a-8aa4-44bb-8bd4-e1855ee0e74b",
- eventType: "client.rateLimit.reset",
- generatedDate: "2022-10-23T00:00:00Z",
- payload: {
- expiryDate: "2022-10-23T00:00:00Z",
- },
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `id` | *string* | :heavy_minus_sign: | Unique identifier of the event. | 743ec94a-8aa4-44bb-8bd4-e1855ee0e74b |
-| `eventType` | *string* | :heavy_minus_sign: | The type of event. | **Example 1:** client.rateLimit.reset
**Example 2:** client.rateLimit.reached |
-| `generatedDate` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 |
+# ClientRateLimitWebhook
+
+## Example Usage
+
+```typescript
+import { ClientRateLimitWebhook } from "@codat/platform/sdk/models/shared";
+
+let value: ClientRateLimitWebhook = {
+ id: "743ec94a-8aa4-44bb-8bd4-e1855ee0e74b",
+ eventType: "client.rateLimit.reset",
+ generatedDate: "2022-10-23T00:00:00Z",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `id` | *string* | :heavy_minus_sign: | Unique identifier of the event. | 743ec94a-8aa4-44bb-8bd4-e1855ee0e74b |
+| `eventType` | *string* | :heavy_minus_sign: | The type of event. | **Example 1:** client.rateLimit.reset
**Example 2:** client.rateLimit.reached |
+| `generatedDate` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 |
| `payload` | [shared.ClientRateLimitWebhookPayload](../../../sdk/models/shared/clientratelimitwebhookpayload.md) | :heavy_minus_sign: | N/A | |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/clientratelimitwebhookpayload.md b/platform/docs/sdk/models/shared/clientratelimitwebhookpayload.md
index 7441544a6..52c32c59e 100644
--- a/platform/docs/sdk/models/shared/clientratelimitwebhookpayload.md
+++ b/platform/docs/sdk/models/shared/clientratelimitwebhookpayload.md
@@ -1,19 +1,19 @@
-# ClientRateLimitWebhookPayload
-
-## Example Usage
-
-```typescript
-import { ClientRateLimitWebhookPayload } from "@codat/platform/sdk/models/shared";
-
-let value: ClientRateLimitWebhookPayload = {
- expiryDate: "2022-10-23T00:00:00Z",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `dailyQuota` | *number* | :heavy_minus_sign: | The number of available requests per day. | |
-| `quotaRemaining` | *number* | :heavy_minus_sign: | Total number of requests remaining for your client. | |
+# ClientRateLimitWebhookPayload
+
+## Example Usage
+
+```typescript
+import { ClientRateLimitWebhookPayload } from "@codat/platform/sdk/models/shared";
+
+let value: ClientRateLimitWebhookPayload = {
+ expiryDate: "2022-10-23T00:00:00Z",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `dailyQuota` | *number* | :heavy_minus_sign: | The number of available requests per day. | |
+| `quotaRemaining` | *number* | :heavy_minus_sign: | Total number of requests remaining for your client. | |
| `expiryDate` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/companies.md b/platform/docs/sdk/models/shared/companies.md
index 013469d05..f38782300 100644
--- a/platform/docs/sdk/models/shared/companies.md
+++ b/platform/docs/sdk/models/shared/companies.md
@@ -1,31 +1,23 @@
-# Companies
-
-## Example Usage
-
-```typescript
-import { Companies } from "@codat/platform/sdk/models/shared";
-
-let value: Companies = {
- pageNumber: 1,
- pageSize: 10,
- totalResults: 1,
- links: {
- self: {
- href: "/companies/{id}/data/{dataType}",
- },
- current: {
- href: "/companies/{id}/data/{dataType}?page=1&pageSize=10",
- },
- },
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
-| `results` | [shared.Company](../../../sdk/models/shared/company.md)[] | :heavy_minus_sign: | N/A | |
-| `pageNumber` | *number* | :heavy_check_mark: | Current page number. | |
-| `pageSize` | *number* | :heavy_check_mark: | Number of items to return in results array. | |
-| `totalResults` | *number* | :heavy_check_mark: | Total number of items. | |
-| `links` | [shared.Links](../../../sdk/models/shared/links.md) | :heavy_check_mark: | N/A | {
"self": {
"href": "/companies"
},
"current": {
"href": "/companies?page=1\u0026pageSize=10"
}
} |
\ No newline at end of file
+# Companies
+
+## Example Usage
+
+```typescript
+import { Companies } from "@codat/platform/sdk/models/shared";
+
+let value: Companies = {
+ pageNumber: 0,
+ pageSize: 0,
+ totalResults: 0,
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- |
+| `pageNumber` | *number* | :heavy_check_mark: | Current page number. |
+| `pageSize` | *number* | :heavy_check_mark: | Number of items to return in results array. |
+| `totalResults` | *number* | :heavy_check_mark: | Total number of items. |
+| `links` | [shared.Links](../../../sdk/models/shared/links.md) | :heavy_check_mark: | N/A |
+| `results` | [shared.Company](../../../sdk/models/shared/company.md)[] | :heavy_minus_sign: | N/A |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/company.md b/platform/docs/sdk/models/shared/company.md
index 02fcbcca2..e9325e1fa 100644
--- a/platform/docs/sdk/models/shared/company.md
+++ b/platform/docs/sdk/models/shared/company.md
@@ -1,63 +1,61 @@
-# Company
-
-In Codat, a company represents a business sharing access to their data. Each company can have multiple [connections](https://docs.codat.io/platform-api#/schemas/Connection) to different data sources such as one connection to [Xero](https://docs.codat.io/integrations/accounting/xero/accounting-xero) for accounting data, two connections to [Plaid](https://docs.codat.io/integrations/banking/plaid/banking-plaid) for two bank accounts and a connection to [Zettle](https://docs.codat.io/integrations/commerce/zettle/commerce-zettle) for POS data.
-
-Typically each company is one of your customers.
-
-When you create a company, you can specify a `name` and we will automatically generate a unique `id` for the company. You can also add a `description` to store any additional information about the company.
-
-## Example Usage
-
-```typescript
-import { Company } from "@codat/platform/sdk/models/shared";
-
-let value: Company = {
- id: "0498e921-9b53-4396-a412-4f2f5983b0a2",
- name: "string",
- redirect:
- "https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739",
- lastSync: "2022-01-01T12:00:00.000Z",
- created: "2022-01-01T12:00:00.000Z",
- createdByUserName: "string",
- products: [
- "spend-insights",
- "lending",
- ],
- tags: {
- "region": "us",
- "uid": "f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c",
- },
- dataConnections: [
- {
- id: "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd",
- integrationId: "bf083d72-62c7-493e-aec9-81b4dbba7e2c",
- integrationKey: "dfxm",
- sourceId: "bdd831ce-eebd-4896-89a7-20e5ee8989ee",
- sourceType: "Banking",
- platformName: "Basiq",
- linkUrl:
- "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start",
- status: "Linked",
- lastSync: "2022-10-27T10:22:43.6464237Z",
- created: "2022-10-27T09:53:29Z",
- },
- ],
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `id` | *string* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
-| `name` | *string* | :heavy_check_mark: | The name of the company | Codat Ltd. |
-| `description` | *string* | :heavy_minus_sign: | Additional information about the company. This can be used to store foreign IDs, references, etc. | Requested early access to the new financing scheme. |
-| `redirect` | *string* | :heavy_check_mark: | The `redirect` [Link URL](https://docs.codat.io/auth-flow/authorize-hosted-link) enabling the customer to start their auth flow journey for the company. | https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739 |
-| `lastSync` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 |
-| `created` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 |
-| `createdByUserName` | *string* | :heavy_minus_sign: | Name of user that created the company in Codat. | |
-| `products` | *string*[] | :heavy_minus_sign: | An array of products that are currently enabled for the company. | |
-| `tags` | Record | :heavy_minus_sign: | A collection of user-defined key-value pairs that store custom metadata against the company. | |
-| `referenceParentCompany` | [shared.CompanyReference](../../../sdk/models/shared/companyreference.md) | :heavy_minus_sign: | N/A | |
-| `referenceSubsidiaryCompanies` | [shared.CompanyReference](../../../sdk/models/shared/companyreference.md)[] | :heavy_minus_sign: | A list of subsidiary companies owned or controlled by this entity. Empty if the company has no children. | |
+# Company
+
+In Codat, a company represents a business sharing access to their data. Each company can have multiple [connections](https://docs.codat.io/platform-api#/schemas/Connection) to different data sources such as one connection to [Xero](https://docs.codat.io/integrations/accounting/xero/accounting-xero) for accounting data, two connections to [Plaid](https://docs.codat.io/integrations/banking/plaid/banking-plaid) for two bank accounts and a connection to [Zettle](https://docs.codat.io/integrations/commerce/zettle/commerce-zettle) for POS data.
+
+Typically each company is one of your customers.
+
+When you create a company, you can specify a `name` and we will automatically generate a unique `id` for the company. You can also add a `description` to store any additional information about the company.
+
+## Example Usage
+
+```typescript
+import { Company } from "@codat/platform/sdk/models/shared";
+
+let value: Company = {
+ id: "0498e921-9b53-4396-a412-4f2f5983b0a2",
+ name: "string",
+ redirect: "https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739",
+ lastSync: "2022-01-01T12:00:00.000Z",
+ created: "2022-01-01T12:00:00.000Z",
+ createdByUserName: "string",
+ products: [
+ "spend-insights",
+ "lending",
+ ],
+ tags: {
+ "region": "us",
+ "uid": "f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c",
+ },
+ dataConnections: [
+ {
+ id: "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd",
+ integrationId: "bf083d72-62c7-493e-aec9-81b4dbba7e2c",
+ integrationKey: "dfxm",
+ sourceId: "bdd831ce-eebd-4896-89a7-20e5ee8989ee",
+ sourceType: "Banking",
+ platformName: "Basiq",
+ linkUrl: "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start",
+ status: "Linked",
+ lastSync: "2022-10-27T10:22:43.6464237Z",
+ created: "2022-10-27T09:53:29Z",
+ },
+ ],
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `id` | *string* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
+| `name` | *string* | :heavy_check_mark: | The name of the company | Codat Ltd. |
+| `description` | *string* | :heavy_minus_sign: | Additional information about the company. This can be used to store foreign IDs, references, etc. | Requested early access to the new financing scheme. |
+| `redirect` | *string* | :heavy_check_mark: | The `redirect` [Link URL](https://docs.codat.io/auth-flow/authorize-hosted-link) enabling the customer to start their auth flow journey for the company. | https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739 |
+| `lastSync` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 |
+| `created` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 |
+| `createdByUserName` | *string* | :heavy_minus_sign: | Name of user that created the company in Codat. | |
+| `products` | *string*[] | :heavy_minus_sign: | An array of products that are currently enabled for the company. | |
+| `tags` | Record | :heavy_minus_sign: | A collection of user-defined key-value pairs that store custom metadata against the company. | |
+| `referenceParentCompany` | [shared.CompanyReference](../../../sdk/models/shared/companyreference.md) | :heavy_minus_sign: | The parent entity or controlling organization of this company. Null if the company has no parent. | |
+| `referenceSubsidiaryCompanies` | [shared.CompanyReference](../../../sdk/models/shared/companyreference.md)[] | :heavy_minus_sign: | A list of subsidiary companies owned or controlled by this entity. Empty if the company has no children. | |
| `dataConnections` | [shared.Connection](../../../sdk/models/shared/connection.md)[] | :heavy_minus_sign: | N/A | |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/companyaccesstoken.md b/platform/docs/sdk/models/shared/companyaccesstoken.md
index 411ab1ac5..31853afe7 100644
--- a/platform/docs/sdk/models/shared/companyaccesstoken.md
+++ b/platform/docs/sdk/models/shared/companyaccesstoken.md
@@ -1,23 +1,23 @@
-# CompanyAccessToken
-
-Details of the access token provisioned for a company.
-
-## Example Usage
-
-```typescript
-import { CompanyAccessToken } from "@codat/platform/sdk/models/shared";
-
-let value: CompanyAccessToken = {
- expiresIn: 86400,
- accessToken: "string",
- tokenType: "Bearer",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
-| `expiresIn` | *number* | :heavy_check_mark: | The number of seconds until the access token expires. | 86400 |
-| `accessToken` | *string* | :heavy_check_mark: | The access token for the company. | |
+# CompanyAccessToken
+
+Details of the access token provisioned for a company.
+
+## Example Usage
+
+```typescript
+import { CompanyAccessToken } from "@codat/platform/sdk/models/shared";
+
+let value: CompanyAccessToken = {
+ expiresIn: 86400,
+ accessToken: "string",
+ tokenType: "Bearer",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
+| `expiresIn` | *number* | :heavy_check_mark: | The number of seconds until the access token expires. | 86400 |
+| `accessToken` | *string* | :heavy_check_mark: | The access token for the company. | |
| `tokenType` | *string* | :heavy_check_mark: | The type of token. | Bearer |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/companydetails.md b/platform/docs/sdk/models/shared/companydetails.md
index 68e95c243..fbe114f73 100644
--- a/platform/docs/sdk/models/shared/companydetails.md
+++ b/platform/docs/sdk/models/shared/companydetails.md
@@ -1,45 +1,32 @@
-# CompanyDetails
-
-## Example Usage
-
-```typescript
-import { CompanyDetails } from "@codat/platform/sdk/models/shared";
-
-let value: CompanyDetails = {
- id: "8a210b68-6988-11ed-a1eb-0242ac120002",
- name: "Codat Ltd.",
- description: "Requested early access to the new financing scheme.",
- redirect:
- "https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739",
- lastSync: "2022-10-23T00:00:00Z",
- created: "2022-10-23T00:00:00Z",
- referenceParentCompany: {
- id: "8a210b68-6988-11ed-a1eb-0242ac120002",
- name: "Codat Ltd.",
- description: "Requested early access to the new financing scheme.",
- },
- referenceSubsidiaryCompanies: [
- {
- id: "8a210b68-6988-11ed-a1eb-0242ac120002",
- name: "Codat Ltd.",
- description: "Requested early access to the new financing scheme.",
- },
- ],
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `id` | *string* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
-| `name` | *string* | :heavy_check_mark: | The name of the company | Codat Ltd. |
-| `description` | *string* | :heavy_minus_sign: | Additional information about the company. This can be used to store foreign IDs, references, etc. | Requested early access to the new financing scheme. |
-| `redirect` | *string* | :heavy_check_mark: | The `redirect` [Link URL](https://docs.codat.io/auth-flow/authorize-hosted-link) enabling the customer to start their auth flow journey for the company. | https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739 |
-| `lastSync` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 |
-| `created` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 |
-| `createdByUserName` | *string* | :heavy_minus_sign: | Name of user that created the company in Codat. | |
-| `products` | *string*[] | :heavy_minus_sign: | An array of products that are currently enabled for the company. | |
-| `tags` | Record | :heavy_minus_sign: | A collection of user-defined key-value pairs that store custom metadata against the company. | |
-| `referenceParentCompany` | [shared.CompanyReference](../../../sdk/models/shared/companyreference.md) | :heavy_minus_sign: | N/A | |
+# CompanyDetails
+
+## Example Usage
+
+```typescript
+import { CompanyDetails } from "@codat/platform/sdk/models/shared";
+
+let value: CompanyDetails = {
+ id: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ name: "Codat Ltd.",
+ description: "Requested early access to the new financing scheme.",
+ redirect: "https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739",
+ lastSync: "2022-10-23T00:00:00Z",
+ created: "2022-10-23T00:00:00Z",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `id` | *string* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
+| `name` | *string* | :heavy_check_mark: | The name of the company | Codat Ltd. |
+| `description` | *string* | :heavy_minus_sign: | Additional information about the company. This can be used to store foreign IDs, references, etc. | Requested early access to the new financing scheme. |
+| `redirect` | *string* | :heavy_check_mark: | The `redirect` [Link URL](https://docs.codat.io/auth-flow/authorize-hosted-link) enabling the customer to start their auth flow journey for the company. | https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739 |
+| `lastSync` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 |
+| `created` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 |
+| `createdByUserName` | *string* | :heavy_minus_sign: | Name of user that created the company in Codat. | |
+| `products` | *string*[] | :heavy_minus_sign: | An array of products that are currently enabled for the company. | |
+| `tags` | Record | :heavy_minus_sign: | A collection of user-defined key-value pairs that store custom metadata against the company. | |
+| `referenceParentCompany` | [shared.CompanyReference](../../../sdk/models/shared/companyreference.md) | :heavy_minus_sign: | The parent entity or controlling organization of this company. Null if the company has no parent. | |
| `referenceSubsidiaryCompanies` | [shared.CompanyReference](../../../sdk/models/shared/companyreference.md)[] | :heavy_minus_sign: | A list of subsidiary companies owned or controlled by this entity. Empty if the company has no children. | |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/companyreference.md b/platform/docs/sdk/models/shared/companyreference.md
index dbaa750ce..b458cc158 100644
--- a/platform/docs/sdk/models/shared/companyreference.md
+++ b/platform/docs/sdk/models/shared/companyreference.md
@@ -1,23 +1,23 @@
-# CompanyReference
-
-## Example Usage
-
-```typescript
-import { CompanyReference } from "@codat/platform/sdk/models/shared";
-
-let value: CompanyReference = {
- id: "8a210b68-6988-11ed-a1eb-0242ac120002",
- name: "Codat Ltd.",
- description: "Requested early access to the new financing scheme.",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
-| `id` | *string* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
-| `name` | *string* | :heavy_minus_sign: | The name of the company | Codat Ltd. |
-| `description` | *string* | :heavy_minus_sign: | Additional information about the company. This can be used to store foreign IDs, references, etc. | Requested early access to the new financing scheme. |
-| `links` | [shared.CompanyReferenceLinks](../../../sdk/models/shared/companyreferencelinks.md) | :heavy_minus_sign: | A collection of links for the company. | |
+# CompanyReference
+
+## Example Usage
+
+```typescript
+import { CompanyReference } from "@codat/platform/sdk/models/shared";
+
+let value: CompanyReference = {
+ id: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ name: "Codat Ltd.",
+ description: "Requested early access to the new financing scheme.",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
+| `id` | *string* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
+| `name` | *string* | :heavy_minus_sign: | The name of the company | Codat Ltd. |
+| `description` | *string* | :heavy_minus_sign: | Additional information about the company. This can be used to store foreign IDs, references, etc. | Requested early access to the new financing scheme. |
+| `links` | [shared.CompanyReferenceLinks](../../../sdk/models/shared/companyreferencelinks.md) | :heavy_minus_sign: | A collection of links for the company. | |
| `tags` | Record | :heavy_minus_sign: | A collection of user-defined key-value pairs that store custom metadata against the company. | |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/companyreferencelinks.md b/platform/docs/sdk/models/shared/companyreferencelinks.md
index e9689a8c2..ae8e88477 100644
--- a/platform/docs/sdk/models/shared/companyreferencelinks.md
+++ b/platform/docs/sdk/models/shared/companyreferencelinks.md
@@ -1,17 +1,17 @@
-# CompanyReferenceLinks
-
-A collection of links for the company.
-
-## Example Usage
-
-```typescript
-import { CompanyReferenceLinks } from "@codat/platform/sdk/models/shared";
-
-let value: CompanyReferenceLinks = {};
-```
-
-## Fields
-
-| Field | Type | Required | Description |
-| --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- |
+# CompanyReferenceLinks
+
+A collection of links for the company.
+
+## Example Usage
+
+```typescript
+import { CompanyReferenceLinks } from "@codat/platform/sdk/models/shared";
+
+let value: CompanyReferenceLinks = {};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- |
| `portal` | *string* | :heavy_minus_sign: | Link to the company page in the portal. |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/companyrequestbody.md b/platform/docs/sdk/models/shared/companyrequestbody.md
index d5a14f87c..55c4b2777 100644
--- a/platform/docs/sdk/models/shared/companyrequestbody.md
+++ b/platform/docs/sdk/models/shared/companyrequestbody.md
@@ -1,20 +1,20 @@
-# CompanyRequestBody
-
-## Example Usage
-
-```typescript
-import { CompanyRequestBody } from "@codat/platform/sdk/models/shared";
-
-let value: CompanyRequestBody = {
- name: "Bank of Dave",
- description: "Requested early access to the new financing scheme.",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
-| `name` | *string* | :heavy_check_mark: | Name of company being connected. | Bank of Dave |
-| `description` | *string* | :heavy_minus_sign: | Additional information about the company. This can be used to store foreign IDs, references, etc. | Requested early access to the new financing scheme. |
+# CompanyRequestBody
+
+## Example Usage
+
+```typescript
+import { CompanyRequestBody } from "@codat/platform/sdk/models/shared";
+
+let value: CompanyRequestBody = {
+ name: "Bank of Dave",
+ description: "Requested early access to the new financing scheme.",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
+| `name` | *string* | :heavy_check_mark: | Name of company being connected. | Bank of Dave |
+| `description` | *string* | :heavy_minus_sign: | Additional information about the company. This can be used to store foreign IDs, references, etc. | Requested early access to the new financing scheme. |
| `tags` | Record | :heavy_minus_sign: | A collection of user-defined key-value pairs that store custom metadata against the company. | |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/companysyncsettings.md b/platform/docs/sdk/models/shared/companysyncsettings.md
index 39762790f..bdbdbe555 100644
--- a/platform/docs/sdk/models/shared/companysyncsettings.md
+++ b/platform/docs/sdk/models/shared/companysyncsettings.md
@@ -1,31 +1,19 @@
-# CompanySyncSettings
-
-## Example Usage
-
-```typescript
-import { CompanySyncSettings } from "@codat/platform/sdk/models/shared";
-
-let value: CompanySyncSettings = {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- settings: [
- {
- dataType: "invoices",
- fetchOnFirstLink: true,
- syncSchedule: 24,
- syncOrder: 0,
- syncFromUtc: "2020-01-01T12:00:00.000Z",
- syncFromWindow: 24,
- monthsToSync: 24,
- isLocked: true,
- },
- ],
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
-| `companyId` | *string* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
-| `settings` | [shared.SyncSetting](../../../sdk/models/shared/syncsetting.md)[] | :heavy_minus_sign: | N/A | |
+# CompanySyncSettings
+
+## Example Usage
+
+```typescript
+import { CompanySyncSettings } from "@codat/platform/sdk/models/shared";
+
+let value: CompanySyncSettings = {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
+| `companyId` | *string* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
+| `settings` | [shared.SyncSetting](../../../sdk/models/shared/syncsetting.md)[] | :heavy_minus_sign: | N/A | |
| `overridesDefaults` | *boolean* | :heavy_minus_sign: | Set to `True` if you want to override the default [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings). | |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/companyupdaterequest.md b/platform/docs/sdk/models/shared/companyupdaterequest.md
index 24e3e56cf..8fb751181 100644
--- a/platform/docs/sdk/models/shared/companyupdaterequest.md
+++ b/platform/docs/sdk/models/shared/companyupdaterequest.md
@@ -1,20 +1,20 @@
-# CompanyUpdateRequest
-
-## Example Usage
-
-```typescript
-import { CompanyUpdateRequest } from "@codat/platform/sdk/models/shared";
-
-let value: CompanyUpdateRequest = {
- name: "Bank of Dave",
- description: "Requested early access to the new financing scheme.",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
-| `name` | *string* | :heavy_minus_sign: | Name of company being connected. | Bank of Dave |
-| `description` | *string* | :heavy_minus_sign: | Additional information about the company. This can be used to store foreign IDs, references, etc. | Requested early access to the new financing scheme. |
+# CompanyUpdateRequest
+
+## Example Usage
+
+```typescript
+import { CompanyUpdateRequest } from "@codat/platform/sdk/models/shared";
+
+let value: CompanyUpdateRequest = {
+ name: "Bank of Dave",
+ description: "Requested early access to the new financing scheme.",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
+| `name` | *string* | :heavy_minus_sign: | Name of company being connected. | Bank of Dave |
+| `description` | *string* | :heavy_minus_sign: | Additional information about the company. This can be used to store foreign IDs, references, etc. | Requested early access to the new financing scheme. |
| `tags` | Record | :heavy_minus_sign: | A collection of user-defined key-value pairs that store custom metadata against the company. | |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/companywebhook.md b/platform/docs/sdk/models/shared/companywebhook.md
index 0d565c3cb..1b041005b 100644
--- a/platform/docs/sdk/models/shared/companywebhook.md
+++ b/platform/docs/sdk/models/shared/companywebhook.md
@@ -1,43 +1,22 @@
-# CompanyWebhook
-
-## Example Usage
-
-```typescript
-import { CompanyWebhook } from "@codat/platform/sdk/models/shared";
-
-let value: CompanyWebhook = {
- id: "ba29118f-5406-4e59-b05c-ba307ca38d01",
- eventType: "company.created",
- generatedDate: "2022-10-23T00:00:00Z",
- payload: {
- id: "8a210b68-6988-11ed-a1eb-0242ac120002",
- name: "Codat Ltd.",
- description: "Requested early access to the new financing scheme.",
- redirect:
- "https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739",
- lastSync: "2022-10-23T00:00:00Z",
- created: "2022-10-23T00:00:00Z",
- referenceParentCompany: {
- id: "8a210b68-6988-11ed-a1eb-0242ac120002",
- name: "Codat Ltd.",
- description: "Requested early access to the new financing scheme.",
- },
- referenceSubsidiaryCompanies: [
- {
- id: "8a210b68-6988-11ed-a1eb-0242ac120002",
- name: "Codat Ltd.",
- description: "Requested early access to the new financing scheme.",
- },
- ],
- },
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `id` | *string* | :heavy_minus_sign: | Unique identifier of the event | ba29118f-5406-4e59-b05c-ba307ca38d01 |
-| `eventType` | *string* | :heavy_minus_sign: | The type of event. | **Example 1:** company.created
**Example 2:** company.deleted |
-| `generatedDate` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 |
+# CompanyWebhook
+
+## Example Usage
+
+```typescript
+import { CompanyWebhook } from "@codat/platform/sdk/models/shared";
+
+let value: CompanyWebhook = {
+ id: "ba29118f-5406-4e59-b05c-ba307ca38d01",
+ eventType: "company.created",
+ generatedDate: "2022-10-23T00:00:00Z",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `id` | *string* | :heavy_minus_sign: | Unique identifier of the event | ba29118f-5406-4e59-b05c-ba307ca38d01 |
+| `eventType` | *string* | :heavy_minus_sign: | The type of event. | **Example 1:** company.created
**Example 2:** company.deleted |
+| `generatedDate` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 |
| `payload` | [shared.CompanyDetails](../../../sdk/models/shared/companydetails.md) | :heavy_minus_sign: | N/A | |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/connection.md b/platform/docs/sdk/models/shared/connection.md
index b4fb763af..489a14533 100644
--- a/platform/docs/sdk/models/shared/connection.md
+++ b/platform/docs/sdk/models/shared/connection.md
@@ -1,49 +1,48 @@
-# Connection
-
-A connection represents a [company's](https://docs.codat.io/platform-api#/schemas/Company) connection to a data source and allows you to synchronize data (pull and/or push) with that source.
-
-A company can have multiple data connections depending on the type of data source it is connecting to. For example, a single company can link to:
-
-- [Accounting data](https://docs.codat.io/accounting-api/overview) - 1 active connection.
-- [Banking data](https://docs.codat.io/banking-api/overview) - Multiple active connections.
-- [Commerce data](https://docs.codat.io/commerce-api/overview) - Multiple active connections.
-Any combination of accounting, banking, and commerce data connections is allowed.
-
-Before you can use a data connection to pull or push data, the company must grant you access to their business data by [linking the connection](https://docs.codat.io/auth-flow/overview).
-
-## Example Usage
-
-```typescript
-import { Connection } from "@codat/platform/sdk/models/shared";
-
-let value: Connection = {
- id: "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd",
- integrationId: "bf083d72-62c7-493e-aec9-81b4dbba7e2c",
- integrationKey: "dfxm",
- sourceId: "bdd831ce-eebd-4896-89a7-20e5ee8989ee",
- sourceType: "Banking",
- platformName: "Basiq",
- linkUrl:
- "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start",
- status: "Linked",
- lastSync: "2022-10-27T10:22:43.6464237Z",
- created: "2022-10-27T09:53:29Z",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `id` | *string* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 |
-| `integrationId` | *string* | :heavy_check_mark: | A Codat ID representing the integration. | fd321cb6-7963-4506-b873-e99593a45e30 |
-| `integrationKey` | *string* | :heavy_minus_sign: | A unique four-character ID that identifies the platform of the company's data connection. This ensures continuity if the platform changes its name in the future. | |
-| `sourceId` | *string* | :heavy_check_mark: | A source-specific ID used to distinguish between different sources originating from the same data connection. In general, a data connection is a single data source. However, for TrueLayer, `sourceId` is associated with a specific bank and has a many-to-one relationship with the `integrationId`. | 35b92968-9851-4095-ad60-395c95cbcba4 |
-| `sourceType` | [shared.SourceType](../../../sdk/models/shared/sourcetype.md) | :heavy_check_mark: | The type of platform of the connection. | Accounting |
-| `platformName` | *string* | :heavy_check_mark: | Name of integration connected to company. | |
-| `linkUrl` | *string* | :heavy_check_mark: | The link URL your customers can use to authorize access to their business application. | https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/2e2eb431-c1fa-4dc9-93fa-d29781c12bcd/start |
-| `status` | [shared.DataConnectionStatus](../../../sdk/models/shared/dataconnectionstatus.md) | :heavy_check_mark: | The current authorization status of the data connection. | |
-| `lastSync` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 |
-| `created` | *string* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 |
-| `dataConnectionErrors` | [shared.DataConnectionError](../../../sdk/models/shared/dataconnectionerror.md)[] | :heavy_minus_sign: | N/A | |
+# Connection
+
+A connection represents a [company's](https://docs.codat.io/platform-api#/schemas/Company) connection to a data source and allows you to synchronize data (pull and/or push) with that source.
+
+A company can have multiple data connections depending on the type of data source it is connecting to. For example, a single company can link to:
+
+- [Accounting data](https://docs.codat.io/accounting-api/overview) - 1 active connection.
+- [Banking data](https://docs.codat.io/banking-api/overview) - Multiple active connections.
+- [Commerce data](https://docs.codat.io/commerce-api/overview) - Multiple active connections.
+Any combination of accounting, banking, and commerce data connections is allowed.
+
+Before you can use a data connection to pull or push data, the company must grant you access to their business data by [linking the connection](https://docs.codat.io/auth-flow/overview).
+
+## Example Usage
+
+```typescript
+import { Connection } from "@codat/platform/sdk/models/shared";
+
+let value: Connection = {
+ id: "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd",
+ integrationId: "bf083d72-62c7-493e-aec9-81b4dbba7e2c",
+ integrationKey: "dfxm",
+ sourceId: "bdd831ce-eebd-4896-89a7-20e5ee8989ee",
+ sourceType: "Banking",
+ platformName: "Basiq",
+ linkUrl: "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start",
+ status: "Linked",
+ lastSync: "2022-10-27T10:22:43.6464237Z",
+ created: "2022-10-27T09:53:29Z",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `id` | *string* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 |
+| `integrationId` | *string* | :heavy_check_mark: | A Codat ID representing the integration. | fd321cb6-7963-4506-b873-e99593a45e30 |
+| `integrationKey` | *string* | :heavy_minus_sign: | A unique four-character ID that identifies the platform of the company's data connection. This ensures continuity if the platform changes its name in the future. | |
+| `sourceId` | *string* | :heavy_check_mark: | A source-specific ID used to distinguish between different sources originating from the same data connection. In general, a data connection is a single data source. However, for TrueLayer, `sourceId` is associated with a specific bank and has a many-to-one relationship with the `integrationId`. | 35b92968-9851-4095-ad60-395c95cbcba4 |
+| `sourceType` | [shared.SourceType](../../../sdk/models/shared/sourcetype.md) | :heavy_check_mark: | The type of platform of the connection. | Accounting |
+| `platformName` | *string* | :heavy_check_mark: | Name of integration connected to company. | |
+| `linkUrl` | *string* | :heavy_check_mark: | The link URL your customers can use to authorize access to their business application. | https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/2e2eb431-c1fa-4dc9-93fa-d29781c12bcd/start |
+| `status` | [shared.DataConnectionStatus](../../../sdk/models/shared/dataconnectionstatus.md) | :heavy_check_mark: | The current authorization status of the data connection. | |
+| `lastSync` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 |
+| `created` | *string* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 |
+| `dataConnectionErrors` | [shared.DataConnectionError](../../../sdk/models/shared/dataconnectionerror.md)[] | :heavy_minus_sign: | N/A | |
| `connectionInfo` | Record | :heavy_minus_sign: | N/A | |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/connectionmanagementaccesstoken.md b/platform/docs/sdk/models/shared/connectionmanagementaccesstoken.md
index a9b78e98d..218a55b2a 100644
--- a/platform/docs/sdk/models/shared/connectionmanagementaccesstoken.md
+++ b/platform/docs/sdk/models/shared/connectionmanagementaccesstoken.md
@@ -1,18 +1,17 @@
-# ConnectionManagementAccessToken
-
-## Example Usage
-
-```typescript
-import { ConnectionManagementAccessToken } from "@codat/platform/sdk/models/shared";
-
-let value: ConnectionManagementAccessToken = {
- accessToken:
- "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
+# ConnectionManagementAccessToken
+
+## Example Usage
+
+```typescript
+import { ConnectionManagementAccessToken } from "@codat/platform/sdk/models/shared";
+
+let value: ConnectionManagementAccessToken = {
+ accessToken: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `accessToken` | *string* | :heavy_minus_sign: | Access token that allows SMBs to manage connections that have access to their data. | eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/connectionmanagementallowedorigins.md b/platform/docs/sdk/models/shared/connectionmanagementallowedorigins.md
index b0d9b8c4e..bd8fb3f72 100644
--- a/platform/docs/sdk/models/shared/connectionmanagementallowedorigins.md
+++ b/platform/docs/sdk/models/shared/connectionmanagementallowedorigins.md
@@ -1,21 +1,19 @@
-# ConnectionManagementAllowedOrigins
-
-Success
-
-## Example Usage
-
-```typescript
-import { ConnectionManagementAllowedOrigins } from "@codat/platform/sdk/models/shared";
-
-let value: ConnectionManagementAllowedOrigins = {
- allowedOrigins: [
- "https://www.bank-of-dave.com",
- ],
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+# ConnectionManagementAllowedOrigins
+
+## Example Usage
+
+```typescript
+import { ConnectionManagementAllowedOrigins } from "@codat/platform/sdk/models/shared";
+
+let value: ConnectionManagementAllowedOrigins = {
+ allowedOrigins: [
+ "https://www.bank-of-dave.com",
+ ],
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `allowedOrigins` | *string*[] | :heavy_minus_sign: | An array of allowed origins (i.e. your domains) to permit cross-origin resource sharing ([CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing)).n resource sharing ([CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing)). |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/connections.md b/platform/docs/sdk/models/shared/connections.md
index e6ab70132..f76caa488 100644
--- a/platform/docs/sdk/models/shared/connections.md
+++ b/platform/docs/sdk/models/shared/connections.md
@@ -1,31 +1,23 @@
-# Connections
-
-## Example Usage
-
-```typescript
-import { Connections } from "@codat/platform/sdk/models/shared";
-
-let value: Connections = {
- pageNumber: 1,
- pageSize: 10,
- totalResults: 1,
- links: {
- self: {
- href: "/companies/{id}/data/{dataType}",
- },
- current: {
- href: "/companies/{id}/data/{dataType}?page=1&pageSize=10",
- },
- },
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
-| `results` | [shared.Connection](../../../sdk/models/shared/connection.md)[] | :heavy_minus_sign: | N/A | |
-| `pageNumber` | *number* | :heavy_check_mark: | Current page number. | |
-| `pageSize` | *number* | :heavy_check_mark: | Number of items to return in results array. | |
-| `totalResults` | *number* | :heavy_check_mark: | Total number of items. | |
-| `links` | [shared.Links](../../../sdk/models/shared/links.md) | :heavy_check_mark: | N/A | {
"self": {
"href": "/companies"
},
"current": {
"href": "/companies?page=1\u0026pageSize=10"
}
} |
\ No newline at end of file
+# Connections
+
+## Example Usage
+
+```typescript
+import { Connections } from "@codat/platform/sdk/models/shared";
+
+let value: Connections = {
+ pageNumber: 0,
+ pageSize: 0,
+ totalResults: 0,
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
+| `pageNumber` | *number* | :heavy_check_mark: | Current page number. |
+| `pageSize` | *number* | :heavy_check_mark: | Number of items to return in results array. |
+| `totalResults` | *number* | :heavy_check_mark: | Total number of items. |
+| `links` | [shared.Links](../../../sdk/models/shared/links.md) | :heavy_check_mark: | N/A |
+| `results` | [shared.Connection](../../../sdk/models/shared/connection.md)[] | :heavy_minus_sign: | N/A |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/connectionwebhook.md b/platform/docs/sdk/models/shared/connectionwebhook.md
index 520672a23..34623ecf8 100644
--- a/platform/docs/sdk/models/shared/connectionwebhook.md
+++ b/platform/docs/sdk/models/shared/connectionwebhook.md
@@ -1,42 +1,22 @@
-# ConnectionWebhook
-
-## Example Usage
-
-```typescript
-import { ConnectionWebhook } from "@codat/platform/sdk/models/shared";
-
-let value: ConnectionWebhook = {
- id: "ba29118f-5406-4e59-b05c-ba307ca38d01",
- eventType: "connection.created",
- generatedDate: "2022-10-23T00:00:00Z",
- payload: {
- referenceCompany: {
- id: "8a210b68-6988-11ed-a1eb-0242ac120002",
- name: "Codat Ltd.",
- description: "Requested early access to the new financing scheme.",
- },
- connection: {
- id: "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd",
- integrationId: "bf083d72-62c7-493e-aec9-81b4dbba7e2c",
- integrationKey: "dfxm",
- sourceId: "bdd831ce-eebd-4896-89a7-20e5ee8989ee",
- sourceType: "Banking",
- platformName: "Basiq",
- linkUrl:
- "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start",
- status: "Linked",
- lastSync: "2022-10-27T10:22:43.6464237Z",
- created: "2022-10-27T09:53:29Z",
- },
- },
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `id` | *string* | :heavy_minus_sign: | Unique identifier of the event. | ba29118f-5406-4e59-b05c-ba307ca38d01 |
-| `eventType` | *string* | :heavy_minus_sign: | The type of event. | **Example 1:** connection.created
**Example 2:** connection.connected
**Example 3:** connection.disconnected
**Example 4:** connection.reconnected
**Example 5:** connection.deleted
**Example 6:** connection.failed |
-| `generatedDate` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 |
+# ConnectionWebhook
+
+## Example Usage
+
+```typescript
+import { ConnectionWebhook } from "@codat/platform/sdk/models/shared";
+
+let value: ConnectionWebhook = {
+ id: "ba29118f-5406-4e59-b05c-ba307ca38d01",
+ eventType: "connection.created",
+ generatedDate: "2022-10-23T00:00:00Z",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `id` | *string* | :heavy_minus_sign: | Unique identifier of the event. | ba29118f-5406-4e59-b05c-ba307ca38d01 |
+| `eventType` | *string* | :heavy_minus_sign: | The type of event. | **Example 1:** connection.created
**Example 2:** connection.connected
**Example 3:** connection.disconnected
**Example 4:** connection.reconnected
**Example 5:** connection.deleted
**Example 6:** connection.failed |
+| `generatedDate` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 |
| `payload` | [shared.ConnectionWebhookPayload](../../../sdk/models/shared/connectionwebhookpayload.md) | :heavy_minus_sign: | N/A | |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/connectionwebhookpayload.md b/platform/docs/sdk/models/shared/connectionwebhookpayload.md
index 687c1c7ce..09fdb039b 100644
--- a/platform/docs/sdk/models/shared/connectionwebhookpayload.md
+++ b/platform/docs/sdk/models/shared/connectionwebhookpayload.md
@@ -1,35 +1,29 @@
-# ConnectionWebhookPayload
-
-## Example Usage
-
-```typescript
-import { ConnectionWebhookPayload } from "@codat/platform/sdk/models/shared";
-
-let value: ConnectionWebhookPayload = {
- referenceCompany: {
- id: "8a210b68-6988-11ed-a1eb-0242ac120002",
- name: "Codat Ltd.",
- description: "Requested early access to the new financing scheme.",
- },
- connection: {
- id: "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd",
- integrationId: "bf083d72-62c7-493e-aec9-81b4dbba7e2c",
- integrationKey: "dfxm",
- sourceId: "bdd831ce-eebd-4896-89a7-20e5ee8989ee",
- sourceType: "Banking",
- platformName: "Basiq",
- linkUrl:
- "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start",
- status: "Linked",
- lastSync: "2022-10-27T10:22:43.6464237Z",
- created: "2022-10-27T09:53:29Z",
- },
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `referenceCompany` | [shared.CompanyReference](../../../sdk/models/shared/companyreference.md) | :heavy_minus_sign: | N/A | |
+# ConnectionWebhookPayload
+
+## Example Usage
+
+```typescript
+import { ConnectionWebhookPayload } from "@codat/platform/sdk/models/shared";
+
+let value: ConnectionWebhookPayload = {
+ connection: {
+ id: "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd",
+ integrationId: "bf083d72-62c7-493e-aec9-81b4dbba7e2c",
+ integrationKey: "dfxm",
+ sourceId: "bdd831ce-eebd-4896-89a7-20e5ee8989ee",
+ sourceType: "Banking",
+ platformName: "Basiq",
+ linkUrl: "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start",
+ status: "Linked",
+ lastSync: "2022-10-27T10:22:43.6464237Z",
+ created: "2022-10-27T09:53:29Z",
+ },
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `referenceCompany` | [shared.CompanyReference](../../../sdk/models/shared/companyreference.md) | :heavy_minus_sign: | N/A | |
| `connection` | [shared.Connection](../../../sdk/models/shared/connection.md) | :heavy_minus_sign: | A connection represents a [company's](https://docs.codat.io/platform-api#/schemas/Company) connection to a data source and allows you to synchronize data (pull and/or push) with that source.
A company can have multiple data connections depending on the type of data source it is connecting to. For example, a single company can link to:
- [Accounting data](https://docs.codat.io/accounting-api/overview) - 1 active connection.
- [Banking data](https://docs.codat.io/banking-api/overview) - Multiple active connections.
- [Commerce data](https://docs.codat.io/commerce-api/overview) - Multiple active connections.
Any combination of accounting, banking, and commerce data connections is allowed.
Before you can use a data connection to pull or push data, the company must grant you access to their business data by [linking the connection](https://docs.codat.io/auth-flow/overview). | {
"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd",
"integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c",
"integrationKey": "dfxm",
"sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee",
"platformName": "Basiq",
"linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start",
"status": "Linked",
"lastSync": "2022-10-27T10:22:43.6464237Z",
"created": "2022-10-27T09:53:29Z",
"sourceType": "Banking"
} |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/content.md b/platform/docs/sdk/models/shared/content.md
index 3e7b1bfc5..b40722c43 100644
--- a/platform/docs/sdk/models/shared/content.md
+++ b/platform/docs/sdk/models/shared/content.md
@@ -1,14 +1,14 @@
-# Content
-
-## Example Usage
-
-```typescript
-import { Content } from "@codat/platform/sdk/models/shared";
-
-let value: Content = {};
-```
-
-## Fields
-
-| Field | Type | Required | Description |
+# Content
+
+## Example Usage
+
+```typescript
+import { Content } from "@codat/platform/sdk/models/shared";
+
+let value: Content = {};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/createapikey.md b/platform/docs/sdk/models/shared/createapikey.md
index c0d0681cf..af2c52cd0 100644
--- a/platform/docs/sdk/models/shared/createapikey.md
+++ b/platform/docs/sdk/models/shared/createapikey.md
@@ -1,19 +1,19 @@
-# CreateApiKey
-
-Details about the newly created API key.
-
-## Example Usage
-
-```typescript
-import { CreateApiKey } from "@codat/platform/sdk/models/shared";
-
-let value: CreateApiKey = {
- name: "azure-invoice-finance-processor",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
+# CreateApiKey
+
+Details about the newly created API key.
+
+## Example Usage
+
+```typescript
+import { CreateApiKey } from "@codat/platform/sdk/models/shared";
+
+let value: CreateApiKey = {
+ name: "azure-invoice-finance-processor",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
| `name` | *string* | :heavy_minus_sign: | A meaningful name assigned to the API key. | azure-invoice-finance-processor |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/customdatatypeconfiguration.md b/platform/docs/sdk/models/shared/customdatatypeconfiguration.md
index 614eb3e83..9fdd4a521 100644
--- a/platform/docs/sdk/models/shared/customdatatypeconfiguration.md
+++ b/platform/docs/sdk/models/shared/customdatatypeconfiguration.md
@@ -1,37 +1,37 @@
-# CustomDataTypeConfiguration
-
-Client's configuration details for a specific custom data type and platform pair.
-
-## Example Usage
-
-```typescript
-import { CustomDataTypeConfiguration } from "@codat/platform/sdk/models/shared";
-
-let value: CustomDataTypeConfiguration = {
- dataSource: "api/purchaseOrders?$filter=currencyCode eq 'NOK'",
- requiredData: {
- "currencyCode": "$[*].currencyCode",
- "id": "$[*].id",
- "number": "$[*].number",
- "orderDate": "$[*].orderDate",
- "totalAmountExcludingTax": "$[*].totalAmountExcludingTax",
- "totalTaxAmount": "$[*].totalTaxAmount",
- "vendorName": "$[*].number",
- },
- keyBy: [
- "$[*].id",
- ],
- sourceModifiedDate: [
- "$[*].lastModifiedDateTime",
- ],
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `dataSource` | *string* | :heavy_minus_sign: | Underlying endpoint of the source platform that will serve as a data source for the custom data type. This value is not validated by Codat. |
-| `requiredData` | Record | :heavy_minus_sign: | Properties required to be fetched from the underlying platform for the custom data type that is being configured. This value is not validated by Codat. |
-| `keyBy` | *string*[] | :heavy_minus_sign: | An array of properties from the source system that can be used to uniquely identify the records returned for the custom data type. This value is not validated by Codat. |
+# CustomDataTypeConfiguration
+
+Client's configuration details for a specific custom data type and platform pair.
+
+## Example Usage
+
+```typescript
+import { CustomDataTypeConfiguration } from "@codat/platform/sdk/models/shared";
+
+let value: CustomDataTypeConfiguration = {
+ dataSource: "api/purchaseOrders?$filter=currencyCode eq 'NOK'",
+ requiredData: {
+ "currencyCode": "$[*].currencyCode",
+ "id": "$[*].id",
+ "number": "$[*].number",
+ "orderDate": "$[*].orderDate",
+ "totalAmountExcludingTax": "$[*].totalAmountExcludingTax",
+ "totalTaxAmount": "$[*].totalTaxAmount",
+ "vendorName": "$[*].number",
+ },
+ keyBy: [
+ "$[*].id",
+ ],
+ sourceModifiedDate: [
+ "$[*].lastModifiedDateTime",
+ ],
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `dataSource` | *string* | :heavy_minus_sign: | Underlying endpoint of the source platform that will serve as a data source for the custom data type. This value is not validated by Codat. |
+| `requiredData` | Record | :heavy_minus_sign: | Properties required to be fetched from the underlying platform for the custom data type that is being configured. This value is not validated by Codat. |
+| `keyBy` | *string*[] | :heavy_minus_sign: | An array of properties from the source system that can be used to uniquely identify the records returned for the custom data type. This value is not validated by Codat. |
| `sourceModifiedDate` | *string*[] | :heavy_minus_sign: | Property in the source platform nominated by the client that defines the date when a record was last modified there. This value is not validated by Codat. |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/customdatatyperecord.md b/platform/docs/sdk/models/shared/customdatatyperecord.md
index 83a43afdf..c38d79270 100644
--- a/platform/docs/sdk/models/shared/customdatatyperecord.md
+++ b/platform/docs/sdk/models/shared/customdatatyperecord.md
@@ -1,21 +1,17 @@
-# CustomDataTypeRecord
-
-## Example Usage
-
-```typescript
-import { CustomDataTypeRecord } from "@codat/platform/sdk/models/shared";
-
-let value: CustomDataTypeRecord = {
- modifiedDate: {
- modifiedDate: "2022-10-23T00:00:00Z",
- },
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description |
-| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
-| `id` | *string* | :heavy_minus_sign: | Unique identifier of the record. |
-| `content` | Record | :heavy_minus_sign: | Values from the source system for the properties defined in the custom data type configuration. |
+# CustomDataTypeRecord
+
+## Example Usage
+
+```typescript
+import { CustomDataTypeRecord } from "@codat/platform/sdk/models/shared";
+
+let value: CustomDataTypeRecord = {};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
+| `id` | *string* | :heavy_minus_sign: | Unique identifier of the record. |
+| `content` | Record | :heavy_minus_sign: | Values from the source system for the properties defined in the custom data type configuration. |
| `modifiedDate` | [shared.ModifiedDate](../../../sdk/models/shared/modifieddate.md) | :heavy_minus_sign: | N/A |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/customdatatyperecords.md b/platform/docs/sdk/models/shared/customdatatyperecords.md
index 931a6ae0e..d05b991ff 100644
--- a/platform/docs/sdk/models/shared/customdatatyperecords.md
+++ b/platform/docs/sdk/models/shared/customdatatyperecords.md
@@ -1,28 +1,20 @@
-# CustomDataTypeRecords
-
-Resulting records pulled from the source platform for a specific custom data type.
-
-## Example Usage
-
-```typescript
-import { CustomDataTypeRecords } from "@codat/platform/sdk/models/shared";
-
-let value: CustomDataTypeRecords = {
- results: [
- {
- modifiedDate: {
- modifiedDate: "2022-10-23T00:00:00Z",
- },
- },
- ],
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description |
-| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
-| `results` | [shared.CustomDataTypeRecord](../../../sdk/models/shared/customdatatyperecord.md)[] | :heavy_minus_sign: | N/A |
-| `pageNumber` | *number* | :heavy_minus_sign: | Current page number. |
-| `pageSize` | *number* | :heavy_minus_sign: | Number of items to return in results array. |
+# CustomDataTypeRecords
+
+Resulting records pulled from the source platform for a specific custom data type.
+
+## Example Usage
+
+```typescript
+import { CustomDataTypeRecords } from "@codat/platform/sdk/models/shared";
+
+let value: CustomDataTypeRecords = {};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
+| `results` | [shared.CustomDataTypeRecord](../../../sdk/models/shared/customdatatyperecord.md)[] | :heavy_minus_sign: | N/A |
+| `pageNumber` | *number* | :heavy_minus_sign: | Current page number. |
+| `pageSize` | *number* | :heavy_minus_sign: | Number of items to return in results array. |
| `totalResults` | *number* | :heavy_minus_sign: | Total number of items. |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/dataconnectionerror.md b/platform/docs/sdk/models/shared/dataconnectionerror.md
index dd554f4ee..22f6071d1 100644
--- a/platform/docs/sdk/models/shared/dataconnectionerror.md
+++ b/platform/docs/sdk/models/shared/dataconnectionerror.md
@@ -1,23 +1,23 @@
-# DataConnectionError
-
-## Example Usage
-
-```typescript
-import { DataConnectionError } from "@codat/platform/sdk/models/shared";
-
-let value: DataConnectionError = {
- erroredOnUtc: "2022-10-23T00:00:00Z",
- resolvedOnUtc: "2022-10-23T00:00:00Z",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `statusCode` | *string* | :heavy_minus_sign: | The HTTP status code returned by the source platform when the error occurred. | |
-| `statusText` | *string* | :heavy_minus_sign: | A non-numeric status code/text returned by the source platform when the error occurred. | |
-| `errorMessage` | *string* | :heavy_minus_sign: | A message about a error returned by Codat. | |
-| `erroredOnUtc` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 |
-| `status` | [shared.ErrorStatus](../../../sdk/models/shared/errorstatus.md) | :heavy_minus_sign: | The current status of a transient error. Null statuses indicate that the error is not transient. | |
+# DataConnectionError
+
+## Example Usage
+
+```typescript
+import { DataConnectionError } from "@codat/platform/sdk/models/shared";
+
+let value: DataConnectionError = {
+ erroredOnUtc: "2022-10-23T00:00:00Z",
+ resolvedOnUtc: "2022-10-23T00:00:00Z",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `statusCode` | *string* | :heavy_minus_sign: | The HTTP status code returned by the source platform when the error occurred. | |
+| `statusText` | *string* | :heavy_minus_sign: | A non-numeric status code/text returned by the source platform when the error occurred. | |
+| `errorMessage` | *string* | :heavy_minus_sign: | A message about a error returned by Codat. | |
+| `erroredOnUtc` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 |
+| `status` | [shared.ErrorStatus](../../../sdk/models/shared/errorstatus.md) | :heavy_minus_sign: | The current status of a transient error. Null statuses indicate that the error is not transient. | |
| `resolvedOnUtc` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/dataconnectionstatus.md b/platform/docs/sdk/models/shared/dataconnectionstatus.md
index 85c311a38..e8da66bd4 100644
--- a/platform/docs/sdk/models/shared/dataconnectionstatus.md
+++ b/platform/docs/sdk/models/shared/dataconnectionstatus.md
@@ -1,17 +1,17 @@
-# DataConnectionStatus
-
-The current authorization status of the data connection.
-
-## Example Usage
-
-```typescript
-import { DataConnectionStatus } from "@codat/platform/sdk/models/shared";
-
-let value: DataConnectionStatus = "Deauthorized";
-```
-
-## Values
-
-```typescript
-"PendingAuth" | "Linked" | "Unlinked" | "Deauthorized"
+# DataConnectionStatus
+
+The current authorization status of the data connection.
+
+## Example Usage
+
+```typescript
+import { DataConnectionStatus } from "@codat/platform/sdk/models/shared";
+
+let value: DataConnectionStatus = "PendingAuth";
+```
+
+## Values
+
+```typescript
+"PendingAuth" | "Linked" | "Unlinked" | "Deauthorized"
```
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/datasetstatus.md b/platform/docs/sdk/models/shared/datasetstatus.md
index 13df9de5d..6ca6ad7ea 100644
--- a/platform/docs/sdk/models/shared/datasetstatus.md
+++ b/platform/docs/sdk/models/shared/datasetstatus.md
@@ -1,17 +1,17 @@
-# DatasetStatus
-
-The current status of the dataset.
-
-## Example Usage
-
-```typescript
-import { DatasetStatus } from "@codat/platform/sdk/models/shared";
-
-let value: DatasetStatus = "RateLimitError";
-```
-
-## Values
-
-```typescript
-"Initial" | "Queued" | "Fetching" | "MapQueued" | "Mapping" | "Complete" | "FetchError" | "MapError" | "InternalError" | "ProcessingQueued" | "Processing" | "ProcessingError" | "ValidationQueued" | "Validating" | "ValidationError" | "AuthError" | "Cancelled" | "NotSupported" | "RateLimitError" | "PermissionsError" | "PrerequisiteNotMet"
+# DatasetStatus
+
+The current status of the dataset.
+
+## Example Usage
+
+```typescript
+import { DatasetStatus } from "@codat/platform/sdk/models/shared";
+
+let value: DatasetStatus = "";
+```
+
+## Values
+
+```typescript
+
```
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/datastatus.md b/platform/docs/sdk/models/shared/datastatus.md
index 13d6b66b5..49aa1a74e 100644
--- a/platform/docs/sdk/models/shared/datastatus.md
+++ b/platform/docs/sdk/models/shared/datastatus.md
@@ -1,27 +1,27 @@
-# DataStatus
-
-Describes the state of data in the Codat cache for a company and data type
-
-## Example Usage
-
-```typescript
-import { DataStatus } from "@codat/platform/sdk/models/shared";
-
-let value: DataStatus = {
- dataType: "itemReceipts",
- lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
- currentStatus: "Processing",
- latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
- latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `dataType` | [shared.DataTypes](../../../sdk/models/shared/datatypes.md) | :heavy_check_mark: | Available data types | invoices |
-| `lastSuccessfulSync` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 |
-| `currentStatus` | [shared.Status](../../../sdk/models/shared/status.md) | :heavy_check_mark: | The current status of the dataset. | |
-| `latestSyncId` | *string* | :heavy_minus_sign: | Unique identifier for most recent sync of data type. | ad474a37-2003-478e-baee-9af9f1ec2fe3 |
+# DataStatus
+
+Describes the state of data in the Codat cache for a company and data type
+
+## Example Usage
+
+```typescript
+import { DataStatus } from "@codat/platform/sdk/models/shared";
+
+let value: DataStatus = {
+ dataType: "string",
+ lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
+ currentStatus: "string",
+ latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
+ latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `dataType` | [shared.DataTypes](../../../sdk/models/shared/datatypes.md) | :heavy_check_mark: | Available data types | invoices |
+| `lastSuccessfulSync` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 |
+| `currentStatus` | [shared.Status](../../../sdk/models/shared/status.md) | :heavy_check_mark: | The current status of the dataset. | |
+| `latestSyncId` | *string* | :heavy_minus_sign: | Unique identifier for most recent sync of data type. | ad474a37-2003-478e-baee-9af9f1ec2fe3 |
| `latestSuccessfulSyncId` | *string* | :heavy_minus_sign: | Unique identifier for the most recent successful sync of data type. | 8220fc90-55b6-47bc-9417-48ac6ea93101 |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/datastatuses.md b/platform/docs/sdk/models/shared/datastatuses.md
index 6d1e7bb23..d93edb61d 100644
--- a/platform/docs/sdk/models/shared/datastatuses.md
+++ b/platform/docs/sdk/models/shared/datastatuses.md
@@ -1,359 +1,254 @@
-# DataStatuses
-
-## Example Usage
-
-```typescript
-import { DataStatuses } from "@codat/platform/sdk/models/shared";
-
-let value: DataStatuses = {
- accountTransactions: {
- dataType: "banking-accounts",
- lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
- currentStatus: "ProcessingError",
- latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
- latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
- },
- balanceSheet: {
- dataType: "balanceSheet",
- lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
- currentStatus: "Initial",
- latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
- latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
- },
- bankAccounts: {
- dataType: "chartOfAccounts",
- lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
- currentStatus: "Fetching",
- latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
- latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
- },
- bankTransactions: {
- dataType: "commerce-transactions",
- lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
- currentStatus: "Validating",
- latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
- latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
- },
- billCreditNotes: {
- dataType: "commerce-transactions",
- lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
- currentStatus: "MapQueued",
- latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
- latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
- },
- billPayments: {
- dataType: "customers",
- lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
- currentStatus: "AuthError",
- latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
- latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
- },
- bills: {
- dataType: "chartOfAccounts",
- lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
- currentStatus: "PrerequisiteNotMet",
- latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
- latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
- },
- cashFlowStatement: {
- dataType: "commerce-disputes",
- lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
- currentStatus: "ProcessingError",
- latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
- latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
- },
- chartOfAccounts: {
- dataType: "suppliers",
- lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
- currentStatus: "Processing",
- latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
- latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
- },
- company: {
- dataType: "invoices",
- lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
- currentStatus: "Queued",
- latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
- latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
- },
- creditNotes: {
- dataType: "purchaseOrders",
- lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
- currentStatus: "ValidationError",
- latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
- latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
- },
- customers: {
- dataType: "banking-transactionCategories",
- lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
- currentStatus: "MapQueued",
- latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
- latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
- },
- directCosts: {
- dataType: "commerce-disputes",
- lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
- currentStatus: "RateLimitError",
- latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
- latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
- },
- directIncomes: {
- dataType: "taxRates",
- lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
- currentStatus: "PermissionsError",
- latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
- latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
- },
- invoices: {
- dataType: "items",
- lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
- currentStatus: "Cancelled",
- latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
- latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
- },
- itemReceipts: {
- dataType: "invoices",
- lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
- currentStatus: "PermissionsError",
- latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
- latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
- },
- items: {
- dataType: "items",
- lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
- currentStatus: "ValidationError",
- latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
- latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
- },
- journalEntries: {
- dataType: "profitAndLoss",
- lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
- currentStatus: "ProcessingQueued",
- latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
- latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
- },
- journals: {
- dataType: "commerce-companyInfo",
- lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
- currentStatus: "ProcessingQueued",
- latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
- latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
- },
- paymentMethods: {
- dataType: "chartOfAccounts",
- lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
- currentStatus: "Mapping",
- latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
- latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
- },
- payments: {
- dataType: "commerce-locations",
- lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
- currentStatus: "ProcessingQueued",
- latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
- latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
- },
- profitAndLoss: {
- dataType: "items",
- lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
- currentStatus: "Queued",
- latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
- latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
- },
- purchaseOrders: {
- dataType: "commerce-products",
- lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
- currentStatus: "ProcessingQueued",
- latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
- latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
- },
- salesOrders: {
- dataType: "commerce-products",
- lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
- currentStatus: "Processing",
- latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
- latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
- },
- suppliers: {
- dataType: "invoices",
- lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
- currentStatus: "Validating",
- latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
- latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
- },
- taxRates: {
- dataType: "taxRates",
- lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
- currentStatus: "PrerequisiteNotMet",
- latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
- latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
- },
- trackingCategories: {
- dataType: "itemReceipts",
- lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
- currentStatus: "Initial",
- latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
- latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
- },
- transfers: {
- dataType: "cashFlowStatement",
- lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
- currentStatus: "InternalError",
- latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
- latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
- },
- bankingAccountBalances: {
- dataType: "bankAccounts",
- lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
- currentStatus: "InternalError",
- latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
- latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
- },
- bankingAccounts: {
- dataType: "commerce-products",
- lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
- currentStatus: "AuthError",
- latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
- latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
- },
- bankingTransactionCategories: {
- dataType: "customers",
- lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
- currentStatus: "NotSupported",
- latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
- latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
- },
- bankingTransactions: {
- dataType: "invoices",
- lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
- currentStatus: "ValidationError",
- latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
- latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
- },
- commerceCompanyInfo: {
- dataType: "cashFlowStatement",
- lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
- currentStatus: "Complete",
- latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
- latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
- },
- commerceCustomers: {
- dataType: "commerce-companyInfo",
- lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
- currentStatus: "Cancelled",
- latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
- latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
- },
- commerceDisputes: {
- dataType: "commerce-payments",
- lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
- currentStatus: "Fetching",
- latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
- latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
- },
- commerceLocations: {
- dataType: "commerce-transactions",
- lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
- currentStatus: "InternalError",
- latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
- latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
- },
- commerceOrders: {
- dataType: "commerce-products",
- lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
- currentStatus: "MapQueued",
- latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
- latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
- },
- commercePaymentMethods: {
- dataType: "billCreditNotes",
- lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
- currentStatus: "NotSupported",
- latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
- latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
- },
- commercePayments: {
- dataType: "billCreditNotes",
- lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
- currentStatus: "Complete",
- latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
- latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
- },
- commerceProductCategories: {
- dataType: "banking-accountBalances",
- lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
- currentStatus: "NotSupported",
- latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
- latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
- },
- commerceProducts: {
- dataType: "billPayments",
- lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
- currentStatus: "RateLimitError",
- latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
- latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
- },
- commerceTaxComponents: {
- dataType: "journals",
- lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
- currentStatus: "PrerequisiteNotMet",
- latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
- latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
- },
- commerceTransactions: {
- dataType: "billCreditNotes",
- lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
- currentStatus: "Cancelled",
- latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
- latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
- },
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `accountTransactions` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
-| `balanceSheet` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
-| `bankAccounts` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
-| `bankTransactions` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
-| `billCreditNotes` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
-| `billPayments` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
-| `bills` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
-| `cashFlowStatement` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
-| `chartOfAccounts` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
-| `company` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
-| `creditNotes` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
-| `customers` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
-| `directCosts` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
-| `directIncomes` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
-| `invoices` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
-| `itemReceipts` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
-| `items` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
-| `journalEntries` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
-| `journals` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
-| `paymentMethods` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
-| `payments` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
-| `profitAndLoss` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
-| `purchaseOrders` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
-| `salesOrders` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
-| `suppliers` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
-| `taxRates` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
-| `trackingCategories` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
-| `transfers` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
-| `bankingAccountBalances` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
-| `bankingAccounts` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
-| `bankingTransactionCategories` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
-| `bankingTransactions` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
-| `commerceCompanyInfo` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
-| `commerceCustomers` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
-| `commerceDisputes` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
-| `commerceLocations` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
-| `commerceOrders` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
-| `commercePaymentMethods` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
-| `commercePayments` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
-| `commerceProductCategories` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
-| `commerceProducts` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
-| `commerceTaxComponents` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
-| `commerceTransactions` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
\ No newline at end of file
+# DataStatuses
+
+## Example Usage
+
+```typescript
+import { DataStatuses } from "@codat/platform/sdk/models/shared";
+
+let value: DataStatuses = {
+ accountTransactions: {
+ dataType: "string",
+ lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
+ currentStatus: "string",
+ latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
+ latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
+ },
+ balanceSheet: {
+ dataType: "string",
+ lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
+ currentStatus: "string",
+ latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
+ latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
+ },
+ bankAccounts: {
+ dataType: "string",
+ lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
+ currentStatus: "string",
+ latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
+ latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
+ },
+ bankTransactions: {
+ dataType: "string",
+ lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
+ currentStatus: "string",
+ latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
+ latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
+ },
+ billCreditNotes: {
+ dataType: "string",
+ lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
+ currentStatus: "string",
+ latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
+ latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
+ },
+ billPayments: {
+ dataType: "string",
+ lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
+ currentStatus: "string",
+ latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
+ latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
+ },
+ bills: {
+ dataType: "string",
+ lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
+ currentStatus: "string",
+ latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
+ latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
+ },
+ cashFlowStatement: {
+ dataType: "string",
+ lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
+ currentStatus: "string",
+ latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
+ latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
+ },
+ chartOfAccounts: {
+ dataType: "string",
+ lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
+ currentStatus: "string",
+ latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
+ latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
+ },
+ company: {
+ dataType: "string",
+ lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
+ currentStatus: "string",
+ latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
+ latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
+ },
+ creditNotes: {
+ dataType: "string",
+ lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
+ currentStatus: "string",
+ latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
+ latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
+ },
+ customers: {
+ dataType: "string",
+ lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
+ currentStatus: "string",
+ latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
+ latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
+ },
+ directCosts: {
+ dataType: "string",
+ lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
+ currentStatus: "string",
+ latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
+ latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
+ },
+ directIncomes: {
+ dataType: "string",
+ lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
+ currentStatus: "string",
+ latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
+ latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
+ },
+ invoices: {
+ dataType: "string",
+ lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
+ currentStatus: "string",
+ latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
+ latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
+ },
+ itemReceipts: {
+ dataType: "string",
+ lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
+ currentStatus: "string",
+ latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
+ latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
+ },
+ items: {
+ dataType: "string",
+ lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
+ currentStatus: "string",
+ latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
+ latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
+ },
+ journalEntries: {
+ dataType: "string",
+ lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
+ currentStatus: "string",
+ latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
+ latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
+ },
+ journals: {
+ dataType: "string",
+ lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
+ currentStatus: "string",
+ latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
+ latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
+ },
+ paymentMethods: {
+ dataType: "string",
+ lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
+ currentStatus: "string",
+ latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
+ latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
+ },
+ payments: {
+ dataType: "string",
+ lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
+ currentStatus: "string",
+ latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
+ latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
+ },
+ profitAndLoss: {
+ dataType: "string",
+ lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
+ currentStatus: "string",
+ latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
+ latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
+ },
+ purchaseOrders: {
+ dataType: "string",
+ lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
+ currentStatus: "string",
+ latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
+ latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
+ },
+ salesOrders: {
+ dataType: "string",
+ lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
+ currentStatus: "string",
+ latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
+ latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
+ },
+ suppliers: {
+ dataType: "string",
+ lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
+ currentStatus: "string",
+ latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
+ latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
+ },
+ taxRates: {
+ dataType: "string",
+ lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
+ currentStatus: "string",
+ latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
+ latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
+ },
+ trackingCategories: {
+ dataType: "string",
+ lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
+ currentStatus: "string",
+ latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
+ latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
+ },
+ transfers: {
+ dataType: "string",
+ lastSuccessfulSync: "2022-01-01T13:00:00.000Z",
+ currentStatus: "string",
+ latestSyncId: "ad474a37-2003-478e-baee-9af9f1ec2fe3",
+ latestSuccessfulSyncId: "8220fc90-55b6-47bc-9417-48ac6ea93101",
+ },
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `accountTransactions` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
+| `balanceSheet` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
+| `bankAccounts` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
+| `bankTransactions` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
+| `billCreditNotes` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
+| `billPayments` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
+| `bills` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
+| `cashFlowStatement` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
+| `chartOfAccounts` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
+| `company` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
+| `creditNotes` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
+| `customers` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
+| `directCosts` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
+| `directIncomes` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
+| `invoices` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
+| `itemReceipts` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
+| `items` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
+| `journalEntries` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
+| `journals` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
+| `paymentMethods` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
+| `payments` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
+| `profitAndLoss` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
+| `purchaseOrders` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
+| `salesOrders` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
+| `suppliers` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
+| `taxRates` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
+| `trackingCategories` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
+| `transfers` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | Describes the state of data in the Codat cache for a company and data type | {
"dataType": "string",
"lastSuccessfulSync": "2022-01-01T13:00:00.000Z",
"currentStatus": "string",
"latestSyncId": "ad474a37-2003-478e-baee-9af9f1ec2fe3",
"latestSuccessfulSyncId": "8220fc90-55b6-47bc-9417-48ac6ea93101"
} |
+| `bankingAccountBalances` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | N/A | |
+| `bankingAccounts` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | N/A | |
+| `bankingTransactionCategories` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | N/A | |
+| `bankingTransactions` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | N/A | |
+| `commerceCompanyInfo` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | N/A | |
+| `commerceCustomers` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | N/A | |
+| `commerceDisputes` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | N/A | |
+| `commerceLocations` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | N/A | |
+| `commerceOrders` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | N/A | |
+| `commercePaymentMethods` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | N/A | |
+| `commercePayments` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | N/A | |
+| `commerceProductCategories` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | N/A | |
+| `commerceProducts` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | N/A | |
+| `commerceTaxComponents` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | N/A | |
+| `commerceTransactions` | [shared.DataStatus](../../../sdk/models/shared/datastatus.md) | :heavy_minus_sign: | N/A | |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/datatype.md b/platform/docs/sdk/models/shared/datatype.md
index 08150e774..14b15eeff 100644
--- a/platform/docs/sdk/models/shared/datatype.md
+++ b/platform/docs/sdk/models/shared/datatype.md
@@ -1,17 +1,17 @@
-# DataType
-
-Available data types
-
-## Example Usage
-
-```typescript
-import { DataType } from "@codat/platform/sdk/models/shared";
-
-let value: DataType = "invoices";
-```
-
-## Values
-
-```typescript
-"accountTransactions" | "balanceSheet" | "bankAccounts" | "bankTransactions" | "billCreditNotes" | "billPayments" | "bills" | "cashFlowStatement" | "chartOfAccounts" | "company" | "creditNotes" | "customers" | "directCosts" | "directIncomes" | "invoices" | "itemReceipts" | "items" | "journalEntries" | "journals" | "paymentMethods" | "payments" | "profitAndLoss" | "purchaseOrders" | "salesOrders" | "suppliers" | "taxRates" | "trackingCategories" | "transfers" | "banking-accountBalances" | "banking-accounts" | "banking-transactionCategories" | "banking-transactions" | "commerce-companyInfo" | "commerce-customers" | "commerce-disputes" | "commerce-locations" | "commerce-orders" | "commerce-paymentMethods" | "commerce-payments" | "commerce-productCategories" | "commerce-products" | "commerce-taxComponents" | "commerce-transactions"
+# DataType
+
+Available data types
+
+## Example Usage
+
+```typescript
+import { DataType } from "@codat/platform/sdk/models/shared";
+
+let value: DataType = "accountTransactions";
+```
+
+## Values
+
+```typescript
+"accountTransactions" | "balanceSheet" | "bankAccounts" | "bankTransactions" | "billCreditNotes" | "billPayments" | "bills" | "cashFlowStatement" | "chartOfAccounts" | "company" | "creditNotes" | "customers" | "directCosts" | "directIncomes" | "invoices" | "itemReceipts" | "items" | "journalEntries" | "journals" | "paymentMethods" | "payments" | "profitAndLoss" | "purchaseOrders" | "salesOrders" | "suppliers" | "taxRates" | "trackingCategories" | "transfers" | "banking-accountBalances" | "banking-accounts" | "banking-transactionCategories" | "banking-transactions" | "commerce-companyInfo" | "commerce-customers" | "commerce-disputes" | "commerce-locations" | "commerce-orders" | "commerce-paymentMethods" | "commerce-payments" | "commerce-productCategories" | "commerce-products" | "commerce-taxComponents" | "commerce-transactions"
```
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/datatypefeature.md b/platform/docs/sdk/models/shared/datatypefeature.md
index 36ab7bf33..068cc1989 100644
--- a/platform/docs/sdk/models/shared/datatypefeature.md
+++ b/platform/docs/sdk/models/shared/datatypefeature.md
@@ -1,25 +1,25 @@
-# DataTypeFeature
-
-Describes support for a given datatype and associated operations
-
-## Example Usage
-
-```typescript
-import { DataTypeFeature } from "@codat/platform/sdk/models/shared";
-
-let value: DataTypeFeature = {
- supportedFeatures: [
- {
- featureType: "Get",
- featureState: "Release",
- },
- ],
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
-| `dataType` | [shared.DataType](../../../sdk/models/shared/datatype.md) | :heavy_minus_sign: | Available data types | invoices |
+# DataTypeFeature
+
+Describes support for a given datatype and associated operations
+
+## Example Usage
+
+```typescript
+import { DataTypeFeature } from "@codat/platform/sdk/models/shared";
+
+let value: DataTypeFeature = {
+ supportedFeatures: [
+ {
+ featureType: "Get",
+ featureState: "Release",
+ },
+ ],
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
+| `dataType` | [shared.DataType](../../../sdk/models/shared/datatype.md) | :heavy_minus_sign: | Available data types | invoices |
| `supportedFeatures` | [shared.SupportedFeature](../../../sdk/models/shared/supportedfeature.md)[] | :heavy_check_mark: | N/A | |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/datatypereadsummary.md b/platform/docs/sdk/models/shared/datatypereadsummary.md
index 80c8f0877..ed2a8927d 100644
--- a/platform/docs/sdk/models/shared/datatypereadsummary.md
+++ b/platform/docs/sdk/models/shared/datatypereadsummary.md
@@ -1,38 +1,19 @@
-# DataTypeReadSummary
-
-## Example Usage
-
-```typescript
-import { DataTypeReadSummary } from "@codat/platform/sdk/models/shared";
-
-let value: DataTypeReadSummary = {
- connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
- dataType: "invoices",
- recordsModified: false,
- issues: [
- {
- type: "warning.validation",
- message:
- "Something doesn't look right about these accounts from Xero. You can see more information in the logs.",
- links: {
- logs:
- "https://api.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/sync/{datasetId}/validation",
- portal:
- "https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/pull-history",
- readMore:
- "https://docs.codat.io/using-the-api/get-data-troubleshooting#warning.validation",
- },
- },
- ],
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
-| `connectionId` | *string* | :heavy_minus_sign: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 |
-| `dataType` | [shared.DataType](../../../sdk/models/shared/datatype.md) | :heavy_minus_sign: | Available data types | invoices |
-| `recordsModified` | *boolean* | :heavy_minus_sign: | `True` if records have been created, updated or deleted in Codat's cache. | false |
-| `status` | [shared.Status](../../../sdk/models/shared/status.md) | :heavy_minus_sign: | The current status of the dataset. | |
-| `issues` | [shared.Issue](../../../sdk/models/shared/issue.md)[] | :heavy_minus_sign: | A array of issues encountered during a data read. | |
\ No newline at end of file
+# DataTypeReadSummary
+
+## Example Usage
+
+```typescript
+import { DataTypeReadSummary } from "@codat/platform/sdk/models/shared";
+
+let value: DataTypeReadSummary = {};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
+| `connectionId` | *string* | :heavy_minus_sign: | Unique identifier for a company's data connection. |
+| `dataType` | [shared.DataType](../../../sdk/models/shared/datatype.md) | :heavy_minus_sign: | Available data types |
+| `recordsModified` | *boolean* | :heavy_minus_sign: | `True` if records have been created, updated or deleted in Codat's cache. |
+| `status` | [shared.Status](../../../sdk/models/shared/status.md) | :heavy_minus_sign: | The current status of the dataset. |
+| `issues` | [shared.Issue](../../../sdk/models/shared/issue.md)[] | :heavy_minus_sign: | A array of issues encountered during a data read. |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/datatypes.md b/platform/docs/sdk/models/shared/datatypes.md
index 02ef4d202..adf0af85a 100644
--- a/platform/docs/sdk/models/shared/datatypes.md
+++ b/platform/docs/sdk/models/shared/datatypes.md
@@ -1,17 +1,17 @@
-# DataTypes
-
-Available data types
-
-## Example Usage
-
-```typescript
-import { DataTypes } from "@codat/platform/sdk/models/shared";
-
-let value: DataTypes = "invoices";
-```
-
-## Values
-
-```typescript
-"accountTransactions" | "balanceSheet" | "bankAccounts" | "bankTransactions" | "billCreditNotes" | "billPayments" | "bills" | "cashFlowStatement" | "chartOfAccounts" | "company" | "creditNotes" | "customers" | "directCosts" | "directIncomes" | "invoices" | "itemReceipts" | "items" | "journalEntries" | "journals" | "paymentMethods" | "payments" | "profitAndLoss" | "purchaseOrders" | "salesOrders" | "suppliers" | "taxRates" | "trackingCategories" | "transfers" | "banking-accountBalances" | "banking-accounts" | "banking-transactionCategories" | "banking-transactions" | "commerce-companyInfo" | "commerce-customers" | "commerce-disputes" | "commerce-locations" | "commerce-orders" | "commerce-paymentMethods" | "commerce-payments" | "commerce-productCategories" | "commerce-products" | "commerce-taxComponents" | "commerce-transactions"
+# DataTypes
+
+Available data types
+
+## Example Usage
+
+```typescript
+import { DataTypes } from "@codat/platform/sdk/models/shared";
+
+let value: DataTypes = "";
+```
+
+## Values
+
+```typescript
+
```
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/datatypewritewebhook.md b/platform/docs/sdk/models/shared/datatypewritewebhook.md
index 917940bab..dc0fadba6 100644
--- a/platform/docs/sdk/models/shared/datatypewritewebhook.md
+++ b/platform/docs/sdk/models/shared/datatypewritewebhook.md
@@ -1,32 +1,22 @@
-# DataTypeWriteWebhook
-
-## Example Usage
-
-```typescript
-import { DataTypeWriteWebhook } from "@codat/platform/sdk/models/shared";
-
-let value: DataTypeWriteWebhook = {
- id: "ba29118f-5406-4e59-b05c-ba307ca38d01",
- eventType: "bills.write.successful",
- generatedDate: "2022-10-23T00:00:00Z",
- payload: {
- referenceCompany: {
- id: "8a210b68-6988-11ed-a1eb-0242ac120002",
- name: "Codat Ltd.",
- description: "Requested early access to the new financing scheme.",
- },
- connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
- requestedOnDate: "2022-10-23T00:00:00Z",
- completedOnDate: "2022-10-23T00:00:00Z",
- },
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `id` | *string* | :heavy_minus_sign: | Unique identifier of the event. | ba29118f-5406-4e59-b05c-ba307ca38d01 |
-| `eventType` | *string* | :heavy_minus_sign: | The type of event. | **Example 1:** bills.write.successful
**Example 2:** bills.write.unsuccessful |
-| `generatedDate` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 |
+# DataTypeWriteWebhook
+
+## Example Usage
+
+```typescript
+import { DataTypeWriteWebhook } from "@codat/platform/sdk/models/shared";
+
+let value: DataTypeWriteWebhook = {
+ id: "ba29118f-5406-4e59-b05c-ba307ca38d01",
+ eventType: "bills.write.successful",
+ generatedDate: "2022-10-23T00:00:00Z",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `id` | *string* | :heavy_minus_sign: | Unique identifier of the event. | ba29118f-5406-4e59-b05c-ba307ca38d01 |
+| `eventType` | *string* | :heavy_minus_sign: | The type of event. | **Example 1:** bills.write.successful
**Example 2:** bills.write.unsuccessful |
+| `generatedDate` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 |
| `payload` | [shared.DataTypeWriteWebhookPayload](../../../sdk/models/shared/datatypewritewebhookpayload.md) | :heavy_minus_sign: | N/A | |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/datatypewritewebhookpayload.md b/platform/docs/sdk/models/shared/datatypewritewebhookpayload.md
index e3f3be19f..c939e4275 100644
--- a/platform/docs/sdk/models/shared/datatypewritewebhookpayload.md
+++ b/platform/docs/sdk/models/shared/datatypewritewebhookpayload.md
@@ -1,32 +1,23 @@
-# DataTypeWriteWebhookPayload
-
-## Example Usage
-
-```typescript
-import { DataTypeWriteWebhookPayload } from "@codat/platform/sdk/models/shared";
-
-let value: DataTypeWriteWebhookPayload = {
- referenceCompany: {
- id: "8a210b68-6988-11ed-a1eb-0242ac120002",
- name: "Codat Ltd.",
- description: "Requested early access to the new financing scheme.",
- },
- connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
- requestedOnDate: "2022-10-23T00:00:00Z",
- completedOnDate: "2022-10-23T00:00:00Z",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `id` | *string* | :heavy_minus_sign: | Unique identifier of the write request. This is also known as the push operation ID. | |
-| `type` | [shared.WriteType](../../../sdk/models/shared/writetype.md) | :heavy_minus_sign: | Type of write request. | |
-| `referenceCompany` | [shared.CompanyReference](../../../sdk/models/shared/companyreference.md) | :heavy_minus_sign: | N/A | |
-| `connectionId` | *string* | :heavy_minus_sign: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 |
-| `requestedOnDate` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 |
-| `completedOnDate` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 |
-| `status` | [shared.WriteStatus](../../../sdk/models/shared/writestatus.md) | :heavy_minus_sign: | The current status of the write request, which is the same as the push operation status. | |
-| `record` | [shared.DataTypeWriteWebhookRecord](../../../sdk/models/shared/datatypewritewebhookrecord.md) | :heavy_minus_sign: | N/A | |
-| `attachmentId` | *string* | :heavy_minus_sign: | Unique identifier for the uploaded attachment, null if no attachment uploaded. | |
\ No newline at end of file
+# DataTypeWriteWebhookPayload
+
+## Example Usage
+
+```typescript
+import { DataTypeWriteWebhookPayload } from "@codat/platform/sdk/models/shared";
+
+let value: DataTypeWriteWebhookPayload = {};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `id` | *string* | :heavy_minus_sign: | Unique identifier of the write request. This is also known as the push operation ID. |
+| `type` | [shared.WriteType](../../../sdk/models/shared/writetype.md) | :heavy_minus_sign: | N/A |
+| `referenceCompany` | [shared.CompanyReference](../../../sdk/models/shared/companyreference.md) | :heavy_minus_sign: | N/A |
+| `connectionId` | *string* | :heavy_minus_sign: | Unique identifier for a company's data connection. |
+| `requestedOnDate` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. |
+| `completedOnDate` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. |
+| `status` | [shared.WriteStatus](../../../sdk/models/shared/writestatus.md) | :heavy_minus_sign: | N/A |
+| `record` | [shared.DataTypeWriteWebhookRecord](../../../sdk/models/shared/datatypewritewebhookrecord.md) | :heavy_minus_sign: | N/A |
+| `attachmentId` | *string* | :heavy_minus_sign: | Unique identifier for the uploaded attachment, null if no attachment uploaded. |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/datatypewritewebhookrecord.md b/platform/docs/sdk/models/shared/datatypewritewebhookrecord.md
index 95e308b9e..e914c094c 100644
--- a/platform/docs/sdk/models/shared/datatypewritewebhookrecord.md
+++ b/platform/docs/sdk/models/shared/datatypewritewebhookrecord.md
@@ -1,15 +1,15 @@
-# DataTypeWriteWebhookRecord
-
-## Example Usage
-
-```typescript
-import { DataTypeWriteWebhookRecord } from "@codat/platform/sdk/models/shared";
-
-let value: DataTypeWriteWebhookRecord = {};
-```
-
-## Fields
-
-| Field | Type | Required | Description |
-| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
+# DataTypeWriteWebhookRecord
+
+## Example Usage
+
+```typescript
+import { DataTypeWriteWebhookRecord } from "@codat/platform/sdk/models/shared";
+
+let value: DataTypeWriteWebhookRecord = {};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
| `id` | *string* | :heavy_minus_sign: | The unique identifier of the data type created, updated, deleted, or had an attachment uploaded in the accounting platform. |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/errormessage.md b/platform/docs/sdk/models/shared/errormessage.md
index cb492cfd1..70bb69e23 100644
--- a/platform/docs/sdk/models/shared/errormessage.md
+++ b/platform/docs/sdk/models/shared/errormessage.md
@@ -1,23 +1,21 @@
-# ErrorMessage
-
-Too many requests were made in a given amount of time. Wait a short period and then try again.
-
-## Example Usage
-
-```typescript
-import { ErrorMessage } from "@codat/platform/sdk/models/shared";
-
-let value: ErrorMessage = {};
-```
-
-## Fields
-
-| Field | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `statusCode` | *number* | :heavy_minus_sign: | The HTTP status code returned by the error. |
-| `service` | *string* | :heavy_minus_sign: | Codat's service the returned the error. |
-| `error` | *string* | :heavy_minus_sign: | A brief description of the error. |
-| `correlationId` | *string* | :heavy_minus_sign: | Unique identifier used to propagate to all downstream services and determine the source of the error. |
-| `validation` | [shared.ErrorValidation](../../../sdk/models/shared/errorvalidation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made. If an operation has failed because of validation errors, they will be detailed here. |
-| `canBeRetried` | *string* | :heavy_minus_sign: | `True` if the error occurred transiently and can be retried. |
+# ErrorMessage
+
+## Example Usage
+
+```typescript
+import { ErrorMessage } from "@codat/platform/sdk/models/shared";
+
+let value: ErrorMessage = {};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `statusCode` | *number* | :heavy_minus_sign: | The HTTP status code returned by the error. |
+| `service` | *string* | :heavy_minus_sign: | Codat's service the returned the error. |
+| `error` | *string* | :heavy_minus_sign: | A brief description of the error. |
+| `correlationId` | *string* | :heavy_minus_sign: | Unique identifier used to propagate to all downstream services and determine the source of the error. |
+| `validation` | [shared.ErrorValidation](../../../sdk/models/shared/errorvalidation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made. If an operation has failed because of validation errors, they will be detailed here. |
+| `canBeRetried` | *string* | :heavy_minus_sign: | `True` if the error occurred transiently and can be retried. |
| `detailedErrorCode` | *number* | :heavy_minus_sign: | Machine readable error code used to automate processes based on the code returned. |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/errorstatus.md b/platform/docs/sdk/models/shared/errorstatus.md
index b4c58ebac..32ec07c19 100644
--- a/platform/docs/sdk/models/shared/errorstatus.md
+++ b/platform/docs/sdk/models/shared/errorstatus.md
@@ -1,17 +1,17 @@
-# ErrorStatus
-
-The current status of a transient error. Null statuses indicate that the error is not transient.
-
-## Example Usage
-
-```typescript
-import { ErrorStatus } from "@codat/platform/sdk/models/shared";
-
-let value: ErrorStatus = "Resolved";
-```
-
-## Values
-
-```typescript
-"Active" | "Resolved"
+# ErrorStatus
+
+The current status of a transient error. Null statuses indicate that the error is not transient.
+
+## Example Usage
+
+```typescript
+import { ErrorStatus } from "@codat/platform/sdk/models/shared";
+
+let value: ErrorStatus = "";
+```
+
+## Values
+
+```typescript
+
```
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/errorvalidation.md b/platform/docs/sdk/models/shared/errorvalidation.md
index 8de2da74e..11ca22195 100644
--- a/platform/docs/sdk/models/shared/errorvalidation.md
+++ b/platform/docs/sdk/models/shared/errorvalidation.md
@@ -1,18 +1,18 @@
-# ErrorValidation
-
-A human-readable object describing validation decisions Codat has made. If an operation has failed because of validation errors, they will be detailed here.
-
-## Example Usage
-
-```typescript
-import { ErrorValidation } from "@codat/platform/sdk/models/shared";
-
-let value: ErrorValidation = {};
-```
-
-## Fields
-
-| Field | Type | Required | Description |
-| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
-| `errors` | [shared.ErrorValidationItem](../../../sdk/models/shared/errorvalidationitem.md)[] | :heavy_minus_sign: | N/A |
+# ErrorValidation
+
+A human-readable object describing validation decisions Codat has made. If an operation has failed because of validation errors, they will be detailed here.
+
+## Example Usage
+
+```typescript
+import { ErrorValidation } from "@codat/platform/sdk/models/shared";
+
+let value: ErrorValidation = {};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
+| `errors` | [shared.ErrorValidationItem](../../../sdk/models/shared/errorvalidationitem.md)[] | :heavy_minus_sign: | N/A |
| `warnings` | [shared.ErrorValidationItem](../../../sdk/models/shared/errorvalidationitem.md)[] | :heavy_minus_sign: | N/A |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/errorvalidationitem.md b/platform/docs/sdk/models/shared/errorvalidationitem.md
index a777a3273..595b028ee 100644
--- a/platform/docs/sdk/models/shared/errorvalidationitem.md
+++ b/platform/docs/sdk/models/shared/errorvalidationitem.md
@@ -1,17 +1,17 @@
-# ErrorValidationItem
-
-## Example Usage
-
-```typescript
-import { ErrorValidationItem } from "@codat/platform/sdk/models/shared";
-
-let value: ErrorValidationItem = {};
-```
-
-## Fields
-
-| Field | Type | Required | Description |
-| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
-| `itemId` | *string* | :heavy_minus_sign: | Unique identifier for a validation item. |
-| `message` | *string* | :heavy_minus_sign: | A message outlining validation item's issue. |
+# ErrorValidationItem
+
+## Example Usage
+
+```typescript
+import { ErrorValidationItem } from "@codat/platform/sdk/models/shared";
+
+let value: ErrorValidationItem = {};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
+| `itemId` | *string* | :heavy_minus_sign: | Unique identifier for a validation item. |
+| `message` | *string* | :heavy_minus_sign: | A message outlining validation item's issue. |
| `validatorName` | *string* | :heavy_minus_sign: | Name of validator. |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/featurestate.md b/platform/docs/sdk/models/shared/featurestate.md
index bed9284e9..43df56ad3 100644
--- a/platform/docs/sdk/models/shared/featurestate.md
+++ b/platform/docs/sdk/models/shared/featurestate.md
@@ -1,17 +1,17 @@
-# FeatureState
-
-The current release state of the feature.
-
-## Example Usage
-
-```typescript
-import { FeatureState } from "@codat/platform/sdk/models/shared";
-
-let value: FeatureState = "Release";
-```
-
-## Values
-
-```typescript
-"Release" | "Alpha" | "Beta" | "Deprecated" | "NotSupported" | "NotImplemented"
+# FeatureState
+
+The current release state of the feature.
+
+## Example Usage
+
+```typescript
+import { FeatureState } from "@codat/platform/sdk/models/shared";
+
+let value: FeatureState = "Release";
+```
+
+## Values
+
+```typescript
+"Release" | "Alpha" | "Beta" | "Deprecated" | "NotSupported" | "NotImplemented"
```
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/featuretype.md b/platform/docs/sdk/models/shared/featuretype.md
index 68ad73a88..558e39514 100644
--- a/platform/docs/sdk/models/shared/featuretype.md
+++ b/platform/docs/sdk/models/shared/featuretype.md
@@ -1,17 +1,17 @@
-# FeatureType
-
-The type of feature.
-
-## Example Usage
-
-```typescript
-import { FeatureType } from "@codat/platform/sdk/models/shared";
-
-let value: FeatureType = "Get";
-```
-
-## Values
-
-```typescript
-"Get" | "Post" | "Categorization" | "Delete" | "Put" | "GetAsPdf" | "DownloadAttachment" | "GetAttachment" | "GetAttachments" | "UploadAttachment"
+# FeatureType
+
+The type of feature.
+
+## Example Usage
+
+```typescript
+import { FeatureType } from "@codat/platform/sdk/models/shared";
+
+let value: FeatureType = "Get";
+```
+
+## Values
+
+```typescript
+"Get" | "Post" | "Categorization" | "Delete" | "Put" | "GetAsPdf" | "DownloadAttachment" | "GetAttachment" | "GetAttachments" | "UploadAttachment"
```
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/halref.md b/platform/docs/sdk/models/shared/halref.md
index e764a29bf..3e2aba998 100644
--- a/platform/docs/sdk/models/shared/halref.md
+++ b/platform/docs/sdk/models/shared/halref.md
@@ -1,15 +1,15 @@
-# HalRef
-
-## Example Usage
-
-```typescript
-import { HalRef } from "@codat/platform/sdk/models/shared";
-
-let value: HalRef = {};
-```
-
-## Fields
-
-| Field | Type | Required | Description |
-| ------------------------ | ------------------------ | ------------------------ | ------------------------ |
+# HalRef
+
+## Example Usage
+
+```typescript
+import { HalRef } from "@codat/platform/sdk/models/shared";
+
+let value: HalRef = {};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| ------------------------ | ------------------------ | ------------------------ | ------------------------ |
| `href` | *string* | :heavy_minus_sign: | Uri hypertext reference. |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/imagereference.md b/platform/docs/sdk/models/shared/imagereference.md
index d1646ee8e..41f0f0e55 100644
--- a/platform/docs/sdk/models/shared/imagereference.md
+++ b/platform/docs/sdk/models/shared/imagereference.md
@@ -1,18 +1,18 @@
-# ImageReference
-
-Image reference.
-
-## Example Usage
-
-```typescript
-import { ImageReference } from "@codat/platform/sdk/models/shared";
-
-let value: ImageReference = {};
-```
-
-## Fields
-
-| Field | Type | Required | Description |
-| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- |
-| `src` | *string* | :heavy_minus_sign: | Source URL for image. |
+# ImageReference
+
+Image reference.
+
+## Example Usage
+
+```typescript
+import { ImageReference } from "@codat/platform/sdk/models/shared";
+
+let value: ImageReference = {};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- |
+| `src` | *string* | :heavy_minus_sign: | Source URL for image. |
| `alt` | *string* | :heavy_minus_sign: | Alternative text when image is not available. |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/integration.md b/platform/docs/sdk/models/shared/integration.md
index cdf6eff3f..befddfa2f 100644
--- a/platform/docs/sdk/models/shared/integration.md
+++ b/platform/docs/sdk/models/shared/integration.md
@@ -1,48 +1,49 @@
-# Integration
-
-An integration that Codat supports
-
-## Example Usage
-
-```typescript
-import { Integration } from "@codat/platform/sdk/models/shared";
-
-let value: Integration = {
- key: "gbol",
- logoUrl: "http://example.com",
- name: "Xero",
- enabled: true,
- sourceId: "accounting",
- sourceType: "Commerce",
- integrationId: "497a18ca-284e-40c0-985d-f72be35d468e",
- isOfflineConnector: true,
- isBeta: true,
- dataProvidedBy: "string",
- datatypeFeatures: [
- {
- supportedFeatures: [
- {
- featureType: "UploadAttachment",
- featureState: "NotImplemented",
- },
- ],
- },
- ],
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `key` | *string* | :heavy_check_mark: | A unique 4-letter key to represent a platform in each integration. View [accounting](https://docs.codat.io/integrations/accounting/overview#platform-keys), [banking](https://docs.codat.io/integrations/banking/overview#platform-keys), and [commerce](https://docs.codat.io/integrations/commerce/overview#platform-keys) platform keys. | gbol |
-| `logoUrl` | *string* | :heavy_check_mark: | Static url for integration's logo. | |
-| `name` | *string* | :heavy_check_mark: | Name of integration. | Xero |
-| `enabled` | *boolean* | :heavy_check_mark: | Whether this integration is enabled for your customers to use. | |
-| `sourceId` | *string* | :heavy_minus_sign: | A source-specific ID used to distinguish between different sources originating from the same data connection. In general, a data connection is a single data source. However, for TrueLayer, `sourceId` is associated with a specific bank and has a many-to-one relationship with the `integrationId`. | 35b92968-9851-4095-ad60-395c95cbcba4 |
-| `sourceType` | [shared.SourceType](../../../sdk/models/shared/sourcetype.md) | :heavy_minus_sign: | The type of platform of the connection. | Accounting |
-| `integrationId` | *string* | :heavy_minus_sign: | A Codat ID representing the integration. | fd321cb6-7963-4506-b873-e99593a45e30 |
-| `isOfflineConnector` | *boolean* | :heavy_minus_sign: | `True` if the integration is to an application installed and run locally on an SMBs computer. | |
-| `isBeta` | *boolean* | :heavy_minus_sign: | `True` if the integration is currently in beta release. | |
-| `dataProvidedBy` | *string* | :heavy_minus_sign: | The name of the data provider. | |
+# Integration
+
+An integration that Codat supports
+
+## Example Usage
+
+```typescript
+import { Integration } from "@codat/platform/sdk/models/shared";
+
+let value: Integration = {
+ key: "gbol",
+ logoUrl: "http://example.com",
+ name: "Xero",
+ enabled: true,
+ sourceId: "accounting",
+ sourceType: "8193a927-ab7a-45a3-9dc2-d357a4932dfe",
+ integrationId: "497a18ca-284e-40c0-985d-f72be35d468e",
+ isOfflineConnector: true,
+ isBeta: true,
+ dataProvidedBy: "string",
+ datatypeFeatures: [
+ {
+ supportedFeatures: [
+ {
+ featureType: "get",
+ featureState: "release",
+ },
+ ],
+ datatype: "invoices",
+ },
+ ],
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `key` | *string* | :heavy_check_mark: | A unique 4-letter key to represent a platform in each integration. View [accounting](https://docs.codat.io/integrations/accounting/overview#platform-keys), [banking](https://docs.codat.io/integrations/banking/overview#platform-keys), and [commerce](https://docs.codat.io/integrations/commerce/overview#platform-keys) platform keys. | gbol |
+| `logoUrl` | *string* | :heavy_check_mark: | Static url for integration's logo. | |
+| `name` | *string* | :heavy_check_mark: | Name of integration. | Xero |
+| `enabled` | *boolean* | :heavy_check_mark: | Whether this integration is enabled for your customers to use. | |
+| `sourceId` | *string* | :heavy_minus_sign: | A source-specific ID used to distinguish between different sources originating from the same data connection. In general, a data connection is a single data source. However, for TrueLayer, `sourceId` is associated with a specific bank and has a many-to-one relationship with the `integrationId`. | 35b92968-9851-4095-ad60-395c95cbcba4 |
+| `sourceType` | [shared.SourceType](../../../sdk/models/shared/sourcetype.md) | :heavy_minus_sign: | The type of platform of the connection. | Accounting |
+| `integrationId` | *string* | :heavy_minus_sign: | A Codat ID representing the integration. | fd321cb6-7963-4506-b873-e99593a45e30 |
+| `isOfflineConnector` | *boolean* | :heavy_minus_sign: | `True` if the integration is to an application installed and run locally on an SMBs computer. | |
+| `isBeta` | *boolean* | :heavy_minus_sign: | `True` if the integration is currently in beta release. | |
+| `dataProvidedBy` | *string* | :heavy_minus_sign: | The name of the data provider. | |
| `datatypeFeatures` | [shared.DataTypeFeature](../../../sdk/models/shared/datatypefeature.md)[] | :heavy_minus_sign: | N/A | |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/integrations.md b/platform/docs/sdk/models/shared/integrations.md
index ae7d91bc8..4df6919d3 100644
--- a/platform/docs/sdk/models/shared/integrations.md
+++ b/platform/docs/sdk/models/shared/integrations.md
@@ -1,31 +1,23 @@
-# Integrations
-
-## Example Usage
-
-```typescript
-import { Integrations } from "@codat/platform/sdk/models/shared";
-
-let value: Integrations = {
- pageNumber: 1,
- pageSize: 10,
- totalResults: 1,
- links: {
- self: {
- href: "/companies/{id}/data/{dataType}",
- },
- current: {
- href: "/companies/{id}/data/{dataType}?page=1&pageSize=10",
- },
- },
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
-| `results` | [shared.Integration](../../../sdk/models/shared/integration.md)[] | :heavy_minus_sign: | N/A | |
-| `pageNumber` | *number* | :heavy_check_mark: | Current page number. | |
-| `pageSize` | *number* | :heavy_check_mark: | Number of items to return in results array. | |
-| `totalResults` | *number* | :heavy_check_mark: | Total number of items. | |
-| `links` | [shared.Links](../../../sdk/models/shared/links.md) | :heavy_check_mark: | N/A | {
"self": {
"href": "/companies"
},
"current": {
"href": "/companies?page=1\u0026pageSize=10"
}
} |
\ No newline at end of file
+# Integrations
+
+## Example Usage
+
+```typescript
+import { Integrations } from "@codat/platform/sdk/models/shared";
+
+let value: Integrations = {
+ pageNumber: 0,
+ pageSize: 0,
+ totalResults: 0,
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
+| `pageNumber` | *number* | :heavy_check_mark: | Current page number. |
+| `pageSize` | *number* | :heavy_check_mark: | Number of items to return in results array. |
+| `totalResults` | *number* | :heavy_check_mark: | Total number of items. |
+| `links` | [shared.Links](../../../sdk/models/shared/links.md) | :heavy_check_mark: | N/A |
+| `results` | [shared.Integration](../../../sdk/models/shared/integration.md)[] | :heavy_minus_sign: | N/A |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/issue.md b/platform/docs/sdk/models/shared/issue.md
index 0e7948ed7..bab8c888f 100644
--- a/platform/docs/sdk/models/shared/issue.md
+++ b/platform/docs/sdk/models/shared/issue.md
@@ -1,31 +1,22 @@
-# Issue
-
-Details of a problem encountered during a data read.
-
-## Example Usage
-
-```typescript
-import { Issue } from "@codat/platform/sdk/models/shared";
-
-let value: Issue = {
- type: "warning.validation",
- message:
- "Something doesn't look right about these accounts from Xero. You can see more information in the logs.",
- links: {
- logs:
- "https://api.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/sync/{datasetId}/validation",
- portal:
- "https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/pull-history",
- readMore:
- "https://docs.codat.io/using-the-api/get-data-troubleshooting#warning.validation",
- },
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
-| `type` | *string* | :heavy_minus_sign: | The type of issue. | warning.validation |
-| `message` | *string* | :heavy_minus_sign: | A message describing the issue. | Something doesn't look right about these accounts from Xero. You can see more information in the logs. |
+# Issue
+
+Details of a problem encountered during a data read.
+
+## Example Usage
+
+```typescript
+import { Issue } from "@codat/platform/sdk/models/shared";
+
+let value: Issue = {
+ type: "warning.validation",
+ message: "Something doesn't look right about these accounts from Xero. You can see more information in the logs.",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
+| `type` | *string* | :heavy_minus_sign: | The type of issue. | warning.validation |
+| `message` | *string* | :heavy_minus_sign: | A message describing the issue. | Something doesn't look right about these accounts from Xero. You can see more information in the logs. |
| `links` | [shared.IssueLinks](../../../sdk/models/shared/issuelinks.md) | :heavy_minus_sign: | N/A | |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/issuelinks.md b/platform/docs/sdk/models/shared/issuelinks.md
index d648c6caf..790507c63 100644
--- a/platform/docs/sdk/models/shared/issuelinks.md
+++ b/platform/docs/sdk/models/shared/issuelinks.md
@@ -1,24 +1,21 @@
-# IssueLinks
-
-## Example Usage
-
-```typescript
-import { IssueLinks } from "@codat/platform/sdk/models/shared";
-
-let value: IssueLinks = {
- logs:
- "https://api.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/sync/{datasetId}/validation",
- portal:
- "https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/pull-history",
- readMore:
- "https://docs.codat.io/using-the-api/get-data-troubleshooting#warning.validation",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
-| `logs` | *string* | :heavy_minus_sign: | A link to the validation logs, providing details on any errors or warnings encountered. | https://api.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/sync/{datasetId}/validation |
-| `portal` | *string* | :heavy_minus_sign: | A link to the company's past data read history in the Codat portal. | https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/pull-history |
+# IssueLinks
+
+## Example Usage
+
+```typescript
+import { IssueLinks } from "@codat/platform/sdk/models/shared";
+
+let value: IssueLinks = {
+ logs: "https://api.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/sync/{datasetId}/validation",
+ portal: "https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/pull-history",
+ readMore: "https://docs.codat.io/using-the-api/get-data-troubleshooting#warning.validation",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
+| `logs` | *string* | :heavy_minus_sign: | A link to the validation logs, providing details on any errors or warnings encountered. | https://api.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/sync/{datasetId}/validation |
+| `portal` | *string* | :heavy_minus_sign: | A link to the company's past data read history in the Codat portal. | https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/pull-history |
| `readMore` | *string* | :heavy_minus_sign: | A link to Codat's documentation with additional information on how to troubleshoot this issue. | https://docs.codat.io/using-the-api/get-data-troubleshooting#warning.validation |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/links.md b/platform/docs/sdk/models/shared/links.md
index 876d190cc..25aa07dac 100644
--- a/platform/docs/sdk/models/shared/links.md
+++ b/platform/docs/sdk/models/shared/links.md
@@ -1,25 +1,25 @@
-# Links
-
-## Example Usage
-
-```typescript
-import { Links } from "@codat/platform/sdk/models/shared";
-
-let value: Links = {
- self: {
- href: "/companies",
- },
- current: {
- href: "/companies?page=1&pageSize=10",
- },
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description |
-| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
-| `self` | [shared.HalRef](../../../sdk/models/shared/halref.md) | :heavy_check_mark: | N/A |
-| `current` | [shared.HalRef](../../../sdk/models/shared/halref.md) | :heavy_check_mark: | N/A |
-| `next` | [shared.HalRef](../../../sdk/models/shared/halref.md) | :heavy_minus_sign: | N/A |
+# Links
+
+## Example Usage
+
+```typescript
+import { Links } from "@codat/platform/sdk/models/shared";
+
+let value: Links = {
+ self: {
+ href: "/companies",
+ },
+ current: {
+ href: "/companies?page=1&pageSize=10",
+ },
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
+| `self` | [shared.HalRef](../../../sdk/models/shared/halref.md) | :heavy_check_mark: | N/A |
+| `current` | [shared.HalRef](../../../sdk/models/shared/halref.md) | :heavy_check_mark: | N/A |
+| `next` | [shared.HalRef](../../../sdk/models/shared/halref.md) | :heavy_minus_sign: | N/A |
| `previous` | [shared.HalRef](../../../sdk/models/shared/halref.md) | :heavy_minus_sign: | N/A |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/modifieddate.md b/platform/docs/sdk/models/shared/modifieddate.md
index 488e53ecf..7c0148f63 100644
--- a/platform/docs/sdk/models/shared/modifieddate.md
+++ b/platform/docs/sdk/models/shared/modifieddate.md
@@ -1,17 +1,17 @@
-# ModifiedDate
-
-## Example Usage
-
-```typescript
-import { ModifiedDate } from "@codat/platform/sdk/models/shared";
-
-let value: ModifiedDate = {
- modifiedDate: "2022-10-23T00:00:00Z",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
+# ModifiedDate
+
+## Example Usage
+
+```typescript
+import { ModifiedDate } from "@codat/platform/sdk/models/shared";
+
+let value: ModifiedDate = {
+ modifiedDate: "2022-10-23T00:00:00Z",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
| `modifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/profile.md b/platform/docs/sdk/models/shared/profile.md
index 5d85ae547..9b0eb399f 100644
--- a/platform/docs/sdk/models/shared/profile.md
+++ b/platform/docs/sdk/models/shared/profile.md
@@ -1,35 +1,33 @@
-# Profile
-
-Describes your Codat client instance
-
-## Example Usage
-
-```typescript
-import { Profile } from "@codat/platform/sdk/models/shared";
-
-let value: Profile = {
- name: "Bob's Burgers",
- logoUrl:
- "https://client-images.codat.io/logo/042399f5-d104-4f38-9ce8-cac3524f4e88_5806cb1f-7342-4c0e-a0a8-99bfbc47b0ff.png",
- iconUrl:
- "https://client-images.codat.io/icon/042399f5-d104-4f38-9ce8-cac3524f4e88_3f5623af-d992-4c22-bc08-e58c520a8526.ico",
- redirectUrl: "https://bobs-burgers.{countrySuffix}/{companyId}",
- whiteListUrls: [
- "https://bobs-burgers.com",
- "https://bobs-burgers.co.uk",
- ],
- confirmCompanyName: true,
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `name` | *string* | :heavy_check_mark: | The name given to the instance. | Bob's Burgers |
-| `logoUrl` | *string* | :heavy_minus_sign: | Static url to your organization's logo. | https://client-images.codat.io/logo/042399f5-d104-4f38-9ce8-cac3524f4e88_5806cb1f-7342-4c0e-a0a8-99bfbc47b0ff.png |
-| `iconUrl` | *string* | :heavy_minus_sign: | Static url to your organization's icon. | https://client-images.codat.io/icon/042399f5-d104-4f38-9ce8-cac3524f4e88_3f5623af-d992-4c22-bc08-e58c520a8526.ico |
-| `redirectUrl` | *string* | :heavy_check_mark: | The redirect URL pasted on to the SMB once Codat's [Hosted Link](https://docs.codat.io/auth-flow/authorize-hosted-link) has been completed by the SMB. | https://bobs-burgers.{countrySuffix}/{companyId} |
-| `whiteListUrls` | *string*[] | :heavy_minus_sign: | A list of urls that are allowed to communicate with Codat. If empty any url is allowed to communicate with Codat. | |
-| ~~`apiKey`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.
The API key for this Codat instance. | sartANTjHAkLdbyDfaynoTQb7pkmj6hXHmnQKMrB |
+# Profile
+
+Describes your Codat client instance
+
+## Example Usage
+
+```typescript
+import { Profile } from "@codat/platform/sdk/models/shared";
+
+let value: Profile = {
+ name: "Bob's Burgers",
+ logoUrl: "https://client-images.codat.io/logo/042399f5-d104-4f38-9ce8-cac3524f4e88_5806cb1f-7342-4c0e-a0a8-99bfbc47b0ff.png",
+ iconUrl: "https://client-images.codat.io/icon/042399f5-d104-4f38-9ce8-cac3524f4e88_3f5623af-d992-4c22-bc08-e58c520a8526.ico",
+ redirectUrl: "https://bobs-burgers.{countrySuffix}/{companyId}",
+ whiteListUrls: [
+ "https://bobs-burgers.com",
+ "https://bobs-burgers.co.uk",
+ ],
+ confirmCompanyName: true,
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `name` | *string* | :heavy_check_mark: | The name given to the instance. | Bob's Burgers |
+| `logoUrl` | *string* | :heavy_minus_sign: | Static url to your organization's logo. | https://client-images.codat.io/logo/042399f5-d104-4f38-9ce8-cac3524f4e88_5806cb1f-7342-4c0e-a0a8-99bfbc47b0ff.png |
+| `iconUrl` | *string* | :heavy_minus_sign: | Static url to your organization's icon. | https://client-images.codat.io/icon/042399f5-d104-4f38-9ce8-cac3524f4e88_3f5623af-d992-4c22-bc08-e58c520a8526.ico |
+| `redirectUrl` | *string* | :heavy_check_mark: | The redirect URL pasted on to the SMB once Codat's [Hosted Link](https://docs.codat.io/auth-flow/authorize-hosted-link) has been completed by the SMB. | https://bobs-burgers.{countrySuffix}/{companyId} |
+| `whiteListUrls` | *string*[] | :heavy_minus_sign: | A list of urls that are allowed to communicate with Codat. If empty any url is allowed to communicate with Codat. | |
+| ~~`apiKey`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.
The API key for this Codat instance. | sartANTjHAkLdbyDfaynoTQb7pkmj6hXHmnQKMrB |
| ~~`confirmCompanyName`~~ | *boolean* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.
`True` if the company name has been confirmed. | |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/pulloperation.md b/platform/docs/sdk/models/shared/pulloperation.md
index f2f6a7610..0ff6ac05f 100644
--- a/platform/docs/sdk/models/shared/pulloperation.md
+++ b/platform/docs/sdk/models/shared/pulloperation.md
@@ -1,40 +1,40 @@
-# PullOperation
-
-Information about a queued, in progress or completed pull operation.
-*Formally called `dataset`*
-
-## Example Usage
-
-```typescript
-import { PullOperation } from "@codat/platform/sdk/models/shared";
-
-let value: PullOperation = {
- id: "97d60846-f07a-4d42-b5a0-0bdcc6ebf56b",
- companyId: "4645bd78-8988-45bc-ac9e-67ba5df6e4e5",
- connectionId: "51baa045-4836-4317-a42e-3542e991e581",
- dataType: "invoices",
- status: "Initial",
- statusDescription: "Paused until 2022-10-23T00:00:00.000Z",
- requested: "2022-11-14T11:18:37.2798351Z",
- progress: 10,
- isCompleted: false,
- isErrored: false,
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `id` | *string* | :heavy_check_mark: | Unique identifier of the pull operation. | 943accd0-4247-42d8-865b-363c8629e1da |
-| `companyId` | *string* | :heavy_check_mark: | Unique identifier of the company associated to this pull operation. | 22ece347-e5f6-4896-95e0-35a4c7f17023 |
-| `connectionId` | *string* | :heavy_check_mark: | Unique identifier of the connection associated to this pull operation. | 50830828-7d39-4367-b0eb-5ddb2de5faa5 |
-| `dataType` | *string* | :heavy_check_mark: | The data type you are requesting in a pull operation. | |
-| `status` | [shared.DatasetStatus](../../../sdk/models/shared/datasetstatus.md) | :heavy_check_mark: | The current status of the dataset. | |
-| `statusDescription` | *string* | :heavy_minus_sign: | Additional information about the dataset status. | Paused until 2022-10-23T00:00:00.000Z |
-| `errorMessage` | *string* | :heavy_minus_sign: | A message about a transient or persistent error returned by Codat or the source platform. | |
-| `requested` | *string* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 |
-| `completed` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 |
-| `progress` | *number* | :heavy_check_mark: | An integer signifying the progress of the pull operation. | |
-| `isCompleted` | *boolean* | :heavy_check_mark: | `True` if the pull operation is completed successfully. The `isCompleted` property is not queryable. To filter failed pull operations, query by `status!=Complete&&status!=NotSupported` instead. | |
+# PullOperation
+
+Information about a queued, in progress or completed pull operation.
+*Formally called `dataset`*
+
+## Example Usage
+
+```typescript
+import { PullOperation } from "@codat/platform/sdk/models/shared";
+
+let value: PullOperation = {
+ id: "97d60846-f07a-4d42-b5a0-0bdcc6ebf56b",
+ companyId: "4645bd78-8988-45bc-ac9e-67ba5df6e4e5",
+ connectionId: "51baa045-4836-4317-a42e-3542e991e581",
+ dataType: "invoices",
+ status: "Initial",
+ statusDescription: "Paused until 2022-10-23T00:00:00.000Z",
+ requested: "2022-11-14T11:18:37.2798351Z",
+ progress: 10,
+ isCompleted: false,
+ isErrored: false,
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `id` | *string* | :heavy_check_mark: | Unique identifier of the pull operation. | 943accd0-4247-42d8-865b-363c8629e1da |
+| `companyId` | *string* | :heavy_check_mark: | Unique identifier of the company associated to this pull operation. | 22ece347-e5f6-4896-95e0-35a4c7f17023 |
+| `connectionId` | *string* | :heavy_check_mark: | Unique identifier of the connection associated to this pull operation. | 50830828-7d39-4367-b0eb-5ddb2de5faa5 |
+| `dataType` | *string* | :heavy_check_mark: | The data type you are requesting in a pull operation. | |
+| `status` | [shared.DatasetStatus](../../../sdk/models/shared/datasetstatus.md) | :heavy_check_mark: | The current status of the dataset. | |
+| `statusDescription` | *string* | :heavy_minus_sign: | Additional information about the dataset status. | Paused until 2022-10-23T00:00:00.000Z |
+| `errorMessage` | *string* | :heavy_minus_sign: | A message about a transient or persistent error returned by Codat or the source platform. | |
+| `requested` | *string* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 |
+| `completed` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 |
+| `progress` | *number* | :heavy_check_mark: | An integer signifying the progress of the pull operation. | |
+| `isCompleted` | *boolean* | :heavy_check_mark: | `True` if the pull operation is completed successfully. The `isCompleted` property is not queryable. To filter failed pull operations, query by `status!=Complete&&status!=NotSupported` instead. | |
| `isErrored` | *boolean* | :heavy_check_mark: | `True` if the pull operation entered an error state. | |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/pulloperations.md b/platform/docs/sdk/models/shared/pulloperations.md
index 31cd22223..3a5e4dafb 100644
--- a/platform/docs/sdk/models/shared/pulloperations.md
+++ b/platform/docs/sdk/models/shared/pulloperations.md
@@ -1,31 +1,23 @@
-# PullOperations
-
-## Example Usage
-
-```typescript
-import { PullOperations } from "@codat/platform/sdk/models/shared";
-
-let value: PullOperations = {
- pageNumber: 1,
- pageSize: 10,
- totalResults: 1,
- links: {
- self: {
- href: "/companies/{id}/data/{dataType}",
- },
- current: {
- href: "/companies/{id}/data/{dataType}?page=1&pageSize=10",
- },
- },
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
-| `results` | [shared.PullOperation](../../../sdk/models/shared/pulloperation.md)[] | :heavy_minus_sign: | N/A | |
-| `pageNumber` | *number* | :heavy_check_mark: | Current page number. | |
-| `pageSize` | *number* | :heavy_check_mark: | Number of items to return in results array. | |
-| `totalResults` | *number* | :heavy_check_mark: | Total number of items. | |
-| `links` | [shared.Links](../../../sdk/models/shared/links.md) | :heavy_check_mark: | N/A | {
"self": {
"href": "/companies"
},
"current": {
"href": "/companies?page=1\u0026pageSize=10"
}
} |
\ No newline at end of file
+# PullOperations
+
+## Example Usage
+
+```typescript
+import { PullOperations } from "@codat/platform/sdk/models/shared";
+
+let value: PullOperations = {
+ pageNumber: 0,
+ pageSize: 0,
+ totalResults: 0,
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
+| `pageNumber` | *number* | :heavy_check_mark: | Current page number. |
+| `pageSize` | *number* | :heavy_check_mark: | Number of items to return in results array. |
+| `totalResults` | *number* | :heavy_check_mark: | Total number of items. |
+| `links` | [shared.Links](../../../sdk/models/shared/links.md) | :heavy_check_mark: | N/A |
+| `results` | [shared.PullOperation](../../../sdk/models/shared/pulloperation.md)[] | :heavy_minus_sign: | N/A |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/pushchangetype.md b/platform/docs/sdk/models/shared/pushchangetype.md
index da6c98fa6..8339c3422 100644
--- a/platform/docs/sdk/models/shared/pushchangetype.md
+++ b/platform/docs/sdk/models/shared/pushchangetype.md
@@ -1,17 +1,17 @@
-# PushChangeType
-
-Type of change being applied to record in third party platform.
-
-## Example Usage
-
-```typescript
-import { PushChangeType } from "@codat/platform/sdk/models/shared";
-
-let value: PushChangeType = "Created";
-```
-
-## Values
-
-```typescript
-"Unknown" | "Created" | "Modified" | "Deleted" | "AttachmentUploaded"
+# PushChangeType
+
+Type of change being applied to record in third party platform.
+
+## Example Usage
+
+```typescript
+import { PushChangeType } from "@codat/platform/sdk/models/shared";
+
+let value: PushChangeType = "Unknown";
+```
+
+## Values
+
+```typescript
+"Unknown" | "Created" | "Modified" | "Deleted" | "AttachmentUploaded"
```
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/pushfieldvalidation.md b/platform/docs/sdk/models/shared/pushfieldvalidation.md
index 98172ed93..83ebb1043 100644
--- a/platform/docs/sdk/models/shared/pushfieldvalidation.md
+++ b/platform/docs/sdk/models/shared/pushfieldvalidation.md
@@ -1,19 +1,19 @@
-# PushFieldValidation
-
-## Example Usage
-
-```typescript
-import { PushFieldValidation } from "@codat/platform/sdk/models/shared";
-
-let value: PushFieldValidation = {
- details: "",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description |
-| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
-| `field` | *string* | :heavy_minus_sign: | Field name that resulted in the validation issue. |
-| `details` | *string* | :heavy_check_mark: | Details on the validation issue. |
+# PushFieldValidation
+
+## Example Usage
+
+```typescript
+import { PushFieldValidation } from "@codat/platform/sdk/models/shared";
+
+let value: PushFieldValidation = {
+ details: "string",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
+| `field` | *string* | :heavy_minus_sign: | Field name that resulted in the validation issue. |
+| `details` | *string* | :heavy_check_mark: | Details on the validation issue. |
| `ref` | *string* | :heavy_minus_sign: | Unique reference identifier for the validation issue. |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/pushoperation.md b/platform/docs/sdk/models/shared/pushoperation.md
index b50671be3..a8f4a9930 100644
--- a/platform/docs/sdk/models/shared/pushoperation.md
+++ b/platform/docs/sdk/models/shared/pushoperation.md
@@ -1,37 +1,36 @@
-# PushOperation
-
-## Example Usage
-
-```typescript
-import { PushOperation } from "@codat/platform/sdk/models/shared";
-
-let value: PushOperation = {
- changes: null,
- dataType: "invoices",
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- pushOperationKey: "9c39f707-db6c-421b-b270-d82fde811810",
- dataConnectionKey: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
- requestedOnUtc: "2022-10-23T00:00:00Z",
- completedOnUtc: "2022-10-23T00:00:00Z",
- status: "Failed",
- statusCode: 143409,
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `changes` | [shared.PushOperationChange](../../../sdk/models/shared/pushoperationchange.md)[] | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | |
-| `dataType` | [shared.DataType](../../../sdk/models/shared/datatype.md) | :heavy_minus_sign: | Available data types | invoices |
-| `companyId` | *string* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
-| `pushOperationKey` | *string* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | |
-| `dataConnectionKey` | *string* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 |
-| `requestedOnUtc` | *string* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 |
-| `completedOnUtc` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 |
-| `timeoutInMinutes` | *number* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | |
-| ~~`timeoutInSeconds`~~ | *number* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.
Number of seconds the push operation must complete within before it times out. | |
-| `status` | [shared.PushOperationStatus](../../../sdk/models/shared/pushoperationstatus.md) | :heavy_check_mark: | The current status of the push operation. | |
-| `errorMessage` | *string* | :heavy_minus_sign: | A message about the error. | |
-| `validation` | [shared.Validation](../../../sdk/models/shared/validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | |
+# PushOperation
+
+## Example Usage
+
+```typescript
+import { PushOperation } from "@codat/platform/sdk/models/shared";
+
+let value: PushOperation = {
+ dataType: "invoices",
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ pushOperationKey: "string",
+ dataConnectionKey: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+ requestedOnUtc: "2022-10-23T00:00:00Z",
+ completedOnUtc: "2022-10-23T00:00:00Z",
+ status: "string",
+ statusCode: 0,
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `changes` | [shared.PushOperationChange](../../../sdk/models/shared/pushoperationchange.md)[] | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | |
+| `dataType` | [shared.DataType](../../../sdk/models/shared/datatype.md) | :heavy_minus_sign: | Available data types | invoices |
+| `companyId` | *string* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
+| `pushOperationKey` | *string* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | |
+| `dataConnectionKey` | *string* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 |
+| `requestedOnUtc` | *string* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 |
+| `completedOnUtc` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 |
+| `timeoutInMinutes` | *number* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | |
+| ~~`timeoutInSeconds`~~ | *number* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.
Number of seconds the push operation must complete within before it times out. | |
+| `status` | [shared.PushOperationStatus](../../../sdk/models/shared/pushoperationstatus.md) | :heavy_check_mark: | The current status of the push operation. | |
+| `errorMessage` | *string* | :heavy_minus_sign: | A message about the error. | |
+| `validation` | [shared.Validation](../../../sdk/models/shared/validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | |
| `statusCode` | *number* | :heavy_check_mark: | Push status code. | |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/pushoperationchange.md b/platform/docs/sdk/models/shared/pushoperationchange.md
index 083b16dc3..7cbb3600b 100644
--- a/platform/docs/sdk/models/shared/pushoperationchange.md
+++ b/platform/docs/sdk/models/shared/pushoperationchange.md
@@ -1,21 +1,17 @@
-# PushOperationChange
-
-## Example Usage
-
-```typescript
-import { PushOperationChange } from "@codat/platform/sdk/models/shared";
-
-let value: PushOperationChange = {
- recordRef: {
- dataType: "invoices",
- },
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description |
-| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
-| `type` | [shared.PushChangeType](../../../sdk/models/shared/pushchangetype.md) | :heavy_minus_sign: | Type of change being applied to record in third party platform. |
-| `recordRef` | [shared.PushOperationRef](../../../sdk/models/shared/pushoperationref.md) | :heavy_minus_sign: | N/A |
+# PushOperationChange
+
+## Example Usage
+
+```typescript
+import { PushOperationChange } from "@codat/platform/sdk/models/shared";
+
+let value: PushOperationChange = {};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
+| `type` | [shared.PushChangeType](../../../sdk/models/shared/pushchangetype.md) | :heavy_minus_sign: | N/A |
+| `recordRef` | [shared.PushOperationRef](../../../sdk/models/shared/pushoperationref.md) | :heavy_minus_sign: | N/A |
| `attachmentId` | *string* | :heavy_minus_sign: | Unique identifier for the attachment created otherwise null. |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/pushoperationref.md b/platform/docs/sdk/models/shared/pushoperationref.md
index 28e8772a8..c4aad3c67 100644
--- a/platform/docs/sdk/models/shared/pushoperationref.md
+++ b/platform/docs/sdk/models/shared/pushoperationref.md
@@ -1,18 +1,16 @@
-# PushOperationRef
-
-## Example Usage
-
-```typescript
-import { PushOperationRef } from "@codat/platform/sdk/models/shared";
-
-let value: PushOperationRef = {
- dataType: "invoices",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- |
-| `id` | *string* | :heavy_minus_sign: | Unique identifier for a push operation. | |
-| `dataType` | [shared.DataType](../../../sdk/models/shared/datatype.md) | :heavy_minus_sign: | Available data types | invoices |
\ No newline at end of file
+# PushOperationRef
+
+## Example Usage
+
+```typescript
+import { PushOperationRef } from "@codat/platform/sdk/models/shared";
+
+let value: PushOperationRef = {};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- |
+| `id` | *string* | :heavy_minus_sign: | Unique identifier for a push operation. |
+| `dataType` | [shared.DataType](../../../sdk/models/shared/datatype.md) | :heavy_minus_sign: | Available data types |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/pushoperations.md b/platform/docs/sdk/models/shared/pushoperations.md
index b9c08aa7f..a89d2129b 100644
--- a/platform/docs/sdk/models/shared/pushoperations.md
+++ b/platform/docs/sdk/models/shared/pushoperations.md
@@ -1,31 +1,23 @@
-# PushOperations
-
-## Example Usage
-
-```typescript
-import { PushOperations } from "@codat/platform/sdk/models/shared";
-
-let value: PushOperations = {
- pageNumber: 1,
- pageSize: 10,
- totalResults: 1,
- links: {
- self: {
- href: "/companies/{id}/data/{dataType}",
- },
- current: {
- href: "/companies/{id}/data/{dataType}?page=1&pageSize=10",
- },
- },
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
-| `results` | [shared.PushOperation](../../../sdk/models/shared/pushoperation.md)[] | :heavy_minus_sign: | N/A | |
-| `pageNumber` | *number* | :heavy_check_mark: | Current page number. | |
-| `pageSize` | *number* | :heavy_check_mark: | Number of items to return in results array. | |
-| `totalResults` | *number* | :heavy_check_mark: | Total number of items. | |
-| `links` | [shared.Links](../../../sdk/models/shared/links.md) | :heavy_check_mark: | N/A | {
"self": {
"href": "/companies"
},
"current": {
"href": "/companies?page=1\u0026pageSize=10"
}
} |
\ No newline at end of file
+# PushOperations
+
+## Example Usage
+
+```typescript
+import { PushOperations } from "@codat/platform/sdk/models/shared";
+
+let value: PushOperations = {
+ pageNumber: 0,
+ pageSize: 0,
+ totalResults: 0,
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
+| `pageNumber` | *number* | :heavy_check_mark: | Current page number. |
+| `pageSize` | *number* | :heavy_check_mark: | Number of items to return in results array. |
+| `totalResults` | *number* | :heavy_check_mark: | Total number of items. |
+| `links` | [shared.Links](../../../sdk/models/shared/links.md) | :heavy_check_mark: | N/A |
+| `results` | [shared.PushOperation](../../../sdk/models/shared/pushoperation.md)[] | :heavy_minus_sign: | N/A |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/pushoperationstatus.md b/platform/docs/sdk/models/shared/pushoperationstatus.md
index c75d37cde..61ec86d77 100644
--- a/platform/docs/sdk/models/shared/pushoperationstatus.md
+++ b/platform/docs/sdk/models/shared/pushoperationstatus.md
@@ -1,17 +1,17 @@
-# PushOperationStatus
-
-The current status of the push operation.
-
-## Example Usage
-
-```typescript
-import { PushOperationStatus } from "@codat/platform/sdk/models/shared";
-
-let value: PushOperationStatus = "Failed";
-```
-
-## Values
-
-```typescript
-"Pending" | "Failed" | "Success" | "TimedOut"
+# PushOperationStatus
+
+The current status of the push operation.
+
+## Example Usage
+
+```typescript
+import { PushOperationStatus } from "@codat/platform/sdk/models/shared";
+
+let value: PushOperationStatus = "Pending";
+```
+
+## Values
+
+```typescript
+"Pending" | "Failed" | "Success" | "TimedOut"
```
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/pushoption.md b/platform/docs/sdk/models/shared/pushoption.md
index a91aa1032..41eb3af3d 100644
--- a/platform/docs/sdk/models/shared/pushoption.md
+++ b/platform/docs/sdk/models/shared/pushoption.md
@@ -1,25 +1,25 @@
-# PushOption
-
-## Example Usage
-
-```typescript
-import { PushOption } from "@codat/platform/sdk/models/shared";
-
-let value: PushOption = {
- type: "MultiPart",
- displayName: "Travis.Ebert-Fahey",
- required: false,
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description |
-| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
-| `type` | [shared.PushOptionType](../../../sdk/models/shared/pushoptiontype.md) | :heavy_check_mark: | The option type. |
-| `displayName` | *string* | :heavy_check_mark: | The property's display name. |
-| `description` | *string* | :heavy_minus_sign: | A description of the property. |
-| `required` | *boolean* | :heavy_check_mark: | The property is required if `True`. |
-| `properties` | Record | :heavy_minus_sign: | N/A |
-| `options` | [shared.PushOptionChoice](../../../sdk/models/shared/pushoptionchoice.md)[] | :heavy_minus_sign: | N/A |
+# PushOption
+
+## Example Usage
+
+```typescript
+import { PushOption } from "@codat/platform/sdk/models/shared";
+
+let value: PushOption = {
+ type: "string",
+ displayName: "string",
+ required: false,
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `type` | [shared.PushOptionType](../../../sdk/models/shared/pushoptiontype.md) | :heavy_check_mark: | The option type. |
+| `displayName` | *string* | :heavy_check_mark: | The property's display name. |
+| `description` | *string* | :heavy_minus_sign: | A description of the property. |
+| `required` | *boolean* | :heavy_check_mark: | The property is required if `True`. |
+| `properties` | Record | :heavy_minus_sign: | N/A |
+| `options` | [shared.PushOptionChoice](../../../sdk/models/shared/pushoptionchoice.md)[] | :heavy_minus_sign: | N/A |
| `validation` | [shared.PushValidationInfo](../../../sdk/models/shared/pushvalidationinfo.md) | :heavy_minus_sign: | N/A |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/pushoptionchoice.md b/platform/docs/sdk/models/shared/pushoptionchoice.md
index 4240342e8..b5ab8b664 100644
--- a/platform/docs/sdk/models/shared/pushoptionchoice.md
+++ b/platform/docs/sdk/models/shared/pushoptionchoice.md
@@ -1,19 +1,19 @@
-# PushOptionChoice
-
-## Example Usage
-
-```typescript
-import { PushOptionChoice } from "@codat/platform/sdk/models/shared";
-
-let value: PushOptionChoice = {};
-```
-
-## Fields
-
-| Field | Type | Required | Description |
-| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
-| `value` | *string* | :heavy_minus_sign: | Allowed value for field. |
-| `type` | [shared.PushOptionType](../../../sdk/models/shared/pushoptiontype.md) | :heavy_minus_sign: | The option type. |
-| `displayName` | *string* | :heavy_minus_sign: | The property's display name. |
-| `description` | *string* | :heavy_minus_sign: | A description of the property. |
+# PushOptionChoice
+
+## Example Usage
+
+```typescript
+import { PushOptionChoice } from "@codat/platform/sdk/models/shared";
+
+let value: PushOptionChoice = {};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
+| `value` | *string* | :heavy_minus_sign: | Allowed value for field. |
+| `type` | [shared.PushOptionType](../../../sdk/models/shared/pushoptiontype.md) | :heavy_minus_sign: | The option type. |
+| `displayName` | *string* | :heavy_minus_sign: | The property's display name. |
+| `description` | *string* | :heavy_minus_sign: | A description of the property. |
| `required` | *boolean* | :heavy_minus_sign: | The property is required if `True`. |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/pushoptionproperty.md b/platform/docs/sdk/models/shared/pushoptionproperty.md
index 220725e19..6ab752847 100644
--- a/platform/docs/sdk/models/shared/pushoptionproperty.md
+++ b/platform/docs/sdk/models/shared/pushoptionproperty.md
@@ -1,27 +1,26 @@
-# PushOptionProperty
-
-## Example Usage
-
-```typescript
-import { PushOptionProperty } from "@codat/platform/sdk/models/shared";
-
-let value: PushOptionProperty = {
- type: "Array",
- displayName: "Fannie10",
- description:
- "sonar very sympathetically notwithstanding alarmed modulo grizzled",
- required: true,
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description |
-| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
-| `type` | [shared.PushOptionType](../../../sdk/models/shared/pushoptiontype.md) | :heavy_check_mark: | The option type. |
-| `displayName` | *string* | :heavy_check_mark: | The property's display name. |
-| `description` | *string* | :heavy_check_mark: | A description of the property. |
-| `required` | *boolean* | :heavy_check_mark: | The property is required if `True`. |
-| `properties` | Record | :heavy_minus_sign: | N/A |
-| `options` | [shared.PushOptionChoice](../../../sdk/models/shared/pushoptionchoice.md)[] | :heavy_minus_sign: | N/A |
+# PushOptionProperty
+
+## Example Usage
+
+```typescript
+import { PushOptionProperty } from "@codat/platform/sdk/models/shared";
+
+let value: PushOptionProperty = {
+ type: "string",
+ displayName: "string",
+ description: "string",
+ required: false,
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `type` | [shared.PushOptionType](../../../sdk/models/shared/pushoptiontype.md) | :heavy_check_mark: | The option type. |
+| `displayName` | *string* | :heavy_check_mark: | The property's display name. |
+| `description` | *string* | :heavy_check_mark: | A description of the property. |
+| `required` | *boolean* | :heavy_check_mark: | The property is required if `True`. |
+| `properties` | Record | :heavy_minus_sign: | N/A |
+| `options` | [shared.PushOptionChoice](../../../sdk/models/shared/pushoptionchoice.md)[] | :heavy_minus_sign: | N/A |
| `validation` | [shared.PushValidationInfo](../../../sdk/models/shared/pushvalidationinfo.md) | :heavy_minus_sign: | N/A |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/pushoptiontype.md b/platform/docs/sdk/models/shared/pushoptiontype.md
index f96bd53ea..cf118c7f4 100644
--- a/platform/docs/sdk/models/shared/pushoptiontype.md
+++ b/platform/docs/sdk/models/shared/pushoptiontype.md
@@ -1,17 +1,17 @@
-# PushOptionType
-
-The option type.
-
-## Example Usage
-
-```typescript
-import { PushOptionType } from "@codat/platform/sdk/models/shared";
-
-let value: PushOptionType = "DateTime";
-```
-
-## Values
-
-```typescript
-"Array" | "Object" | "String" | "Number" | "Boolean" | "DateTime" | "File" | "MultiPart"
+# PushOptionType
+
+The option type.
+
+## Example Usage
+
+```typescript
+import { PushOptionType } from "@codat/platform/sdk/models/shared";
+
+let value: PushOptionType = "Array";
+```
+
+## Values
+
+```typescript
+"Array" | "Object" | "String" | "Number" | "Boolean" | "DateTime" | "File" | "MultiPart"
```
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/pushvalidationinfo.md b/platform/docs/sdk/models/shared/pushvalidationinfo.md
index 976ca04d3..36e13c123 100644
--- a/platform/docs/sdk/models/shared/pushvalidationinfo.md
+++ b/platform/docs/sdk/models/shared/pushvalidationinfo.md
@@ -1,16 +1,16 @@
-# PushValidationInfo
-
-## Example Usage
-
-```typescript
-import { PushValidationInfo } from "@codat/platform/sdk/models/shared";
-
-let value: PushValidationInfo = {};
-```
-
-## Fields
-
-| Field | Type | Required | Description |
-| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
-| `warnings` | [shared.PushFieldValidation](../../../sdk/models/shared/pushfieldvalidation.md)[] | :heavy_minus_sign: | N/A |
+# PushValidationInfo
+
+## Example Usage
+
+```typescript
+import { PushValidationInfo } from "@codat/platform/sdk/models/shared";
+
+let value: PushValidationInfo = {};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
+| `warnings` | [shared.PushFieldValidation](../../../sdk/models/shared/pushfieldvalidation.md)[] | :heavy_minus_sign: | N/A |
| `information` | [shared.PushFieldValidation](../../../sdk/models/shared/pushfieldvalidation.md)[] | :heavy_minus_sign: | N/A |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/readcompletedwebhook.md b/platform/docs/sdk/models/shared/readcompletedwebhook.md
index cb71ac729..fe6f5ad48 100644
--- a/platform/docs/sdk/models/shared/readcompletedwebhook.md
+++ b/platform/docs/sdk/models/shared/readcompletedwebhook.md
@@ -1,51 +1,21 @@
-# ReadCompletedWebhook
-
-## Example Usage
-
-```typescript
-import { ReadCompletedWebhook } from "@codat/platform/sdk/models/shared";
-
-let value: ReadCompletedWebhook = {
- id: "743ec94a-8aa4-44bb-8bd4-e1855ee0e74b",
- generatedDate: "2022-10-23T00:00:00Z",
- payload: {
- referenceCompany: {
- id: "8a210b68-6988-11ed-a1eb-0242ac120002",
- name: "Codat Ltd.",
- description: "Requested early access to the new financing scheme.",
- },
- modifiedFromDate: "2022-10-23T00:00:00Z",
- dataTypes: [
- {
- connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
- dataType: "invoices",
- recordsModified: false,
- issues: [
- {
- type: "warning.validation",
- message:
- "Something doesn't look right about these accounts from Xero. You can see more information in the logs.",
- links: {
- logs:
- "https://api.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/sync/{datasetId}/validation",
- portal:
- "https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/pull-history",
- readMore:
- "https://docs.codat.io/using-the-api/get-data-troubleshooting#warning.validation",
- },
- },
- ],
- },
- ],
- },
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `id` | *string* | :heavy_minus_sign: | Unique identifier of the event. | 743ec94a-8aa4-44bb-8bd4-e1855ee0e74b |
-| `eventType` | *string* | :heavy_minus_sign: | The type of event. | |
-| `generatedDate` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 |
+# ReadCompletedWebhook
+
+## Example Usage
+
+```typescript
+import { ReadCompletedWebhook } from "@codat/platform/sdk/models/shared";
+
+let value: ReadCompletedWebhook = {
+ id: "743ec94a-8aa4-44bb-8bd4-e1855ee0e74b",
+ generatedDate: "2022-10-23T00:00:00Z",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `id` | *string* | :heavy_minus_sign: | Unique identifier of the event. | 743ec94a-8aa4-44bb-8bd4-e1855ee0e74b |
+| `eventType` | *string* | :heavy_minus_sign: | The type of event. | |
+| `generatedDate` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 |
| `payload` | [shared.ReadCompletedWebhookPayload](../../../sdk/models/shared/readcompletedwebhookpayload.md) | :heavy_minus_sign: | N/A | |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/readcompletedwebhookpayload.md b/platform/docs/sdk/models/shared/readcompletedwebhookpayload.md
index fb29e779b..525733d10 100644
--- a/platform/docs/sdk/models/shared/readcompletedwebhookpayload.md
+++ b/platform/docs/sdk/models/shared/readcompletedwebhookpayload.md
@@ -1,46 +1,17 @@
-# ReadCompletedWebhookPayload
-
-## Example Usage
-
-```typescript
-import { ReadCompletedWebhookPayload } from "@codat/platform/sdk/models/shared";
-
-let value: ReadCompletedWebhookPayload = {
- referenceCompany: {
- id: "8a210b68-6988-11ed-a1eb-0242ac120002",
- name: "Codat Ltd.",
- description: "Requested early access to the new financing scheme.",
- },
- modifiedFromDate: "2022-10-23T00:00:00Z",
- dataTypes: [
- {
- connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
- dataType: "invoices",
- recordsModified: false,
- issues: [
- {
- type: "warning.validation",
- message:
- "Something doesn't look right about these accounts from Xero. You can see more information in the logs.",
- links: {
- logs:
- "https://api.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/sync/{datasetId}/validation",
- portal:
- "https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/pull-history",
- readMore:
- "https://docs.codat.io/using-the-api/get-data-troubleshooting#warning.validation",
- },
- },
- ],
- },
- ],
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `referenceCompany` | [shared.CompanyReference](../../../sdk/models/shared/companyreference.md) | :heavy_minus_sign: | N/A | |
-| `modifiedFromDate` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 |
-| `dataTypes` | [shared.DataTypeReadSummary](../../../sdk/models/shared/datatypereadsummary.md)[] | :heavy_minus_sign: | N/A | |
\ No newline at end of file
+# ReadCompletedWebhookPayload
+
+## Example Usage
+
+```typescript
+import { ReadCompletedWebhookPayload } from "@codat/platform/sdk/models/shared";
+
+let value: ReadCompletedWebhookPayload = {};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `referenceCompany` | [shared.CompanyReference](../../../sdk/models/shared/companyreference.md) | :heavy_minus_sign: | N/A |
+| `modifiedFromDate` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. |
+| `dataTypes` | [shared.DataTypeReadSummary](../../../sdk/models/shared/datatypereadsummary.md)[] | :heavy_minus_sign: | N/A |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/schemadatatype.md b/platform/docs/sdk/models/shared/schemadatatype.md
index 54ebf76d2..e7489ab20 100644
--- a/platform/docs/sdk/models/shared/schemadatatype.md
+++ b/platform/docs/sdk/models/shared/schemadatatype.md
@@ -1,17 +1,15 @@
-# SchemaDataType
-
-Available data types
-
-## Example Usage
-
-```typescript
-import { SchemaDataType } from "@codat/platform/sdk/models/shared";
-
-let value: SchemaDataType = "invoices";
-```
-
-## Values
-
-```typescript
-"accountTransactions" | "balanceSheet" | "bankAccounts" | "bankTransactions" | "billCreditNotes" | "billPayments" | "bills" | "cashFlowStatement" | "chartOfAccounts" | "company" | "creditNotes" | "customers" | "directCosts" | "directIncomes" | "invoices" | "itemReceipts" | "items" | "journalEntries" | "journals" | "paymentMethods" | "payments" | "profitAndLoss" | "purchaseOrders" | "salesOrders" | "suppliers" | "taxRates" | "trackingCategories" | "transfers" | "banking-accountBalances" | "banking-accounts" | "banking-transactionCategories" | "banking-transactions" | "commerce-companyInfo" | "commerce-customers" | "commerce-disputes" | "commerce-locations" | "commerce-orders" | "commerce-paymentMethods" | "commerce-payments" | "commerce-productCategories" | "commerce-products" | "commerce-taxComponents" | "commerce-transactions"
+# SchemaDataType
+
+## Example Usage
+
+```typescript
+import { SchemaDataType } from "@codat/platform/sdk/models/shared";
+
+let value: SchemaDataType = "";
+```
+
+## Values
+
+```typescript
+
```
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/security.md b/platform/docs/sdk/models/shared/security.md
index 570497a1f..1773d015b 100644
--- a/platform/docs/sdk/models/shared/security.md
+++ b/platform/docs/sdk/models/shared/security.md
@@ -1,17 +1,15 @@
-# Security
-
-## Example Usage
-
-```typescript
-import { Security } from "@codat/platform/sdk/models/shared";
-
-let value: Security = {
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
-| `authHeader` | *string* | :heavy_check_mark: | N/A | Basic BASE_64_ENCODED(API_KEY) |
\ No newline at end of file
+# Security
+
+## Example Usage
+
+```typescript
+import { Security } from "@codat/platform/sdk/models/shared";
+
+let value: Security = {};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `authHeader` | *string* | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/sourcetype.md b/platform/docs/sdk/models/shared/sourcetype.md
index 8ec02b1fd..1432317ae 100644
--- a/platform/docs/sdk/models/shared/sourcetype.md
+++ b/platform/docs/sdk/models/shared/sourcetype.md
@@ -1,17 +1,17 @@
-# SourceType
-
-The type of platform of the connection.
-
-## Example Usage
-
-```typescript
-import { SourceType } from "@codat/platform/sdk/models/shared";
-
-let value: SourceType = "Accounting";
-```
-
-## Values
-
-```typescript
-"Accounting" | "Banking" | "BankFeed" | "Commerce" | "Expense" | "Other" | "Unknown"
+# SourceType
+
+The type of platform of the connection.
+
+## Example Usage
+
+```typescript
+import { SourceType } from "@codat/platform/sdk/models/shared";
+
+let value: SourceType = "Accounting";
+```
+
+## Values
+
+```typescript
+"Accounting" | "Banking" | "BankFeed" | "Commerce" | "Expense" | "Other" | "Unknown"
```
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/status.md b/platform/docs/sdk/models/shared/status.md
index 7a98b6153..7d6daae9d 100644
--- a/platform/docs/sdk/models/shared/status.md
+++ b/platform/docs/sdk/models/shared/status.md
@@ -1,17 +1,17 @@
-# Status
-
-The current status of the dataset.
-
-## Example Usage
-
-```typescript
-import { Status } from "@codat/platform/sdk/models/shared";
-
-let value: Status = "Validating";
-```
-
-## Values
-
-```typescript
-"Initial" | "Queued" | "Fetching" | "MapQueued" | "Mapping" | "Complete" | "FetchError" | "MapError" | "InternalError" | "ProcessingQueued" | "Processing" | "ProcessingError" | "ValidationQueued" | "Validating" | "ValidationError" | "AuthError" | "Cancelled" | "NotSupported" | "RateLimitError" | "PermissionsError" | "PrerequisiteNotMet"
+# Status
+
+The current status of the dataset.
+
+## Example Usage
+
+```typescript
+import { Status } from "@codat/platform/sdk/models/shared";
+
+let value: Status = "Initial";
+```
+
+## Values
+
+```typescript
+"Initial" | "Queued" | "Fetching" | "MapQueued" | "Mapping" | "Complete" | "FetchError" | "MapError" | "InternalError" | "ProcessingQueued" | "Processing" | "ProcessingError" | "ValidationQueued" | "Validating" | "ValidationError" | "AuthError" | "Cancelled" | "NotSupported" | "RateLimitError" | "PermissionsError" | "PrerequisiteNotMet"
```
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/supplementaldataconfiguration.md b/platform/docs/sdk/models/shared/supplementaldataconfiguration.md
index 8abb9c9fd..c76473335 100644
--- a/platform/docs/sdk/models/shared/supplementaldataconfiguration.md
+++ b/platform/docs/sdk/models/shared/supplementaldataconfiguration.md
@@ -1,27 +1,27 @@
-# SupplementalDataConfiguration
-
-## Example Usage
-
-```typescript
-import { SupplementalDataConfiguration } from "@codat/platform/sdk/models/shared";
-
-let value: SupplementalDataConfiguration = {
- supplementalDataConfig: {
- "orders-supplemental-data": {
- dataSource: "/orders",
- pullData: {
- "orderNumber": "order_num",
- },
- pushData: {
- "orderNumber": "order_num",
- },
- },
- },
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
+# SupplementalDataConfiguration
+
+## Example Usage
+
+```typescript
+import { SupplementalDataConfiguration } from "@codat/platform/sdk/models/shared";
+
+let value: SupplementalDataConfiguration = {
+ supplementalDataConfig: {
+ "orders-supplemental-data": {
+ dataSource: "/orders",
+ pullData: {
+ "orderNumber": "order_num",
+ },
+ pushData: {
+ "orderNumber": "order_num",
+ },
+ },
+ },
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `supplementalDataConfig` | Record | :heavy_minus_sign: | N/A |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/supplementaldatasourceconfiguration.md b/platform/docs/sdk/models/shared/supplementaldatasourceconfiguration.md
index 0fc38e7d6..d705f098d 100644
--- a/platform/docs/sdk/models/shared/supplementaldatasourceconfiguration.md
+++ b/platform/docs/sdk/models/shared/supplementaldatasourceconfiguration.md
@@ -1,19 +1,19 @@
-# SupplementalDataSourceConfiguration
-
-The client's defined name for the object.
-
-## Example Usage
-
-```typescript
-import { SupplementalDataSourceConfiguration } from "@codat/platform/sdk/models/shared";
-
-let value: SupplementalDataSourceConfiguration = {};
-```
-
-## Fields
-
-| Field | Type | Required | Description |
-| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
-| `dataSource` | *string* | :heavy_minus_sign: | The underlying endpoint of the source system which the configuration is targeting. |
-| `pullData` | Record | :heavy_minus_sign: | The additional properties that are required when pulling records. |
+# SupplementalDataSourceConfiguration
+
+The client's defined name for the object.
+
+## Example Usage
+
+```typescript
+import { SupplementalDataSourceConfiguration } from "@codat/platform/sdk/models/shared";
+
+let value: SupplementalDataSourceConfiguration = {};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
+| `dataSource` | *string* | :heavy_minus_sign: | The underlying endpoint of the source system which the configuration is targeting. |
+| `pullData` | Record | :heavy_minus_sign: | The additional properties that are required when pulling records. |
| `pushData` | Record | :heavy_minus_sign: | The additional properties that are required to create and/or update records. |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/supportedfeature.md b/platform/docs/sdk/models/shared/supportedfeature.md
index 98c35c953..4dd7db6a2 100644
--- a/platform/docs/sdk/models/shared/supportedfeature.md
+++ b/platform/docs/sdk/models/shared/supportedfeature.md
@@ -1,19 +1,16 @@
-# SupportedFeature
-
-## Example Usage
-
-```typescript
-import { SupportedFeature } from "@codat/platform/sdk/models/shared";
-
-let value: SupportedFeature = {
- featureType: "Get",
- featureState: "Release",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
-| `featureType` | [shared.FeatureType](../../../sdk/models/shared/featuretype.md) | :heavy_check_mark: | The type of feature. | Get |
-| `featureState` | [shared.FeatureState](../../../sdk/models/shared/featurestate.md) | :heavy_check_mark: | The current release state of the feature. | Release |
\ No newline at end of file
+# SupportedFeature
+
+## Example Usage
+
+```typescript
+import { SupportedFeature } from "@codat/platform/sdk/models/shared";
+
+let value: SupportedFeature = {};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
+| `featureType` | [shared.FeatureType](../../../sdk/models/shared/featuretype.md) | :heavy_check_mark: | N/A |
+| `featureState` | [shared.FeatureState](../../../sdk/models/shared/featurestate.md) | :heavy_check_mark: | N/A |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/syncsetting.md b/platform/docs/sdk/models/shared/syncsetting.md
index d6ab3f02a..e02ecafe0 100644
--- a/platform/docs/sdk/models/shared/syncsetting.md
+++ b/platform/docs/sdk/models/shared/syncsetting.md
@@ -1,33 +1,33 @@
-# SyncSetting
-
-Describes how often, and how much history, should be fetched for the given data type when a pull operation is queued.
-
-## Example Usage
-
-```typescript
-import { SyncSetting } from "@codat/platform/sdk/models/shared";
-
-let value: SyncSetting = {
- dataType: "invoices",
- fetchOnFirstLink: true,
- syncSchedule: 24,
- syncOrder: 0,
- syncFromUtc: "2020-01-01T12:00:00.000Z",
- syncFromWindow: 24,
- monthsToSync: 24,
- isLocked: true,
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `dataType` | [shared.DataType](../../../sdk/models/shared/datatype.md) | :heavy_check_mark: | Available data types | invoices |
-| `fetchOnFirstLink` | *boolean* | :heavy_check_mark: | Whether this data type should be queued after a company has authorized a connection. | |
-| `syncSchedule` | *number* | :heavy_check_mark: | Number of hours after which this data type should be refreshed. | 24 |
-| `syncOrder` | *number* | :heavy_check_mark: | The sync in which data types are queued for a sync. | |
-| `syncFromUtc` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 |
-| `syncFromWindow` | *number* | :heavy_minus_sign: | Number of months of data to be fetched. Set this *or* `syncFromUTC`. | 24 |
-| `monthsToSync` | *number* | :heavy_minus_sign: | Months of data to fetch, for report data types (`balanceSheet` & `profitAndLoss`) only. | 24 |
+# SyncSetting
+
+Describes how often, and how much history, should be fetched for the given data type when a pull operation is queued.
+
+## Example Usage
+
+```typescript
+import { SyncSetting } from "@codat/platform/sdk/models/shared";
+
+let value: SyncSetting = {
+ dataType: "invoices",
+ fetchOnFirstLink: true,
+ syncSchedule: 24,
+ syncOrder: 0,
+ syncFromUtc: "2020-01-01T12:00:00.000Z",
+ syncFromWindow: 24,
+ monthsToSync: 24,
+ isLocked: true,
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `dataType` | [shared.DataType](../../../sdk/models/shared/datatype.md) | :heavy_check_mark: | Available data types | invoices |
+| `fetchOnFirstLink` | *boolean* | :heavy_check_mark: | Whether this data type should be queued after a company has authorized a connection. | |
+| `syncSchedule` | *number* | :heavy_check_mark: | Number of hours after which this data type should be refreshed. | 24 |
+| `syncOrder` | *number* | :heavy_check_mark: | The sync in which data types are queued for a sync. | |
+| `syncFromUtc` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:
```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```
When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`
> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 |
+| `syncFromWindow` | *number* | :heavy_minus_sign: | Number of months of data to be fetched. Set this *or* `syncFromUTC`. | 24 |
+| `monthsToSync` | *number* | :heavy_minus_sign: | Months of data to fetch, for report data types (`balanceSheet` & `profitAndLoss`) only. | 24 |
| `isLocked` | *boolean* | :heavy_minus_sign: | `True` if the [sync setting](https://docs.codat.io/knowledge-base/advanced-sync-settings) is locked. | |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/syncsettings.md b/platform/docs/sdk/models/shared/syncsettings.md
index cc2b1d5ad..88050e0a0 100644
--- a/platform/docs/sdk/models/shared/syncsettings.md
+++ b/platform/docs/sdk/models/shared/syncsettings.md
@@ -1,30 +1,17 @@
-# SyncSettings
-
-## Example Usage
-
-```typescript
-import { SyncSettings } from "@codat/platform/sdk/models/shared";
-
-let value: SyncSettings = {
- settings: [
- {
- dataType: "invoices",
- fetchOnFirstLink: true,
- syncSchedule: 24,
- syncOrder: 0,
- syncFromUtc: "2020-01-01T12:00:00.000Z",
- syncFromWindow: 24,
- monthsToSync: 24,
- isLocked: true,
- },
- ],
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
-| `clientId` | *string* | :heavy_minus_sign: | Unique identifier for your client in Codat. |
-| `settings` | [shared.SyncSetting](../../../sdk/models/shared/syncsetting.md)[] | :heavy_minus_sign: | N/A |
+# SyncSettings
+
+## Example Usage
+
+```typescript
+import { SyncSettings } from "@codat/platform/sdk/models/shared";
+
+let value: SyncSettings = {};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
+| `clientId` | *string* | :heavy_minus_sign: | Unique identifier for your client in Codat. |
+| `settings` | [shared.SyncSetting](../../../sdk/models/shared/syncsetting.md)[] | :heavy_minus_sign: | N/A |
| `overridesDefaults` | *boolean* | :heavy_minus_sign: | Set to `True` if you want to override the default [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings). |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/updateconnectionstatus.md b/platform/docs/sdk/models/shared/updateconnectionstatus.md
index 3dfce0901..92ad70d7d 100644
--- a/platform/docs/sdk/models/shared/updateconnectionstatus.md
+++ b/platform/docs/sdk/models/shared/updateconnectionstatus.md
@@ -1,15 +1,15 @@
-# UpdateConnectionStatus
-
-## Example Usage
-
-```typescript
-import { UpdateConnectionStatus } from "@codat/platform/sdk/models/shared";
-
-let value: UpdateConnectionStatus = {};
-```
-
-## Fields
-
-| Field | Type | Required | Description |
-| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
+# UpdateConnectionStatus
+
+## Example Usage
+
+```typescript
+import { UpdateConnectionStatus } from "@codat/platform/sdk/models/shared";
+
+let value: UpdateConnectionStatus = {};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `status` | [shared.DataConnectionStatus](../../../sdk/models/shared/dataconnectionstatus.md) | :heavy_minus_sign: | The current authorization status of the data connection. |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/validation.md b/platform/docs/sdk/models/shared/validation.md
index ffa69ff19..41266e483 100644
--- a/platform/docs/sdk/models/shared/validation.md
+++ b/platform/docs/sdk/models/shared/validation.md
@@ -1,18 +1,18 @@
-# Validation
-
-A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here.
-
-## Example Usage
-
-```typescript
-import { Validation } from "@codat/platform/sdk/models/shared";
-
-let value: Validation = {};
-```
-
-## Fields
-
-| Field | Type | Required | Description |
-| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
-| `errors` | [shared.ValidationItem1](../../../sdk/models/shared/validationitem1.md)[] | :heavy_minus_sign: | N/A |
+# Validation
+
+A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here.
+
+## Example Usage
+
+```typescript
+import { Validation } from "@codat/platform/sdk/models/shared";
+
+let value: Validation = {};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
+| `errors` | [shared.ValidationItem1](../../../sdk/models/shared/validationitem1.md)[] | :heavy_minus_sign: | N/A |
| `warnings` | [shared.ValidationItem1](../../../sdk/models/shared/validationitem1.md)[] | :heavy_minus_sign: | N/A |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/validationitem.md b/platform/docs/sdk/models/shared/validationitem.md
index 0e9a8c316..2be01dda6 100644
--- a/platform/docs/sdk/models/shared/validationitem.md
+++ b/platform/docs/sdk/models/shared/validationitem.md
@@ -1,18 +1,18 @@
-# ValidationItem
-
-## Example Usage
-
-```typescript
-import { ValidationItem } from "@codat/platform/sdk/models/shared";
-
-let value: ValidationItem = {};
-```
-
-## Fields
-
-| Field | Type | Required | Description |
-| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
-| `ruleId` | *string* | :heavy_minus_sign: | The unique identifier of the rule that wasn't met. |
-| `itemId` | *string* | :heavy_minus_sign: | The unique identifier of the item that was validated. |
-| `message` | *string* | :heavy_minus_sign: | The message that describes the validation warning or error. |
+# ValidationItem
+
+## Example Usage
+
+```typescript
+import { ValidationItem } from "@codat/platform/sdk/models/shared";
+
+let value: ValidationItem = {};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
+| `ruleId` | *string* | :heavy_minus_sign: | The unique identifier of the rule that wasn't met. |
+| `itemId` | *string* | :heavy_minus_sign: | The unique identifier of the item that was validated. |
+| `message` | *string* | :heavy_minus_sign: | The message that describes the validation warning or error. |
| `validatorName` | *string* | :heavy_minus_sign: | The name of the validator that was used to validate the item. |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/validationitem1.md b/platform/docs/sdk/models/shared/validationitem1.md
index 42624d40e..d887ff886 100644
--- a/platform/docs/sdk/models/shared/validationitem1.md
+++ b/platform/docs/sdk/models/shared/validationitem1.md
@@ -1,17 +1,17 @@
-# ValidationItem1
-
-## Example Usage
-
-```typescript
-import { ValidationItem1 } from "@codat/platform/sdk/models/shared";
-
-let value: ValidationItem1 = {};
-```
-
-## Fields
-
-| Field | Type | Required | Description |
-| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
-| `itemId` | *string* | :heavy_minus_sign: | Unique identifier for a validation item. |
-| `message` | *string* | :heavy_minus_sign: | A message outlining validation item's issue. |
+# ValidationItem1
+
+## Example Usage
+
+```typescript
+import { ValidationItem1 } from "@codat/platform/sdk/models/shared";
+
+let value: ValidationItem1 = {};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
+| `itemId` | *string* | :heavy_minus_sign: | Unique identifier for a validation item. |
+| `message` | *string* | :heavy_minus_sign: | A message outlining validation item's issue. |
| `validatorName` | *string* | :heavy_minus_sign: | Name of validator. |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/validationresult.md b/platform/docs/sdk/models/shared/validationresult.md
index 97150b68b..91d6ca311 100644
--- a/platform/docs/sdk/models/shared/validationresult.md
+++ b/platform/docs/sdk/models/shared/validationresult.md
@@ -1,16 +1,16 @@
-# ValidationResult
-
-## Example Usage
-
-```typescript
-import { ValidationResult } from "@codat/platform/sdk/models/shared";
-
-let value: ValidationResult = {};
-```
-
-## Fields
-
-| Field | Type | Required | Description |
-| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
-| `errors` | [shared.ValidationItem](../../../sdk/models/shared/validationitem.md)[] | :heavy_minus_sign: | N/A |
+# ValidationResult
+
+## Example Usage
+
+```typescript
+import { ValidationResult } from "@codat/platform/sdk/models/shared";
+
+let value: ValidationResult = {};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
+| `errors` | [shared.ValidationItem](../../../sdk/models/shared/validationitem.md)[] | :heavy_minus_sign: | N/A |
| `warnings` | [shared.ValidationItem](../../../sdk/models/shared/validationitem.md)[] | :heavy_minus_sign: | N/A |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/webhookconsumer.md b/platform/docs/sdk/models/shared/webhookconsumer.md
index 73b394759..dfc448fb2 100644
--- a/platform/docs/sdk/models/shared/webhookconsumer.md
+++ b/platform/docs/sdk/models/shared/webhookconsumer.md
@@ -1,26 +1,26 @@
-# WebhookConsumer
-
-A webhook consumer is an HTTP endpoint that developers can configure to subscribe to Codat's supported event types.
-
-See our documentation for more details on [Codat's webhook service](https://docs.codat.io/using-the-api/webhooks/overview).
-
-
-## Example Usage
-
-```typescript
-import { WebhookConsumer } from "@codat/platform/sdk/models/shared";
-
-let value: WebhookConsumer = {
- id: "8a210b68-6988-11ed-a1eb-0242ac120002",
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description | Example |
-| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `id` | *string* | :heavy_minus_sign: | Unique identifier for the webhook consumer. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
-| `url` | *string* | :heavy_minus_sign: | The URL that will consume webhook events dispatched by Codat. | |
-| `disabled` | *boolean* | :heavy_minus_sign: | Flag that enables or disables the endpoint from receiving events. Disabled when set to `true`. | |
-| `eventTypes` | *string*[] | :heavy_minus_sign: | An array of event types the webhook consumer subscribes to. | |
+# WebhookConsumer
+
+A webhook consumer is an HTTP endpoint that developers can configure to subscribe to Codat's supported event types.
+
+See our documentation for more details on [Codat's webhook service](https://docs.codat.io/using-the-api/webhooks/overview).
+
+
+## Example Usage
+
+```typescript
+import { WebhookConsumer } from "@codat/platform/sdk/models/shared";
+
+let value: WebhookConsumer = {
+ id: "8a210b68-6988-11ed-a1eb-0242ac120002",
+};
+```
+
+## Fields
+
+| Field | Type | Required | Description | Example |
+| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `id` | *string* | :heavy_minus_sign: | Unique identifier for the webhook consumer. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
+| `url` | *string* | :heavy_minus_sign: | The URL that will consume webhook events dispatched by Codat. | |
+| `disabled` | *boolean* | :heavy_minus_sign: | Flag that enables or disables the endpoint from receiving events. Disabled when set to `true`. | |
+| `eventTypes` | *string*[] | :heavy_minus_sign: | An array of event types the webhook consumer subscribes to. | |
| `companyTags` | *string*[] | :heavy_minus_sign: | Company tags provide an additional way to filter messages, independent of event types. Company tags are case-sensitive, and only messages from companies with matching tags will be sent to this endpoint. Use the format `tagKey:tagValue`. | |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/webhookconsumerprototype.md b/platform/docs/sdk/models/shared/webhookconsumerprototype.md
index c193effb3..61c154b8d 100644
--- a/platform/docs/sdk/models/shared/webhookconsumerprototype.md
+++ b/platform/docs/sdk/models/shared/webhookconsumerprototype.md
@@ -1,18 +1,18 @@
-# WebhookConsumerPrototype
-
-## Example Usage
-
-```typescript
-import { WebhookConsumerPrototype } from "@codat/platform/sdk/models/shared";
-
-let value: WebhookConsumerPrototype = {};
-```
-
-## Fields
-
-| Field | Type | Required | Description |
-| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `url` | *string* | :heavy_minus_sign: | The URL that will consume webhook events dispatched by Codat. |
-| `disabled` | *boolean* | :heavy_minus_sign: | Flag that enables or disables the endpoint from receiving events. Disabled when set to `true`. |
-| `eventTypes` | *string*[] | :heavy_minus_sign: | An array of event types the webhook consumer subscribes to. |
+# WebhookConsumerPrototype
+
+## Example Usage
+
+```typescript
+import { WebhookConsumerPrototype } from "@codat/platform/sdk/models/shared";
+
+let value: WebhookConsumerPrototype = {};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `url` | *string* | :heavy_minus_sign: | The URL that will consume webhook events dispatched by Codat. |
+| `disabled` | *boolean* | :heavy_minus_sign: | Flag that enables or disables the endpoint from receiving events. Disabled when set to `true`. |
+| `eventTypes` | *string*[] | :heavy_minus_sign: | An array of event types the webhook consumer subscribes to. |
| `companyTags` | *string*[] | :heavy_minus_sign: | Company tags provide an additional way to filter messages, independent of event types. Company tags are case-sensitive, and only messages from companies with matching tags will be sent to this endpoint. Use the format `tagKey:tagValue`. |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/webhookconsumers.md b/platform/docs/sdk/models/shared/webhookconsumers.md
index 55769a986..884b14900 100644
--- a/platform/docs/sdk/models/shared/webhookconsumers.md
+++ b/platform/docs/sdk/models/shared/webhookconsumers.md
@@ -1,21 +1,15 @@
-# WebhookConsumers
-
-## Example Usage
-
-```typescript
-import { WebhookConsumers } from "@codat/platform/sdk/models/shared";
-
-let value: WebhookConsumers = {
- results: [
- {
- id: "8a210b68-6988-11ed-a1eb-0242ac120002",
- },
- ],
-};
-```
-
-## Fields
-
-| Field | Type | Required | Description |
-| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
+# WebhookConsumers
+
+## Example Usage
+
+```typescript
+import { WebhookConsumers } from "@codat/platform/sdk/models/shared";
+
+let value: WebhookConsumers = {};
+```
+
+## Fields
+
+| Field | Type | Required | Description |
+| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `results` | [shared.WebhookConsumer](../../../sdk/models/shared/webhookconsumer.md)[] | :heavy_minus_sign: | N/A |
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/writestatus.md b/platform/docs/sdk/models/shared/writestatus.md
index df9cbc797..f90f99747 100644
--- a/platform/docs/sdk/models/shared/writestatus.md
+++ b/platform/docs/sdk/models/shared/writestatus.md
@@ -1,17 +1,17 @@
-# WriteStatus
-
-The current status of the write request, which is the same as the push operation status.
-
-## Example Usage
-
-```typescript
-import { WriteStatus } from "@codat/platform/sdk/models/shared";
-
-let value: WriteStatus = "Pending";
-```
-
-## Values
-
-```typescript
-"Pending" | "Failed" | "Success" | "TimedOut"
+# WriteStatus
+
+The current status of the write request, which is the same as the push operation status.
+
+## Example Usage
+
+```typescript
+import { WriteStatus } from "@codat/platform/sdk/models/shared";
+
+let value: WriteStatus = "Pending";
+```
+
+## Values
+
+```typescript
+"Pending" | "Failed" | "Success" | "TimedOut"
```
\ No newline at end of file
diff --git a/platform/docs/sdk/models/shared/writetype.md b/platform/docs/sdk/models/shared/writetype.md
index 0a3c6740c..2130ca5b9 100644
--- a/platform/docs/sdk/models/shared/writetype.md
+++ b/platform/docs/sdk/models/shared/writetype.md
@@ -1,17 +1,17 @@
-# WriteType
-
-Type of write request.
-
-## Example Usage
-
-```typescript
-import { WriteType } from "@codat/platform/sdk/models/shared";
-
-let value: WriteType = "UploadAttachment";
-```
-
-## Values
-
-```typescript
-"Create" | "Update" | "Delete" | "UploadAttachment"
+# WriteType
+
+Type of write request.
+
+## Example Usage
+
+```typescript
+import { WriteType } from "@codat/platform/sdk/models/shared";
+
+let value: WriteType = "Create";
+```
+
+## Values
+
+```typescript
+"Create" | "Update" | "Delete" | "UploadAttachment"
```
\ No newline at end of file
diff --git a/platform/docs/sdks/companies/README.md b/platform/docs/sdks/companies/README.md
index b1ac040b3..902e507c3 100644
--- a/platform/docs/sdks/companies/README.md
+++ b/platform/docs/sdks/companies/README.md
@@ -1,1568 +1,1568 @@
-# Companies
-
-## Overview
-
-Create and manage your SMB users' companies.
-
-### Available Operations
-
-* [list](#list) - List companies
-* [create](#create) - Create company
-* [get](#get) - Get company
-* [delete](#delete) - Delete a company
-* [replace](#replace) - Replace company
-* [update](#update) - Update company
-* [addProduct](#addproduct) - Add product
-* [removeProduct](#removeproduct) - Remove product
-* [refreshProductData](#refreshproductdata) - Refresh product data
-* [getAccessToken](#getaccesstoken) - Get company access token
-* [getCompanySyncSettings](#getcompanysyncsettings) - Get company sync settings
-* [setCompanySyncSettings](#setcompanysyncsettings) - Set company sync settings
-
-## list
-
-The *List companies* endpoint returns a list of [companies](https://docs.codat.io/platform-api#/schemas/Company) associated to your instances.
-
-A [company](https://docs.codat.io/platform-api#/schemas/Company) represents a business sharing access to their data.
-Each company can have multiple [connections](https://docs.codat.io/platform-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.
-
-## Filter by tags
-
-The *List companies* endpoint supports the filtering of companies using [tags](https://docs.codat.io/using-the-api/managing-companies#add-metadata-to-a-company). It supports the following operators with [Codat’s query language](https://docs.codat.io/using-the-api/querying):
-
-- equals (`=`)
-- not equals (`!=`)
-- contains (`~`)
-
-For example, you can use the querying to filter companies tagged with a specific foreign key, region, or owning team:
-- Foreign key: `uid = {yourCustomerId}`
-- Region: `region != uk`
-- Owning team and region: `region = uk && owningTeam = invoice-finance`
-
-### Example Usage: List of Companies
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.companies.list({
- query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
- orderBy: "-modifiedDate",
- tags: "region=uk && team=invoice-finance",
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { companiesList } from "@codat/platform/funcs/companiesList.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await companiesList(codatPlatform, {
- query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
- orderBy: "-modifiedDate",
- tags: "region=uk && team=invoice-finance",
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("companiesList failed:", res.error);
- }
-}
-
-run();
-```
-### Example Usage: One company
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.companies.list({
- query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
- orderBy: "-modifiedDate",
- tags: "region=uk && team=invoice-finance",
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { companiesList } from "@codat/platform/funcs/companiesList.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await companiesList(codatPlatform, {
- query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
- orderBy: "-modifiedDate",
- tags: "region=uk && team=invoice-finance",
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("companiesList failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [operations.ListCompaniesRequest](../../sdk/models/operations/listcompaniesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\<[shared.Companies](../../sdk/models/shared/companies.md)\>**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ---------------------------- | ---------------------------- | ---------------------------- |
-| errors.ErrorMessage | 400, 401, 402, 403, 404, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
-| errors.SDKError | 4XX, 5XX | \*/\* |
-
-## create
-
-Use the *Create company* endpoint to create a new [company](https://docs.codat.io/platform-api#/schemas/Company) that represents your customer in Codat.
-
-A [company](https://docs.codat.io/platform-api#/schemas/Company) represents a business sharing access to their data.
-Each company can have multiple [connections](https://docs.codat.io/platform-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.
-
-If forbidden characters (see `name` pattern) are present in the request, a company will be created with the forbidden characters removed. For example, `Company (Codat[1])` with be created as `Company Codat1`.
-
-### Example Usage: Malformed query
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.companies.create({
- name: "Bank of Dave",
- description: "Requested early access to the new financing scheme.",
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { companiesCreate } from "@codat/platform/funcs/companiesCreate.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await companiesCreate(codatPlatform, {
- name: "Bank of Dave",
- description: "Requested early access to the new financing scheme.",
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("companiesCreate failed:", res.error);
- }
-}
-
-run();
-```
-### Example Usage: With a description
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.companies.create({
- name: "Technicalium",
- description: "Technology services, including web and app design and development",
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { companiesCreate } from "@codat/platform/funcs/companiesCreate.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await companiesCreate(codatPlatform, {
- name: "Technicalium",
- description: "Technology services, including web and app design and development",
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("companiesCreate failed:", res.error);
- }
-}
-
-run();
-```
-### Example Usage: With a tag
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.companies.create({
- name: "Bank of Dave",
- description: "Requested early access to the new financing scheme.",
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { companiesCreate } from "@codat/platform/funcs/companiesCreate.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await companiesCreate(codatPlatform, {
- name: "Bank of Dave",
- description: "Requested early access to the new financing scheme.",
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("companiesCreate failed:", res.error);
- }
-}
-
-run();
-```
-### Example Usage: With no description
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.companies.create({
- name: "Technicalium",
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { companiesCreate } from "@codat/platform/funcs/companiesCreate.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await companiesCreate(codatPlatform, {
- name: "Technicalium",
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("companiesCreate failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [shared.CompanyRequestBody](../../sdk/models/shared/companyrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\<[shared.Company](../../sdk/models/shared/company.md)\>**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ----------------------- | ----------------------- | ----------------------- |
-| errors.ErrorMessage | 400, 401, 402, 403, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
-| errors.SDKError | 4XX, 5XX | \*/\* |
-
-## get
-
-The *Get company* endpoint returns a single company for a given `companyId`.
-
-A [company](https://docs.codat.io/platform-api#/schemas/Company) represents a business sharing access to their data.
-Each company can have multiple [connections](https://docs.codat.io/platform-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.
-
-
-### Example Usage: Parent multi-entity company
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.companies.get({
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { companiesGet } from "@codat/platform/funcs/companiesGet.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await companiesGet(codatPlatform, {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("companiesGet failed:", res.error);
- }
-}
-
-run();
-```
-### Example Usage: Simple company
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.companies.get({
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { companiesGet } from "@codat/platform/funcs/companiesGet.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await companiesGet(codatPlatform, {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("companiesGet failed:", res.error);
- }
-}
-
-run();
-```
-### Example Usage: Subsidiary multi-entity company
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.companies.get({
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { companiesGet } from "@codat/platform/funcs/companiesGet.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await companiesGet(codatPlatform, {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("companiesGet failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [operations.GetCompanyRequest](../../sdk/models/operations/getcompanyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\<[shared.Company](../../sdk/models/shared/company.md)\>**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ----------------------- | ----------------------- | ----------------------- |
-| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
-| errors.SDKError | 4XX, 5XX | \*/\* |
-
-## delete
-
-The *Delete company* endpoint permanently deletes a [company](https://docs.codat.io/platform-api#/schemas/Company), its [connections](https://docs.codat.io/platform-api#/schemas/Connection) and any cached data. This operation is irreversible.
-
-A [company](https://docs.codat.io/platform-api#/schemas/Company) represents a business sharing access to their data.
-Each company can have multiple [connections](https://docs.codat.io/platform-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.
-
-
-### Example Usage
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- await codatPlatform.companies.delete({
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- });
-
-
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { companiesDelete } from "@codat/platform/funcs/companiesDelete.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await companiesDelete(codatPlatform, {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- });
- if (res.ok) {
- const { value: result } = res;
-
- } else {
- console.log("companiesDelete failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [operations.DeleteCompanyRequest](../../sdk/models/operations/deletecompanyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ----------------------- | ----------------------- | ----------------------- |
-| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
-| errors.SDKError | 4XX, 5XX | \*/\* |
-
-## replace
-
-Use the *Replace company* endpoint to replace the existing name, description, and tags of the company. Calling the endpoint will replace existing values even if new values haven't been defined in the payload.
-
-A [company](https://docs.codat.io/platform-api#/schemas/Company) represents a business sharing access to their data.
-Each company can have multiple [connections](https://docs.codat.io/platform-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.
-
-### Example Usage: Unauthorized
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.companies.replace({
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- companyRequestBody: {
- name: "Bank of Dave",
- description: "Requested early access to the new financing scheme.",
- },
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { companiesReplace } from "@codat/platform/funcs/companiesReplace.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await companiesReplace(codatPlatform, {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- companyRequestBody: {
- name: "Bank of Dave",
- description: "Requested early access to the new financing scheme.",
- },
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("companiesReplace failed:", res.error);
- }
-}
-
-run();
-```
-### Example Usage: Update description
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.companies.replace({
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- companyRequestBody: {
- name: "Same name",
- description: "Additional documents required",
- },
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { companiesReplace } from "@codat/platform/funcs/companiesReplace.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await companiesReplace(codatPlatform, {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- companyRequestBody: {
- name: "Same name",
- description: "Additional documents required",
- },
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("companiesReplace failed:", res.error);
- }
-}
-
-run();
-```
-### Example Usage: Update name
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.companies.replace({
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- companyRequestBody: {
- name: "New Name",
- },
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { companiesReplace } from "@codat/platform/funcs/companiesReplace.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await companiesReplace(codatPlatform, {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- companyRequestBody: {
- name: "New Name",
- },
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("companiesReplace failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [operations.ReplaceCompanyRequest](../../sdk/models/operations/replacecompanyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\<[shared.Company](../../sdk/models/shared/company.md)\>**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ----------------------- | ----------------------- | ----------------------- |
-| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
-| errors.SDKError | 4XX, 5XX | \*/\* |
-
-## update
-
-Use the *Update company* endpoint to update the name, description, or tags of the company.
-
-The *Update company* endpoint doesn't have any required fields. If any of the fields provided are `null` or not provided, they won't be included in the update.
-
-A [company](https://docs.codat.io/platform-api#/schemas/Company) represents a business sharing access to their data.
-
-### Example Usage: Unauthorized
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.companies.update({
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- companyUpdateRequest: {
- name: "Bank of Dave",
- description: "Requested early access to the new financing scheme.",
- },
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { companiesUpdate } from "@codat/platform/funcs/companiesUpdate.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await companiesUpdate(codatPlatform, {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- companyUpdateRequest: {
- name: "Bank of Dave",
- description: "Requested early access to the new financing scheme.",
- },
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("companiesUpdate failed:", res.error);
- }
-}
-
-run();
-```
-### Example Usage: Update name
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.companies.update({
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- companyUpdateRequest: {
- name: "New Name",
- },
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { companiesUpdate } from "@codat/platform/funcs/companiesUpdate.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await companiesUpdate(codatPlatform, {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- companyUpdateRequest: {
- name: "New Name",
- },
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("companiesUpdate failed:", res.error);
- }
-}
-
-run();
-```
-### Example Usage: Update tags
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.companies.update({
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- companyUpdateRequest: {
- tags: {
- "refrence": "new reference",
- },
- },
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { companiesUpdate } from "@codat/platform/funcs/companiesUpdate.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await companiesUpdate(codatPlatform, {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- companyUpdateRequest: {
- tags: {
- "refrence": "new reference",
- },
- },
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("companiesUpdate failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [operations.UpdateCompanyRequest](../../sdk/models/operations/updatecompanyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\<[shared.Company](../../sdk/models/shared/company.md)\>**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ----------------------- | ----------------------- | ----------------------- |
-| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
-| errors.SDKError | 4XX, 5XX | \*/\* |
-
-## addProduct
-
-Use the *Add product* endpoint to enable a product for the company specified by `companyId`.
-
-> Note: This feature is currently in alpha and available only to participants in the development program.
-
-### Example Usage
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- await codatPlatform.companies.addProduct({
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- productIdentifier: "bank-feeds",
- });
-
-
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { companiesAddProduct } from "@codat/platform/funcs/companiesAddProduct.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await companiesAddProduct(codatPlatform, {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- productIdentifier: "bank-feeds",
- });
- if (res.ok) {
- const { value: result } = res;
-
- } else {
- console.log("companiesAddProduct failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [operations.AddProductRequest](../../sdk/models/operations/addproductrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ----------------------- | ----------------------- | ----------------------- |
-| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
-| errors.SDKError | 4XX, 5XX | \*/\* |
-
-## removeProduct
-
-Use the *Remove product* endpoint to disable a product for the company specified by `companyId`.
-
-> Note: This feature is currently in alpha and available only to participants in the development program.
-
-### Example Usage
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- await codatPlatform.companies.removeProduct({
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- productIdentifier: "bank-feeds",
- });
-
-
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { companiesRemoveProduct } from "@codat/platform/funcs/companiesRemoveProduct.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await companiesRemoveProduct(codatPlatform, {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- productIdentifier: "bank-feeds",
- });
- if (res.ok) {
- const { value: result } = res;
-
- } else {
- console.log("companiesRemoveProduct failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [operations.RemoveProductRequest](../../sdk/models/operations/removeproductrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ----------------------- | ----------------------- | ----------------------- |
-| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
-| errors.SDKError | 4XX, 5XX | \*/\* |
-
-## refreshProductData
-
-Use the **Refresh product data** endpoint to manually refresh data for a custom product for a specific company.
-
-### Tips and traps
-
-- This endpoint only supports refreshing data for **custom products** and can't be used for Codat's standard solutions. Refer to [individual solutions' documentation](https://docs.codat.io/) instead.
-- If a data sync is already in progress for a custom product, the refresh request will return a `Bad request (400)` response.
-- If a company has multiple custom products enabled, you can refresh data for each product individually.
- - Optionally include a request body with `dataTypes` to refresh only selected data types for the specified product. If omitted, the product's scheduled refresh is triggered as usual.
- - When specifying `dataTypes`, each value must be a valid data type supported by the product. Invalid values will result in a `Bad request (400)` response listing valid options.
-
-### Example Usage
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- await codatPlatform.companies.refreshProductData({
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- productIdentifier: "bank-feeds",
- requestBody: {
- dataTypes: [
- "invoices",
- "payments",
- ],
- },
- });
-
-
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { companiesRefreshProductData } from "@codat/platform/funcs/companiesRefreshProductData.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await companiesRefreshProductData(codatPlatform, {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- productIdentifier: "bank-feeds",
- requestBody: {
- dataTypes: [
- "invoices",
- "payments",
- ],
- },
- });
- if (res.ok) {
- const { value: result } = res;
-
- } else {
- console.log("companiesRefreshProductData failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [operations.RefreshProductDataRequest](../../sdk/models/operations/refreshproductdatarequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ---------------------------- | ---------------------------- | ---------------------------- |
-| errors.ErrorMessage | 400, 401, 402, 403, 404, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
-| errors.SDKError | 4XX, 5XX | \*/\* |
-
-## getAccessToken
-
-Use the _Get company access token_ endpoint to return an access token for the specified company ID. The token is valid for one day.
-
-The token is required by Codat's embeddable UIs (such as [Connections SDK](https://docs.codat.io/auth-flow/optimize/connection-management) and [Link SDK](https://docs.codat.io/auth-flow/authorize-embedded-link)) to verify the identity of the user and improve the reliability of data provided by them.
-
-### Example Usage
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.companies.getAccessToken({
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { companiesGetAccessToken } from "@codat/platform/funcs/companiesGetAccessToken.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await companiesGetAccessToken(codatPlatform, {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("companiesGetAccessToken failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [operations.GetCompanyAccessTokenRequest](../../sdk/models/operations/getcompanyaccesstokenrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\<[shared.CompanyAccessToken](../../sdk/models/shared/companyaccesstoken.md)\>**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ----------------------- | ----------------------- | ----------------------- |
-| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
-| errors.SDKError | 4XX, 5XX | \*/\* |
-
-## getCompanySyncSettings
-
-Retrieve the [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings) for a specific company. This includes how often data types should be queued to be updated, and how much history should be fetched.
-
-### Example Usage
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.companies.getCompanySyncSettings({
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { companiesGetCompanySyncSettings } from "@codat/platform/funcs/companiesGetCompanySyncSettings.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await companiesGetCompanySyncSettings(codatPlatform, {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("companiesGetCompanySyncSettings failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [operations.GetCompanySyncSettingsRequest](../../sdk/models/operations/getcompanysyncsettingsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\<[shared.CompanySyncSettings](../../sdk/models/shared/companysyncsettings.md)\>**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ----------------------- | ----------------------- | ----------------------- |
-| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
-| errors.SDKError | 4XX, 5XX | \*/\* |
-
-## setCompanySyncSettings
-
-Set the sync settings for a specific company.
-
-### Example Usage
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- await codatPlatform.companies.setCompanySyncSettings({
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- requestBody: {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- settings: [
- {
- dataType: "invoices",
- fetchOnFirstLink: true,
- syncSchedule: 24,
- syncOrder: 0,
- syncFromUtc: "2020-01-01T12:00:00.000Z",
- syncFromWindow: 24,
- monthsToSync: 24,
- isLocked: true,
- },
- ],
- },
- });
-
-
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { companiesSetCompanySyncSettings } from "@codat/platform/funcs/companiesSetCompanySyncSettings.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await companiesSetCompanySyncSettings(codatPlatform, {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- requestBody: {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- settings: [
- {
- dataType: "invoices",
- fetchOnFirstLink: true,
- syncSchedule: 24,
- syncOrder: 0,
- syncFromUtc: "2020-01-01T12:00:00.000Z",
- syncFromWindow: 24,
- monthsToSync: 24,
- isLocked: true,
- },
- ],
- },
- });
- if (res.ok) {
- const { value: result } = res;
-
- } else {
- console.log("companiesSetCompanySyncSettings failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [operations.SetCompanySyncSettingsRequest](../../sdk/models/operations/setcompanysyncsettingsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ---------------------------- | ---------------------------- | ---------------------------- |
-| errors.ErrorMessage | 400, 401, 402, 403, 404, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
+# Companies
+
+## Overview
+
+Create and manage your SMB users' companies.
+
+### Available Operations
+
+* [list](#list) - List companies
+* [create](#create) - Create company
+* [get](#get) - Get company
+* [delete](#delete) - Delete a company
+* [replace](#replace) - Replace company
+* [update](#update) - Update company
+* [addProduct](#addproduct) - Add product
+* [removeProduct](#removeproduct) - Remove product
+* [refreshProductData](#refreshproductdata) - Refresh product data
+* [getAccessToken](#getaccesstoken) - Get company access token
+* [getCompanySyncSettings](#getcompanysyncsettings) - Get company sync settings
+* [setCompanySyncSettings](#setcompanysyncsettings) - Set company sync settings
+
+## list
+
+The *List companies* endpoint returns a list of [companies](https://docs.codat.io/platform-api#/schemas/Company) associated to your instances.
+
+A [company](https://docs.codat.io/platform-api#/schemas/Company) represents a business sharing access to their data.
+Each company can have multiple [connections](https://docs.codat.io/platform-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.
+
+## Filter by tags
+
+The *List companies* endpoint supports the filtering of companies using [tags](https://docs.codat.io/using-the-api/managing-companies#add-metadata-to-a-company). It supports the following operators with [Codat’s query language](https://docs.codat.io/using-the-api/querying):
+
+- equals (`=`)
+- not equals (`!=`)
+- contains (`~`)
+
+For example, you can use the querying to filter companies tagged with a specific foreign key, region, or owning team:
+- Foreign key: `uid = {yourCustomerId}`
+- Region: `region != uk`
+- Owning team and region: `region = uk && owningTeam = invoice-finance`
+
+### Example Usage: List of Companies
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.companies.list({
+ query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
+ orderBy: "-modifiedDate",
+ tags: "region=uk && team=invoice-finance",
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { companiesList } from "@codat/platform/funcs/companiesList.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await companiesList(codatPlatform, {
+ query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
+ orderBy: "-modifiedDate",
+ tags: "region=uk && team=invoice-finance",
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("companiesList failed:", res.error);
+ }
+}
+
+run();
+```
+### Example Usage: One company
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.companies.list({
+ query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
+ orderBy: "-modifiedDate",
+ tags: "region=uk && team=invoice-finance",
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { companiesList } from "@codat/platform/funcs/companiesList.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await companiesList(codatPlatform, {
+ query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
+ orderBy: "-modifiedDate",
+ tags: "region=uk && team=invoice-finance",
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("companiesList failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.ListCompaniesRequest](../../sdk/models/operations/listcompaniesrequest.md) | :heavy_minus_sign: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\<[shared.Companies](../../sdk/models/shared/companies.md)\>**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ---------------------------- | ---------------------------- | ---------------------------- |
+| errors.ErrorMessage | 400, 401, 402, 403, 404, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
+| errors.SDKError | 4XX, 5XX | \*/\* |
+
+## create
+
+Use the *Create company* endpoint to create a new [company](https://docs.codat.io/platform-api#/schemas/Company) that represents your customer in Codat.
+
+A [company](https://docs.codat.io/platform-api#/schemas/Company) represents a business sharing access to their data.
+Each company can have multiple [connections](https://docs.codat.io/platform-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.
+
+If forbidden characters (see `name` pattern) are present in the request, a company will be created with the forbidden characters removed. For example, `Company (Codat[1])` with be created as `Company Codat1`.
+
+### Example Usage: Malformed query
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.companies.create({
+ name: "Bank of Dave",
+ description: "Requested early access to the new financing scheme.",
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { companiesCreate } from "@codat/platform/funcs/companiesCreate.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await companiesCreate(codatPlatform, {
+ name: "Bank of Dave",
+ description: "Requested early access to the new financing scheme.",
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("companiesCreate failed:", res.error);
+ }
+}
+
+run();
+```
+### Example Usage: With a description
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.companies.create({
+ name: "Technicalium",
+ description: "Technology services, including web and app design and development",
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { companiesCreate } from "@codat/platform/funcs/companiesCreate.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await companiesCreate(codatPlatform, {
+ name: "Technicalium",
+ description: "Technology services, including web and app design and development",
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("companiesCreate failed:", res.error);
+ }
+}
+
+run();
+```
+### Example Usage: With a tag
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.companies.create({
+ name: "Bank of Dave",
+ description: "Requested early access to the new financing scheme.",
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { companiesCreate } from "@codat/platform/funcs/companiesCreate.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await companiesCreate(codatPlatform, {
+ name: "Bank of Dave",
+ description: "Requested early access to the new financing scheme.",
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("companiesCreate failed:", res.error);
+ }
+}
+
+run();
+```
+### Example Usage: With no description
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.companies.create({
+ name: "Technicalium",
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { companiesCreate } from "@codat/platform/funcs/companiesCreate.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await companiesCreate(codatPlatform, {
+ name: "Technicalium",
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("companiesCreate failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [shared.CompanyRequestBody](../../sdk/models/shared/companyrequestbody.md) | :heavy_minus_sign: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\<[shared.Company](../../sdk/models/shared/company.md)\>**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ErrorMessage | 400, 401, 402, 403, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
+| errors.SDKError | 4XX, 5XX | \*/\* |
+
+## get
+
+The *Get company* endpoint returns a single company for a given `companyId`.
+
+A [company](https://docs.codat.io/platform-api#/schemas/Company) represents a business sharing access to their data.
+Each company can have multiple [connections](https://docs.codat.io/platform-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.
+
+
+### Example Usage: Parent multi-entity company
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.companies.get({
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { companiesGet } from "@codat/platform/funcs/companiesGet.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await companiesGet(codatPlatform, {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("companiesGet failed:", res.error);
+ }
+}
+
+run();
+```
+### Example Usage: Simple company
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.companies.get({
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { companiesGet } from "@codat/platform/funcs/companiesGet.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await companiesGet(codatPlatform, {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("companiesGet failed:", res.error);
+ }
+}
+
+run();
+```
+### Example Usage: Subsidiary multi-entity company
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.companies.get({
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { companiesGet } from "@codat/platform/funcs/companiesGet.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await companiesGet(codatPlatform, {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("companiesGet failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.GetCompanyRequest](../../sdk/models/operations/getcompanyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\<[shared.Company](../../sdk/models/shared/company.md)\>**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
+| errors.SDKError | 4XX, 5XX | \*/\* |
+
+## delete
+
+The *Delete company* endpoint permanently deletes a [company](https://docs.codat.io/platform-api#/schemas/Company), its [connections](https://docs.codat.io/platform-api#/schemas/Connection) and any cached data. This operation is irreversible.
+
+A [company](https://docs.codat.io/platform-api#/schemas/Company) represents a business sharing access to their data.
+Each company can have multiple [connections](https://docs.codat.io/platform-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.
+
+
+### Example Usage
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ await codatPlatform.companies.delete({
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ });
+
+
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { companiesDelete } from "@codat/platform/funcs/companiesDelete.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await companiesDelete(codatPlatform, {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ });
+ if (res.ok) {
+ const { value: result } = res;
+
+ } else {
+ console.log("companiesDelete failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.DeleteCompanyRequest](../../sdk/models/operations/deletecompanyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
+| errors.SDKError | 4XX, 5XX | \*/\* |
+
+## replace
+
+Use the *Replace company* endpoint to replace the existing name, description, and tags of the company. Calling the endpoint will replace existing values even if new values haven't been defined in the payload.
+
+A [company](https://docs.codat.io/platform-api#/schemas/Company) represents a business sharing access to their data.
+Each company can have multiple [connections](https://docs.codat.io/platform-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.
+
+### Example Usage: Unauthorized
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.companies.replace({
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ companyRequestBody: {
+ name: "Bank of Dave",
+ description: "Requested early access to the new financing scheme.",
+ },
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { companiesReplace } from "@codat/platform/funcs/companiesReplace.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await companiesReplace(codatPlatform, {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ companyRequestBody: {
+ name: "Bank of Dave",
+ description: "Requested early access to the new financing scheme.",
+ },
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("companiesReplace failed:", res.error);
+ }
+}
+
+run();
+```
+### Example Usage: Update description
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.companies.replace({
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ companyRequestBody: {
+ name: "Same name",
+ description: "Additional documents required",
+ },
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { companiesReplace } from "@codat/platform/funcs/companiesReplace.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await companiesReplace(codatPlatform, {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ companyRequestBody: {
+ name: "Same name",
+ description: "Additional documents required",
+ },
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("companiesReplace failed:", res.error);
+ }
+}
+
+run();
+```
+### Example Usage: Update name
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.companies.replace({
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ companyRequestBody: {
+ name: "New Name",
+ },
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { companiesReplace } from "@codat/platform/funcs/companiesReplace.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await companiesReplace(codatPlatform, {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ companyRequestBody: {
+ name: "New Name",
+ },
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("companiesReplace failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.ReplaceCompanyRequest](../../sdk/models/operations/replacecompanyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\<[shared.Company](../../sdk/models/shared/company.md)\>**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
+| errors.SDKError | 4XX, 5XX | \*/\* |
+
+## update
+
+Use the *Update company* endpoint to update the name, description, or tags of the company.
+
+The *Update company* endpoint doesn't have any required fields. If any of the fields provided are `null` or not provided, they won't be included in the update.
+
+A [company](https://docs.codat.io/platform-api#/schemas/Company) represents a business sharing access to their data.
+
+### Example Usage: Unauthorized
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.companies.update({
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ companyUpdateRequest: {
+ name: "Bank of Dave",
+ description: "Requested early access to the new financing scheme.",
+ },
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { companiesUpdate } from "@codat/platform/funcs/companiesUpdate.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await companiesUpdate(codatPlatform, {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ companyUpdateRequest: {
+ name: "Bank of Dave",
+ description: "Requested early access to the new financing scheme.",
+ },
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("companiesUpdate failed:", res.error);
+ }
+}
+
+run();
+```
+### Example Usage: Update name
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.companies.update({
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ companyUpdateRequest: {
+ name: "New Name",
+ },
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { companiesUpdate } from "@codat/platform/funcs/companiesUpdate.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await companiesUpdate(codatPlatform, {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ companyUpdateRequest: {
+ name: "New Name",
+ },
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("companiesUpdate failed:", res.error);
+ }
+}
+
+run();
+```
+### Example Usage: Update tags
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.companies.update({
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ companyUpdateRequest: {
+ tags: {
+ "refrence": "new reference",
+ },
+ },
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { companiesUpdate } from "@codat/platform/funcs/companiesUpdate.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await companiesUpdate(codatPlatform, {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ companyUpdateRequest: {
+ tags: {
+ "refrence": "new reference",
+ },
+ },
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("companiesUpdate failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.UpdateCompanyRequest](../../sdk/models/operations/updatecompanyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\<[shared.Company](../../sdk/models/shared/company.md)\>**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
+| errors.SDKError | 4XX, 5XX | \*/\* |
+
+## addProduct
+
+Use the *Add product* endpoint to enable a product for the company specified by `companyId`.
+
+> Note: This feature is currently in alpha and available only to participants in the development program.
+
+### Example Usage
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ await codatPlatform.companies.addProduct({
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ productIdentifier: "bank-feeds",
+ });
+
+
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { companiesAddProduct } from "@codat/platform/funcs/companiesAddProduct.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await companiesAddProduct(codatPlatform, {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ productIdentifier: "bank-feeds",
+ });
+ if (res.ok) {
+ const { value: result } = res;
+
+ } else {
+ console.log("companiesAddProduct failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.AddProductRequest](../../sdk/models/operations/addproductrequest.md) | :heavy_check_mark: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
+| errors.SDKError | 4XX, 5XX | \*/\* |
+
+## removeProduct
+
+Use the *Remove product* endpoint to disable a product for the company specified by `companyId`.
+
+> Note: This feature is currently in alpha and available only to participants in the development program.
+
+### Example Usage
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ await codatPlatform.companies.removeProduct({
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ productIdentifier: "bank-feeds",
+ });
+
+
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { companiesRemoveProduct } from "@codat/platform/funcs/companiesRemoveProduct.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await companiesRemoveProduct(codatPlatform, {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ productIdentifier: "bank-feeds",
+ });
+ if (res.ok) {
+ const { value: result } = res;
+
+ } else {
+ console.log("companiesRemoveProduct failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.RemoveProductRequest](../../sdk/models/operations/removeproductrequest.md) | :heavy_check_mark: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
+| errors.SDKError | 4XX, 5XX | \*/\* |
+
+## refreshProductData
+
+Use the **Refresh product data** endpoint to manually refresh data for a custom product for a specific company.
+
+### Tips and traps
+
+- This endpoint only supports refreshing data for **custom products** and can't be used for Codat's standard solutions. Refer to [individual solutions' documentation](https://docs.codat.io/) instead.
+- If a data sync is already in progress for a custom product, the refresh request will return a `Bad request (400)` response.
+- If a company has multiple custom products enabled, you can refresh data for each product individually.
+ - Optionally include a request body with `dataTypes` to refresh only selected data types for the specified product. If omitted, the product's scheduled refresh is triggered as usual.
+ - When specifying `dataTypes`, each value must be a valid data type supported by the product. Invalid values will result in a `Bad request (400)` response listing valid options.
+
+### Example Usage
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ await codatPlatform.companies.refreshProductData({
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ productIdentifier: "bank-feeds",
+ requestBody: {
+ dataTypes: [
+ "invoices",
+ "payments",
+ ],
+ },
+ });
+
+
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { companiesRefreshProductData } from "@codat/platform/funcs/companiesRefreshProductData.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await companiesRefreshProductData(codatPlatform, {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ productIdentifier: "bank-feeds",
+ requestBody: {
+ dataTypes: [
+ "invoices",
+ "payments",
+ ],
+ },
+ });
+ if (res.ok) {
+ const { value: result } = res;
+
+ } else {
+ console.log("companiesRefreshProductData failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.RefreshProductDataRequest](../../sdk/models/operations/refreshproductdatarequest.md) | :heavy_check_mark: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ---------------------------- | ---------------------------- | ---------------------------- |
+| errors.ErrorMessage | 400, 401, 402, 403, 404, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
+| errors.SDKError | 4XX, 5XX | \*/\* |
+
+## getAccessToken
+
+Use the _Get company access token_ endpoint to return an access token for the specified company ID. The token is valid for one day.
+
+The token is required by Codat's embeddable UIs (such as [Connections SDK](https://docs.codat.io/auth-flow/optimize/connection-management) and [Link SDK](https://docs.codat.io/auth-flow/authorize-embedded-link)) to verify the identity of the user and improve the reliability of data provided by them.
+
+### Example Usage
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.companies.getAccessToken({
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { companiesGetAccessToken } from "@codat/platform/funcs/companiesGetAccessToken.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await companiesGetAccessToken(codatPlatform, {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("companiesGetAccessToken failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.GetCompanyAccessTokenRequest](../../sdk/models/operations/getcompanyaccesstokenrequest.md) | :heavy_check_mark: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\<[shared.CompanyAccessToken](../../sdk/models/shared/companyaccesstoken.md)\>**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
+| errors.SDKError | 4XX, 5XX | \*/\* |
+
+## getCompanySyncSettings
+
+Retrieve the [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings) for a specific company. This includes how often data types should be queued to be updated, and how much history should be fetched.
+
+### Example Usage
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.companies.getCompanySyncSettings({
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { companiesGetCompanySyncSettings } from "@codat/platform/funcs/companiesGetCompanySyncSettings.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await companiesGetCompanySyncSettings(codatPlatform, {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("companiesGetCompanySyncSettings failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.GetCompanySyncSettingsRequest](../../sdk/models/operations/getcompanysyncsettingsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\<[shared.CompanySyncSettings](../../sdk/models/shared/companysyncsettings.md)\>**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
+| errors.SDKError | 4XX, 5XX | \*/\* |
+
+## setCompanySyncSettings
+
+Set the sync settings for a specific company.
+
+### Example Usage
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ await codatPlatform.companies.setCompanySyncSettings({
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ requestBody: {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ settings: [
+ {
+ dataType: "invoices",
+ fetchOnFirstLink: true,
+ syncSchedule: 24,
+ syncOrder: 0,
+ syncFromUtc: "2020-01-01T12:00:00.000Z",
+ syncFromWindow: 24,
+ monthsToSync: 24,
+ isLocked: true,
+ },
+ ],
+ },
+ });
+
+
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { companiesSetCompanySyncSettings } from "@codat/platform/funcs/companiesSetCompanySyncSettings.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await companiesSetCompanySyncSettings(codatPlatform, {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ requestBody: {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ settings: [
+ {
+ dataType: "invoices",
+ fetchOnFirstLink: true,
+ syncSchedule: 24,
+ syncOrder: 0,
+ syncFromUtc: "2020-01-01T12:00:00.000Z",
+ syncFromWindow: 24,
+ monthsToSync: 24,
+ isLocked: true,
+ },
+ ],
+ },
+ });
+ if (res.ok) {
+ const { value: result } = res;
+
+ } else {
+ console.log("companiesSetCompanySyncSettings failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.SetCompanySyncSettingsRequest](../../sdk/models/operations/setcompanysyncsettingsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ---------------------------- | ---------------------------- | ---------------------------- |
+| errors.ErrorMessage | 400, 401, 402, 403, 404, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |
\ No newline at end of file
diff --git a/platform/docs/sdks/connectionmanagement/README.md b/platform/docs/sdks/connectionmanagement/README.md
index 9f645690b..0b26a2237 100644
--- a/platform/docs/sdks/connectionmanagement/README.md
+++ b/platform/docs/sdks/connectionmanagement/README.md
@@ -1,92 +1,92 @@
-# ~~ConnectionManagement~~
-
-> [!WARNING]
-> This SDK is **DEPRECATED**
-
-## Overview
-
-Configure UI and retrieve access tokens for authentication used by **Connections SDK**.
-
-### Available Operations
-
-* [~~get~~](#get) - Get access token (old) :warning: **Deprecated** Use [getAccessToken](docs/sdks/companies/README.md#getaccesstoken) instead.
-
-## ~~get~~
-
-The new [Get company access token](https://docs.codat.io/platform-api#/operations/get-company-access-token) endpoint replaces this endpoint and includes additional functionality.
-
-> :warning: **DEPRECATED**: The endpoint for generating company-specific connection management access tokens has been deprecated.
-Codat now supports a global company access token, providing seamless access across multiple products.
-Update your integration to use the global token for improved efficiency and consistency.
-. Use `getAccessToken` instead.
-
-### Example Usage
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.connectionManagement.get({
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { connectionManagementGet } from "@codat/platform/funcs/connectionManagementGet.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await connectionManagementGet(codatPlatform, {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("connectionManagementGet failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [operations.GetConnectionManagementAccessTokenRequest](../../sdk/models/operations/getconnectionmanagementaccesstokenrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\<[shared.ConnectionManagementAccessToken](../../sdk/models/shared/connectionmanagementaccesstoken.md)\>**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ----------------------- | ----------------------- | ----------------------- |
-| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
+# ~~ConnectionManagement~~
+
+> [!WARNING]
+> This SDK is **DEPRECATED**
+
+## Overview
+
+Configure UI and retrieve access tokens for authentication used by **Connections SDK**.
+
+### Available Operations
+
+* [~~get~~](#get) - Get access token (old) :warning: **Deprecated** Use [getAccessToken](docs/sdks/companies/README.md#getaccesstoken) instead.
+
+## ~~get~~
+
+The new [Get company access token](https://docs.codat.io/platform-api#/operations/get-company-access-token) endpoint replaces this endpoint and includes additional functionality.
+
+> :warning: **DEPRECATED**: The endpoint for generating company-specific connection management access tokens has been deprecated.
+Codat now supports a global company access token, providing seamless access across multiple products.
+Update your integration to use the global token for improved efficiency and consistency.
+. Use `getAccessToken` instead.
+
+### Example Usage
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.connectionManagement.get({
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { connectionManagementGet } from "@codat/platform/funcs/connectionManagementGet.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await connectionManagementGet(codatPlatform, {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("connectionManagementGet failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.GetConnectionManagementAccessTokenRequest](../../sdk/models/operations/getconnectionmanagementaccesstokenrequest.md) | :heavy_check_mark: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\<[shared.ConnectionManagementAccessToken](../../sdk/models/shared/connectionmanagementaccesstoken.md)\>**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |
\ No newline at end of file
diff --git a/platform/docs/sdks/connections/README.md b/platform/docs/sdks/connections/README.md
index bc0ad2ca3..efb2e09fb 100644
--- a/platform/docs/sdks/connections/README.md
+++ b/platform/docs/sdks/connections/README.md
@@ -1,546 +1,546 @@
-# Connections
-
-## Overview
-
-Create new and manage existing data connections for a company.
-
-### Available Operations
-
-* [list](#list) - List connections
-* [create](#create) - Create connection
-* [get](#get) - Get connection
-* [delete](#delete) - Delete connection
-* [unlink](#unlink) - Unlink connection
-* [updateAuthorization](#updateauthorization) - Update authorization
-
-## list
-
-List the connections for a company.
-
-### Example Usage
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.connections.list({
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
- orderBy: "-modifiedDate",
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { connectionsList } from "@codat/platform/funcs/connectionsList.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await connectionsList(codatPlatform, {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
- orderBy: "-modifiedDate",
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("connectionsList failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [operations.ListConnectionsRequest](../../sdk/models/operations/listconnectionsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\<[shared.Connections](../../sdk/models/shared/connections.md)\>**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ---------------------------- | ---------------------------- | ---------------------------- |
-| errors.ErrorMessage | 400, 401, 402, 403, 404, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
-| errors.SDKError | 4XX, 5XX | \*/\* |
-
-## create
-
-Creates a connection for the company by providing a valid `platformKey`.
-
-Use the [List Integrations](https://docs.codat.io/platform-api#/operations/list-integrations) endpoint to access valid platform keys.
-
-### Example Usage: Connection
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.connections.create({
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- requestBody: {
- platformKey: "gbol",
- },
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { connectionsCreate } from "@codat/platform/funcs/connectionsCreate.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await connectionsCreate(codatPlatform, {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- requestBody: {
- platformKey: "gbol",
- },
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("connectionsCreate failed:", res.error);
- }
-}
-
-run();
-```
-### Example Usage: Unauthorized
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.connections.create({
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- requestBody: {
- platformKey: "gbol",
- },
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { connectionsCreate } from "@codat/platform/funcs/connectionsCreate.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await connectionsCreate(codatPlatform, {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- requestBody: {
- platformKey: "gbol",
- },
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("connectionsCreate failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [operations.CreateConnectionRequest](../../sdk/models/operations/createconnectionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\<[shared.Connection](../../sdk/models/shared/connection.md)\>**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ----------------------- | ----------------------- | ----------------------- |
-| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
-| errors.SDKError | 4XX, 5XX | \*/\* |
-
-## get
-
-Returns a specific connection for a company when valid identifiers are provided. If the identifiers are for a deleted company and/or connection, a not found response is returned.
-
-### Example Usage
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.connections.get({
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { connectionsGet } from "@codat/platform/funcs/connectionsGet.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await connectionsGet(codatPlatform, {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("connectionsGet failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [operations.GetConnectionRequest](../../sdk/models/operations/getconnectionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\<[shared.Connection](../../sdk/models/shared/connection.md)\>**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ----------------------- | ----------------------- | ----------------------- |
-| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
-| errors.SDKError | 4XX, 5XX | \*/\* |
-
-## delete
-
-Revoke and remove a connection from a company.
-This operation is not reversible. The end user would need to reauthorize a new data connection if you wish to view new data for this company.
-
-### Example Usage
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- await codatPlatform.connections.delete({
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
- });
-
-
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { connectionsDelete } from "@codat/platform/funcs/connectionsDelete.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await connectionsDelete(codatPlatform, {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
- });
- if (res.ok) {
- const { value: result } = res;
-
- } else {
- console.log("connectionsDelete failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [operations.DeleteConnectionRequest](../../sdk/models/operations/deleteconnectionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ----------------------- | ----------------------- | ----------------------- |
-| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
-| errors.SDKError | 4XX, 5XX | \*/\* |
-
-## unlink
-
-This allows you to deauthorize a connection, without deleting it from Codat. This means you can still view any data that has previously been pulled into Codat, and also lets you re-authorize in future if your customer wishes to resume sharing their data.
-
-### Example Usage
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.connections.unlink({
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
- updateConnectionStatus: {
- status: "Unlinked",
- },
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { connectionsUnlink } from "@codat/platform/funcs/connectionsUnlink.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await connectionsUnlink(codatPlatform, {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
- updateConnectionStatus: {
- status: "Unlinked",
- },
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("connectionsUnlink failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [operations.UnlinkConnectionRequest](../../sdk/models/operations/unlinkconnectionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\<[shared.Connection](../../sdk/models/shared/connection.md)\>**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ----------------------- | ----------------------- | ----------------------- |
-| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
-| errors.SDKError | 4XX, 5XX | \*/\* |
-
-## updateAuthorization
-
-Update data connection's authorization.
-
-### Example Usage
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.connections.updateAuthorization({
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { connectionsUpdateAuthorization } from "@codat/platform/funcs/connectionsUpdateAuthorization.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await connectionsUpdateAuthorization(codatPlatform, {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("connectionsUpdateAuthorization failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [operations.UpdateConnectionAuthorizationRequest](../../sdk/models/operations/updateconnectionauthorizationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\<[shared.Connection](../../sdk/models/shared/connection.md)\>**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ----------------------- | ----------------------- | ----------------------- |
-| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
+# Connections
+
+## Overview
+
+Create new and manage existing data connections for a company.
+
+### Available Operations
+
+* [list](#list) - List connections
+* [create](#create) - Create connection
+* [get](#get) - Get connection
+* [delete](#delete) - Delete connection
+* [unlink](#unlink) - Unlink connection
+* [updateAuthorization](#updateauthorization) - Update authorization
+
+## list
+
+List the connections for a company.
+
+### Example Usage
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.connections.list({
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
+ orderBy: "-modifiedDate",
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { connectionsList } from "@codat/platform/funcs/connectionsList.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await connectionsList(codatPlatform, {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
+ orderBy: "-modifiedDate",
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("connectionsList failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.ListConnectionsRequest](../../sdk/models/operations/listconnectionsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\<[shared.Connections](../../sdk/models/shared/connections.md)\>**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ---------------------------- | ---------------------------- | ---------------------------- |
+| errors.ErrorMessage | 400, 401, 402, 403, 404, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
+| errors.SDKError | 4XX, 5XX | \*/\* |
+
+## create
+
+Creates a connection for the company by providing a valid `platformKey`.
+
+Use the [List Integrations](https://docs.codat.io/platform-api#/operations/list-integrations) endpoint to access valid platform keys.
+
+### Example Usage: Connection
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.connections.create({
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ requestBody: {
+ platformKey: "gbol",
+ },
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { connectionsCreate } from "@codat/platform/funcs/connectionsCreate.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await connectionsCreate(codatPlatform, {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ requestBody: {
+ platformKey: "gbol",
+ },
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("connectionsCreate failed:", res.error);
+ }
+}
+
+run();
+```
+### Example Usage: Unauthorized
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.connections.create({
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ requestBody: {
+ platformKey: "gbol",
+ },
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { connectionsCreate } from "@codat/platform/funcs/connectionsCreate.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await connectionsCreate(codatPlatform, {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ requestBody: {
+ platformKey: "gbol",
+ },
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("connectionsCreate failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.CreateConnectionRequest](../../sdk/models/operations/createconnectionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\<[shared.Connection](../../sdk/models/shared/connection.md)\>**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
+| errors.SDKError | 4XX, 5XX | \*/\* |
+
+## get
+
+Returns a specific connection for a company when valid identifiers are provided. If the identifiers are for a deleted company and/or connection, a not found response is returned.
+
+### Example Usage
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.connections.get({
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { connectionsGet } from "@codat/platform/funcs/connectionsGet.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await connectionsGet(codatPlatform, {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("connectionsGet failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.GetConnectionRequest](../../sdk/models/operations/getconnectionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\<[shared.Connection](../../sdk/models/shared/connection.md)\>**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
+| errors.SDKError | 4XX, 5XX | \*/\* |
+
+## delete
+
+Revoke and remove a connection from a company.
+This operation is not reversible. The end user would need to reauthorize a new data connection if you wish to view new data for this company.
+
+### Example Usage
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ await codatPlatform.connections.delete({
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+ });
+
+
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { connectionsDelete } from "@codat/platform/funcs/connectionsDelete.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await connectionsDelete(codatPlatform, {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+ });
+ if (res.ok) {
+ const { value: result } = res;
+
+ } else {
+ console.log("connectionsDelete failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.DeleteConnectionRequest](../../sdk/models/operations/deleteconnectionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
+| errors.SDKError | 4XX, 5XX | \*/\* |
+
+## unlink
+
+This allows you to deauthorize a connection, without deleting it from Codat. This means you can still view any data that has previously been pulled into Codat, and also lets you re-authorize in future if your customer wishes to resume sharing their data.
+
+### Example Usage
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.connections.unlink({
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+ updateConnectionStatus: {
+ status: "Unlinked",
+ },
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { connectionsUnlink } from "@codat/platform/funcs/connectionsUnlink.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await connectionsUnlink(codatPlatform, {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+ updateConnectionStatus: {
+ status: "Unlinked",
+ },
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("connectionsUnlink failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.UnlinkConnectionRequest](../../sdk/models/operations/unlinkconnectionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\<[shared.Connection](../../sdk/models/shared/connection.md)\>**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
+| errors.SDKError | 4XX, 5XX | \*/\* |
+
+## updateAuthorization
+
+Update data connection's authorization.
+
+### Example Usage
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.connections.updateAuthorization({
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { connectionsUpdateAuthorization } from "@codat/platform/funcs/connectionsUpdateAuthorization.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await connectionsUpdateAuthorization(codatPlatform, {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("connectionsUpdateAuthorization failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.UpdateConnectionAuthorizationRequest](../../sdk/models/operations/updateconnectionauthorizationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\<[shared.Connection](../../sdk/models/shared/connection.md)\>**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |
\ No newline at end of file
diff --git a/platform/docs/sdks/cors/README.md b/platform/docs/sdks/cors/README.md
index 7cc250dae..10b29de8f 100644
--- a/platform/docs/sdks/cors/README.md
+++ b/platform/docs/sdks/cors/README.md
@@ -1,225 +1,225 @@
-# ~~Cors~~
-
-> [!WARNING]
-> This SDK is **DEPRECATED**
-
-## Overview
-
-### Available Operations
-
-* [~~get~~](#get) - Get CORS settings (old) :warning: **Deprecated** Use [get](docs/sdks/settings/README.md#get) instead.
-* [~~set~~](#set) - Set CORS settings (old) :warning: **Deprecated** Use [set](docs/sdks/settings/README.md#set) instead.
-
-## ~~get~~
-
-The *Get CORS settings* endpoint returns the allowed origins (i.e. your domains) you want to allow cross-origin resource sharing ([CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing)) with Codat.
-
-Enabling CORS with Codat is required by our embeddable UIs (such as [Connections SDK](https://docs.codat.io/auth-flow/optimize/connection-management) and [Link SDK](https://docs.codat.io/auth-flow/authorize-embedded-link)) to access Codat's API endpoints.
-
-> :warning: **DEPRECATED**: The new [Get CORS settings](https://docs.codat.io/platform-api#/operations/get-cors-settings) endpoint replaces this endpoint and includes additional functionality.
-Update your integrations to use the new path `/corsSettings` as the existing route will be removed in a future release.
-. Use `get` instead.
-
-### Example Usage
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.cors.get();
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { corsGet } from "@codat/platform/funcs/corsGet.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await corsGet(codatPlatform);
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("corsGet failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\<[shared.ConnectionManagementAllowedOrigins](../../sdk/models/shared/connectionmanagementallowedorigins.md)\>**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ----------------------- | ----------------------- | ----------------------- |
-| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
-| errors.SDKError | 4XX, 5XX | \*/\* |
-
-## ~~set~~
-
-The *Set CORS settings* endpoint allows you to register allowed origins (i.e. your domains) for use in cross-origin resource sharing ([CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing)).
-
-Enabling CORS with Codat is required by our embeddable UIs (such as [Connections SDK](https://docs.codat.io/auth-flow/optimize/connection-management) and [Link SDK](https://docs.codat.io/auth-flow/authorize-embedded-link)) to access Codat's API endpoints.
-
-> :warning: **DEPRECATED**: The new [Set CORS settings](https://docs.codat.io/platform-api#/operations/set-cors-settings) endpoint replaces this endpoint and includes additional functionality.
-Update your integrations to use the new path `/corsSettings` as the existing route will be removed in a future release.
-. Use `set` instead.
-
-### Example Usage: Allowed origins
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.cors.set({
- allowedOrigins: [
- "https://www.bank-of-dave.com",
- ],
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { corsSet } from "@codat/platform/funcs/corsSet.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await corsSet(codatPlatform, {
- allowedOrigins: [
- "https://www.bank-of-dave.com",
- ],
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("corsSet failed:", res.error);
- }
-}
-
-run();
-```
-### Example Usage: Unauthorized
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.cors.set({
- allowedOrigins: [
- "https://www.bank-of-dave.com",
- ],
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { corsSet } from "@codat/platform/funcs/corsSet.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await corsSet(codatPlatform, {
- allowedOrigins: [
- "https://www.bank-of-dave.com",
- ],
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("corsSet failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [shared.ConnectionManagementAllowedOrigins](../../sdk/models/shared/connectionmanagementallowedorigins.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\<[shared.ConnectionManagementAllowedOrigins](../../sdk/models/shared/connectionmanagementallowedorigins.md)\>**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ----------------------- | ----------------------- | ----------------------- |
-| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
+# ~~Cors~~
+
+> [!WARNING]
+> This SDK is **DEPRECATED**
+
+## Overview
+
+### Available Operations
+
+* [~~get~~](#get) - Get CORS settings (old) :warning: **Deprecated** Use [get](docs/sdks/settings/README.md#get) instead.
+* [~~set~~](#set) - Set CORS settings (old) :warning: **Deprecated** Use [set](docs/sdks/settings/README.md#set) instead.
+
+## ~~get~~
+
+The *Get CORS settings* endpoint returns the allowed origins (i.e. your domains) you want to allow cross-origin resource sharing ([CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing)) with Codat.
+
+Enabling CORS with Codat is required by our embeddable UIs (such as [Connections SDK](https://docs.codat.io/auth-flow/optimize/connection-management) and [Link SDK](https://docs.codat.io/auth-flow/authorize-embedded-link)) to access Codat's API endpoints.
+
+> :warning: **DEPRECATED**: The new [Get CORS settings](https://docs.codat.io/platform-api#/operations/get-cors-settings) endpoint replaces this endpoint and includes additional functionality.
+Update your integrations to use the new path `/corsSettings` as the existing route will be removed in a future release.
+. Use `get` instead.
+
+### Example Usage
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.cors.get();
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { corsGet } from "@codat/platform/funcs/corsGet.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await corsGet(codatPlatform);
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("corsGet failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\<[shared.ConnectionManagementAllowedOrigins](../../sdk/models/shared/connectionmanagementallowedorigins.md)\>**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
+| errors.SDKError | 4XX, 5XX | \*/\* |
+
+## ~~set~~
+
+The *Set CORS settings* endpoint allows you to register allowed origins (i.e. your domains) for use in cross-origin resource sharing ([CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing)).
+
+Enabling CORS with Codat is required by our embeddable UIs (such as [Connections SDK](https://docs.codat.io/auth-flow/optimize/connection-management) and [Link SDK](https://docs.codat.io/auth-flow/authorize-embedded-link)) to access Codat's API endpoints.
+
+> :warning: **DEPRECATED**: The new [Set CORS settings](https://docs.codat.io/platform-api#/operations/set-cors-settings) endpoint replaces this endpoint and includes additional functionality.
+Update your integrations to use the new path `/corsSettings` as the existing route will be removed in a future release.
+. Use `set` instead.
+
+### Example Usage: Allowed origins
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.cors.set({
+ allowedOrigins: [
+ "https://www.bank-of-dave.com",
+ ],
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { corsSet } from "@codat/platform/funcs/corsSet.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await corsSet(codatPlatform, {
+ allowedOrigins: [
+ "https://www.bank-of-dave.com",
+ ],
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("corsSet failed:", res.error);
+ }
+}
+
+run();
+```
+### Example Usage: Unauthorized
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.cors.set({
+ allowedOrigins: [
+ "https://www.bank-of-dave.com",
+ ],
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { corsSet } from "@codat/platform/funcs/corsSet.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await corsSet(codatPlatform, {
+ allowedOrigins: [
+ "https://www.bank-of-dave.com",
+ ],
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("corsSet failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [shared.ConnectionManagementAllowedOrigins](../../sdk/models/shared/connectionmanagementallowedorigins.md) | :heavy_minus_sign: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\<[shared.ConnectionManagementAllowedOrigins](../../sdk/models/shared/connectionmanagementallowedorigins.md)\>**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |
\ No newline at end of file
diff --git a/platform/docs/sdks/customdatatype/README.md b/platform/docs/sdks/customdatatype/README.md
index 3eaa58ef5..35fef49e3 100644
--- a/platform/docs/sdks/customdatatype/README.md
+++ b/platform/docs/sdks/customdatatype/README.md
@@ -1,694 +1,694 @@
-# CustomDataType
-
-## Overview
-
-Configure and pull additional data types that are not included in Codat's standardized data model.
-
-### Available Operations
-
-* [configure](#configure) - Configure custom data type
-* [getConfiguration](#getconfiguration) - Get custom data configuration
-* [refresh](#refresh) - Refresh custom data type
-* [list](#list) - List custom data type records
-
-## configure
-
-The *Configure custom data type* endpoint allows you to maintain or change the configuration required to return a custom data type for a specific integration.
-
-A [custom data type](https://docs.codat.io/using-the-api/custom-data) is an additional data type you can create that is not included in Codat's standardized data model.
-
-### Tips and traps
-
-- You can only configure a single custom data type for a single platform at a time. Use the endpoint multiple times if you need to configure it for multiple platforms.
-
-- You can only indicate a single data source for each customer data type.
-
-- Make your custom configuration as similar as possible to our standard data types so you can interact with them in exactly the same way.
-
-### Example Usage: Dynamics 365 Business Central
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.customDataType.configure({
- platformKey: "gbol",
- customDataIdentifier: "DynamicsPurchaseOrders",
- customDataTypeConfiguration: {
- dataSource: "api/purchaseOrders",
- requiredData: {
- "currency": "$[*].currencyCode",
- "number": "$[*].number",
- "date": "$[*].orderDate",
- "totalexvat": "$[*].totalAmountExcludingTax",
- "totaltax": "$[*].totalTaxAmount",
- "vendor": "$[*].number",
- },
- keyBy: [
- "$[*].id",
- ],
- sourceModifiedDate: [
- "$[*].lastModifiedDateTime",
- ],
- },
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { customDataTypeConfigure } from "@codat/platform/funcs/customDataTypeConfigure.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await customDataTypeConfigure(codatPlatform, {
- platformKey: "gbol",
- customDataIdentifier: "DynamicsPurchaseOrders",
- customDataTypeConfiguration: {
- dataSource: "api/purchaseOrders",
- requiredData: {
- "currency": "$[*].currencyCode",
- "number": "$[*].number",
- "date": "$[*].orderDate",
- "totalexvat": "$[*].totalAmountExcludingTax",
- "totaltax": "$[*].totalTaxAmount",
- "vendor": "$[*].number",
- },
- keyBy: [
- "$[*].id",
- ],
- sourceModifiedDate: [
- "$[*].lastModifiedDateTime",
- ],
- },
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("customDataTypeConfigure failed:", res.error);
- }
-}
-
-run();
-```
-### Example Usage: QuickBooks Online
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.customDataType.configure({
- platformKey: "gbol",
- customDataIdentifier: "DynamicsPurchaseOrders",
- customDataTypeConfiguration: {
- dataSource: "/query?query=select * from Account",
- requiredData: {
- "id": "$.Id",
- "Currentbal": "$.CurrentBalance",
- "SubAcc": "$.SubAccount",
- },
- keyBy: [
- "$.Id",
- ],
- sourceModifiedDate: [
- "$.time",
- ],
- },
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { customDataTypeConfigure } from "@codat/platform/funcs/customDataTypeConfigure.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await customDataTypeConfigure(codatPlatform, {
- platformKey: "gbol",
- customDataIdentifier: "DynamicsPurchaseOrders",
- customDataTypeConfiguration: {
- dataSource: "/query?query=select * from Account",
- requiredData: {
- "id": "$.Id",
- "Currentbal": "$.CurrentBalance",
- "SubAcc": "$.SubAccount",
- },
- keyBy: [
- "$.Id",
- ],
- sourceModifiedDate: [
- "$.time",
- ],
- },
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("customDataTypeConfigure failed:", res.error);
- }
-}
-
-run();
-```
-### Example Usage: Unauthorized
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.customDataType.configure({
- platformKey: "gbol",
- customDataIdentifier: "DynamicsPurchaseOrders",
- customDataTypeConfiguration: {
- dataSource: "api/purchaseOrders?$filter=currencyCode eq 'NOK'",
- requiredData: {
- "currencyCode": "$[*].currencyCode",
- "id": "$[*].id",
- "number": "$[*].number",
- "orderDate": "$[*].orderDate",
- "totalAmountExcludingTax": "$[*].totalAmountExcludingTax",
- "totalTaxAmount": "$[*].totalTaxAmount",
- "vendorName": "$[*].number",
- },
- keyBy: [
- "$[*].id",
- ],
- sourceModifiedDate: [
- "$[*].lastModifiedDateTime",
- ],
- },
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { customDataTypeConfigure } from "@codat/platform/funcs/customDataTypeConfigure.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await customDataTypeConfigure(codatPlatform, {
- platformKey: "gbol",
- customDataIdentifier: "DynamicsPurchaseOrders",
- customDataTypeConfiguration: {
- dataSource: "api/purchaseOrders?$filter=currencyCode eq 'NOK'",
- requiredData: {
- "currencyCode": "$[*].currencyCode",
- "id": "$[*].id",
- "number": "$[*].number",
- "orderDate": "$[*].orderDate",
- "totalAmountExcludingTax": "$[*].totalAmountExcludingTax",
- "totalTaxAmount": "$[*].totalTaxAmount",
- "vendorName": "$[*].number",
- },
- keyBy: [
- "$[*].id",
- ],
- sourceModifiedDate: [
- "$[*].lastModifiedDateTime",
- ],
- },
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("customDataTypeConfigure failed:", res.error);
- }
-}
-
-run();
-```
-### Example Usage: Xero Mapping Arrays
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.customDataType.configure({
- platformKey: "gbol",
- customDataIdentifier: "DynamicsPurchaseOrders",
- customDataTypeConfiguration: {
- dataSource: "/api.xro/2.0/Invoices",
- requiredData: {
- "invNumber": "$.InvoiceNumber",
- "type": "$.Type",
- "InvoiceID": "$.InvoiceID",
- "lines": "$.LineItems[*]",
- },
- keyBy: [
- "$.InvoiceID",
- ],
- sourceModifiedDate: [
- "$.UpdatedDateUTC",
- ],
- },
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { customDataTypeConfigure } from "@codat/platform/funcs/customDataTypeConfigure.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await customDataTypeConfigure(codatPlatform, {
- platformKey: "gbol",
- customDataIdentifier: "DynamicsPurchaseOrders",
- customDataTypeConfiguration: {
- dataSource: "/api.xro/2.0/Invoices",
- requiredData: {
- "invNumber": "$.InvoiceNumber",
- "type": "$.Type",
- "InvoiceID": "$.InvoiceID",
- "lines": "$.LineItems[*]",
- },
- keyBy: [
- "$.InvoiceID",
- ],
- sourceModifiedDate: [
- "$.UpdatedDateUTC",
- ],
- },
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("customDataTypeConfigure failed:", res.error);
- }
-}
-
-run();
-```
-### Example Usage: Xero Simple Record
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.customDataType.configure({
- platformKey: "gbol",
- customDataIdentifier: "DynamicsPurchaseOrders",
- customDataTypeConfiguration: {
- dataSource: "/api.xro/2.0/Accounts",
- requiredData: {
- "code": "$.Code",
- "accountId": "$.AccountID",
- "type": "$.Type",
- "SysAcc": "$.SystemAccount",
- },
- keyBy: [
- "$.AccountID",
- ],
- },
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { customDataTypeConfigure } from "@codat/platform/funcs/customDataTypeConfigure.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await customDataTypeConfigure(codatPlatform, {
- platformKey: "gbol",
- customDataIdentifier: "DynamicsPurchaseOrders",
- customDataTypeConfiguration: {
- dataSource: "/api.xro/2.0/Accounts",
- requiredData: {
- "code": "$.Code",
- "accountId": "$.AccountID",
- "type": "$.Type",
- "SysAcc": "$.SystemAccount",
- },
- keyBy: [
- "$.AccountID",
- ],
- },
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("customDataTypeConfigure failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [operations.ConfigureCustomDataTypeRequest](../../sdk/models/operations/configurecustomdatatyperequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\<[shared.CustomDataTypeConfiguration](../../sdk/models/shared/customdatatypeconfiguration.md)\>**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ----------------------- | ----------------------- | ----------------------- |
-| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
-| errors.SDKError | 4XX, 5XX | \*/\* |
-
-## getConfiguration
-
-The *Get custom data configuration* endpoint returns existing configuration details for the specified custom data type and integration pair you previously configured.
-
-A [custom data type](https://docs.codat.io/using-the-api/custom-data) is an additional data type you can create that is not included in Codat's standardized data model.
-
-### Example Usage
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.customDataType.getConfiguration({
- platformKey: "gbol",
- customDataIdentifier: "DynamicsPurchaseOrders",
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { customDataTypeGetConfiguration } from "@codat/platform/funcs/customDataTypeGetConfiguration.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await customDataTypeGetConfiguration(codatPlatform, {
- platformKey: "gbol",
- customDataIdentifier: "DynamicsPurchaseOrders",
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("customDataTypeGetConfiguration failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [operations.GetCustomDataTypeConfigurationRequest](../../sdk/models/operations/getcustomdatatypeconfigurationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\<[shared.CustomDataTypeRecords](../../sdk/models/shared/customdatatyperecords.md)\>**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ----------------------- | ----------------------- | ----------------------- |
-| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
-| errors.SDKError | 4XX, 5XX | \*/\* |
-
-## refresh
-
-The *Refresh custom data type* endpoint refreshes the specified custom data type for a given company. This is an asynchronous operation that will sync updated data from the linked integration into Codat for you to view.
-
-### Example Usage
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.customDataType.refresh({
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
- customDataIdentifier: "DynamicsPurchaseOrders",
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { customDataTypeRefresh } from "@codat/platform/funcs/customDataTypeRefresh.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await customDataTypeRefresh(codatPlatform, {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
- customDataIdentifier: "DynamicsPurchaseOrders",
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("customDataTypeRefresh failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [operations.RefreshCustomDataTypeRequest](../../sdk/models/operations/refreshcustomdatatyperequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\<[shared.PullOperation](../../sdk/models/shared/pulloperation.md)\>**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ---------------------------- | ---------------------------- | ---------------------------- |
-| errors.ErrorMessage | 401, 402, 403, 404, 429, 451 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
-| errors.SDKError | 4XX, 5XX | \*/\* |
-
-## list
-
-The *List custom data type records* endpoint returns a paginated list of records pulled for the specified custom data type you previously configured.
-
-A [custom data type](https://docs.codat.io/using-the-api/custom-data) is an additional data type you can create that is not included in Codat's standardized data model.s endpoint returns a paginated list of records whose schema is defined [Configure custom data type](https://docs.codat.io/platform-api#/operations/configure-custom-data-type)
-
-### Example Usage
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.customDataType.list({
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
- customDataIdentifier: "DynamicsPurchaseOrders",
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { customDataTypeList } from "@codat/platform/funcs/customDataTypeList.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await customDataTypeList(codatPlatform, {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
- customDataIdentifier: "DynamicsPurchaseOrders",
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("customDataTypeList failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [operations.ListCustomDataTypeRecordsRequest](../../sdk/models/operations/listcustomdatatyperecordsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\<[shared.CustomDataTypeRecords](../../sdk/models/shared/customdatatyperecords.md)\>**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| --------------------------------- | --------------------------------- | --------------------------------- |
-| errors.ErrorMessage | 400, 401, 402, 403, 404, 429, 451 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
+# CustomDataType
+
+## Overview
+
+Configure and pull additional data types that are not included in Codat's standardized data model.
+
+### Available Operations
+
+* [configure](#configure) - Configure custom data type
+* [getConfiguration](#getconfiguration) - Get custom data configuration
+* [refresh](#refresh) - Refresh custom data type
+* [list](#list) - List custom data type records
+
+## configure
+
+The *Configure custom data type* endpoint allows you to maintain or change the configuration required to return a custom data type for a specific integration.
+
+A [custom data type](https://docs.codat.io/using-the-api/custom-data) is an additional data type you can create that is not included in Codat's standardized data model.
+
+### Tips and traps
+
+- You can only configure a single custom data type for a single platform at a time. Use the endpoint multiple times if you need to configure it for multiple platforms.
+
+- You can only indicate a single data source for each customer data type.
+
+- Make your custom configuration as similar as possible to our standard data types so you can interact with them in exactly the same way.
+
+### Example Usage: Dynamics 365 Business Central
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.customDataType.configure({
+ platformKey: "gbol",
+ customDataIdentifier: "DynamicsPurchaseOrders",
+ customDataTypeConfiguration: {
+ dataSource: "api/purchaseOrders",
+ requiredData: {
+ "currency": "$[*].currencyCode",
+ "number": "$[*].number",
+ "date": "$[*].orderDate",
+ "totalexvat": "$[*].totalAmountExcludingTax",
+ "totaltax": "$[*].totalTaxAmount",
+ "vendor": "$[*].number",
+ },
+ keyBy: [
+ "$[*].id",
+ ],
+ sourceModifiedDate: [
+ "$[*].lastModifiedDateTime",
+ ],
+ },
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { customDataTypeConfigure } from "@codat/platform/funcs/customDataTypeConfigure.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await customDataTypeConfigure(codatPlatform, {
+ platformKey: "gbol",
+ customDataIdentifier: "DynamicsPurchaseOrders",
+ customDataTypeConfiguration: {
+ dataSource: "api/purchaseOrders",
+ requiredData: {
+ "currency": "$[*].currencyCode",
+ "number": "$[*].number",
+ "date": "$[*].orderDate",
+ "totalexvat": "$[*].totalAmountExcludingTax",
+ "totaltax": "$[*].totalTaxAmount",
+ "vendor": "$[*].number",
+ },
+ keyBy: [
+ "$[*].id",
+ ],
+ sourceModifiedDate: [
+ "$[*].lastModifiedDateTime",
+ ],
+ },
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("customDataTypeConfigure failed:", res.error);
+ }
+}
+
+run();
+```
+### Example Usage: QuickBooks Online
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.customDataType.configure({
+ platformKey: "gbol",
+ customDataIdentifier: "DynamicsPurchaseOrders",
+ customDataTypeConfiguration: {
+ dataSource: "/query?query=select * from Account",
+ requiredData: {
+ "id": "$.Id",
+ "Currentbal": "$.CurrentBalance",
+ "SubAcc": "$.SubAccount",
+ },
+ keyBy: [
+ "$.Id",
+ ],
+ sourceModifiedDate: [
+ "$.time",
+ ],
+ },
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { customDataTypeConfigure } from "@codat/platform/funcs/customDataTypeConfigure.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await customDataTypeConfigure(codatPlatform, {
+ platformKey: "gbol",
+ customDataIdentifier: "DynamicsPurchaseOrders",
+ customDataTypeConfiguration: {
+ dataSource: "/query?query=select * from Account",
+ requiredData: {
+ "id": "$.Id",
+ "Currentbal": "$.CurrentBalance",
+ "SubAcc": "$.SubAccount",
+ },
+ keyBy: [
+ "$.Id",
+ ],
+ sourceModifiedDate: [
+ "$.time",
+ ],
+ },
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("customDataTypeConfigure failed:", res.error);
+ }
+}
+
+run();
+```
+### Example Usage: Unauthorized
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.customDataType.configure({
+ platformKey: "gbol",
+ customDataIdentifier: "DynamicsPurchaseOrders",
+ customDataTypeConfiguration: {
+ dataSource: "api/purchaseOrders?$filter=currencyCode eq 'NOK'",
+ requiredData: {
+ "currencyCode": "$[*].currencyCode",
+ "id": "$[*].id",
+ "number": "$[*].number",
+ "orderDate": "$[*].orderDate",
+ "totalAmountExcludingTax": "$[*].totalAmountExcludingTax",
+ "totalTaxAmount": "$[*].totalTaxAmount",
+ "vendorName": "$[*].number",
+ },
+ keyBy: [
+ "$[*].id",
+ ],
+ sourceModifiedDate: [
+ "$[*].lastModifiedDateTime",
+ ],
+ },
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { customDataTypeConfigure } from "@codat/platform/funcs/customDataTypeConfigure.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await customDataTypeConfigure(codatPlatform, {
+ platformKey: "gbol",
+ customDataIdentifier: "DynamicsPurchaseOrders",
+ customDataTypeConfiguration: {
+ dataSource: "api/purchaseOrders?$filter=currencyCode eq 'NOK'",
+ requiredData: {
+ "currencyCode": "$[*].currencyCode",
+ "id": "$[*].id",
+ "number": "$[*].number",
+ "orderDate": "$[*].orderDate",
+ "totalAmountExcludingTax": "$[*].totalAmountExcludingTax",
+ "totalTaxAmount": "$[*].totalTaxAmount",
+ "vendorName": "$[*].number",
+ },
+ keyBy: [
+ "$[*].id",
+ ],
+ sourceModifiedDate: [
+ "$[*].lastModifiedDateTime",
+ ],
+ },
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("customDataTypeConfigure failed:", res.error);
+ }
+}
+
+run();
+```
+### Example Usage: Xero Mapping Arrays
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.customDataType.configure({
+ platformKey: "gbol",
+ customDataIdentifier: "DynamicsPurchaseOrders",
+ customDataTypeConfiguration: {
+ dataSource: "/api.xro/2.0/Invoices",
+ requiredData: {
+ "invNumber": "$.InvoiceNumber",
+ "type": "$.Type",
+ "InvoiceID": "$.InvoiceID",
+ "lines": "$.LineItems[*]",
+ },
+ keyBy: [
+ "$.InvoiceID",
+ ],
+ sourceModifiedDate: [
+ "$.UpdatedDateUTC",
+ ],
+ },
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { customDataTypeConfigure } from "@codat/platform/funcs/customDataTypeConfigure.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await customDataTypeConfigure(codatPlatform, {
+ platformKey: "gbol",
+ customDataIdentifier: "DynamicsPurchaseOrders",
+ customDataTypeConfiguration: {
+ dataSource: "/api.xro/2.0/Invoices",
+ requiredData: {
+ "invNumber": "$.InvoiceNumber",
+ "type": "$.Type",
+ "InvoiceID": "$.InvoiceID",
+ "lines": "$.LineItems[*]",
+ },
+ keyBy: [
+ "$.InvoiceID",
+ ],
+ sourceModifiedDate: [
+ "$.UpdatedDateUTC",
+ ],
+ },
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("customDataTypeConfigure failed:", res.error);
+ }
+}
+
+run();
+```
+### Example Usage: Xero Simple Record
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.customDataType.configure({
+ platformKey: "gbol",
+ customDataIdentifier: "DynamicsPurchaseOrders",
+ customDataTypeConfiguration: {
+ dataSource: "/api.xro/2.0/Accounts",
+ requiredData: {
+ "code": "$.Code",
+ "accountId": "$.AccountID",
+ "type": "$.Type",
+ "SysAcc": "$.SystemAccount",
+ },
+ keyBy: [
+ "$.AccountID",
+ ],
+ },
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { customDataTypeConfigure } from "@codat/platform/funcs/customDataTypeConfigure.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await customDataTypeConfigure(codatPlatform, {
+ platformKey: "gbol",
+ customDataIdentifier: "DynamicsPurchaseOrders",
+ customDataTypeConfiguration: {
+ dataSource: "/api.xro/2.0/Accounts",
+ requiredData: {
+ "code": "$.Code",
+ "accountId": "$.AccountID",
+ "type": "$.Type",
+ "SysAcc": "$.SystemAccount",
+ },
+ keyBy: [
+ "$.AccountID",
+ ],
+ },
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("customDataTypeConfigure failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.ConfigureCustomDataTypeRequest](../../sdk/models/operations/configurecustomdatatyperequest.md) | :heavy_check_mark: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\<[shared.CustomDataTypeConfiguration](../../sdk/models/shared/customdatatypeconfiguration.md)\>**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
+| errors.SDKError | 4XX, 5XX | \*/\* |
+
+## getConfiguration
+
+The *Get custom data configuration* endpoint returns existing configuration details for the specified custom data type and integration pair you previously configured.
+
+A [custom data type](https://docs.codat.io/using-the-api/custom-data) is an additional data type you can create that is not included in Codat's standardized data model.
+
+### Example Usage
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.customDataType.getConfiguration({
+ platformKey: "gbol",
+ customDataIdentifier: "DynamicsPurchaseOrders",
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { customDataTypeGetConfiguration } from "@codat/platform/funcs/customDataTypeGetConfiguration.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await customDataTypeGetConfiguration(codatPlatform, {
+ platformKey: "gbol",
+ customDataIdentifier: "DynamicsPurchaseOrders",
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("customDataTypeGetConfiguration failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.GetCustomDataTypeConfigurationRequest](../../sdk/models/operations/getcustomdatatypeconfigurationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\<[shared.CustomDataTypeRecords](../../sdk/models/shared/customdatatyperecords.md)\>**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
+| errors.SDKError | 4XX, 5XX | \*/\* |
+
+## refresh
+
+The *Refresh custom data type* endpoint refreshes the specified custom data type for a given company. This is an asynchronous operation that will sync updated data from the linked integration into Codat for you to view.
+
+### Example Usage
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.customDataType.refresh({
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+ customDataIdentifier: "DynamicsPurchaseOrders",
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { customDataTypeRefresh } from "@codat/platform/funcs/customDataTypeRefresh.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await customDataTypeRefresh(codatPlatform, {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+ customDataIdentifier: "DynamicsPurchaseOrders",
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("customDataTypeRefresh failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.RefreshCustomDataTypeRequest](../../sdk/models/operations/refreshcustomdatatyperequest.md) | :heavy_check_mark: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\<[shared.PullOperation](../../sdk/models/shared/pulloperation.md)\>**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ---------------------------- | ---------------------------- | ---------------------------- |
+| errors.ErrorMessage | 401, 402, 403, 404, 429, 451 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
+| errors.SDKError | 4XX, 5XX | \*/\* |
+
+## list
+
+The *List custom data type records* endpoint returns a paginated list of records pulled for the specified custom data type you previously configured.
+
+A [custom data type](https://docs.codat.io/using-the-api/custom-data) is an additional data type you can create that is not included in Codat's standardized data model.s endpoint returns a paginated list of records whose schema is defined [Configure custom data type](https://docs.codat.io/platform-api#/operations/configure-custom-data-type)
+
+### Example Usage
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.customDataType.list({
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+ customDataIdentifier: "DynamicsPurchaseOrders",
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { customDataTypeList } from "@codat/platform/funcs/customDataTypeList.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await customDataTypeList(codatPlatform, {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+ customDataIdentifier: "DynamicsPurchaseOrders",
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("customDataTypeList failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.ListCustomDataTypeRecordsRequest](../../sdk/models/operations/listcustomdatatyperecordsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\<[shared.CustomDataTypeRecords](../../sdk/models/shared/customdatatyperecords.md)\>**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| --------------------------------- | --------------------------------- | --------------------------------- |
+| errors.ErrorMessage | 400, 401, 402, 403, 404, 429, 451 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |
\ No newline at end of file
diff --git a/platform/docs/sdks/integrations/README.md b/platform/docs/sdks/integrations/README.md
index e922543c4..730e1182c 100644
--- a/platform/docs/sdks/integrations/README.md
+++ b/platform/docs/sdks/integrations/README.md
@@ -1,238 +1,238 @@
-# Integrations
-
-## Overview
-
-Get a list of integrations supported by Codat and their logos.
-
-### Available Operations
-
-* [list](#list) - List integrations
-* [get](#get) - Get integration
-* [getBranding](#getbranding) - Get branding
-
-## list
-
-List your available integrations
-
-### Example Usage
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.integrations.list({
- query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
- orderBy: "-modifiedDate",
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { integrationsList } from "@codat/platform/funcs/integrationsList.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await integrationsList(codatPlatform, {
- query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
- orderBy: "-modifiedDate",
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("integrationsList failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [operations.ListIntegrationsRequest](../../sdk/models/operations/listintegrationsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\<[shared.Integrations](../../sdk/models/shared/integrations.md)\>**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ----------------------- | ----------------------- | ----------------------- |
-| errors.ErrorMessage | 400, 401, 402, 403, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
-| errors.SDKError | 4XX, 5XX | \*/\* |
-
-## get
-
-Get single integration, by platformKey
-
-### Example Usage
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.integrations.get({
- platformKey: "gbol",
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { integrationsGet } from "@codat/platform/funcs/integrationsGet.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await integrationsGet(codatPlatform, {
- platformKey: "gbol",
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("integrationsGet failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [operations.GetIntegrationRequest](../../sdk/models/operations/getintegrationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\<[shared.Integration](../../sdk/models/shared/integration.md)\>**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ----------------------- | ----------------------- | ----------------------- |
-| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
-| errors.SDKError | 4XX, 5XX | \*/\* |
-
-## getBranding
-
-Get branding for platform.
-
-### Example Usage
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.integrations.getBranding({
- platformKey: "gbol",
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { integrationsGetBranding } from "@codat/platform/funcs/integrationsGetBranding.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await integrationsGetBranding(codatPlatform, {
- platformKey: "gbol",
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("integrationsGetBranding failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [operations.GetIntegrationsBrandingRequest](../../sdk/models/operations/getintegrationsbrandingrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\<[shared.Branding](../../sdk/models/shared/branding.md)\>**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ----------------------- | ----------------------- | ----------------------- |
-| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
+# Integrations
+
+## Overview
+
+Get a list of integrations supported by Codat and their logos.
+
+### Available Operations
+
+* [list](#list) - List integrations
+* [get](#get) - Get integration
+* [getBranding](#getbranding) - Get branding
+
+## list
+
+List your available integrations
+
+### Example Usage
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.integrations.list({
+ query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
+ orderBy: "-modifiedDate",
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { integrationsList } from "@codat/platform/funcs/integrationsList.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await integrationsList(codatPlatform, {
+ query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
+ orderBy: "-modifiedDate",
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("integrationsList failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.ListIntegrationsRequest](../../sdk/models/operations/listintegrationsrequest.md) | :heavy_minus_sign: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\<[shared.Integrations](../../sdk/models/shared/integrations.md)\>**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ErrorMessage | 400, 401, 402, 403, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
+| errors.SDKError | 4XX, 5XX | \*/\* |
+
+## get
+
+Get single integration, by platformKey
+
+### Example Usage
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.integrations.get({
+ platformKey: "gbol",
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { integrationsGet } from "@codat/platform/funcs/integrationsGet.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await integrationsGet(codatPlatform, {
+ platformKey: "gbol",
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("integrationsGet failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.GetIntegrationRequest](../../sdk/models/operations/getintegrationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\<[shared.Integration](../../sdk/models/shared/integration.md)\>**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
+| errors.SDKError | 4XX, 5XX | \*/\* |
+
+## getBranding
+
+Get branding for platform.
+
+### Example Usage
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.integrations.getBranding({
+ platformKey: "gbol",
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { integrationsGetBranding } from "@codat/platform/funcs/integrationsGetBranding.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await integrationsGetBranding(codatPlatform, {
+ platformKey: "gbol",
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("integrationsGetBranding failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.GetIntegrationsBrandingRequest](../../sdk/models/operations/getintegrationsbrandingrequest.md) | :heavy_check_mark: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\<[shared.Branding](../../sdk/models/shared/branding.md)\>**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |
\ No newline at end of file
diff --git a/platform/docs/sdks/pushdata/README.md b/platform/docs/sdks/pushdata/README.md
index 00231222f..d20909860 100644
--- a/platform/docs/sdks/pushdata/README.md
+++ b/platform/docs/sdks/pushdata/README.md
@@ -1,254 +1,252 @@
-# PushData
-
-## Overview
-
-Initiate and monitor Create, Update, and Delete operations.
-
-### Available Operations
-
-* [getModelOptions](#getmodeloptions) - Get push options
-* [listOperations](#listoperations) - List push operations
-* [getOperation](#getoperation) - Get push operation
-
-## getModelOptions
-
-This is the generic documentation for creation and updating of data. See the equivalent endpoint for a given data type for more specific information.
-
-Before pushing data into accounting software, it is often necessary to collect some details from the user as to how they would like the data to be inserted. This includes names and amounts on transactional entities, but also factors such as categorisation of entities, which is often handled differently between different accounting software. A good example of this is specifying where on the balance sheet/profit and loss reports the user would like a newly-created nominal account to appear.
-
-Codat tries not to limit users to pushing to a very limited number of standard categories, so we have implemented "options" endpoints, which allow us to expose to our clients the fields which are required to be pushed for a specific linked company, and the options which may be selected for each field.
-
-### Example Usage
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.pushData.getModelOptions({
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
- dataType: "invoices",
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { pushDataGetModelOptions } from "@codat/platform/funcs/pushDataGetModelOptions.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await pushDataGetModelOptions(codatPlatform, {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
- dataType: "invoices",
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("pushDataGetModelOptions failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [operations.GetCreateUpdateModelOptionsByDataTypeRequest](../../sdk/models/operations/getcreateupdatemodeloptionsbydatatyperequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\<[shared.PushOption](../../sdk/models/shared/pushoption.md)\>**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ----------------------- | ----------------------- | ----------------------- |
-| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
-| errors.SDKError | 4XX, 5XX | \*/\* |
-
-## listOperations
-
-The **List push operations** endpoint returns a list of [push operations](/using-the-api/push) performed on the company.
-
-Write operations are actions that send requests to Codat, enabling the creation, updating, deletion of records, or uploading attachments in the connected accounting software.
-
-### Example Usage
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.pushData.listOperations({
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
- orderBy: "-modifiedDate",
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { pushDataListOperations } from "@codat/platform/funcs/pushDataListOperations.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await pushDataListOperations(codatPlatform, {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
- orderBy: "-modifiedDate",
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("pushDataListOperations failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [operations.GetCompanyPushHistoryRequest](../../sdk/models/operations/getcompanypushhistoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\<[shared.PushOperations](../../sdk/models/shared/pushoperations.md)\>**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ---------------------------- | ---------------------------- | ---------------------------- |
-| errors.ErrorMessage | 400, 401, 402, 403, 404, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
-| errors.SDKError | 4XX, 5XX | \*/\* |
-
-## getOperation
-
-The **Get push operation** endpoint returns a specific [push operation](/using-the-api/push) identified by the `pushOperationKey` that was performed on the company.
-
-Write operations are actions that send requests to Codat, enabling the creation, updating, deletion of records, or uploading attachments in the connected accounting software.
-
-### Example Usage
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.pushData.getOperation({
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- pushOperationKey: "660e8684-c0fb-4468-9e2a-b2e3b115d747",
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { pushDataGetOperation } from "@codat/platform/funcs/pushDataGetOperation.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await pushDataGetOperation(codatPlatform, {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- pushOperationKey: "660e8684-c0fb-4468-9e2a-b2e3b115d747",
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("pushDataGetOperation failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [operations.GetPushOperationRequest](../../sdk/models/operations/getpushoperationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\<[shared.PushOperation](../../sdk/models/shared/pushoperation.md)\>**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ----------------------- | ----------------------- | ----------------------- |
-| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
+# PushData
+
+## Overview
+
+Initiate and monitor Create, Update, and Delete operations.
+
+### Available Operations
+
+* [getModelOptions](#getmodeloptions) - Get push options
+* [listOperations](#listoperations) - List push operations
+* [getOperation](#getoperation) - Get push operation
+
+## getModelOptions
+
+This is the generic documentation for creation and updating of data. See the equivalent endpoint for a given data type for more specific information.
+
+Before pushing data into accounting software, it is often necessary to collect some details from the user as to how they would like the data to be inserted. This includes names and amounts on transactional entities, but also factors such as categorisation of entities, which is often handled differently between different accounting software. A good example of this is specifying where on the balance sheet/profit and loss reports the user would like a newly-created nominal account to appear.
+
+Codat tries not to limit users to pushing to a very limited number of standard categories, so we have implemented "options" endpoints, which allow us to expose to our clients the fields which are required to be pushed for a specific linked company, and the options which may be selected for each field.
+
+### Example Usage
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.pushData.getModelOptions({
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+ dataType: "invoices",
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { pushDataGetModelOptions } from "@codat/platform/funcs/pushDataGetModelOptions.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await pushDataGetModelOptions(codatPlatform, {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
+ dataType: "invoices",
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("pushDataGetModelOptions failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.GetCreateUpdateModelOptionsByDataTypeRequest](../../sdk/models/operations/getcreateupdatemodeloptionsbydatatyperequest.md) | :heavy_check_mark: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\<[shared.PushOption](../../sdk/models/shared/pushoption.md)\>**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
+| errors.SDKError | 4XX, 5XX | \*/\* |
+
+## listOperations
+
+The **List push operations** endpoint returns a list of [push operations](/using-the-api/push) performed on the company.
+
+Write operations are actions that send requests to Codat, enabling the creation, updating, deletion of records, or uploading attachments in the connected accounting software.
+
+### Example Usage
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.pushData.listOperations({
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
+ orderBy: "-modifiedDate",
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { pushDataListOperations } from "@codat/platform/funcs/pushDataListOperations.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await pushDataListOperations(codatPlatform, {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
+ orderBy: "-modifiedDate",
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("pushDataListOperations failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.GetCompanyPushHistoryRequest](../../sdk/models/operations/getcompanypushhistoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\<[shared.PushOperations](../../sdk/models/shared/pushoperations.md)\>**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ---------------------------- | ---------------------------- | ---------------------------- |
+| errors.ErrorMessage | 400, 401, 402, 403, 404, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
+| errors.SDKError | 4XX, 5XX | \*/\* |
+
+## getOperation
+
+The **Get push operation** endpoint returns a specific [push operation](/using-the-api/push) identified by the `pushOperationKey` that was performed on the company.
+
+Write operations are actions that send requests to Codat, enabling the creation, updating, deletion of records, or uploading attachments in the connected accounting software.
+
+### Example Usage
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.pushData.getOperation({
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { pushDataGetOperation } from "@codat/platform/funcs/pushDataGetOperation.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await pushDataGetOperation(codatPlatform, {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("pushDataGetOperation failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.GetPushOperationRequest](../../sdk/models/operations/getpushoperationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\<[shared.PushOperation](../../sdk/models/shared/pushoperation.md)\>**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |
\ No newline at end of file
diff --git a/platform/docs/sdks/readdata/README.md b/platform/docs/sdks/readdata/README.md
index 79d62c950..0a602513f 100644
--- a/platform/docs/sdks/readdata/README.md
+++ b/platform/docs/sdks/readdata/README.md
@@ -1,91 +1,89 @@
-# ReadData
-
-## Overview
-
-View validation outcomes for completed read data operations.
-
-### Available Operations
-
-* [getValidationResults](#getvalidationresults) - Get validation results
-
-## getValidationResults
-
-Use the **Get validation results** endpoint to review warnings and errors encountered during the data type validation phase.
-
-The validation result [schema](https://docs.codat.io/platform-api#/schemas/ValidationResult) contains two message arrays:
-
-- **`warnings`** array lists potential issues with the data type that may require attention but don't block usage.
-- **`errors`** array contains critical issues that must be resolved before the data type can be used.
-
-### Example Usage
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.readData.getValidationResults({
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- datasetId: "0812af6e-436a-491f-9056-db91cb961ad3",
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { readDataGetValidationResults } from "@codat/platform/funcs/readDataGetValidationResults.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await readDataGetValidationResults(codatPlatform, {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- datasetId: "0812af6e-436a-491f-9056-db91cb961ad3",
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("readDataGetValidationResults failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [operations.GetReadValidationResultsRequest](../../sdk/models/operations/getreadvalidationresultsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\<[shared.ValidationResult](../../sdk/models/shared/validationresult.md)\>**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ----------------------- | ----------------------- | ----------------------- |
-| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
+# ReadData
+
+## Overview
+
+View validation outcomes for completed read data operations.
+
+### Available Operations
+
+* [getValidationResults](#getvalidationresults) - Get validation results
+
+## getValidationResults
+
+Use the **Get validation results** endpoint to review warnings and errors encountered during the data type validation phase.
+
+The validation result [schema](https://docs.codat.io/platform-api#/schemas/ValidationResult) contains two message arrays:
+
+- **`warnings`** array lists potential issues with the data type that may require attention but don't block usage.
+- **`errors`** array contains critical issues that must be resolved before the data type can be used.
+
+### Example Usage
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.readData.getValidationResults({
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { readDataGetValidationResults } from "@codat/platform/funcs/readDataGetValidationResults.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await readDataGetValidationResults(codatPlatform, {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("readDataGetValidationResults failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.GetReadValidationResultsRequest](../../sdk/models/operations/getreadvalidationresultsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\<[shared.ValidationResult](../../sdk/models/shared/validationresult.md)\>**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |
\ No newline at end of file
diff --git a/platform/docs/sdks/refreshdata/README.md b/platform/docs/sdks/refreshdata/README.md
index 73a47f90d..ac12e30e2 100644
--- a/platform/docs/sdks/refreshdata/README.md
+++ b/platform/docs/sdks/refreshdata/README.md
@@ -1,402 +1,400 @@
-# RefreshData
-
-## Overview
-
-Initiate data refreshes, view pull status and history.
-
-### Available Operations
-
-* [all](#all) - Refresh all data
-* [byDataType](#bydatatype) - Refresh data type
-* [get](#get) - Get data status
-* [listPullOperations](#listpulloperations) - List pull operations
-* [getPullOperation](#getpulloperation) - Get pull operation
-
-## all
-
-Refreshes all data types with `fetch on first link` set to `true` for a given company.
-
-This is an asynchronous operation, and will bring updated data into Codat from the linked integration for you to view.
-
-[Read more](https://docs.codat.io/core-concepts/data-type-settings) about data type settings and `fetch on first link`.
-
-### Example Usage
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- await codatPlatform.refreshData.all({
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- });
-
-
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { refreshDataAll } from "@codat/platform/funcs/refreshDataAll.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await refreshDataAll(codatPlatform, {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- });
- if (res.ok) {
- const { value: result } = res;
-
- } else {
- console.log("refreshDataAll failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [operations.RefreshCompanyDataRequest](../../sdk/models/operations/refreshcompanydatarequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ---------------------------- | ---------------------------- | ---------------------------- |
-| errors.ErrorMessage | 400, 401, 402, 403, 404, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
-| errors.SDKError | 4XX, 5XX | \*/\* |
-
-## byDataType
-
-Refreshes a given data type for a given company.
-
-This is an asynchronous operation, and will bring updated data into Codat from the linked integration for you to view.
-
-### Example Usage
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.refreshData.byDataType({
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- dataType: "invoices",
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { refreshDataByDataType } from "@codat/platform/funcs/refreshDataByDataType.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await refreshDataByDataType(codatPlatform, {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- dataType: "invoices",
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("refreshDataByDataType failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [operations.RefreshDataTypeRequest](../../sdk/models/operations/refreshdatatyperequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\<[shared.PullOperation](../../sdk/models/shared/pulloperation.md)\>**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ---------------------------- | ---------------------------- | ---------------------------- |
-| errors.ErrorMessage | 400, 401, 402, 403, 404, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
-| errors.SDKError | 4XX, 5XX | \*/\* |
-
-## get
-
-Get the state of each data type for a company
-
-### Example Usage
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.refreshData.get({
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { refreshDataGet } from "@codat/platform/funcs/refreshDataGet.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await refreshDataGet(codatPlatform, {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("refreshDataGet failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [operations.GetCompanyDataStatusRequest](../../sdk/models/operations/getcompanydatastatusrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\<[shared.DataStatuses](../../sdk/models/shared/datastatuses.md)\>**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ----------------------- | ----------------------- | ----------------------- |
-| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
-| errors.SDKError | 4XX, 5XX | \*/\* |
-
-## listPullOperations
-
-Gets the pull operation history (datasets) for a given company.
-
-### Example Usage
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.refreshData.listPullOperations({
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
- orderBy: "-modifiedDate",
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { refreshDataListPullOperations } from "@codat/platform/funcs/refreshDataListPullOperations.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await refreshDataListPullOperations(codatPlatform, {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
- orderBy: "-modifiedDate",
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("refreshDataListPullOperations failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [operations.ListPullOperationsRequest](../../sdk/models/operations/listpulloperationsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\<[shared.PullOperations](../../sdk/models/shared/pulloperations.md)\>**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ---------------------------- | ---------------------------- | ---------------------------- |
-| errors.ErrorMessage | 400, 401, 402, 403, 404, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
-| errors.SDKError | 4XX, 5XX | \*/\* |
-
-## getPullOperation
-
-Retrieve information about a single dataset or pull operation.
-
-### Example Usage
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.refreshData.getPullOperation({
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- datasetId: "fa5f3e86-bd80-49b8-853c-5fbba4b201f5",
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { refreshDataGetPullOperation } from "@codat/platform/funcs/refreshDataGetPullOperation.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await refreshDataGetPullOperation(codatPlatform, {
- companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- datasetId: "fa5f3e86-bd80-49b8-853c-5fbba4b201f5",
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("refreshDataGetPullOperation failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [operations.GetPullOperationRequest](../../sdk/models/operations/getpulloperationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\<[shared.PullOperation](../../sdk/models/shared/pulloperation.md)\>**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ----------------------- | ----------------------- | ----------------------- |
-| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
+# RefreshData
+
+## Overview
+
+Initiate data refreshes, view pull status and history.
+
+### Available Operations
+
+* [all](#all) - Refresh all data
+* [byDataType](#bydatatype) - Refresh data type
+* [get](#get) - Get data status
+* [listPullOperations](#listpulloperations) - List pull operations
+* [getPullOperation](#getpulloperation) - Get pull operation
+
+## all
+
+Refreshes all data types with `fetch on first link` set to `true` for a given company.
+
+This is an asynchronous operation, and will bring updated data into Codat from the linked integration for you to view.
+
+[Read more](https://docs.codat.io/core-concepts/data-type-settings) about data type settings and `fetch on first link`.
+
+### Example Usage
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ await codatPlatform.refreshData.all({
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ });
+
+
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { refreshDataAll } from "@codat/platform/funcs/refreshDataAll.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await refreshDataAll(codatPlatform, {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ });
+ if (res.ok) {
+ const { value: result } = res;
+
+ } else {
+ console.log("refreshDataAll failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.RefreshCompanyDataRequest](../../sdk/models/operations/refreshcompanydatarequest.md) | :heavy_check_mark: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ---------------------------- | ---------------------------- | ---------------------------- |
+| errors.ErrorMessage | 400, 401, 402, 403, 404, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
+| errors.SDKError | 4XX, 5XX | \*/\* |
+
+## byDataType
+
+Refreshes a given data type for a given company.
+
+This is an asynchronous operation, and will bring updated data into Codat from the linked integration for you to view.
+
+### Example Usage
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.refreshData.byDataType({
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ dataType: "invoices",
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { refreshDataByDataType } from "@codat/platform/funcs/refreshDataByDataType.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await refreshDataByDataType(codatPlatform, {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ dataType: "invoices",
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("refreshDataByDataType failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.RefreshDataTypeRequest](../../sdk/models/operations/refreshdatatyperequest.md) | :heavy_check_mark: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\<[shared.PullOperation](../../sdk/models/shared/pulloperation.md)\>**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ---------------------------- | ---------------------------- | ---------------------------- |
+| errors.ErrorMessage | 400, 401, 402, 403, 404, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
+| errors.SDKError | 4XX, 5XX | \*/\* |
+
+## get
+
+Get the state of each data type for a company
+
+### Example Usage
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.refreshData.get({
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { refreshDataGet } from "@codat/platform/funcs/refreshDataGet.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await refreshDataGet(codatPlatform, {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("refreshDataGet failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.GetCompanyDataStatusRequest](../../sdk/models/operations/getcompanydatastatusrequest.md) | :heavy_check_mark: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\<[shared.DataStatuses](../../sdk/models/shared/datastatuses.md)\>**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
+| errors.SDKError | 4XX, 5XX | \*/\* |
+
+## listPullOperations
+
+Gets the pull operation history (datasets) for a given company.
+
+### Example Usage
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.refreshData.listPullOperations({
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
+ orderBy: "-modifiedDate",
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { refreshDataListPullOperations } from "@codat/platform/funcs/refreshDataListPullOperations.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await refreshDataListPullOperations(codatPlatform, {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
+ orderBy: "-modifiedDate",
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("refreshDataListPullOperations failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.ListPullOperationsRequest](../../sdk/models/operations/listpulloperationsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\<[shared.PullOperations](../../sdk/models/shared/pulloperations.md)\>**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ---------------------------- | ---------------------------- | ---------------------------- |
+| errors.ErrorMessage | 400, 401, 402, 403, 404, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
+| errors.SDKError | 4XX, 5XX | \*/\* |
+
+## getPullOperation
+
+Retrieve information about a single dataset or pull operation.
+
+### Example Usage
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.refreshData.getPullOperation({
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { refreshDataGetPullOperation } from "@codat/platform/funcs/refreshDataGetPullOperation.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await refreshDataGetPullOperation(codatPlatform, {
+ companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("refreshDataGetPullOperation failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.GetPullOperationRequest](../../sdk/models/operations/getpulloperationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\<[shared.PullOperation](../../sdk/models/shared/pulloperation.md)\>**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |
\ No newline at end of file
diff --git a/platform/docs/sdks/settings/README.md b/platform/docs/sdks/settings/README.md
index 75b5f2167..87674546f 100644
--- a/platform/docs/sdks/settings/README.md
+++ b/platform/docs/sdks/settings/README.md
@@ -1,943 +1,941 @@
-# Settings
-
-## Overview
-
-Manage company profile configuration, sync settings, and API keys.
-
-### Available Operations
-
-* [get](#get) - Get CORS settings
-* [set](#set) - Set CORS settings
-* [getProfile](#getprofile) - Get profile
-* [updateProfile](#updateprofile) - Update profile
-* [getSyncSettings](#getsyncsettings) - Get sync settings
-* [updateSyncSettings](#updatesyncsettings) - Update all sync settings
-* [listApiKeys](#listapikeys) - List API keys
-* [createApiKey](#createapikey) - Create API key
-* [deleteApiKey](#deleteapikey) - Delete API key
-
-## get
-
-The *Get CORS settings* endpoint returns the allowed origins (i.e. your domains) you want to allow cross-origin resource sharing ([CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing)) with Codat.
-
-Enabling CORS with Codat is required by our embeddable UIs (such as [Connections SDK](https://docs.codat.io/auth-flow/optimize/connection-management) and [Link SDK](https://docs.codat.io/auth-flow/authorize-embedded-link)) to access Codat's API endpoints.
-
-### Example Usage
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.settings.get();
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { settingsGet } from "@codat/platform/funcs/settingsGet.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await settingsGet(codatPlatform);
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("settingsGet failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\<[shared.ConnectionManagementAllowedOrigins](../../sdk/models/shared/connectionmanagementallowedorigins.md)\>**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ----------------------- | ----------------------- | ----------------------- |
-| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
-| errors.SDKError | 4XX, 5XX | \*/\* |
-
-## set
-
-The *Set CORS settings* endpoint allows you to register allowed origins (i.e. your domains) for use in cross-origin resource sharing ([CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing)).
-
-Enabling CORS with Codat is required by our embeddable UIs (such as [Connections SDK](https://docs.codat.io/auth-flow/optimize/connection-management) and [Link SDK](https://docs.codat.io/auth-flow/authorize-embedded-link)) to access Codat's API endpoints.
-
-### Example Usage: Allowed origins
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.settings.set({
- allowedOrigins: [
- "https://www.bank-of-dave.com",
- ],
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { settingsSet } from "@codat/platform/funcs/settingsSet.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await settingsSet(codatPlatform, {
- allowedOrigins: [
- "https://www.bank-of-dave.com",
- ],
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("settingsSet failed:", res.error);
- }
-}
-
-run();
-```
-### Example Usage: Unauthorized
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.settings.set({
- allowedOrigins: [
- "https://www.bank-of-dave.com",
- ],
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { settingsSet } from "@codat/platform/funcs/settingsSet.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await settingsSet(codatPlatform, {
- allowedOrigins: [
- "https://www.bank-of-dave.com",
- ],
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("settingsSet failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [shared.ConnectionManagementAllowedOrigins](../../sdk/models/shared/connectionmanagementallowedorigins.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\<[shared.ConnectionManagementAllowedOrigins](../../sdk/models/shared/connectionmanagementallowedorigins.md)\>**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ----------------------- | ----------------------- | ----------------------- |
-| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
-| errors.SDKError | 4XX, 5XX | \*/\* |
-
-## getProfile
-
-Fetch your Codat profile.
-
-### Example Usage
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.settings.getProfile();
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { settingsGetProfile } from "@codat/platform/funcs/settingsGetProfile.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await settingsGetProfile(codatPlatform);
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("settingsGetProfile failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\<[shared.Profile](../../sdk/models/shared/profile.md)\>**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ------------------- | ------------------- | ------------------- |
-| errors.ErrorMessage | 401, 402, 403, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
-| errors.SDKError | 4XX, 5XX | \*/\* |
-
-## updateProfile
-
-Update your Codat profile
-
-### Example Usage
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.settings.updateProfile({
- name: "Bob's Burgers",
- logoUrl: "https://client-images.codat.io/logo/042399f5-d104-4f38-9ce8-cac3524f4e88_5806cb1f-7342-4c0e-a0a8-99bfbc47b0ff.png",
- iconUrl: "https://client-images.codat.io/icon/042399f5-d104-4f38-9ce8-cac3524f4e88_3f5623af-d992-4c22-bc08-e58c520a8526.ico",
- redirectUrl: "https://bobs-burgers.{countrySuffix}/{companyId}",
- whiteListUrls: [
- "https://bobs-burgers.com",
- "https://bobs-burgers.co.uk",
- ],
- confirmCompanyName: true,
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { settingsUpdateProfile } from "@codat/platform/funcs/settingsUpdateProfile.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await settingsUpdateProfile(codatPlatform, {
- name: "Bob's Burgers",
- logoUrl: "https://client-images.codat.io/logo/042399f5-d104-4f38-9ce8-cac3524f4e88_5806cb1f-7342-4c0e-a0a8-99bfbc47b0ff.png",
- iconUrl: "https://client-images.codat.io/icon/042399f5-d104-4f38-9ce8-cac3524f4e88_3f5623af-d992-4c22-bc08-e58c520a8526.ico",
- redirectUrl: "https://bobs-burgers.{countrySuffix}/{companyId}",
- whiteListUrls: [
- "https://bobs-burgers.com",
- "https://bobs-burgers.co.uk",
- ],
- confirmCompanyName: true,
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("settingsUpdateProfile failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [shared.Profile](../../sdk/models/shared/profile.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\<[shared.Profile](../../sdk/models/shared/profile.md)\>**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ------------------- | ------------------- | ------------------- |
-| errors.ErrorMessage | 401, 402, 403, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
-| errors.SDKError | 4XX, 5XX | \*/\* |
-
-## getSyncSettings
-
-Retrieve the [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings) for your client. This includes how often data types should be queued to be updated, and how much history should be fetched.
-
-### Example Usage
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.settings.getSyncSettings();
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { settingsGetSyncSettings } from "@codat/platform/funcs/settingsGetSyncSettings.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await settingsGetSyncSettings(codatPlatform);
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("settingsGetSyncSettings failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\<[shared.SyncSettings](../../sdk/models/shared/syncsettings.md)\>**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ------------------- | ------------------- | ------------------- |
-| errors.ErrorMessage | 401, 402, 403, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
-| errors.SDKError | 4XX, 5XX | \*/\* |
-
-## updateSyncSettings
-
-Update sync settings for all data types.
-
-### Example Usage
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- await codatPlatform.settings.updateSyncSettings({
- clientId: "9807ce3e-cfa5-4370-b4f2-09c282b1598b",
- settings: [
- {
- dataType: "invoices",
- fetchOnFirstLink: true,
- syncSchedule: 24,
- syncOrder: 0,
- syncFromUtc: "2020-01-01T12:00:00.000Z",
- syncFromWindow: 24,
- monthsToSync: 24,
- isLocked: true,
- },
- ],
- });
-
-
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { settingsUpdateSyncSettings } from "@codat/platform/funcs/settingsUpdateSyncSettings.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await settingsUpdateSyncSettings(codatPlatform, {
- clientId: "9807ce3e-cfa5-4370-b4f2-09c282b1598b",
- settings: [
- {
- dataType: "invoices",
- fetchOnFirstLink: true,
- syncSchedule: 24,
- syncOrder: 0,
- syncFromUtc: "2020-01-01T12:00:00.000Z",
- syncFromWindow: 24,
- monthsToSync: 24,
- isLocked: true,
- },
- ],
- });
- if (res.ok) {
- const { value: result } = res;
-
- } else {
- console.log("settingsUpdateSyncSettings failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [operations.UpdateProfileSyncSettingsRequestBody](../../sdk/models/operations/updateprofilesyncsettingsrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ------------------- | ------------------- | ------------------- |
-| errors.ErrorMessage | 401, 402, 403, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
-| errors.SDKError | 4XX, 5XX | \*/\* |
-
-## listApiKeys
-
-Use the *List API keys* endpoint to return a list of all API keys that currently exist for your client. This includes keys created via the Portal UI or the *Create API keys* endpoint.
-
-[API keys](https://docs.codat.io/platform-api#/schemas/apiKeys) are tokens used to control access to the API. Include this token in the `Authorization` header parameter when making API calls, following the word "Basic" and a space with your API key.
-
-You can [read more](https://docs.codat.io/using-the-api/authentication) about authentication at Codat and managing API keys via the Portal UI or API.
-
-### Example Usage
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.settings.listApiKeys();
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { settingsListApiKeys } from "@codat/platform/funcs/settingsListApiKeys.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await settingsListApiKeys(codatPlatform);
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("settingsListApiKeys failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\<[shared.ApiKeys](../../sdk/models/shared/apikeys.md)\>**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ------------------- | ------------------- | ------------------- |
-| errors.ErrorMessage | 401, 402, 403, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
-| errors.SDKError | 4XX, 5XX | \*/\* |
-
-## createApiKey
-
-Use the *Create API keys* endpoint to generate a new API key for your client.
-
-[API keys](https://docs.codat.io/platform-api#/schemas/apiKeys) are tokens used to control access to the API. Include this token in the `Authorization` header parameter when making API calls, following the word "Basic" and a space with your API key.
-
-You can [read more](https://docs.codat.io/using-the-api/authentication) about authentication at Codat and managing API keys via the Portal UI or API.
-
-### Tips and pitfalls
-
-* Your first API key is created for you. Access this key via [Codat's Portal](https://app.codat.io/developers/api-keys).
-* If you require multiple API keys, perform multiple calls to the *Create API keys* endpoint.
-* The number of API keys is limited to 10. If you have reached the maximum amount of keys, use the *Delete API key* endpoint to delete an unused key first.
-
-### Example Usage: API key details
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.settings.createApiKey({
- name: "azure-invoice-finance-processor",
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { settingsCreateApiKey } from "@codat/platform/funcs/settingsCreateApiKey.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await settingsCreateApiKey(codatPlatform, {
- name: "azure-invoice-finance-processor",
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("settingsCreateApiKey failed:", res.error);
- }
-}
-
-run();
-```
-### Example Usage: API key details with name
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.settings.createApiKey({
- name: "azure-invoice-finance-processor",
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { settingsCreateApiKey } from "@codat/platform/funcs/settingsCreateApiKey.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await settingsCreateApiKey(codatPlatform, {
- name: "azure-invoice-finance-processor",
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("settingsCreateApiKey failed:", res.error);
- }
-}
-
-run();
-```
-### Example Usage: Create API key with name
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.settings.createApiKey({
- name: "azure-invoice-finance-processor",
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { settingsCreateApiKey } from "@codat/platform/funcs/settingsCreateApiKey.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await settingsCreateApiKey(codatPlatform, {
- name: "azure-invoice-finance-processor",
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("settingsCreateApiKey failed:", res.error);
- }
-}
-
-run();
-```
-### Example Usage: Max length for name reached
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.settings.createApiKey({
- name: "azure-invoice-finance-processor",
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { settingsCreateApiKey } from "@codat/platform/funcs/settingsCreateApiKey.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await settingsCreateApiKey(codatPlatform, {
- name: "azure-invoice-finance-processor",
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("settingsCreateApiKey failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [shared.CreateApiKey](../../sdk/models/shared/createapikey.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\<[shared.ApiKeyDetails](../../sdk/models/shared/apikeydetails.md)\>**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ---------------------------- | ---------------------------- | ---------------------------- |
-| errors.ErrorMessage | 400, 401, 402, 403, 409, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
-| errors.SDKError | 4XX, 5XX | \*/\* |
-
-## deleteApiKey
-
-Use the *Delete API keys* endpoint to delete an existing API key, providing its valid `id` as a parameter. Note that this operation is not reversible.
-
-[API keys](https://docs.codat.io/platform-api#/schemas/apiKeys) are tokens used to control access to the API. Include this token in the `Authorization` header parameter when making API calls, following the word "Basic" and a space with your API key.
-
-You can [read more](https://docs.codat.io/using-the-api/authentication) about authentication at Codat and managing API keys via the Portal UI or API.
-
-### Tips and pitfalls
-
-* It is possible to delete the last remaining API key. If this happens, a new key can be created via the [API key management page](https://app.codat.io/developers/api-keys) of the Portal.
-* It is possible to delete the API key used to authenticate the *Delete API key* request.
-
-### Example Usage
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.settings.deleteApiKey({
- apiKeyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { settingsDeleteApiKey } from "@codat/platform/funcs/settingsDeleteApiKey.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await settingsDeleteApiKey(codatPlatform, {
- apiKeyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("settingsDeleteApiKey failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [operations.DeleteApiKeyRequest](../../sdk/models/operations/deleteapikeyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\<[shared.ErrorMessage](../../sdk/models/shared/errormessage.md)\>**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ----------------------- | ----------------------- | ----------------------- |
-| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
+# Settings
+
+## Overview
+
+Manage company profile configuration, sync settings, and API keys.
+
+### Available Operations
+
+* [get](#get) - Get CORS settings
+* [set](#set) - Set CORS settings
+* [getProfile](#getprofile) - Get profile
+* [updateProfile](#updateprofile) - Update profile
+* [getSyncSettings](#getsyncsettings) - Get sync settings
+* [updateSyncSettings](#updatesyncsettings) - Update all sync settings
+* [listApiKeys](#listapikeys) - List API keys
+* [createApiKey](#createapikey) - Create API key
+* [deleteApiKey](#deleteapikey) - Delete API key
+
+## get
+
+The *Get CORS settings* endpoint returns the allowed origins (i.e. your domains) you want to allow cross-origin resource sharing ([CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing)) with Codat.
+
+Enabling CORS with Codat is required by our embeddable UIs (such as [Connections SDK](https://docs.codat.io/auth-flow/optimize/connection-management) and [Link SDK](https://docs.codat.io/auth-flow/authorize-embedded-link)) to access Codat's API endpoints.
+
+### Example Usage
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.settings.get();
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { settingsGet } from "@codat/platform/funcs/settingsGet.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await settingsGet(codatPlatform);
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("settingsGet failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\<[shared.ConnectionManagementAllowedOrigins](../../sdk/models/shared/connectionmanagementallowedorigins.md)\>**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
+| errors.SDKError | 4XX, 5XX | \*/\* |
+
+## set
+
+The *Set CORS settings* endpoint allows you to register allowed origins (i.e. your domains) for use in cross-origin resource sharing ([CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing)).
+
+Enabling CORS with Codat is required by our embeddable UIs (such as [Connections SDK](https://docs.codat.io/auth-flow/optimize/connection-management) and [Link SDK](https://docs.codat.io/auth-flow/authorize-embedded-link)) to access Codat's API endpoints.
+
+### Example Usage: Allowed origins
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.settings.set({
+ allowedOrigins: [
+ "https://www.bank-of-dave.com",
+ ],
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { settingsSet } from "@codat/platform/funcs/settingsSet.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await settingsSet(codatPlatform, {
+ allowedOrigins: [
+ "https://www.bank-of-dave.com",
+ ],
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("settingsSet failed:", res.error);
+ }
+}
+
+run();
+```
+### Example Usage: Unauthorized
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.settings.set({
+ allowedOrigins: [
+ "https://www.bank-of-dave.com",
+ ],
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { settingsSet } from "@codat/platform/funcs/settingsSet.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await settingsSet(codatPlatform, {
+ allowedOrigins: [
+ "https://www.bank-of-dave.com",
+ ],
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("settingsSet failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [shared.ConnectionManagementAllowedOrigins](../../sdk/models/shared/connectionmanagementallowedorigins.md) | :heavy_minus_sign: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\<[shared.ConnectionManagementAllowedOrigins](../../sdk/models/shared/connectionmanagementallowedorigins.md)\>**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
+| errors.SDKError | 4XX, 5XX | \*/\* |
+
+## getProfile
+
+Fetch your Codat profile.
+
+### Example Usage
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.settings.getProfile();
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { settingsGetProfile } from "@codat/platform/funcs/settingsGetProfile.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await settingsGetProfile(codatPlatform);
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("settingsGetProfile failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\<[shared.Profile](../../sdk/models/shared/profile.md)\>**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ------------------- | ------------------- | ------------------- |
+| errors.ErrorMessage | 401, 402, 403, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
+| errors.SDKError | 4XX, 5XX | \*/\* |
+
+## updateProfile
+
+Update your Codat profile
+
+### Example Usage
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.settings.updateProfile({
+ name: "Bob's Burgers",
+ logoUrl: "https://client-images.codat.io/logo/042399f5-d104-4f38-9ce8-cac3524f4e88_5806cb1f-7342-4c0e-a0a8-99bfbc47b0ff.png",
+ iconUrl: "https://client-images.codat.io/icon/042399f5-d104-4f38-9ce8-cac3524f4e88_3f5623af-d992-4c22-bc08-e58c520a8526.ico",
+ redirectUrl: "https://bobs-burgers.{countrySuffix}/{companyId}",
+ whiteListUrls: [
+ "https://bobs-burgers.com",
+ "https://bobs-burgers.co.uk",
+ ],
+ confirmCompanyName: true,
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { settingsUpdateProfile } from "@codat/platform/funcs/settingsUpdateProfile.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await settingsUpdateProfile(codatPlatform, {
+ name: "Bob's Burgers",
+ logoUrl: "https://client-images.codat.io/logo/042399f5-d104-4f38-9ce8-cac3524f4e88_5806cb1f-7342-4c0e-a0a8-99bfbc47b0ff.png",
+ iconUrl: "https://client-images.codat.io/icon/042399f5-d104-4f38-9ce8-cac3524f4e88_3f5623af-d992-4c22-bc08-e58c520a8526.ico",
+ redirectUrl: "https://bobs-burgers.{countrySuffix}/{companyId}",
+ whiteListUrls: [
+ "https://bobs-burgers.com",
+ "https://bobs-burgers.co.uk",
+ ],
+ confirmCompanyName: true,
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("settingsUpdateProfile failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [shared.Profile](../../sdk/models/shared/profile.md) | :heavy_minus_sign: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\<[shared.Profile](../../sdk/models/shared/profile.md)\>**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ------------------- | ------------------- | ------------------- |
+| errors.ErrorMessage | 401, 402, 403, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
+| errors.SDKError | 4XX, 5XX | \*/\* |
+
+## getSyncSettings
+
+Retrieve the [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings) for your client. This includes how often data types should be queued to be updated, and how much history should be fetched.
+
+### Example Usage
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.settings.getSyncSettings();
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { settingsGetSyncSettings } from "@codat/platform/funcs/settingsGetSyncSettings.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await settingsGetSyncSettings(codatPlatform);
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("settingsGetSyncSettings failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\<[shared.SyncSettings](../../sdk/models/shared/syncsettings.md)\>**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ------------------- | ------------------- | ------------------- |
+| errors.ErrorMessage | 401, 402, 403, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
+| errors.SDKError | 4XX, 5XX | \*/\* |
+
+## updateSyncSettings
+
+Update sync settings for all data types.
+
+### Example Usage
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ await codatPlatform.settings.updateSyncSettings({
+ settings: [
+ {
+ dataType: "invoices",
+ fetchOnFirstLink: true,
+ syncSchedule: 24,
+ syncOrder: 0,
+ syncFromUtc: "2020-01-01T12:00:00.000Z",
+ syncFromWindow: 24,
+ monthsToSync: 24,
+ isLocked: true,
+ },
+ ],
+ });
+
+
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { settingsUpdateSyncSettings } from "@codat/platform/funcs/settingsUpdateSyncSettings.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await settingsUpdateSyncSettings(codatPlatform, {
+ settings: [
+ {
+ dataType: "invoices",
+ fetchOnFirstLink: true,
+ syncSchedule: 24,
+ syncOrder: 0,
+ syncFromUtc: "2020-01-01T12:00:00.000Z",
+ syncFromWindow: 24,
+ monthsToSync: 24,
+ isLocked: true,
+ },
+ ],
+ });
+ if (res.ok) {
+ const { value: result } = res;
+
+ } else {
+ console.log("settingsUpdateSyncSettings failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.UpdateProfileSyncSettingsRequestBody](../../sdk/models/operations/updateprofilesyncsettingsrequestbody.md) | :heavy_minus_sign: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ------------------- | ------------------- | ------------------- |
+| errors.ErrorMessage | 401, 402, 403, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
+| errors.SDKError | 4XX, 5XX | \*/\* |
+
+## listApiKeys
+
+Use the *List API keys* endpoint to return a list of all API keys that currently exist for your client. This includes keys created via the Portal UI or the *Create API keys* endpoint.
+
+[API keys](https://docs.codat.io/platform-api#/schemas/apiKeys) are tokens used to control access to the API. Include this token in the `Authorization` header parameter when making API calls, following the word "Basic" and a space with your API key.
+
+You can [read more](https://docs.codat.io/using-the-api/authentication) about authentication at Codat and managing API keys via the Portal UI or API.
+
+### Example Usage
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.settings.listApiKeys();
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { settingsListApiKeys } from "@codat/platform/funcs/settingsListApiKeys.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await settingsListApiKeys(codatPlatform);
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("settingsListApiKeys failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\<[shared.ApiKeys](../../sdk/models/shared/apikeys.md)\>**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ------------------- | ------------------- | ------------------- |
+| errors.ErrorMessage | 401, 402, 403, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
+| errors.SDKError | 4XX, 5XX | \*/\* |
+
+## createApiKey
+
+Use the *Create API keys* endpoint to generate a new API key for your client.
+
+[API keys](https://docs.codat.io/platform-api#/schemas/apiKeys) are tokens used to control access to the API. Include this token in the `Authorization` header parameter when making API calls, following the word "Basic" and a space with your API key.
+
+You can [read more](https://docs.codat.io/using-the-api/authentication) about authentication at Codat and managing API keys via the Portal UI or API.
+
+### Tips and pitfalls
+
+* Your first API key is created for you. Access this key via [Codat's Portal](https://app.codat.io/developers/api-keys).
+* If you require multiple API keys, perform multiple calls to the *Create API keys* endpoint.
+* The number of API keys is limited to 10. If you have reached the maximum amount of keys, use the *Delete API key* endpoint to delete an unused key first.
+
+### Example Usage: API key details
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.settings.createApiKey({
+ name: "azure-invoice-finance-processor",
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { settingsCreateApiKey } from "@codat/platform/funcs/settingsCreateApiKey.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await settingsCreateApiKey(codatPlatform, {
+ name: "azure-invoice-finance-processor",
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("settingsCreateApiKey failed:", res.error);
+ }
+}
+
+run();
+```
+### Example Usage: API key details with name
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.settings.createApiKey({
+ name: "azure-invoice-finance-processor",
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { settingsCreateApiKey } from "@codat/platform/funcs/settingsCreateApiKey.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await settingsCreateApiKey(codatPlatform, {
+ name: "azure-invoice-finance-processor",
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("settingsCreateApiKey failed:", res.error);
+ }
+}
+
+run();
+```
+### Example Usage: Create API key with name
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.settings.createApiKey({
+ name: "azure-invoice-finance-processor",
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { settingsCreateApiKey } from "@codat/platform/funcs/settingsCreateApiKey.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await settingsCreateApiKey(codatPlatform, {
+ name: "azure-invoice-finance-processor",
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("settingsCreateApiKey failed:", res.error);
+ }
+}
+
+run();
+```
+### Example Usage: Max length for name reached
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.settings.createApiKey({
+ name: "azure-invoice-finance-processor",
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { settingsCreateApiKey } from "@codat/platform/funcs/settingsCreateApiKey.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await settingsCreateApiKey(codatPlatform, {
+ name: "azure-invoice-finance-processor",
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("settingsCreateApiKey failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [shared.CreateApiKey](../../sdk/models/shared/createapikey.md) | :heavy_minus_sign: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\<[shared.ApiKeyDetails](../../sdk/models/shared/apikeydetails.md)\>**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ---------------------------- | ---------------------------- | ---------------------------- |
+| errors.ErrorMessage | 400, 401, 402, 403, 409, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
+| errors.SDKError | 4XX, 5XX | \*/\* |
+
+## deleteApiKey
+
+Use the *Delete API keys* endpoint to delete an existing API key, providing its valid `id` as a parameter. Note that this operation is not reversible.
+
+[API keys](https://docs.codat.io/platform-api#/schemas/apiKeys) are tokens used to control access to the API. Include this token in the `Authorization` header parameter when making API calls, following the word "Basic" and a space with your API key.
+
+You can [read more](https://docs.codat.io/using-the-api/authentication) about authentication at Codat and managing API keys via the Portal UI or API.
+
+### Tips and pitfalls
+
+* It is possible to delete the last remaining API key. If this happens, a new key can be created via the [API key management page](https://app.codat.io/developers/api-keys) of the Portal.
+* It is possible to delete the API key used to authenticate the *Delete API key* request.
+
+### Example Usage
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.settings.deleteApiKey({
+ apiKeyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { settingsDeleteApiKey } from "@codat/platform/funcs/settingsDeleteApiKey.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await settingsDeleteApiKey(codatPlatform, {
+ apiKeyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("settingsDeleteApiKey failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.DeleteApiKeyRequest](../../sdk/models/operations/deleteapikeyrequest.md) | :heavy_check_mark: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\<[shared.ErrorMessage](../../sdk/models/shared/errormessage.md)\>**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |
\ No newline at end of file
diff --git a/platform/docs/sdks/supplementaldata/README.md b/platform/docs/sdks/supplementaldata/README.md
index 8be9e1527..935e63b06 100644
--- a/platform/docs/sdks/supplementaldata/README.md
+++ b/platform/docs/sdks/supplementaldata/README.md
@@ -1,568 +1,568 @@
-# SupplementalData
-
-## Overview
-
-Configure and pull additional data you can include in Codat's standard data types.
-
-### Available Operations
-
-* [configure](#configure) - Configure
-* [getConfiguration](#getconfiguration) - Get configuration
-
-## configure
-
-The *Configure* endpoint allows you to maintain or change configuration required to return supplemental data for each integration and data type combination.
-
-[Supplemental data](https://docs.codat.io/using-the-api/supplemental-data/overview) is additional data you can include in Codat's standard data types.
-
-**Integration-specific behavior**
-See the *examples* for integration-specific frequently requested properties.
-
-### Example Usage: QBO - Customers
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- await codatPlatform.supplementalData.configure({
- platformKey: "gbol",
- dataType: "invoices",
- supplementalDataConfiguration: {},
- });
-
-
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { supplementalDataConfigure } from "@codat/platform/funcs/supplementalDataConfigure.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await supplementalDataConfigure(codatPlatform, {
- platformKey: "gbol",
- dataType: "invoices",
- supplementalDataConfiguration: {},
- });
- if (res.ok) {
- const { value: result } = res;
-
- } else {
- console.log("supplementalDataConfigure failed:", res.error);
- }
-}
-
-run();
-```
-### Example Usage: QBO - Invoices
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- await codatPlatform.supplementalData.configure({
- platformKey: "gbol",
- dataType: "invoices",
- supplementalDataConfiguration: {},
- });
-
-
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { supplementalDataConfigure } from "@codat/platform/funcs/supplementalDataConfigure.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await supplementalDataConfigure(codatPlatform, {
- platformKey: "gbol",
- dataType: "invoices",
- supplementalDataConfiguration: {},
- });
- if (res.ok) {
- const { value: result } = res;
-
- } else {
- console.log("supplementalDataConfigure failed:", res.error);
- }
-}
-
-run();
-```
-### Example Usage: Unauthorized
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- await codatPlatform.supplementalData.configure({
- platformKey: "gbol",
- dataType: "invoices",
- supplementalDataConfiguration: {
- supplementalDataConfig: {
- "orders-supplemental-data": {
- dataSource: "/orders",
- pullData: {
- "orderNumber": "order_num",
- },
- pushData: {
- "orderNumber": "order_num",
- },
- },
- },
- },
- });
-
-
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { supplementalDataConfigure } from "@codat/platform/funcs/supplementalDataConfigure.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await supplementalDataConfigure(codatPlatform, {
- platformKey: "gbol",
- dataType: "invoices",
- supplementalDataConfiguration: {
- supplementalDataConfig: {
- "orders-supplemental-data": {
- dataSource: "/orders",
- pullData: {
- "orderNumber": "order_num",
- },
- pushData: {
- "orderNumber": "order_num",
- },
- },
- },
- },
- });
- if (res.ok) {
- const { value: result } = res;
-
- } else {
- console.log("supplementalDataConfigure failed:", res.error);
- }
-}
-
-run();
-```
-### Example Usage: Xero - Accounts
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- await codatPlatform.supplementalData.configure({
- platformKey: "gbol",
- dataType: "invoices",
- supplementalDataConfiguration: {},
- });
-
-
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { supplementalDataConfigure } from "@codat/platform/funcs/supplementalDataConfigure.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await supplementalDataConfigure(codatPlatform, {
- platformKey: "gbol",
- dataType: "invoices",
- supplementalDataConfiguration: {},
- });
- if (res.ok) {
- const { value: result } = res;
-
- } else {
- console.log("supplementalDataConfigure failed:", res.error);
- }
-}
-
-run();
-```
-### Example Usage: Xero - Contacts
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- await codatPlatform.supplementalData.configure({
- platformKey: "gbol",
- dataType: "invoices",
- supplementalDataConfiguration: {},
- });
-
-
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { supplementalDataConfigure } from "@codat/platform/funcs/supplementalDataConfigure.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await supplementalDataConfigure(codatPlatform, {
- platformKey: "gbol",
- dataType: "invoices",
- supplementalDataConfiguration: {},
- });
- if (res.ok) {
- const { value: result } = res;
-
- } else {
- console.log("supplementalDataConfigure failed:", res.error);
- }
-}
-
-run();
-```
-### Example Usage: Xero - Invoices
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- await codatPlatform.supplementalData.configure({
- platformKey: "gbol",
- dataType: "invoices",
- supplementalDataConfiguration: {},
- });
-
-
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { supplementalDataConfigure } from "@codat/platform/funcs/supplementalDataConfigure.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await supplementalDataConfigure(codatPlatform, {
- platformKey: "gbol",
- dataType: "invoices",
- supplementalDataConfiguration: {},
- });
- if (res.ok) {
- const { value: result } = res;
-
- } else {
- console.log("supplementalDataConfigure failed:", res.error);
- }
-}
-
-run();
-```
-### Example Usage: Xero - Items
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- await codatPlatform.supplementalData.configure({
- platformKey: "gbol",
- dataType: "invoices",
- supplementalDataConfiguration: {},
- });
-
-
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { supplementalDataConfigure } from "@codat/platform/funcs/supplementalDataConfigure.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await supplementalDataConfigure(codatPlatform, {
- platformKey: "gbol",
- dataType: "invoices",
- supplementalDataConfiguration: {},
- });
- if (res.ok) {
- const { value: result } = res;
-
- } else {
- console.log("supplementalDataConfigure failed:", res.error);
- }
-}
-
-run();
-```
-### Example Usage: Xero - Tax rates
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- await codatPlatform.supplementalData.configure({
- platformKey: "gbol",
- dataType: "invoices",
- supplementalDataConfiguration: {},
- });
-
-
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { supplementalDataConfigure } from "@codat/platform/funcs/supplementalDataConfigure.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await supplementalDataConfigure(codatPlatform, {
- platformKey: "gbol",
- dataType: "invoices",
- supplementalDataConfiguration: {},
- });
- if (res.ok) {
- const { value: result } = res;
-
- } else {
- console.log("supplementalDataConfigure failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [operations.ConfigureSupplementalDataRequest](../../sdk/models/operations/configuresupplementaldatarequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ----------------------- | ----------------------- | ----------------------- |
-| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
-| errors.SDKError | 4XX, 5XX | \*/\* |
-
-## getConfiguration
-
-The *Get configuration* endpoint returns supplemental data configuration previously created for each integration and data type combination.
-
-[Supplemental data](https://docs.codat.io/using-the-api/supplemental-data/overview) is additional data you can include in Codat's standard data types.
-
-### Example Usage
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.supplementalData.getConfiguration({
- platformKey: "gbol",
- dataType: "invoices",
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { supplementalDataGetConfiguration } from "@codat/platform/funcs/supplementalDataGetConfiguration.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await supplementalDataGetConfiguration(codatPlatform, {
- platformKey: "gbol",
- dataType: "invoices",
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("supplementalDataGetConfiguration failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [operations.GetSupplementalDataConfigurationRequest](../../sdk/models/operations/getsupplementaldataconfigurationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\<[shared.SupplementalDataConfiguration](../../sdk/models/shared/supplementaldataconfiguration.md)\>**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ----------------------- | ----------------------- | ----------------------- |
-| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
+# SupplementalData
+
+## Overview
+
+Configure and pull additional data you can include in Codat's standard data types.
+
+### Available Operations
+
+* [configure](#configure) - Configure
+* [getConfiguration](#getconfiguration) - Get configuration
+
+## configure
+
+The *Configure* endpoint allows you to maintain or change configuration required to return supplemental data for each integration and data type combination.
+
+[Supplemental data](https://docs.codat.io/using-the-api/supplemental-data/overview) is additional data you can include in Codat's standard data types.
+
+**Integration-specific behavior**
+See the *examples* for integration-specific frequently requested properties.
+
+### Example Usage: QBO - Customers
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ await codatPlatform.supplementalData.configure({
+ platformKey: "gbol",
+ dataType: "invoices",
+ supplementalDataConfiguration: {},
+ });
+
+
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { supplementalDataConfigure } from "@codat/platform/funcs/supplementalDataConfigure.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await supplementalDataConfigure(codatPlatform, {
+ platformKey: "gbol",
+ dataType: "invoices",
+ supplementalDataConfiguration: {},
+ });
+ if (res.ok) {
+ const { value: result } = res;
+
+ } else {
+ console.log("supplementalDataConfigure failed:", res.error);
+ }
+}
+
+run();
+```
+### Example Usage: QBO - Invoices
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ await codatPlatform.supplementalData.configure({
+ platformKey: "gbol",
+ dataType: "invoices",
+ supplementalDataConfiguration: {},
+ });
+
+
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { supplementalDataConfigure } from "@codat/platform/funcs/supplementalDataConfigure.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await supplementalDataConfigure(codatPlatform, {
+ platformKey: "gbol",
+ dataType: "invoices",
+ supplementalDataConfiguration: {},
+ });
+ if (res.ok) {
+ const { value: result } = res;
+
+ } else {
+ console.log("supplementalDataConfigure failed:", res.error);
+ }
+}
+
+run();
+```
+### Example Usage: Unauthorized
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ await codatPlatform.supplementalData.configure({
+ platformKey: "gbol",
+ dataType: "invoices",
+ supplementalDataConfiguration: {
+ supplementalDataConfig: {
+ "orders-supplemental-data": {
+ dataSource: "/orders",
+ pullData: {
+ "orderNumber": "order_num",
+ },
+ pushData: {
+ "orderNumber": "order_num",
+ },
+ },
+ },
+ },
+ });
+
+
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { supplementalDataConfigure } from "@codat/platform/funcs/supplementalDataConfigure.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await supplementalDataConfigure(codatPlatform, {
+ platformKey: "gbol",
+ dataType: "invoices",
+ supplementalDataConfiguration: {
+ supplementalDataConfig: {
+ "orders-supplemental-data": {
+ dataSource: "/orders",
+ pullData: {
+ "orderNumber": "order_num",
+ },
+ pushData: {
+ "orderNumber": "order_num",
+ },
+ },
+ },
+ },
+ });
+ if (res.ok) {
+ const { value: result } = res;
+
+ } else {
+ console.log("supplementalDataConfigure failed:", res.error);
+ }
+}
+
+run();
+```
+### Example Usage: Xero - Accounts
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ await codatPlatform.supplementalData.configure({
+ platformKey: "gbol",
+ dataType: "invoices",
+ supplementalDataConfiguration: {},
+ });
+
+
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { supplementalDataConfigure } from "@codat/platform/funcs/supplementalDataConfigure.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await supplementalDataConfigure(codatPlatform, {
+ platformKey: "gbol",
+ dataType: "invoices",
+ supplementalDataConfiguration: {},
+ });
+ if (res.ok) {
+ const { value: result } = res;
+
+ } else {
+ console.log("supplementalDataConfigure failed:", res.error);
+ }
+}
+
+run();
+```
+### Example Usage: Xero - Contacts
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ await codatPlatform.supplementalData.configure({
+ platformKey: "gbol",
+ dataType: "invoices",
+ supplementalDataConfiguration: {},
+ });
+
+
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { supplementalDataConfigure } from "@codat/platform/funcs/supplementalDataConfigure.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await supplementalDataConfigure(codatPlatform, {
+ platformKey: "gbol",
+ dataType: "invoices",
+ supplementalDataConfiguration: {},
+ });
+ if (res.ok) {
+ const { value: result } = res;
+
+ } else {
+ console.log("supplementalDataConfigure failed:", res.error);
+ }
+}
+
+run();
+```
+### Example Usage: Xero - Invoices
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ await codatPlatform.supplementalData.configure({
+ platformKey: "gbol",
+ dataType: "invoices",
+ supplementalDataConfiguration: {},
+ });
+
+
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { supplementalDataConfigure } from "@codat/platform/funcs/supplementalDataConfigure.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await supplementalDataConfigure(codatPlatform, {
+ platformKey: "gbol",
+ dataType: "invoices",
+ supplementalDataConfiguration: {},
+ });
+ if (res.ok) {
+ const { value: result } = res;
+
+ } else {
+ console.log("supplementalDataConfigure failed:", res.error);
+ }
+}
+
+run();
+```
+### Example Usage: Xero - Items
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ await codatPlatform.supplementalData.configure({
+ platformKey: "gbol",
+ dataType: "invoices",
+ supplementalDataConfiguration: {},
+ });
+
+
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { supplementalDataConfigure } from "@codat/platform/funcs/supplementalDataConfigure.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await supplementalDataConfigure(codatPlatform, {
+ platformKey: "gbol",
+ dataType: "invoices",
+ supplementalDataConfiguration: {},
+ });
+ if (res.ok) {
+ const { value: result } = res;
+
+ } else {
+ console.log("supplementalDataConfigure failed:", res.error);
+ }
+}
+
+run();
+```
+### Example Usage: Xero - Tax rates
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ await codatPlatform.supplementalData.configure({
+ platformKey: "gbol",
+ dataType: "invoices",
+ supplementalDataConfiguration: {},
+ });
+
+
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { supplementalDataConfigure } from "@codat/platform/funcs/supplementalDataConfigure.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await supplementalDataConfigure(codatPlatform, {
+ platformKey: "gbol",
+ dataType: "invoices",
+ supplementalDataConfiguration: {},
+ });
+ if (res.ok) {
+ const { value: result } = res;
+
+ } else {
+ console.log("supplementalDataConfigure failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.ConfigureSupplementalDataRequest](../../sdk/models/operations/configuresupplementaldatarequest.md) | :heavy_check_mark: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
+| errors.SDKError | 4XX, 5XX | \*/\* |
+
+## getConfiguration
+
+The *Get configuration* endpoint returns supplemental data configuration previously created for each integration and data type combination.
+
+[Supplemental data](https://docs.codat.io/using-the-api/supplemental-data/overview) is additional data you can include in Codat's standard data types.
+
+### Example Usage
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.supplementalData.getConfiguration({
+ platformKey: "gbol",
+ dataType: "invoices",
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { supplementalDataGetConfiguration } from "@codat/platform/funcs/supplementalDataGetConfiguration.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await supplementalDataGetConfiguration(codatPlatform, {
+ platformKey: "gbol",
+ dataType: "invoices",
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("supplementalDataGetConfiguration failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.GetSupplementalDataConfigurationRequest](../../sdk/models/operations/getsupplementaldataconfigurationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\<[shared.SupplementalDataConfiguration](../../sdk/models/shared/supplementaldataconfiguration.md)\>**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |
\ No newline at end of file
diff --git a/platform/docs/sdks/webhooks/README.md b/platform/docs/sdks/webhooks/README.md
index a7d2a14f9..67d017dd2 100644
--- a/platform/docs/sdks/webhooks/README.md
+++ b/platform/docs/sdks/webhooks/README.md
@@ -1,305 +1,384 @@
-# Webhooks
-
-## Overview
-
-Create and manage webhooks that listen to Codat's events.
-
-### Available Operations
-
-* [listConsumers](#listconsumers) - List webhook consumers
-* [createConsumer](#createconsumer) - Create webhook consumer
-* [deleteConsumer](#deleteconsumer) - Delete webhook consumer
-
-## listConsumers
-
-Use the *List webhook consumers* endpoint to return a list of all webhook consumers that currently exist for your client.
-
-[Webhook consumer](https://docs.codat.io/platform-api#/schemas/WebhookConsumer) is an HTTP endpoint that you configure to subscribe to specific events. See our documentation for more details on [Codat's webhook service](https://docs.codat.io/using-the-api/webhooks/overview).
-
-### Example Usage
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.webhooks.listConsumers();
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { webhooksListConsumers } from "@codat/platform/funcs/webhooksListConsumers.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await webhooksListConsumers(codatPlatform);
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("webhooksListConsumers failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\<[shared.WebhookConsumers](../../sdk/models/shared/webhookconsumers.md)\>**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ----------------------- | ----------------------- | ----------------------- |
-| errors.ErrorMessage | 400, 401, 402, 403, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
-| errors.SDKError | 4XX, 5XX | \*/\* |
-
-## createConsumer
-
-Use the *Create webhook consumer* endpoint to create a new webhook consumer that will listen to messages we send you.
-
-[Webhook consumer](https://docs.codat.io/platform-api#/schemas/WebhookConsumer) is an HTTP endpoint that you configure to subscribe to specific events. See our documentation for more details on [Codat's webhook service](https://docs.codat.io/using-the-api/webhooks/overview).
-
-### Tips and traps
-- The number of webhook consumers you can create is limited to 50. If you have reached the maximum number of consumers, use the [*Delete webhook consumer*](https://docs.codat.io/platform-api#/operations/delete-webhook-consumer) endpoint to delete an unused consumer first.
-
-### Example Usage: Subscribe consumer to one or more event types
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.webhooks.createConsumer({
- url: "https://example.com/webhoook-consumer",
- eventTypes: [
- "DataSyncCompleted",
- "Dataset data changed",
- ],
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { webhooksCreateConsumer } from "@codat/platform/funcs/webhooksCreateConsumer.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await webhooksCreateConsumer(codatPlatform, {
- url: "https://example.com/webhoook-consumer",
- eventTypes: [
- "DataSyncCompleted",
- "Dataset data changed",
- ],
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("webhooksCreateConsumer failed:", res.error);
- }
-}
-
-run();
-```
-### Example Usage: Subscribe consumer with disabled endpoint
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const result = await codatPlatform.webhooks.createConsumer({
- url: "https://example.com/webhoook-consumer",
- disabled: true,
- eventTypes: [
- "DataSyncCompleted",
- ],
- });
-
- console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { webhooksCreateConsumer } from "@codat/platform/funcs/webhooksCreateConsumer.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await webhooksCreateConsumer(codatPlatform, {
- url: "https://example.com/webhoook-consumer",
- disabled: true,
- eventTypes: [
- "DataSyncCompleted",
- ],
- });
- if (res.ok) {
- const { value: result } = res;
- console.log(result);
- } else {
- console.log("webhooksCreateConsumer failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [shared.WebhookConsumerPrototype](../../sdk/models/shared/webhookconsumerprototype.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\<[shared.WebhookConsumer](../../sdk/models/shared/webhookconsumer.md)\>**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ----------------------- | ----------------------- | ----------------------- |
-| errors.ErrorMessage | 400, 401, 402, 403, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
-| errors.SDKError | 4XX, 5XX | \*/\* |
-
-## deleteConsumer
-
-Use the *Delete webhook consumer* endpoint to delete an existing webhoook consumer, providing its valid `id` as a parameter.
-
-[Webhook consumer](https://docs.codat.io/platform-api#/schemas/WebhookConsumer) is an HTTP endpoint that you configure to subscribe to specific events. See our documentation for more details on [Codat's webhook service](https://docs.codat.io/using-the-api/webhooks/overview).
-
-### Example Usage
-
-
-```typescript
-import { CodatPlatform } from "@codat/platform";
-
-const codatPlatform = new CodatPlatform({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- await codatPlatform.webhooks.deleteConsumer({
- webhookId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- });
-
-
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CodatPlatformCore } from "@codat/platform/core.js";
-import { webhooksDeleteConsumer } from "@codat/platform/funcs/webhooksDeleteConsumer.js";
-
-// Use `CodatPlatformCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const codatPlatform = new CodatPlatformCore({
- authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-});
-
-async function run() {
- const res = await webhooksDeleteConsumer(codatPlatform, {
- webhookId: "8a210b68-6988-11ed-a1eb-0242ac120002",
- });
- if (res.ok) {
- const { value: result } = res;
-
- } else {
- console.log("webhooksDeleteConsumer failed:", res.error);
- }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter | Type | Required | Description |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request` | [operations.DeleteWebhookConsumerRequest](../../sdk/models/operations/deletewebhookconsumerrequest.md) | :heavy_check_mark: | The request object to use for the request. |
-| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
-| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
-
-### Response
-
-**Promise\**
-
-### Errors
-
-| Error Type | Status Code | Content Type |
-| ----------------------- | ----------------------- | ----------------------- |
-| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
-| errors.ErrorMessage | 500, 503 | application/json |
-| errors.SDKError | 4XX, 5XX | \*/\* |
\ No newline at end of file
+# Webhooks
+
+## Overview
+
+Create and manage webhooks that listen to Codat's events.
+
+### Available Operations
+
+* [listConsumers](#listconsumers) - List webhook consumers
+* [createConsumer](#createconsumer) - Create webhook consumer
+* [deleteConsumer](#deleteconsumer) - Delete webhook consumer
+* [rotateZapierKey](#rotatezapierkey) - Rotate Zapier key
+
+## listConsumers
+
+Use the *List webhook consumers* endpoint to return a list of all webhook consumers that currently exist for your client.
+
+[Webhook consumer](https://docs.codat.io/platform-api#/schemas/WebhookConsumer) is an HTTP endpoint that you configure to subscribe to specific events. See our documentation for more details on [Codat's webhook service](https://docs.codat.io/using-the-api/webhooks/overview).
+
+### Example Usage
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.webhooks.listConsumers();
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { webhooksListConsumers } from "@codat/platform/funcs/webhooksListConsumers.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await webhooksListConsumers(codatPlatform);
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("webhooksListConsumers failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\<[shared.WebhookConsumers](../../sdk/models/shared/webhookconsumers.md)\>**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ErrorMessage | 400, 401, 402, 403, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
+| errors.SDKError | 4XX, 5XX | \*/\* |
+
+## createConsumer
+
+Use the *Create webhook consumer* endpoint to create a new webhook consumer that will listen to messages we send you.
+
+[Webhook consumer](https://docs.codat.io/platform-api#/schemas/WebhookConsumer) is an HTTP endpoint that you configure to subscribe to specific events. See our documentation for more details on [Codat's webhook service](https://docs.codat.io/using-the-api/webhooks/overview).
+
+### Tips and traps
+- The number of webhook consumers you can create is limited to 50. If you have reached the maximum number of consumers, use the [*Delete webhook consumer*](https://docs.codat.io/platform-api#/operations/delete-webhook-consumer) endpoint to delete an unused consumer first.
+
+### Example Usage: Subscribe consumer to one or more event types
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.webhooks.createConsumer({
+ url: "https://example.com/webhoook-consumer",
+ eventTypes: [
+ "DataSyncCompleted",
+ "Dataset data changed",
+ ],
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { webhooksCreateConsumer } from "@codat/platform/funcs/webhooksCreateConsumer.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await webhooksCreateConsumer(codatPlatform, {
+ url: "https://example.com/webhoook-consumer",
+ eventTypes: [
+ "DataSyncCompleted",
+ "Dataset data changed",
+ ],
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("webhooksCreateConsumer failed:", res.error);
+ }
+}
+
+run();
+```
+### Example Usage: Subscribe consumer with disabled endpoint
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.webhooks.createConsumer({
+ url: "https://example.com/webhoook-consumer",
+ disabled: true,
+ eventTypes: [
+ "DataSyncCompleted",
+ ],
+ });
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { webhooksCreateConsumer } from "@codat/platform/funcs/webhooksCreateConsumer.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await webhooksCreateConsumer(codatPlatform, {
+ url: "https://example.com/webhoook-consumer",
+ disabled: true,
+ eventTypes: [
+ "DataSyncCompleted",
+ ],
+ });
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("webhooksCreateConsumer failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [shared.WebhookConsumerPrototype](../../sdk/models/shared/webhookconsumerprototype.md) | :heavy_minus_sign: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\<[shared.WebhookConsumer](../../sdk/models/shared/webhookconsumer.md)\>**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ErrorMessage | 400, 401, 402, 403, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
+| errors.SDKError | 4XX, 5XX | \*/\* |
+
+## deleteConsumer
+
+Use the *Delete webhook consumer* endpoint to delete an existing webhoook consumer, providing its valid `id` as a parameter.
+
+[Webhook consumer](https://docs.codat.io/platform-api#/schemas/WebhookConsumer) is an HTTP endpoint that you configure to subscribe to specific events. See our documentation for more details on [Codat's webhook service](https://docs.codat.io/using-the-api/webhooks/overview).
+
+### Example Usage
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ await codatPlatform.webhooks.deleteConsumer({
+ webhookId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ });
+
+
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { webhooksDeleteConsumer } from "@codat/platform/funcs/webhooksDeleteConsumer.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await webhooksDeleteConsumer(codatPlatform, {
+ webhookId: "8a210b68-6988-11ed-a1eb-0242ac120002",
+ });
+ if (res.ok) {
+ const { value: result } = res;
+
+ } else {
+ console.log("webhooksDeleteConsumer failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request` | [operations.DeleteWebhookConsumerRequest](../../sdk/models/operations/deletewebhookconsumerrequest.md) | :heavy_check_mark: | The request object to use for the request. |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ----------------------- | ----------------------- | ----------------------- |
+| errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
+| errors.SDKError | 4XX, 5XX | \*/\* |
+
+## rotateZapierKey
+
+The *Rotate Zapier key* endpoint returns the Zapier integration key needed to configure Zaps triggered by Codat's webhooks.
+
+If a key has already been created, calling this will revoke that existing key.
+
+The key changes each time this endpoint is called. If you are already using our Zapier integration and called this endpoint again, you need to reauthenticate using the latest integration key returned in the response.
+
+Our Zapier integration makes it simple for you to set up and receive user notifications in your preferred ways, such as via email or Slack. See our [Zapier documentation](https://docs.codat.io/using-the-api/webhooks/zapier-integration) for detailed instructions on setting up this integration.
+
+
+
+### Example Usage
+
+
+```typescript
+import { CodatPlatform } from "@codat/platform";
+
+const codatPlatform = new CodatPlatform({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const result = await codatPlatform.webhooks.rotateZapierKey();
+
+ console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CodatPlatformCore } from "@codat/platform/core.js";
+import { webhooksRotateZapierKey } from "@codat/platform/funcs/webhooksRotateZapierKey.js";
+
+// Use `CodatPlatformCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const codatPlatform = new CodatPlatformCore({
+ authHeader: "Basic BASE_64_ENCODED(API_KEY)",
+});
+
+async function run() {
+ const res = await webhooksRotateZapierKey(codatPlatform);
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("webhooksRotateZapierKey failed:", res.error);
+ }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter | Type | Required | Description |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
+| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
+
+### Response
+
+**Promise\<[WebhookZapierKey](../../models/.md)\>**
+
+### Errors
+
+| Error Type | Status Code | Content Type |
+| ------------------- | ------------------- | ------------------- |
+| errors.ErrorMessage | 401, 402, 403, 429 | application/json |
+| errors.ErrorMessage | 500, 503 | application/json |
+| errors.SDKError | 4XX, 5XX | \*/\* |
\ No newline at end of file
diff --git a/platform/files.gen b/platform/files.gen
deleted file mode 100755
index 25df67e66..000000000
--- a/platform/files.gen
+++ /dev/null
@@ -1,350 +0,0 @@
-src/sdk/settings.ts
-src/sdk/companies.ts
-src/sdk/connections.ts
-src/sdk/customdatatype.ts
-src/sdk/pushdata.ts
-src/sdk/refreshdata.ts
-src/sdk/groups.ts
-src/sdk/integrations.ts
-src/sdk/supplementaldata.ts
-src/sdk/webhooks.ts
-src/sdk/sdk.ts
-.eslintrc.yml
-jest.config.js
-package-lock.json
-package.json
-src/index.ts
-src/internal/utils/contenttype.ts
-src/internal/utils/headers.ts
-src/internal/utils/index.ts
-src/internal/utils/pathparams.ts
-src/internal/utils/queryparams.ts
-src/internal/utils/requestbody.ts
-src/internal/utils/retries.ts
-src/internal/utils/security.ts
-src/internal/utils/utils.ts
-src/sdk/index.ts
-src/sdk/models/errors/sdkerror.ts
-src/sdk/types/index.ts
-src/sdk/types/rfcdate.ts
-tsconfig.json
-src/sdk/models/operations/createapikey.ts
-src/sdk/models/operations/deleteapikey.ts
-src/sdk/models/operations/getprofile.ts
-src/sdk/models/operations/getprofilesyncsettings.ts
-src/sdk/models/operations/listapikeys.ts
-src/sdk/models/operations/updateprofile.ts
-src/sdk/models/operations/updateprofilesyncsettings.ts
-src/sdk/models/operations/createcompany.ts
-src/sdk/models/operations/deletecompany.ts
-src/sdk/models/operations/getcompany.ts
-src/sdk/models/operations/listcompanies.ts
-src/sdk/models/operations/updatecompany.ts
-src/sdk/models/operations/createconnection.ts
-src/sdk/models/operations/deleteconnection.ts
-src/sdk/models/operations/getconnection.ts
-src/sdk/models/operations/listconnections.ts
-src/sdk/models/operations/unlinkconnection.ts
-src/sdk/models/operations/updateconnectionauthorization.ts
-src/sdk/models/operations/configurecustomdatatype.ts
-src/sdk/models/operations/getcustomdatatypeconfiguration.ts
-src/sdk/models/operations/listcustomdatatyperecords.ts
-src/sdk/models/operations/refreshcustomdatatype.ts
-src/sdk/models/operations/getcreateupdatemodeloptionsbydatatype.ts
-src/sdk/models/operations/getpushoperation.ts
-src/sdk/models/operations/getcompanypushhistory.ts
-src/sdk/models/operations/refreshcompanydata.ts
-src/sdk/models/operations/refreshdatatype.ts
-src/sdk/models/operations/getcompanydatastatus.ts
-src/sdk/models/operations/getpulloperation.ts
-src/sdk/models/operations/listpulloperations.ts
-src/sdk/models/operations/addcompanytogroup.ts
-src/sdk/models/operations/creategroup.ts
-src/sdk/models/operations/listgroups.ts
-src/sdk/models/operations/removecompanyfromgroup.ts
-src/sdk/models/operations/getintegration.ts
-src/sdk/models/operations/getintegrationsbranding.ts
-src/sdk/models/operations/listintegrations.ts
-src/sdk/models/operations/configuresupplementaldata.ts
-src/sdk/models/operations/getsupplementaldataconfiguration.ts
-src/sdk/models/operations/createrule.ts
-src/sdk/models/operations/getwebhook.ts
-src/sdk/models/operations/listrules.ts
-src/sdk/models/shared/errormessage.ts
-src/sdk/models/shared/apikeydetails.ts
-src/sdk/models/shared/createapikey.ts
-src/sdk/models/shared/profile.ts
-src/sdk/models/shared/syncsettings.ts
-src/sdk/models/shared/syncsetting.ts
-src/sdk/models/shared/datatype.ts
-src/sdk/models/shared/apikeys.ts
-src/sdk/models/shared/company.ts
-src/sdk/models/shared/groupref.ts
-src/sdk/models/shared/connection.ts
-src/sdk/models/shared/dataconnectionstatus.ts
-src/sdk/models/shared/sourcetype.ts
-src/sdk/models/shared/dataconnectionerror.ts
-src/sdk/models/shared/companyrequestbody.ts
-src/sdk/models/shared/companies.ts
-src/sdk/models/shared/links.ts
-src/sdk/models/shared/halref.ts
-src/sdk/models/shared/connections.ts
-src/sdk/models/shared/updateconnectionstatus.ts
-src/sdk/models/shared/customdatatypeconfiguration.ts
-src/sdk/models/shared/customdatatyperecords.ts
-src/sdk/models/shared/customdatatyperecord.ts
-src/sdk/models/shared/pulloperation.ts
-src/sdk/models/shared/pushoption.ts
-src/sdk/models/shared/pushvalidationinfo.ts
-src/sdk/models/shared/pushfieldvalidation.ts
-src/sdk/models/shared/pushoptiontype.ts
-src/sdk/models/shared/pushoptionproperty.ts
-src/sdk/models/shared/pushoptionchoice.ts
-src/sdk/models/shared/schemadatatype.ts
-src/sdk/models/shared/pushoperation.ts
-src/sdk/models/shared/validation.ts
-src/sdk/models/shared/validationitem.ts
-src/sdk/models/shared/pushoperationstatus.ts
-src/sdk/models/shared/pushoperationchange.ts
-src/sdk/models/shared/pushchangetype.ts
-src/sdk/models/shared/pushoperationref.ts
-src/sdk/models/shared/pushoperations.ts
-src/sdk/models/shared/datastatus.ts
-src/sdk/models/shared/pulloperations.ts
-src/sdk/models/shared/companygroupassignment.ts
-src/sdk/models/shared/group.ts
-src/sdk/models/shared/groupprototype.ts
-src/sdk/models/shared/groups.ts
-src/sdk/models/shared/integration.ts
-src/sdk/models/shared/datatypefeature.ts
-src/sdk/models/shared/supportedfeature.ts
-src/sdk/models/shared/featuretype.ts
-src/sdk/models/shared/featurestate.ts
-src/sdk/models/shared/branding.ts
-src/sdk/models/shared/brandinglogo.ts
-src/sdk/models/shared/brandingimage.ts
-src/sdk/models/shared/imagereference.ts
-src/sdk/models/shared/brandingbutton.ts
-src/sdk/models/shared/integrations.ts
-src/sdk/models/shared/supplementaldataconfiguration.ts
-src/sdk/models/shared/webhook.ts
-src/sdk/models/shared/webhooknotifier.ts
-src/sdk/models/shared/createrule.ts
-src/sdk/models/shared/webhooks.ts
-src/sdk/models/shared/security.ts
-src/sdk/models/shared/clientratelimitreachedwebhook.ts
-src/sdk/models/shared/clientratelimitreachedwebhookdata.ts
-src/sdk/models/shared/clientratelimitresetwebhook.ts
-src/sdk/models/shared/clientratelimitresetwebhookdata.ts
-src/sdk/models/shared/connectionstatuschangedwebhook.ts
-src/sdk/models/shared/connectionstatuschangedwebhookdata.ts
-src/sdk/models/shared/datasynccompletedwebhook.ts
-src/sdk/models/shared/datasynccompletedwebhookdata.ts
-src/sdk/models/shared/datasetdatachangedwebhook.ts
-src/sdk/models/shared/datasetstatuschangederrorwebhook.ts
-src/sdk/models/shared/datasetstatuschangederrorwebhookdata.ts
-src/sdk/models/shared/newcompanysynchronizedwebhook.ts
-src/sdk/models/shared/newcompanysynchronizedwebhookdata.ts
-src/sdk/models/shared/pushoperationtimedoutwebhook.ts
-src/sdk/models/shared/pushoperationtimedoutwebhookdata.ts
-src/sdk/models/shared/pushoperationstatuschangedwebhook.ts
-src/sdk/models/shared/pushoperationstatuschangedwebhookdata.ts
-src/sdk/models/webhooks/clientratelimitreached.ts
-src/sdk/models/webhooks/clientratelimitreset.ts
-src/sdk/models/webhooks/companydataconnectionstatuschanged.ts
-src/sdk/models/webhooks/datasynccompleted.ts
-src/sdk/models/webhooks/datasetdatachanged.ts
-src/sdk/models/webhooks/datasetstatushaschangedtoanerrorstate.ts
-src/sdk/models/webhooks/newcompanysynchronized.ts
-src/sdk/models/webhooks/pushoperationhastimedout.ts
-src/sdk/models/webhooks/pushoperationstatushaschanged.ts
-src/sdk/models/errors/index.ts
-src/sdk/models/operations/index.ts
-src/sdk/models/shared/index.ts
-src/sdk/models/webhooks/index.ts
-docs/sdk/models/operations/createapikeyresponse.md
-docs/sdk/models/operations/deleteapikeyrequest.md
-docs/sdk/models/operations/deleteapikeyresponse.md
-docs/sdk/models/operations/getprofileresponse.md
-docs/sdk/models/operations/getprofilesyncsettingsresponse.md
-docs/sdk/models/operations/listapikeysresponse.md
-docs/sdk/models/operations/updateprofileresponse.md
-docs/sdk/models/operations/updateprofilesyncsettingsrequestbody.md
-docs/sdk/models/operations/updateprofilesyncsettingsresponse.md
-docs/sdk/models/operations/createcompanyresponse.md
-docs/sdk/models/operations/deletecompanyrequest.md
-docs/sdk/models/operations/deletecompanyresponse.md
-docs/sdk/models/operations/getcompanyrequest.md
-docs/sdk/models/operations/getcompanyresponse.md
-docs/sdk/models/operations/listcompaniesrequest.md
-docs/sdk/models/operations/listcompaniesresponse.md
-docs/sdk/models/operations/updatecompanyrequest.md
-docs/sdk/models/operations/updatecompanyresponse.md
-docs/sdk/models/operations/createconnectionrequestbody.md
-docs/sdk/models/operations/createconnectionrequest.md
-docs/sdk/models/operations/createconnectionresponse.md
-docs/sdk/models/operations/deleteconnectionrequest.md
-docs/sdk/models/operations/deleteconnectionresponse.md
-docs/sdk/models/operations/getconnectionrequest.md
-docs/sdk/models/operations/getconnectionresponse.md
-docs/sdk/models/operations/listconnectionsrequest.md
-docs/sdk/models/operations/listconnectionsresponse.md
-docs/sdk/models/operations/unlinkconnectionrequest.md
-docs/sdk/models/operations/unlinkconnectionresponse.md
-docs/sdk/models/operations/updateconnectionauthorizationrequest.md
-docs/sdk/models/operations/updateconnectionauthorizationresponse.md
-docs/sdk/models/operations/configurecustomdatatyperequest.md
-docs/sdk/models/operations/configurecustomdatatyperesponse.md
-docs/sdk/models/operations/getcustomdatatypeconfigurationrequest.md
-docs/sdk/models/operations/getcustomdatatypeconfigurationresponse.md
-docs/sdk/models/operations/listcustomdatatyperecordsrequest.md
-docs/sdk/models/operations/listcustomdatatyperecordsresponse.md
-docs/sdk/models/operations/refreshcustomdatatyperequest.md
-docs/sdk/models/operations/refreshcustomdatatyperesponse.md
-docs/sdk/models/operations/getcreateupdatemodeloptionsbydatatyperequest.md
-docs/sdk/models/operations/getcreateupdatemodeloptionsbydatatyperesponse.md
-docs/sdk/models/operations/getpushoperationrequest.md
-docs/sdk/models/operations/getpushoperationresponse.md
-docs/sdk/models/operations/getcompanypushhistoryrequest.md
-docs/sdk/models/operations/getcompanypushhistoryresponse.md
-docs/sdk/models/operations/refreshcompanydatarequest.md
-docs/sdk/models/operations/refreshcompanydataresponse.md
-docs/sdk/models/operations/refreshdatatyperequest.md
-docs/sdk/models/operations/refreshdatatyperesponse.md
-docs/sdk/models/operations/getcompanydatastatusrequest.md
-docs/sdk/models/operations/getcompanydatastatusresponse.md
-docs/sdk/models/operations/getpulloperationrequest.md
-docs/sdk/models/operations/getpulloperationresponse.md
-docs/sdk/models/operations/listpulloperationsrequest.md
-docs/sdk/models/operations/listpulloperationsresponse.md
-docs/sdk/models/operations/addcompanytogrouprequest.md
-docs/sdk/models/operations/addcompanytogroupresponse.md
-docs/sdk/models/operations/creategroupresponse.md
-docs/sdk/models/operations/listgroupsresponse.md
-docs/sdk/models/operations/removecompanyfromgrouprequest.md
-docs/sdk/models/operations/removecompanyfromgroupresponse.md
-docs/sdk/models/operations/getintegrationrequest.md
-docs/sdk/models/operations/getintegrationresponse.md
-docs/sdk/models/operations/getintegrationsbrandingrequest.md
-docs/sdk/models/operations/getintegrationsbrandingresponse.md
-docs/sdk/models/operations/listintegrationsrequest.md
-docs/sdk/models/operations/listintegrationsresponse.md
-docs/sdk/models/operations/datatype.md
-docs/sdk/models/operations/configuresupplementaldatarequest.md
-docs/sdk/models/operations/configuresupplementaldataresponse.md
-docs/sdk/models/operations/pathparamdatatype.md
-docs/sdk/models/operations/getsupplementaldataconfigurationrequest.md
-docs/sdk/models/operations/getsupplementaldataconfigurationresponse.md
-docs/sdk/models/operations/createruleresponse.md
-docs/sdk/models/operations/getwebhookrequest.md
-docs/sdk/models/operations/getwebhookresponse.md
-docs/sdk/models/operations/listrulesrequest.md
-docs/sdk/models/operations/listrulesresponse.md
-docs/sdk/models/shared/errormessage.md
-docs/sdk/models/shared/apikeydetails.md
-docs/sdk/models/shared/createapikey.md
-docs/sdk/models/shared/profile.md
-docs/sdk/models/shared/syncsettings.md
-docs/sdk/models/shared/syncsetting.md
-docs/sdk/models/shared/datatype.md
-docs/sdk/models/shared/apikeys.md
-docs/sdk/models/shared/company.md
-docs/sdk/models/shared/groupref.md
-docs/sdk/models/shared/connection.md
-docs/sdk/models/shared/dataconnectionstatus.md
-docs/sdk/models/shared/sourcetype.md
-docs/sdk/models/shared/dataconnectionerror.md
-docs/sdk/models/shared/companyrequestbody.md
-docs/sdk/models/shared/companies.md
-docs/sdk/models/shared/links.md
-docs/sdk/models/shared/halref.md
-docs/sdk/models/shared/connections.md
-docs/sdk/models/shared/updateconnectionstatus.md
-docs/sdk/models/shared/customdatatypeconfiguration.md
-docs/sdk/models/shared/customdatatyperecords.md
-docs/sdk/models/shared/content.md
-docs/sdk/models/shared/modifieddate.md
-docs/sdk/models/shared/customdatatyperecord.md
-docs/sdk/models/shared/status.md
-docs/sdk/models/shared/pulloperation.md
-docs/sdk/models/shared/pushoption.md
-docs/sdk/models/shared/pushvalidationinfo.md
-docs/sdk/models/shared/pushfieldvalidation.md
-docs/sdk/models/shared/pushoptiontype.md
-docs/sdk/models/shared/pushoptionproperty.md
-docs/sdk/models/shared/pushoptionchoice.md
-docs/sdk/models/shared/schemadatatype.md
-docs/sdk/models/shared/pushoperation.md
-docs/sdk/models/shared/validation.md
-docs/sdk/models/shared/validationitem.md
-docs/sdk/models/shared/pushoperationstatus.md
-docs/sdk/models/shared/pushoperationchange.md
-docs/sdk/models/shared/pushchangetype.md
-docs/sdk/models/shared/pushoperationref.md
-docs/sdk/models/shared/pushoperations.md
-docs/sdk/models/shared/datatypes.md
-docs/sdk/models/shared/datastatus.md
-docs/sdk/models/shared/pulloperations.md
-docs/sdk/models/shared/companygroupassignment.md
-docs/sdk/models/shared/group.md
-docs/sdk/models/shared/groupprototype.md
-docs/sdk/models/shared/groups.md
-docs/sdk/models/shared/integration.md
-docs/sdk/models/shared/datatypefeature.md
-docs/sdk/models/shared/supportedfeature.md
-docs/sdk/models/shared/featuretype.md
-docs/sdk/models/shared/featurestate.md
-docs/sdk/models/shared/branding.md
-docs/sdk/models/shared/brandinglogo.md
-docs/sdk/models/shared/brandingimage.md
-docs/sdk/models/shared/imagereference.md
-docs/sdk/models/shared/brandingbutton.md
-docs/sdk/models/shared/integrations.md
-docs/sdk/models/shared/supplementaldatasourceconfiguration.md
-docs/sdk/models/shared/supplementaldataconfiguration.md
-docs/sdk/models/shared/webhook.md
-docs/sdk/models/shared/webhooknotifier.md
-docs/sdk/models/shared/createrule.md
-docs/sdk/models/shared/webhooks.md
-docs/sdk/models/shared/security.md
-docs/sdk/models/shared/clientratelimitreachedwebhook.md
-docs/sdk/models/shared/clientratelimitreachedwebhookdata.md
-docs/sdk/models/shared/clientratelimitresetwebhook.md
-docs/sdk/models/shared/clientratelimitresetwebhookdata.md
-docs/sdk/models/shared/connectionstatuschangedwebhook.md
-docs/sdk/models/shared/connectionstatuschangedwebhookdata.md
-docs/sdk/models/shared/datasynccompletedwebhook.md
-docs/sdk/models/shared/datasynccompletedwebhookdata.md
-docs/sdk/models/shared/datasetdatachangedwebhookdata.md
-docs/sdk/models/shared/datasetdatachangedwebhook.md
-docs/sdk/models/shared/datasetstatuschangederrorwebhook.md
-docs/sdk/models/shared/datasetstatuschangederrorwebhookdata.md
-docs/sdk/models/shared/newcompanysynchronizedwebhook.md
-docs/sdk/models/shared/newcompanysynchronizedwebhookdata.md
-docs/sdk/models/shared/pushoperationtimedoutwebhook.md
-docs/sdk/models/shared/pushoperationtimedoutwebhookdata.md
-docs/sdk/models/shared/pushoperationstatuschangedwebhook.md
-docs/sdk/models/shared/pushoperationstatuschangedwebhookdata.md
-docs/sdk/models/webhooks/clientratelimitreachedresponse.md
-docs/sdk/models/webhooks/clientratelimitresetresponse.md
-docs/sdk/models/webhooks/companydataconnectionstatuschangedresponse.md
-docs/sdk/models/webhooks/datasynccompletedresponse.md
-docs/sdk/models/webhooks/datasetdatachangedresponse.md
-docs/sdk/models/webhooks/datasetstatushaschangedtoanerrorstateresponse.md
-docs/sdk/models/webhooks/newcompanysynchronizedresponse.md
-docs/sdk/models/webhooks/pushoperationhastimedoutresponse.md
-docs/sdk/models/webhooks/pushoperationstatushaschangedresponse.md
-docs/sdks/codatplatform/README.md
-docs/internal/utils/retryconfig.md
-docs/sdks/settings/README.md
-docs/sdks/companies/README.md
-docs/sdks/connections/README.md
-docs/sdks/customdatatype/README.md
-docs/sdks/pushdata/README.md
-docs/sdks/refreshdata/README.md
-docs/sdks/groups/README.md
-docs/sdks/integrations/README.md
-docs/sdks/supplementaldata/README.md
-docs/sdks/webhooks/README.md
-USAGE.md
-.gitattributes
\ No newline at end of file
diff --git a/platform/jsr.json b/platform/jsr.json
deleted file mode 100644
index a06825c1d..000000000
--- a/platform/jsr.json
+++ /dev/null
@@ -1,27 +0,0 @@
-
-
-{
- "name": "@codat/platform",
- "version": "6.2.1",
- "exports": {
- ".": "./src/index.ts",
- "./sdk/models/errors": "./src/sdk/models/errors/index.ts",
- "./sdk/models/shared": "./src/sdk/models/shared/index.ts",
- "./sdk/models/operations": "./src/sdk/models/operations/index.ts",
- "./lib/config": "./src/lib/config.ts",
- "./lib/http": "./src/lib/http.ts",
- "./lib/retries": "./src/lib/retries.ts",
- "./lib/sdks": "./src/lib/sdks.ts",
- "./types": "./src/sdk/types/index.ts"
- },
- "publish": {
- "include": [
- "LICENSE",
- "README.md",
- "RUNTIMES.md",
- "USAGE.md",
- "jsr.json",
- "src/**/*.ts"
- ]
- }
-}
diff --git a/platform/package.json b/platform/package.json
index 57d35bf9d..0c8f4e750 100644
--- a/platform/package.json
+++ b/platform/package.json
@@ -1,30 +1,56 @@
{
"name": "@codat/platform",
- "version": "6.2.1",
+ "version": "6.2.2",
"author": "Codat",
- "main": "./index.js",
- "sideEffects": false,
"repository": {
"type": "git",
"url": "https://github.com/codatio/client-sdk-typescript.git",
"directory": "platform"
},
+ "main": "./dist/index.js",
+ "typings": "./dist/index.d.ts",
+ "module": "./dist/esm/index.js",
+ "sideEffects": false,
"scripts": {
- "lint": "eslint --cache --max-warnings=0 src",
- "build": "tsc",
- "prepublishOnly": "npm run build"
- },
- "peerDependencies": {
-
+ "build": "tsc && tsc -p tsconfig.esm.json",
+ "prepare": "npm run build"
},
"devDependencies": {
- "@eslint/js": "^9.26.0",
- "eslint": "^9.26.0",
- "globals": "^15.14.0",
- "typescript": "~5.8.3",
- "typescript-eslint": "^8.26.0"
+ "typescript": "^4.0 || ^5.0"
},
- "dependencies": {
- "zod": "^3.25.0 || ^4.0.0"
+ "exports": {
+ ".": {
+ "types": "./dist/index.d.ts",
+ "default": "./dist/index.js"
+ },
+ "./sdk/models/shared": {
+ "types": "./dist/sdk/models/shared/index.d.ts",
+ "default": "./dist/sdk/models/shared/index.js"
+ },
+ "./sdk/models/operations": {
+ "types": "./dist/sdk/models/operations/index.d.ts",
+ "default": "./dist/sdk/models/operations/index.js"
+ },
+ "./sdk/models/errors": {
+ "types": "./dist/sdk/models/errors/index.d.ts",
+ "default": "./dist/sdk/models/errors/index.js"
+ },
+ "./sdk/types": {
+ "types": "./dist/sdk/types/index.d.ts",
+ "default": "./dist/sdk/types/index.js"
+ },
+ "./core.js": {
+ "types": "./dist/core.d.ts",
+ "default": "./dist/core.js"
+ },
+ "./lib/http": {
+ "types": "./dist/lib/sdkconfig.d.ts",
+ "default": "./dist/lib/sdkconfig.js"
+ },
+ "./funcs/*.js": {
+ "types": "./dist/funcs/*.d.ts",
+ "default": "./dist/funcs/*.js"
+ },
+ "./package.json": "./package.json"
}
}
diff --git a/platform/src/apis/Companies.ts b/platform/src/apis/Companies.ts
new file mode 100644
index 000000000..02522082f
--- /dev/null
+++ b/platform/src/apis/Companies.ts
@@ -0,0 +1,649 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Platform API
+ * An API for the common components of all of Codat\'s products. These end points cover creating and managing your companies, data connections, and integrations. [Read about the building blocks of Codat...](https://docs.codat.io/core-concepts/companies) | [See our OpenAPI spec](https://github.com/codatio/oas) --- ## Endpoints | Endpoints | Description | | :- |:- | | Companies | Create and manage your SMB users\' companies. | | Connections | Create new and manage existing data connections for a company. | | Connection management | Configure connection management UI and retrieve access tokens for authentication. | | Webhooks | Create and manage webhooks that listen to Codat\'s events. | | Integrations | Get a list of integrations supported by Codat and their logos. | | Refresh data | Initiate data refreshes, view pull status and history. | | Settings | Manage company profile configuration, sync settings, and API keys. | | Push data | Initiate and monitor Create, Update, and Delete operations. | | Supplemental data | Configure and pull additional data you can include in Codat\'s standard data types. | | Custom data type | Configure and pull additional data types that are not included in Codat\'s standardized data model. |
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@codat.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import type { CompanyAccessToken } from '../sdk/models/index';
+import * as runtime from '../runtime';
+import type * as shared from '../sdk/models/index';
+import type {
+ AccessToken,
+ Company,
+ CompanyRequestBody,
+ CompanySyncSettings,
+ CompanyUpdateRequest,
+ ErrorMessage,
+ RefreshProductDataRequestBody,
+ SetCompanySyncSettingsRequestBody,
+} from '../sdk/models/index';
+import {
+ AccessTokenFromJSON,
+ AccessTokenToJSON,
+ CompaniesFromJSON,
+ CompaniesToJSON,
+ CompanyFromJSON,
+ CompanyToJSON,
+ CompanyRequestBodyFromJSON,
+ CompanyRequestBodyToJSON,
+ CompanySyncSettingsFromJSON,
+ CompanySyncSettingsToJSON,
+ CompanyUpdateRequestFromJSON,
+ CompanyUpdateRequestToJSON,
+ ErrorMessageFromJSON,
+ ErrorMessageToJSON,
+ RefreshProductDataRequestBodyFromJSON,
+ RefreshProductDataRequestBodyToJSON,
+ SetCompanySyncSettingsRequestBodyFromJSON,
+ SetCompanySyncSettingsRequestBodyToJSON,
+} from '../sdk/models/index';
+
+export interface AddProductRequest {
+ companyId: string;
+ productIdentifier: string;
+}
+
+export interface CreateCompanyRequest {
+ companyRequestBody?: CompanyRequestBody;
+}
+
+export interface DeleteCompanyRequest {
+ companyId: string;
+}
+
+export interface GetCompanyRequest {
+ companyId: string;
+}
+
+export interface GetCompanyAccessTokenRequest {
+ companyId: string;
+}
+
+export interface GetCompanySyncSettingsRequest {
+ companyId: string;
+}
+
+export interface ListCompaniesRequest {
+ page?: number;
+ pageSize?: number;
+ query?: string;
+ orderBy?: string;
+ tags?: string;
+}
+
+export interface RefreshProductDataRequest {
+ companyId: string;
+ productIdentifier: string;
+ requestBody?: RefreshProductDataRequestBody;
+}
+
+export interface RemoveProductRequest {
+ companyId: string;
+ productIdentifier: string;
+}
+
+export interface ReplaceCompanyRequest {
+ companyId: string;
+ companyRequestBody?: CompanyRequestBody;
+}
+
+export interface SetCompanySyncSettingsRequest {
+ companyId: string;
+ requestBody?: SetCompanySyncSettingsRequestBody;
+}
+
+export interface UpdateCompanyRequest {
+ companyId: string;
+ companyUpdateRequest?: CompanyUpdateRequest;
+}
+
+/**
+ *
+ */
+export class Companies extends runtime.BaseAPI {
+
+ /**
+ * Use the *Add product* endpoint to enable a product for the company specified by `companyId`. > Note: This feature is currently in alpha and available only to participants in the development program.
+ * Add product
+ */
+ private async addProductRaw(requestParameters: AddProductRequest, options?: runtime.RequestOptions): Promise> {
+ if (requestParameters['companyId'] == null) {
+ throw new runtime.RequiredError(
+ 'companyId',
+ 'Required parameter "companyId" was null or undefined when calling addProduct().'
+ );
+ }
+
+ if (requestParameters['productIdentifier'] == null) {
+ throw new runtime.RequiredError(
+ 'productIdentifier',
+ 'Required parameter "productIdentifier" was null or undefined when calling addProduct().'
+ );
+ }
+
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/companies/{companyId}/products/{productIdentifier}`.replace(`{${"companyId"}}`, encodeURIComponent(String(requestParameters['companyId']))).replace(`{${"productIdentifier"}}`, encodeURIComponent(String(requestParameters['productIdentifier']))),
+ method: 'PUT',
+ operationId: 'add-product',
+ errorStatuses: [401, 402, 403, 404, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ }, options);
+
+ return new runtime.VoidApiResponse(response);
+ }
+
+ /**
+ * Use the *Add product* endpoint to enable a product for the company specified by `companyId`. > Note: This feature is currently in alpha and available only to participants in the development program.
+ * Add product
+ */
+ async addProduct(requestParameters: AddProductRequest, options?: runtime.RequestOptions): Promise {
+ await this.addProductRaw(requestParameters, options);
+ }
+
+ /**
+ * Use the *Create company* endpoint to create a new [company](https://docs.codat.io/platform-api#/schemas/Company) that represents your customer in Codat. A [company](https://docs.codat.io/platform-api#/schemas/Company) represents a business sharing access to their data. Each company can have multiple [connections](https://docs.codat.io/platform-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data. If forbidden characters (see `name` pattern) are present in the request, a company will be created with the forbidden characters removed. For example, `Company (Codat[1])` with be created as `Company Codat1`.
+ * Create company
+ */
+ private async createCompanyRaw(requestParameters: CreateCompanyRequest, options?: runtime.RequestOptions): Promise> {
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ headerParameters['Content-Type'] = 'application/json';
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/companies`,
+ method: 'POST',
+ operationId: 'create-company',
+ errorStatuses: [400, 401, 402, 403, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ body: CompanyRequestBodyToJSON(requestParameters['companyRequestBody']),
+ }, options);
+
+ return new runtime.JSONApiResponse(response, (jsonValue) => CompanyFromJSON(jsonValue));
+ }
+
+ /**
+ * Use the *Create company* endpoint to create a new [company](https://docs.codat.io/platform-api#/schemas/Company) that represents your customer in Codat. A [company](https://docs.codat.io/platform-api#/schemas/Company) represents a business sharing access to their data. Each company can have multiple [connections](https://docs.codat.io/platform-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data. If forbidden characters (see `name` pattern) are present in the request, a company will be created with the forbidden characters removed. For example, `Company (Codat[1])` with be created as `Company Codat1`.
+ * Create company
+ */
+ async create(companyRequestBody?: CompanyRequestBody, options?: runtime.RequestOptions): Promise {
+ const response = await this.createCompanyRaw({ companyRequestBody: companyRequestBody }, options);
+ return await response.value();
+ }
+
+ /**
+ * The *Delete company* endpoint permanently deletes a [company](https://docs.codat.io/platform-api#/schemas/Company), its [connections](https://docs.codat.io/platform-api#/schemas/Connection) and any cached data. This operation is irreversible. A [company](https://docs.codat.io/platform-api#/schemas/Company) represents a business sharing access to their data. Each company can have multiple [connections](https://docs.codat.io/platform-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.
+ * Delete a company
+ */
+ private async deleteCompanyRaw(requestParameters: DeleteCompanyRequest, options?: runtime.RequestOptions): Promise> {
+ if (requestParameters['companyId'] == null) {
+ throw new runtime.RequiredError(
+ 'companyId',
+ 'Required parameter "companyId" was null or undefined when calling deleteCompany().'
+ );
+ }
+
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/companies/{companyId}`.replace(`{${"companyId"}}`, encodeURIComponent(String(requestParameters['companyId']))),
+ method: 'DELETE',
+ operationId: 'delete-company',
+ errorStatuses: [401, 402, 403, 404, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ }, options);
+
+ return new runtime.VoidApiResponse(response);
+ }
+
+ /**
+ * The *Delete company* endpoint permanently deletes a [company](https://docs.codat.io/platform-api#/schemas/Company), its [connections](https://docs.codat.io/platform-api#/schemas/Connection) and any cached data. This operation is irreversible. A [company](https://docs.codat.io/platform-api#/schemas/Company) represents a business sharing access to their data. Each company can have multiple [connections](https://docs.codat.io/platform-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.
+ * Delete a company
+ */
+ async delete(requestParameters: DeleteCompanyRequest, options?: runtime.RequestOptions): Promise {
+ await this.deleteCompanyRaw(requestParameters, options);
+ }
+
+ /**
+ * The *Get company* endpoint returns a single company for a given `companyId`. A [company](https://docs.codat.io/platform-api#/schemas/Company) represents a business sharing access to their data. Each company can have multiple [connections](https://docs.codat.io/platform-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.
+ * Get company
+ */
+ private async getCompanyRaw(requestParameters: GetCompanyRequest, options?: runtime.RequestOptions): Promise> {
+ if (requestParameters['companyId'] == null) {
+ throw new runtime.RequiredError(
+ 'companyId',
+ 'Required parameter "companyId" was null or undefined when calling getCompany().'
+ );
+ }
+
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/companies/{companyId}`.replace(`{${"companyId"}}`, encodeURIComponent(String(requestParameters['companyId']))),
+ method: 'GET',
+ operationId: 'get-company',
+ errorStatuses: [401, 402, 403, 404, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ }, options);
+
+ return new runtime.JSONApiResponse(response, (jsonValue) => CompanyFromJSON(jsonValue));
+ }
+
+ /**
+ * The *Get company* endpoint returns a single company for a given `companyId`. A [company](https://docs.codat.io/platform-api#/schemas/Company) represents a business sharing access to their data. Each company can have multiple [connections](https://docs.codat.io/platform-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.
+ * Get company
+ */
+ async get(requestParameters: GetCompanyRequest, options?: runtime.RequestOptions): Promise {
+ const response = await this.getCompanyRaw(requestParameters, options);
+ return await response.value();
+ }
+
+ /**
+ * Use the _Get company access token_ endpoint to return an access token for the specified company ID. The token is valid for one day. The token is required by Codat\'s embeddable UIs (such as [Connections SDK](https://docs.codat.io/auth-flow/optimize/connection-management) and [Link SDK](https://docs.codat.io/auth-flow/authorize-embedded-link)) to verify the identity of the user and improve the reliability of data provided by them.
+ * Get company access token
+ */
+ private async getCompanyAccessTokenRaw(requestParameters: GetCompanyAccessTokenRequest, options?: runtime.RequestOptions): Promise> {
+ if (requestParameters['companyId'] == null) {
+ throw new runtime.RequiredError(
+ 'companyId',
+ 'Required parameter "companyId" was null or undefined when calling getCompanyAccessToken().'
+ );
+ }
+
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/companies/{companyId}/accessToken`.replace(`{${"companyId"}}`, encodeURIComponent(String(requestParameters['companyId']))),
+ method: 'GET',
+ operationId: 'get-company-access-token',
+ errorStatuses: [401, 402, 403, 404, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ }, options);
+
+ return new runtime.JSONApiResponse(response, (jsonValue) => AccessTokenFromJSON(jsonValue));
+ }
+
+ /**
+ * Use the _Get company access token_ endpoint to return an access token for the specified company ID. The token is valid for one day. The token is required by Codat\'s embeddable UIs (such as [Connections SDK](https://docs.codat.io/auth-flow/optimize/connection-management) and [Link SDK](https://docs.codat.io/auth-flow/authorize-embedded-link)) to verify the identity of the user and improve the reliability of data provided by them.
+ * Get company access token
+ */
+ async getAccessToken(requestParameters: GetCompanyAccessTokenRequest, options?: runtime.RequestOptions): Promise {
+ const response = await this.getCompanyAccessTokenRaw(requestParameters, options);
+ return await response.value();
+ }
+
+ /**
+ * Retrieve the [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings) for a specific company. This includes how often data types should be queued to be updated, and how much history should be fetched.
+ * Get company sync settings
+ */
+ private async getCompanySyncSettingsRaw(requestParameters: GetCompanySyncSettingsRequest, options?: runtime.RequestOptions): Promise> {
+ if (requestParameters['companyId'] == null) {
+ throw new runtime.RequiredError(
+ 'companyId',
+ 'Required parameter "companyId" was null or undefined when calling getCompanySyncSettings().'
+ );
+ }
+
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/companies/{companyId}/syncSettings`.replace(`{${"companyId"}}`, encodeURIComponent(String(requestParameters['companyId']))),
+ method: 'GET',
+ operationId: 'get-company-syncSettings',
+ errorStatuses: [401, 402, 403, 404, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ }, options);
+
+ return new runtime.JSONApiResponse(response, (jsonValue) => CompanySyncSettingsFromJSON(jsonValue));
+ }
+
+ /**
+ * Retrieve the [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings) for a specific company. This includes how often data types should be queued to be updated, and how much history should be fetched.
+ * Get company sync settings
+ */
+ async getCompanySyncSettings(requestParameters: GetCompanySyncSettingsRequest, options?: runtime.RequestOptions): Promise {
+ const response = await this.getCompanySyncSettingsRaw(requestParameters, options);
+ return await response.value();
+ }
+
+ /**
+ * The *List companies* endpoint returns a list of [companies](https://docs.codat.io/platform-api#/schemas/Company) associated to your instances. A [company](https://docs.codat.io/platform-api#/schemas/Company) represents a business sharing access to their data. Each company can have multiple [connections](https://docs.codat.io/platform-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data. ## Filter by tags The *List companies* endpoint supports the filtering of companies using [tags](https://docs.codat.io/using-the-api/managing-companies#add-metadata-to-a-company). It supports the following operators with [Codat’s query language](https://docs.codat.io/using-the-api/querying): - equals (`=`) - not equals (`!=`) - contains (`~`) For example, you can use the querying to filter companies tagged with a specific foreign key, region, or owning team: - Foreign key: `uid = {yourCustomerId}` - Region: `region != uk` - Owning team and region: `region = uk && owningTeam = invoice-finance`
+ * List companies
+ */
+ private async listCompaniesRaw(requestParameters: ListCompaniesRequest, options?: runtime.RequestOptions): Promise> {
+ const queryParameters: any = {};
+
+ if (requestParameters['page'] != null) {
+ queryParameters['page'] = requestParameters['page'];
+ }
+ else {
+ queryParameters['page'] = 1;
+ }
+
+ if (requestParameters['pageSize'] != null) {
+ queryParameters['pageSize'] = requestParameters['pageSize'];
+ }
+ else {
+ queryParameters['pageSize'] = 100;
+ }
+
+ if (requestParameters['query'] != null) {
+ queryParameters['query'] = requestParameters['query'];
+ }
+
+ if (requestParameters['orderBy'] != null) {
+ queryParameters['orderBy'] = requestParameters['orderBy'];
+ }
+
+ if (requestParameters['tags'] != null) {
+ queryParameters['tags'] = requestParameters['tags'];
+ }
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/companies`,
+ method: 'GET',
+ operationId: 'list-companies',
+ errorStatuses: [400, 401, 402, 403, 404, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ }, options);
+
+ return new runtime.JSONApiResponse(response, (jsonValue) => CompaniesFromJSON(jsonValue));
+ }
+
+ /**
+ * The *List companies* endpoint returns a list of [companies](https://docs.codat.io/platform-api#/schemas/Company) associated to your instances. A [company](https://docs.codat.io/platform-api#/schemas/Company) represents a business sharing access to their data. Each company can have multiple [connections](https://docs.codat.io/platform-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data. ## Filter by tags The *List companies* endpoint supports the filtering of companies using [tags](https://docs.codat.io/using-the-api/managing-companies#add-metadata-to-a-company). It supports the following operators with [Codat’s query language](https://docs.codat.io/using-the-api/querying): - equals (`=`) - not equals (`!=`) - contains (`~`) For example, you can use the querying to filter companies tagged with a specific foreign key, region, or owning team: - Foreign key: `uid = {yourCustomerId}` - Region: `region != uk` - Owning team and region: `region = uk && owningTeam = invoice-finance`
+ * List companies
+ */
+ async list(requestParameters: ListCompaniesRequest = {}, options?: runtime.RequestOptions): Promise {
+ const response = await this.listCompaniesRaw(requestParameters, options);
+ return await response.value();
+ }
+
+ /**
+ * Use the **Refresh product data** endpoint to manually refresh data for a custom product for a specific company. ### Tips and traps - This endpoint only supports refreshing data for **custom products** and can\'t be used for Codat\'s standard solutions. Refer to [individual solutions\' documentation](https://docs.codat.io/) instead. - If a data sync is already in progress for a custom product, the refresh request will return a `Bad request (400)` response. - If a company has multiple custom products enabled, you can refresh data for each product individually. - Optionally include a request body with `dataTypes` to refresh only selected data types for the specified product. If omitted, the product\'s scheduled refresh is triggered as usual. - When specifying `dataTypes`, each value must be a valid data type supported by the product. Invalid values will result in a `Bad request (400)` response listing valid options.
+ * Refresh product data
+ */
+ private async refreshProductDataRaw(requestParameters: RefreshProductDataRequest, options?: runtime.RequestOptions): Promise> {
+ if (requestParameters['companyId'] == null) {
+ throw new runtime.RequiredError(
+ 'companyId',
+ 'Required parameter "companyId" was null or undefined when calling refreshProductData().'
+ );
+ }
+
+ if (requestParameters['productIdentifier'] == null) {
+ throw new runtime.RequiredError(
+ 'productIdentifier',
+ 'Required parameter "productIdentifier" was null or undefined when calling refreshProductData().'
+ );
+ }
+
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ headerParameters['Content-Type'] = 'application/json';
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/companies/{companyId}/products/{productIdentifier}/refresh`.replace(`{${"companyId"}}`, encodeURIComponent(String(requestParameters['companyId']))).replace(`{${"productIdentifier"}}`, encodeURIComponent(String(requestParameters['productIdentifier']))),
+ method: 'POST',
+ operationId: 'refresh-product-data',
+ errorStatuses: [400, 401, 402, 403, 404, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ body: RefreshProductDataRequestBodyToJSON(requestParameters['requestBody']),
+ }, options);
+
+ return new runtime.VoidApiResponse(response);
+ }
+
+ /**
+ * Use the **Refresh product data** endpoint to manually refresh data for a custom product for a specific company. ### Tips and traps - This endpoint only supports refreshing data for **custom products** and can\'t be used for Codat\'s standard solutions. Refer to [individual solutions\' documentation](https://docs.codat.io/) instead. - If a data sync is already in progress for a custom product, the refresh request will return a `Bad request (400)` response. - If a company has multiple custom products enabled, you can refresh data for each product individually. - Optionally include a request body with `dataTypes` to refresh only selected data types for the specified product. If omitted, the product\'s scheduled refresh is triggered as usual. - When specifying `dataTypes`, each value must be a valid data type supported by the product. Invalid values will result in a `Bad request (400)` response listing valid options.
+ * Refresh product data
+ */
+ async refreshProductData(requestParameters: RefreshProductDataRequest, options?: runtime.RequestOptions): Promise {
+ await this.refreshProductDataRaw(requestParameters, options);
+ }
+
+ /**
+ * Use the *Remove product* endpoint to disable a product for the company specified by `companyId`. > Note: This feature is currently in alpha and available only to participants in the development program.
+ * Remove product
+ */
+ private async removeProductRaw(requestParameters: RemoveProductRequest, options?: runtime.RequestOptions): Promise> {
+ if (requestParameters['companyId'] == null) {
+ throw new runtime.RequiredError(
+ 'companyId',
+ 'Required parameter "companyId" was null or undefined when calling removeProduct().'
+ );
+ }
+
+ if (requestParameters['productIdentifier'] == null) {
+ throw new runtime.RequiredError(
+ 'productIdentifier',
+ 'Required parameter "productIdentifier" was null or undefined when calling removeProduct().'
+ );
+ }
+
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/companies/{companyId}/products/{productIdentifier}`.replace(`{${"companyId"}}`, encodeURIComponent(String(requestParameters['companyId']))).replace(`{${"productIdentifier"}}`, encodeURIComponent(String(requestParameters['productIdentifier']))),
+ method: 'DELETE',
+ operationId: 'remove-product',
+ errorStatuses: [401, 402, 403, 404, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ }, options);
+
+ return new runtime.VoidApiResponse(response);
+ }
+
+ /**
+ * Use the *Remove product* endpoint to disable a product for the company specified by `companyId`. > Note: This feature is currently in alpha and available only to participants in the development program.
+ * Remove product
+ */
+ async removeProduct(requestParameters: RemoveProductRequest, options?: runtime.RequestOptions): Promise {
+ await this.removeProductRaw(requestParameters, options);
+ }
+
+ /**
+ * Use the *Replace company* endpoint to replace the existing name, description, and tags of the company. Calling the endpoint will replace existing values even if new values haven\'t been defined in the payload. A [company](https://docs.codat.io/platform-api#/schemas/Company) represents a business sharing access to their data. Each company can have multiple [connections](https://docs.codat.io/platform-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.
+ * Replace company
+ */
+ private async replaceCompanyRaw(requestParameters: ReplaceCompanyRequest, options?: runtime.RequestOptions): Promise> {
+ if (requestParameters['companyId'] == null) {
+ throw new runtime.RequiredError(
+ 'companyId',
+ 'Required parameter "companyId" was null or undefined when calling replaceCompany().'
+ );
+ }
+
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ headerParameters['Content-Type'] = 'application/json';
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/companies/{companyId}`.replace(`{${"companyId"}}`, encodeURIComponent(String(requestParameters['companyId']))),
+ method: 'PUT',
+ operationId: 'replace-company',
+ errorStatuses: [401, 402, 403, 404, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ body: CompanyRequestBodyToJSON(requestParameters['companyRequestBody']),
+ }, options);
+
+ return new runtime.JSONApiResponse(response, (jsonValue) => CompanyFromJSON(jsonValue));
+ }
+
+ /**
+ * Use the *Replace company* endpoint to replace the existing name, description, and tags of the company. Calling the endpoint will replace existing values even if new values haven\'t been defined in the payload. A [company](https://docs.codat.io/platform-api#/schemas/Company) represents a business sharing access to their data. Each company can have multiple [connections](https://docs.codat.io/platform-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.
+ * Replace company
+ */
+ async replace(requestParameters: ReplaceCompanyRequest, options?: runtime.RequestOptions): Promise {
+ const response = await this.replaceCompanyRaw(requestParameters, options);
+ return await response.value();
+ }
+
+ /**
+ * Set the sync settings for a specific company.
+ * Set company sync settings
+ */
+ private async setCompanySyncSettingsRaw(requestParameters: SetCompanySyncSettingsRequest, options?: runtime.RequestOptions): Promise> {
+ if (requestParameters['companyId'] == null) {
+ throw new runtime.RequiredError(
+ 'companyId',
+ 'Required parameter "companyId" was null or undefined when calling setCompanySyncSettings().'
+ );
+ }
+
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ headerParameters['Content-Type'] = 'application/json';
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/companies/{companyId}/syncSettings`.replace(`{${"companyId"}}`, encodeURIComponent(String(requestParameters['companyId']))),
+ method: 'POST',
+ operationId: 'set-company-syncSettings',
+ errorStatuses: [400, 401, 402, 403, 404, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ body: SetCompanySyncSettingsRequestBodyToJSON(requestParameters['requestBody']),
+ }, options);
+
+ return new runtime.VoidApiResponse(response);
+ }
+
+ /**
+ * Set the sync settings for a specific company.
+ * Set company sync settings
+ */
+ async setCompanySyncSettings(requestParameters: SetCompanySyncSettingsRequest, options?: runtime.RequestOptions): Promise {
+ await this.setCompanySyncSettingsRaw(requestParameters, options);
+ }
+
+ /**
+ * Use the *Update company* endpoint to update the name, description, or tags of the company. The *Update company* endpoint doesn\'t have any required fields. If any of the fields provided are `null` or not provided, they won\'t be included in the update. A [company](https://docs.codat.io/platform-api#/schemas/Company) represents a business sharing access to their data.
+ * Update company
+ */
+ private async updateCompanyRaw(requestParameters: UpdateCompanyRequest, options?: runtime.RequestOptions): Promise> {
+ if (requestParameters['companyId'] == null) {
+ throw new runtime.RequiredError(
+ 'companyId',
+ 'Required parameter "companyId" was null or undefined when calling updateCompany().'
+ );
+ }
+
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ headerParameters['Content-Type'] = 'application/json';
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/companies/{companyId}`.replace(`{${"companyId"}}`, encodeURIComponent(String(requestParameters['companyId']))),
+ method: 'PATCH',
+ operationId: 'update-company',
+ errorStatuses: [401, 402, 403, 404, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ body: CompanyUpdateRequestToJSON(requestParameters['companyUpdateRequest']),
+ }, options);
+
+ return new runtime.JSONApiResponse(response, (jsonValue) => CompanyFromJSON(jsonValue));
+ }
+
+ /**
+ * Use the *Update company* endpoint to update the name, description, or tags of the company. The *Update company* endpoint doesn\'t have any required fields. If any of the fields provided are `null` or not provided, they won\'t be included in the update. A [company](https://docs.codat.io/platform-api#/schemas/Company) represents a business sharing access to their data.
+ * Update company
+ */
+ async update(requestParameters: UpdateCompanyRequest, options?: runtime.RequestOptions): Promise {
+ const response = await this.updateCompanyRaw(requestParameters, options);
+ return await response.value();
+ }
+
+}
diff --git a/platform/src/apis/ConnectionManagement.ts b/platform/src/apis/ConnectionManagement.ts
new file mode 100644
index 000000000..0f2dae82c
--- /dev/null
+++ b/platform/src/apis/ConnectionManagement.ts
@@ -0,0 +1,80 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Platform API
+ * An API for the common components of all of Codat\'s products. These end points cover creating and managing your companies, data connections, and integrations. [Read about the building blocks of Codat...](https://docs.codat.io/core-concepts/companies) | [See our OpenAPI spec](https://github.com/codatio/oas) --- ## Endpoints | Endpoints | Description | | :- |:- | | Companies | Create and manage your SMB users\' companies. | | Connections | Create new and manage existing data connections for a company. | | Connection management | Configure connection management UI and retrieve access tokens for authentication. | | Webhooks | Create and manage webhooks that listen to Codat\'s events. | | Integrations | Get a list of integrations supported by Codat and their logos. | | Refresh data | Initiate data refreshes, view pull status and history. | | Settings | Manage company profile configuration, sync settings, and API keys. | | Push data | Initiate and monitor Create, Update, and Delete operations. | | Supplemental data | Configure and pull additional data you can include in Codat\'s standard data types. | | Custom data type | Configure and pull additional data types that are not included in Codat\'s standardized data model. |
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@codat.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+ ConnectionManagementAccessToken,
+ ErrorMessage,
+} from '../sdk/models/index';
+import {
+ ConnectionManagementAccessTokenFromJSON,
+ ConnectionManagementAccessTokenToJSON,
+ ErrorMessageFromJSON,
+ ErrorMessageToJSON,
+} from '../sdk/models/index';
+
+export interface GetConnectionManagementAccessTokenRequest {
+ companyId: string;
+}
+
+/**
+ *
+ */
+export class ConnectionManagement extends runtime.BaseAPI {
+
+ /**
+ * The new [Get company access token](https://docs.codat.io/platform-api#/operations/get-company-access-token) endpoint replaces this endpoint and includes additional functionality.
+ * Get access token (old)
+ * @deprecated
+ */
+ private async getConnectionManagementAccessTokenRaw(requestParameters: GetConnectionManagementAccessTokenRequest, options?: runtime.RequestOptions): Promise> {
+ if (requestParameters['companyId'] == null) {
+ throw new runtime.RequiredError(
+ 'companyId',
+ 'Required parameter "companyId" was null or undefined when calling getConnectionManagementAccessToken().'
+ );
+ }
+
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/companies/{companyId}/connectionManagement/accessToken`.replace(`{${"companyId"}}`, encodeURIComponent(String(requestParameters['companyId']))),
+ method: 'GET',
+ operationId: 'get-connection-management-access-token',
+ errorStatuses: [401, 402, 403, 404, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ }, options);
+
+ return new runtime.JSONApiResponse(response, (jsonValue) => ConnectionManagementAccessTokenFromJSON(jsonValue));
+ }
+
+ /**
+ * The new [Get company access token](https://docs.codat.io/platform-api#/operations/get-company-access-token) endpoint replaces this endpoint and includes additional functionality.
+ * Get access token (old)
+ * @deprecated
+ */
+ async get(requestParameters: GetConnectionManagementAccessTokenRequest, options?: runtime.RequestOptions): Promise {
+ const response = await this.getConnectionManagementAccessTokenRaw(requestParameters, options);
+ return await response.value();
+ }
+
+}
diff --git a/platform/src/apis/Connections.ts b/platform/src/apis/Connections.ts
new file mode 100644
index 000000000..09337d253
--- /dev/null
+++ b/platform/src/apis/Connections.ts
@@ -0,0 +1,381 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Platform API
+ * An API for the common components of all of Codat\'s products. These end points cover creating and managing your companies, data connections, and integrations. [Read about the building blocks of Codat...](https://docs.codat.io/core-concepts/companies) | [See our OpenAPI spec](https://github.com/codatio/oas) --- ## Endpoints | Endpoints | Description | | :- |:- | | Companies | Create and manage your SMB users\' companies. | | Connections | Create new and manage existing data connections for a company. | | Connection management | Configure connection management UI and retrieve access tokens for authentication. | | Webhooks | Create and manage webhooks that listen to Codat\'s events. | | Integrations | Get a list of integrations supported by Codat and their logos. | | Refresh data | Initiate data refreshes, view pull status and history. | | Settings | Manage company profile configuration, sync settings, and API keys. | | Push data | Initiate and monitor Create, Update, and Delete operations. | | Supplemental data | Configure and pull additional data you can include in Codat\'s standard data types. | | Custom data type | Configure and pull additional data types that are not included in Codat\'s standardized data model. |
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@codat.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import type * as shared from '../sdk/models/index';
+import type {
+ Connection,
+ CreateConnectionRequestBody,
+ ErrorMessage,
+ UpdateConnectionStatus,
+} from '../sdk/models/index';
+import {
+ ConnectionFromJSON,
+ ConnectionToJSON,
+ ConnectionsFromJSON,
+ ConnectionsToJSON,
+ CreateConnectionRequestBodyFromJSON,
+ CreateConnectionRequestBodyToJSON,
+ ErrorMessageFromJSON,
+ ErrorMessageToJSON,
+ UpdateConnectionStatusFromJSON,
+ UpdateConnectionStatusToJSON,
+} from '../sdk/models/index';
+
+export interface CreateConnectionRequest {
+ companyId: string;
+ requestBody?: CreateConnectionRequestBody;
+}
+
+export interface DeleteConnectionRequest {
+ companyId: string;
+ connectionId: string;
+}
+
+export interface GetConnectionRequest {
+ companyId: string;
+ connectionId: string;
+}
+
+export interface ListConnectionsRequest {
+ companyId: string;
+ page?: number;
+ pageSize?: number;
+ query?: string;
+ orderBy?: string;
+}
+
+export interface UnlinkConnectionRequest {
+ companyId: string;
+ connectionId: string;
+ updateConnectionStatus?: UpdateConnectionStatus;
+}
+
+export interface UpdateConnectionAuthorizationRequest {
+ companyId: string;
+ connectionId: string;
+ requestBody?: { [key: string]: string; };
+}
+
+/**
+ *
+ */
+export class Connections extends runtime.BaseAPI {
+
+ /**
+ * Creates a connection for the company by providing a valid `platformKey`. Use the [List Integrations](https://docs.codat.io/platform-api#/operations/list-integrations) endpoint to access valid platform keys.
+ * Create connection
+ */
+ private async createConnectionRaw(requestParameters: CreateConnectionRequest, options?: runtime.RequestOptions): Promise> {
+ if (requestParameters['companyId'] == null) {
+ throw new runtime.RequiredError(
+ 'companyId',
+ 'Required parameter "companyId" was null or undefined when calling createConnection().'
+ );
+ }
+
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ headerParameters['Content-Type'] = 'application/json';
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/companies/{companyId}/connections`.replace(`{${"companyId"}}`, encodeURIComponent(String(requestParameters['companyId']))),
+ method: 'POST',
+ operationId: 'create-connection',
+ errorStatuses: [401, 402, 403, 404, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ body: CreateConnectionRequestBodyToJSON(requestParameters['requestBody']),
+ }, options);
+
+ return new runtime.JSONApiResponse(response, (jsonValue) => ConnectionFromJSON(jsonValue));
+ }
+
+ /**
+ * Creates a connection for the company by providing a valid `platformKey`. Use the [List Integrations](https://docs.codat.io/platform-api#/operations/list-integrations) endpoint to access valid platform keys.
+ * Create connection
+ */
+ async create(requestParameters: CreateConnectionRequest, options?: runtime.RequestOptions): Promise {
+ const response = await this.createConnectionRaw(requestParameters, options);
+ return await response.value();
+ }
+
+ /**
+ * Revoke and remove a connection from a company. This operation is not reversible. The end user would need to reauthorize a new data connection if you wish to view new data for this company.
+ * Delete connection
+ */
+ private async deleteConnectionRaw(requestParameters: DeleteConnectionRequest, options?: runtime.RequestOptions): Promise> {
+ if (requestParameters['companyId'] == null) {
+ throw new runtime.RequiredError(
+ 'companyId',
+ 'Required parameter "companyId" was null or undefined when calling deleteConnection().'
+ );
+ }
+
+ if (requestParameters['connectionId'] == null) {
+ throw new runtime.RequiredError(
+ 'connectionId',
+ 'Required parameter "connectionId" was null or undefined when calling deleteConnection().'
+ );
+ }
+
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/companies/{companyId}/connections/{connectionId}`.replace(`{${"companyId"}}`, encodeURIComponent(String(requestParameters['companyId']))).replace(`{${"connectionId"}}`, encodeURIComponent(String(requestParameters['connectionId']))),
+ method: 'DELETE',
+ operationId: 'delete-connection',
+ errorStatuses: [401, 402, 403, 404, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ }, options);
+
+ return new runtime.VoidApiResponse(response);
+ }
+
+ /**
+ * Revoke and remove a connection from a company. This operation is not reversible. The end user would need to reauthorize a new data connection if you wish to view new data for this company.
+ * Delete connection
+ */
+ async delete(requestParameters: DeleteConnectionRequest, options?: runtime.RequestOptions): Promise {
+ await this.deleteConnectionRaw(requestParameters, options);
+ }
+
+ /**
+ * Returns a specific connection for a company when valid identifiers are provided. If the identifiers are for a deleted company and/or connection, a not found response is returned.
+ * Get connection
+ */
+ private async getConnectionRaw(requestParameters: GetConnectionRequest, options?: runtime.RequestOptions): Promise> {
+ if (requestParameters['companyId'] == null) {
+ throw new runtime.RequiredError(
+ 'companyId',
+ 'Required parameter "companyId" was null or undefined when calling getConnection().'
+ );
+ }
+
+ if (requestParameters['connectionId'] == null) {
+ throw new runtime.RequiredError(
+ 'connectionId',
+ 'Required parameter "connectionId" was null or undefined when calling getConnection().'
+ );
+ }
+
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/companies/{companyId}/connections/{connectionId}`.replace(`{${"companyId"}}`, encodeURIComponent(String(requestParameters['companyId']))).replace(`{${"connectionId"}}`, encodeURIComponent(String(requestParameters['connectionId']))),
+ method: 'GET',
+ operationId: 'get-connection',
+ errorStatuses: [401, 402, 403, 404, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ }, options);
+
+ return new runtime.JSONApiResponse(response, (jsonValue) => ConnectionFromJSON(jsonValue));
+ }
+
+ /**
+ * Returns a specific connection for a company when valid identifiers are provided. If the identifiers are for a deleted company and/or connection, a not found response is returned.
+ * Get connection
+ */
+ async get(requestParameters: GetConnectionRequest, options?: runtime.RequestOptions): Promise {
+ const response = await this.getConnectionRaw(requestParameters, options);
+ return await response.value();
+ }
+
+ /**
+ * List the connections for a company.
+ * List connections
+ */
+ private async listConnectionsRaw(requestParameters: ListConnectionsRequest, options?: runtime.RequestOptions): Promise> {
+ if (requestParameters['companyId'] == null) {
+ throw new runtime.RequiredError(
+ 'companyId',
+ 'Required parameter "companyId" was null or undefined when calling listConnections().'
+ );
+ }
+
+ const queryParameters: any = {};
+
+ if (requestParameters['page'] != null) {
+ queryParameters['page'] = requestParameters['page'];
+ }
+ else {
+ queryParameters['page'] = 1;
+ }
+
+ if (requestParameters['pageSize'] != null) {
+ queryParameters['pageSize'] = requestParameters['pageSize'];
+ }
+ else {
+ queryParameters['pageSize'] = 100;
+ }
+
+ if (requestParameters['query'] != null) {
+ queryParameters['query'] = requestParameters['query'];
+ }
+
+ if (requestParameters['orderBy'] != null) {
+ queryParameters['orderBy'] = requestParameters['orderBy'];
+ }
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/companies/{companyId}/connections`.replace(`{${"companyId"}}`, encodeURIComponent(String(requestParameters['companyId']))),
+ method: 'GET',
+ operationId: 'list-connections',
+ errorStatuses: [400, 401, 402, 403, 404, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ }, options);
+
+ return new runtime.JSONApiResponse(response, (jsonValue) => ConnectionsFromJSON(jsonValue));
+ }
+
+ /**
+ * List the connections for a company.
+ * List connections
+ */
+ async list(requestParameters: ListConnectionsRequest, options?: runtime.RequestOptions): Promise {
+ const response = await this.listConnectionsRaw(requestParameters, options);
+ return await response.value();
+ }
+
+ /**
+ * This allows you to deauthorize a connection, without deleting it from Codat. This means you can still view any data that has previously been pulled into Codat, and also lets you re-authorize in future if your customer wishes to resume sharing their data.
+ * Unlink connection
+ */
+ private async unlinkConnectionRaw(requestParameters: UnlinkConnectionRequest, options?: runtime.RequestOptions): Promise> {
+ if (requestParameters['companyId'] == null) {
+ throw new runtime.RequiredError(
+ 'companyId',
+ 'Required parameter "companyId" was null or undefined when calling unlinkConnection().'
+ );
+ }
+
+ if (requestParameters['connectionId'] == null) {
+ throw new runtime.RequiredError(
+ 'connectionId',
+ 'Required parameter "connectionId" was null or undefined when calling unlinkConnection().'
+ );
+ }
+
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ headerParameters['Content-Type'] = 'application/json';
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/companies/{companyId}/connections/{connectionId}`.replace(`{${"companyId"}}`, encodeURIComponent(String(requestParameters['companyId']))).replace(`{${"connectionId"}}`, encodeURIComponent(String(requestParameters['connectionId']))),
+ method: 'PATCH',
+ operationId: 'unlink-connection',
+ errorStatuses: [401, 402, 403, 404, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ body: UpdateConnectionStatusToJSON(requestParameters['updateConnectionStatus']),
+ }, options);
+
+ return new runtime.JSONApiResponse(response, (jsonValue) => ConnectionFromJSON(jsonValue));
+ }
+
+ /**
+ * This allows you to deauthorize a connection, without deleting it from Codat. This means you can still view any data that has previously been pulled into Codat, and also lets you re-authorize in future if your customer wishes to resume sharing their data.
+ * Unlink connection
+ */
+ async unlink(requestParameters: UnlinkConnectionRequest, options?: runtime.RequestOptions): Promise {
+ const response = await this.unlinkConnectionRaw(requestParameters, options);
+ return await response.value();
+ }
+
+ /**
+ * Update data connection\'s authorization.
+ * Update authorization
+ */
+ private async updateConnectionAuthorizationRaw(requestParameters: UpdateConnectionAuthorizationRequest, options?: runtime.RequestOptions): Promise> {
+ if (requestParameters['companyId'] == null) {
+ throw new runtime.RequiredError(
+ 'companyId',
+ 'Required parameter "companyId" was null or undefined when calling updateConnectionAuthorization().'
+ );
+ }
+
+ if (requestParameters['connectionId'] == null) {
+ throw new runtime.RequiredError(
+ 'connectionId',
+ 'Required parameter "connectionId" was null or undefined when calling updateConnectionAuthorization().'
+ );
+ }
+
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ headerParameters['Content-Type'] = 'application/json';
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/companies/{companyId}/connections/{connectionId}/authorization`.replace(`{${"companyId"}}`, encodeURIComponent(String(requestParameters['companyId']))).replace(`{${"connectionId"}}`, encodeURIComponent(String(requestParameters['connectionId']))),
+ method: 'PUT',
+ operationId: 'update-connection-authorization',
+ errorStatuses: [401, 402, 403, 404, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ body: requestParameters['requestBody'],
+ }, options);
+
+ return new runtime.JSONApiResponse(response, (jsonValue) => ConnectionFromJSON(jsonValue));
+ }
+
+ /**
+ * Update data connection\'s authorization.
+ * Update authorization
+ */
+ async updateAuthorization(requestParameters: UpdateConnectionAuthorizationRequest, options?: runtime.RequestOptions): Promise {
+ const response = await this.updateConnectionAuthorizationRaw(requestParameters, options);
+ return await response.value();
+ }
+
+}
diff --git a/platform/src/apis/Cors.ts b/platform/src/apis/Cors.ts
new file mode 100644
index 000000000..ae0a1f4bc
--- /dev/null
+++ b/platform/src/apis/Cors.ts
@@ -0,0 +1,112 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Platform API
+ * An API for the common components of all of Codat\'s products. These end points cover creating and managing your companies, data connections, and integrations. [Read about the building blocks of Codat...](https://docs.codat.io/core-concepts/companies) | [See our OpenAPI spec](https://github.com/codatio/oas) --- ## Endpoints | Endpoints | Description | | :- |:- | | Companies | Create and manage your SMB users\' companies. | | Connections | Create new and manage existing data connections for a company. | | Connection management | Configure connection management UI and retrieve access tokens for authentication. | | Webhooks | Create and manage webhooks that listen to Codat\'s events. | | Integrations | Get a list of integrations supported by Codat and their logos. | | Refresh data | Initiate data refreshes, view pull status and history. | | Settings | Manage company profile configuration, sync settings, and API keys. | | Push data | Initiate and monitor Create, Update, and Delete operations. | | Supplemental data | Configure and pull additional data you can include in Codat\'s standard data types. | | Custom data type | Configure and pull additional data types that are not included in Codat\'s standardized data model. |
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@codat.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+ ConnectionManagementAllowedOrigins,
+ ErrorMessage,
+} from '../sdk/models/index';
+import {
+ ConnectionManagementAllowedOriginsFromJSON,
+ ConnectionManagementAllowedOriginsToJSON,
+ ErrorMessageFromJSON,
+ ErrorMessageToJSON,
+} from '../sdk/models/index';
+
+export interface SetConnectionManagementCorsSettingsRequest {
+ connectionManagementAllowedOrigins?: ConnectionManagementAllowedOrigins;
+}
+
+/**
+ *
+ */
+export class Cors extends runtime.BaseAPI {
+
+ /**
+ * The *Get CORS settings* endpoint returns the allowed origins (i.e. your domains) you want to allow cross-origin resource sharing ([CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing)) with Codat. Enabling CORS with Codat is required by our embeddable UIs (such as [Connections SDK](https://docs.codat.io/auth-flow/optimize/connection-management) and [Link SDK](https://docs.codat.io/auth-flow/authorize-embedded-link)) to access Codat\'s API endpoints.
+ * Get CORS settings (old)
+ * @deprecated
+ */
+ private async getConnectionManagementCorsSettingsRaw(options?: runtime.RequestOptions): Promise> {
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/connectionManagement/corsSettings`,
+ method: 'GET',
+ operationId: 'get-connection-management-cors-settings',
+ errorStatuses: [401, 402, 403, 404, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ }, options);
+
+ return new runtime.JSONApiResponse(response, (jsonValue) => ConnectionManagementAllowedOriginsFromJSON(jsonValue));
+ }
+
+ /**
+ * The *Get CORS settings* endpoint returns the allowed origins (i.e. your domains) you want to allow cross-origin resource sharing ([CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing)) with Codat. Enabling CORS with Codat is required by our embeddable UIs (such as [Connections SDK](https://docs.codat.io/auth-flow/optimize/connection-management) and [Link SDK](https://docs.codat.io/auth-flow/authorize-embedded-link)) to access Codat\'s API endpoints.
+ * Get CORS settings (old)
+ * @deprecated
+ */
+ async get(options?: runtime.RequestOptions): Promise {
+ const response = await this.getConnectionManagementCorsSettingsRaw(options);
+ return await response.value();
+ }
+
+ /**
+ * The *Set CORS settings* endpoint allows you to register allowed origins (i.e. your domains) for use in cross-origin resource sharing ([CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing)). Enabling CORS with Codat is required by our embeddable UIs (such as [Connections SDK](https://docs.codat.io/auth-flow/optimize/connection-management) and [Link SDK](https://docs.codat.io/auth-flow/authorize-embedded-link)) to access Codat\'s API endpoints.
+ * Set CORS settings (old)
+ * @deprecated
+ */
+ private async setConnectionManagementCorsSettingsRaw(requestParameters: SetConnectionManagementCorsSettingsRequest, options?: runtime.RequestOptions): Promise> {
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ headerParameters['Content-Type'] = 'application/json';
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/connectionManagement/corsSettings`,
+ method: 'POST',
+ operationId: 'set-connection-management-cors-settings',
+ errorStatuses: [401, 402, 403, 404, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ body: ConnectionManagementAllowedOriginsToJSON(requestParameters['connectionManagementAllowedOrigins']),
+ }, options);
+
+ return new runtime.JSONApiResponse(response, (jsonValue) => ConnectionManagementAllowedOriginsFromJSON(jsonValue));
+ }
+
+ /**
+ * The *Set CORS settings* endpoint allows you to register allowed origins (i.e. your domains) for use in cross-origin resource sharing ([CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing)). Enabling CORS with Codat is required by our embeddable UIs (such as [Connections SDK](https://docs.codat.io/auth-flow/optimize/connection-management) and [Link SDK](https://docs.codat.io/auth-flow/authorize-embedded-link)) to access Codat\'s API endpoints.
+ * Set CORS settings (old)
+ * @deprecated
+ */
+ async set(connectionManagementAllowedOrigins?: ConnectionManagementAllowedOrigins, options?: runtime.RequestOptions): Promise {
+ const response = await this.setConnectionManagementCorsSettingsRaw({ connectionManagementAllowedOrigins: connectionManagementAllowedOrigins }, options);
+ return await response.value();
+ }
+
+}
diff --git a/platform/src/apis/CustomDataType.ts b/platform/src/apis/CustomDataType.ts
new file mode 100644
index 000000000..76e67c005
--- /dev/null
+++ b/platform/src/apis/CustomDataType.ts
@@ -0,0 +1,287 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Platform API
+ * An API for the common components of all of Codat\'s products. These end points cover creating and managing your companies, data connections, and integrations. [Read about the building blocks of Codat...](https://docs.codat.io/core-concepts/companies) | [See our OpenAPI spec](https://github.com/codatio/oas) --- ## Endpoints | Endpoints | Description | | :- |:- | | Companies | Create and manage your SMB users\' companies. | | Connections | Create new and manage existing data connections for a company. | | Connection management | Configure connection management UI and retrieve access tokens for authentication. | | Webhooks | Create and manage webhooks that listen to Codat\'s events. | | Integrations | Get a list of integrations supported by Codat and their logos. | | Refresh data | Initiate data refreshes, view pull status and history. | | Settings | Manage company profile configuration, sync settings, and API keys. | | Push data | Initiate and monitor Create, Update, and Delete operations. | | Supplemental data | Configure and pull additional data you can include in Codat\'s standard data types. | | Custom data type | Configure and pull additional data types that are not included in Codat\'s standardized data model. |
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@codat.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+ CustomDataTypeConfiguration,
+ CustomDataTypeRecords,
+ ErrorMessage,
+ PullOperation,
+} from '../sdk/models/index';
+import {
+ CustomDataTypeConfigurationFromJSON,
+ CustomDataTypeConfigurationToJSON,
+ CustomDataTypeRecordsFromJSON,
+ CustomDataTypeRecordsToJSON,
+ ErrorMessageFromJSON,
+ ErrorMessageToJSON,
+ PullOperationFromJSON,
+ PullOperationToJSON,
+} from '../sdk/models/index';
+
+export interface ConfigureCustomDataTypeRequest {
+ platformKey: string;
+ customDataIdentifier: string;
+ customDataTypeConfiguration?: CustomDataTypeConfiguration;
+}
+
+export interface GetCustomDataTypeConfigurationRequest {
+ platformKey: string;
+ customDataIdentifier: string;
+}
+
+export interface ListCustomDataTypeRecordsRequest {
+ companyId: string;
+ connectionId: string;
+ customDataIdentifier: string;
+ page?: number;
+ pageSize?: number;
+}
+
+export interface RefreshCustomDataTypeRequest {
+ companyId: string;
+ connectionId: string;
+ customDataIdentifier: string;
+}
+
+/**
+ *
+ */
+export class CustomDataType extends runtime.BaseAPI {
+
+ /**
+ * The *Configure custom data type* endpoint allows you to maintain or change the configuration required to return a custom data type for a specific integration. A [custom data type](https://docs.codat.io/using-the-api/custom-data) is an additional data type you can create that is not included in Codat\'s standardized data model. ### Tips and traps - You can only configure a single custom data type for a single platform at a time. Use the endpoint multiple times if you need to configure it for multiple platforms. - You can only indicate a single data source for each customer data type. - Make your custom configuration as similar as possible to our standard data types so you can interact with them in exactly the same way.
+ * Configure custom data type
+ */
+ private async configureCustomDataTypeRaw(requestParameters: ConfigureCustomDataTypeRequest, options?: runtime.RequestOptions): Promise> {
+ if (requestParameters['platformKey'] == null) {
+ throw new runtime.RequiredError(
+ 'platformKey',
+ 'Required parameter "platformKey" was null or undefined when calling configureCustomDataType().'
+ );
+ }
+
+ if (requestParameters['customDataIdentifier'] == null) {
+ throw new runtime.RequiredError(
+ 'customDataIdentifier',
+ 'Required parameter "customDataIdentifier" was null or undefined when calling configureCustomDataType().'
+ );
+ }
+
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ headerParameters['Content-Type'] = 'application/json';
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/integrations/{platformKey}/dataTypes/custom/{customDataIdentifier}`.replace(`{${"platformKey"}}`, encodeURIComponent(String(requestParameters['platformKey']))).replace(`{${"customDataIdentifier"}}`, encodeURIComponent(String(requestParameters['customDataIdentifier']))),
+ method: 'PUT',
+ operationId: 'configure-custom-data-type',
+ errorStatuses: [401, 402, 403, 404, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ body: CustomDataTypeConfigurationToJSON(requestParameters['customDataTypeConfiguration']),
+ }, options);
+
+ return new runtime.JSONApiResponse(response, (jsonValue) => CustomDataTypeConfigurationFromJSON(jsonValue));
+ }
+
+ /**
+ * The *Configure custom data type* endpoint allows you to maintain or change the configuration required to return a custom data type for a specific integration. A [custom data type](https://docs.codat.io/using-the-api/custom-data) is an additional data type you can create that is not included in Codat\'s standardized data model. ### Tips and traps - You can only configure a single custom data type for a single platform at a time. Use the endpoint multiple times if you need to configure it for multiple platforms. - You can only indicate a single data source for each customer data type. - Make your custom configuration as similar as possible to our standard data types so you can interact with them in exactly the same way.
+ * Configure custom data type
+ */
+ async configure(requestParameters: ConfigureCustomDataTypeRequest, options?: runtime.RequestOptions): Promise {
+ const response = await this.configureCustomDataTypeRaw(requestParameters, options);
+ return await response.value();
+ }
+
+ /**
+ * The *Get custom data configuration* endpoint returns existing configuration details for the specified custom data type and integration pair you previously configured. A [custom data type](https://docs.codat.io/using-the-api/custom-data) is an additional data type you can create that is not included in Codat\'s standardized data model.
+ * Get custom data configuration
+ */
+ private async getCustomDataTypeConfigurationRaw(requestParameters: GetCustomDataTypeConfigurationRequest, options?: runtime.RequestOptions): Promise> {
+ if (requestParameters['platformKey'] == null) {
+ throw new runtime.RequiredError(
+ 'platformKey',
+ 'Required parameter "platformKey" was null or undefined when calling getCustomDataTypeConfiguration().'
+ );
+ }
+
+ if (requestParameters['customDataIdentifier'] == null) {
+ throw new runtime.RequiredError(
+ 'customDataIdentifier',
+ 'Required parameter "customDataIdentifier" was null or undefined when calling getCustomDataTypeConfiguration().'
+ );
+ }
+
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/integrations/{platformKey}/dataTypes/custom/{customDataIdentifier}`.replace(`{${"platformKey"}}`, encodeURIComponent(String(requestParameters['platformKey']))).replace(`{${"customDataIdentifier"}}`, encodeURIComponent(String(requestParameters['customDataIdentifier']))),
+ method: 'GET',
+ operationId: 'get-custom-data-type-configuration',
+ errorStatuses: [401, 402, 403, 404, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ }, options);
+
+ return new runtime.JSONApiResponse(response, (jsonValue) => CustomDataTypeRecordsFromJSON(jsonValue));
+ }
+
+ /**
+ * The *Get custom data configuration* endpoint returns existing configuration details for the specified custom data type and integration pair you previously configured. A [custom data type](https://docs.codat.io/using-the-api/custom-data) is an additional data type you can create that is not included in Codat\'s standardized data model.
+ * Get custom data configuration
+ */
+ async getConfiguration(requestParameters: GetCustomDataTypeConfigurationRequest, options?: runtime.RequestOptions): Promise {
+ const response = await this.getCustomDataTypeConfigurationRaw(requestParameters, options);
+ return await response.value();
+ }
+
+ /**
+ * The *List custom data type records* endpoint returns a paginated list of records pulled for the specified custom data type you previously configured. A [custom data type](https://docs.codat.io/using-the-api/custom-data) is an additional data type you can create that is not included in Codat\'s standardized data model.s endpoint returns a paginated list of records whose schema is defined [Configure custom data type](https://docs.codat.io/platform-api#/operations/configure-custom-data-type)
+ * List custom data type records
+ */
+ private async listCustomDataTypeRecordsRaw(requestParameters: ListCustomDataTypeRecordsRequest, options?: runtime.RequestOptions): Promise> {
+ if (requestParameters['companyId'] == null) {
+ throw new runtime.RequiredError(
+ 'companyId',
+ 'Required parameter "companyId" was null or undefined when calling listCustomDataTypeRecords().'
+ );
+ }
+
+ if (requestParameters['connectionId'] == null) {
+ throw new runtime.RequiredError(
+ 'connectionId',
+ 'Required parameter "connectionId" was null or undefined when calling listCustomDataTypeRecords().'
+ );
+ }
+
+ if (requestParameters['customDataIdentifier'] == null) {
+ throw new runtime.RequiredError(
+ 'customDataIdentifier',
+ 'Required parameter "customDataIdentifier" was null or undefined when calling listCustomDataTypeRecords().'
+ );
+ }
+
+ const queryParameters: any = {};
+
+ if (requestParameters['page'] != null) {
+ queryParameters['page'] = requestParameters['page'];
+ }
+ else {
+ queryParameters['page'] = 1;
+ }
+
+ if (requestParameters['pageSize'] != null) {
+ queryParameters['pageSize'] = requestParameters['pageSize'];
+ }
+ else {
+ queryParameters['pageSize'] = 100;
+ }
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/companies/{companyId}/connections/{connectionId}/data/custom/{customDataIdentifier}`.replace(`{${"companyId"}}`, encodeURIComponent(String(requestParameters['companyId']))).replace(`{${"connectionId"}}`, encodeURIComponent(String(requestParameters['connectionId']))).replace(`{${"customDataIdentifier"}}`, encodeURIComponent(String(requestParameters['customDataIdentifier']))),
+ method: 'GET',
+ operationId: 'list-custom-data-type-records',
+ errorStatuses: [400, 401, 402, 403, 404, 429, 451, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ }, options);
+
+ return new runtime.JSONApiResponse(response, (jsonValue) => CustomDataTypeRecordsFromJSON(jsonValue));
+ }
+
+ /**
+ * The *List custom data type records* endpoint returns a paginated list of records pulled for the specified custom data type you previously configured. A [custom data type](https://docs.codat.io/using-the-api/custom-data) is an additional data type you can create that is not included in Codat\'s standardized data model.s endpoint returns a paginated list of records whose schema is defined [Configure custom data type](https://docs.codat.io/platform-api#/operations/configure-custom-data-type)
+ * List custom data type records
+ */
+ async list(requestParameters: ListCustomDataTypeRecordsRequest, options?: runtime.RequestOptions): Promise {
+ const response = await this.listCustomDataTypeRecordsRaw(requestParameters, options);
+ return await response.value();
+ }
+
+ /**
+ * The *Refresh custom data type* endpoint refreshes the specified custom data type for a given company. This is an asynchronous operation that will sync updated data from the linked integration into Codat for you to view.
+ * Refresh custom data type
+ */
+ private async refreshCustomDataTypeRaw(requestParameters: RefreshCustomDataTypeRequest, options?: runtime.RequestOptions): Promise> {
+ if (requestParameters['companyId'] == null) {
+ throw new runtime.RequiredError(
+ 'companyId',
+ 'Required parameter "companyId" was null or undefined when calling refreshCustomDataType().'
+ );
+ }
+
+ if (requestParameters['connectionId'] == null) {
+ throw new runtime.RequiredError(
+ 'connectionId',
+ 'Required parameter "connectionId" was null or undefined when calling refreshCustomDataType().'
+ );
+ }
+
+ if (requestParameters['customDataIdentifier'] == null) {
+ throw new runtime.RequiredError(
+ 'customDataIdentifier',
+ 'Required parameter "customDataIdentifier" was null or undefined when calling refreshCustomDataType().'
+ );
+ }
+
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/companies/{companyId}/connections/{connectionId}/data/queue/custom/{customDataIdentifier}`.replace(`{${"companyId"}}`, encodeURIComponent(String(requestParameters['companyId']))).replace(`{${"connectionId"}}`, encodeURIComponent(String(requestParameters['connectionId']))).replace(`{${"customDataIdentifier"}}`, encodeURIComponent(String(requestParameters['customDataIdentifier']))),
+ method: 'POST',
+ operationId: 'refresh-custom-data-type',
+ errorStatuses: [401, 402, 403, 404, 429, 451, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ }, options);
+
+ return new runtime.JSONApiResponse(response, (jsonValue) => PullOperationFromJSON(jsonValue));
+ }
+
+ /**
+ * The *Refresh custom data type* endpoint refreshes the specified custom data type for a given company. This is an asynchronous operation that will sync updated data from the linked integration into Codat for you to view.
+ * Refresh custom data type
+ */
+ async refresh(requestParameters: RefreshCustomDataTypeRequest, options?: runtime.RequestOptions): Promise {
+ const response = await this.refreshCustomDataTypeRaw(requestParameters, options);
+ return await response.value();
+ }
+
+}
diff --git a/platform/src/apis/Integrations.ts b/platform/src/apis/Integrations.ts
new file mode 100644
index 000000000..455e7bc19
--- /dev/null
+++ b/platform/src/apis/Integrations.ts
@@ -0,0 +1,192 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Platform API
+ * An API for the common components of all of Codat\'s products. These end points cover creating and managing your companies, data connections, and integrations. [Read about the building blocks of Codat...](https://docs.codat.io/core-concepts/companies) | [See our OpenAPI spec](https://github.com/codatio/oas) --- ## Endpoints | Endpoints | Description | | :- |:- | | Companies | Create and manage your SMB users\' companies. | | Connections | Create new and manage existing data connections for a company. | | Connection management | Configure connection management UI and retrieve access tokens for authentication. | | Webhooks | Create and manage webhooks that listen to Codat\'s events. | | Integrations | Get a list of integrations supported by Codat and their logos. | | Refresh data | Initiate data refreshes, view pull status and history. | | Settings | Manage company profile configuration, sync settings, and API keys. | | Push data | Initiate and monitor Create, Update, and Delete operations. | | Supplemental data | Configure and pull additional data you can include in Codat\'s standard data types. | | Custom data type | Configure and pull additional data types that are not included in Codat\'s standardized data model. |
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@codat.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import type * as shared from '../sdk/models/index';
+import type {
+ Branding,
+ ErrorMessage,
+ Integration,
+} from '../sdk/models/index';
+import {
+ BrandingFromJSON,
+ BrandingToJSON,
+ ErrorMessageFromJSON,
+ ErrorMessageToJSON,
+ IntegrationFromJSON,
+ IntegrationToJSON,
+ IntegrationsFromJSON,
+ IntegrationsToJSON,
+} from '../sdk/models/index';
+
+export interface GetIntegrationRequest {
+ platformKey: string;
+}
+
+export interface GetIntegrationsBrandingRequest {
+ platformKey: string;
+}
+
+export interface ListIntegrationsRequest {
+ page?: number;
+ pageSize?: number;
+ query?: string;
+ orderBy?: string;
+}
+
+/**
+ *
+ */
+export class Integrations extends runtime.BaseAPI {
+
+ /**
+ * Get single integration, by platformKey
+ * Get integration
+ */
+ private async getIntegrationRaw(requestParameters: GetIntegrationRequest, options?: runtime.RequestOptions): Promise> {
+ if (requestParameters['platformKey'] == null) {
+ throw new runtime.RequiredError(
+ 'platformKey',
+ 'Required parameter "platformKey" was null or undefined when calling getIntegration().'
+ );
+ }
+
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/integrations/{platformKey}`.replace(`{${"platformKey"}}`, encodeURIComponent(String(requestParameters['platformKey']))),
+ method: 'GET',
+ operationId: 'get-integration',
+ errorStatuses: [401, 402, 403, 404, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ }, options);
+
+ return new runtime.JSONApiResponse(response, (jsonValue) => IntegrationFromJSON(jsonValue));
+ }
+
+ /**
+ * Get single integration, by platformKey
+ * Get integration
+ */
+ async get(requestParameters: GetIntegrationRequest, options?: runtime.RequestOptions): Promise {
+ const response = await this.getIntegrationRaw(requestParameters, options);
+ return await response.value();
+ }
+
+ /**
+ * Get branding for platform.
+ * Get branding
+ */
+ private async getIntegrationsBrandingRaw(requestParameters: GetIntegrationsBrandingRequest, options?: runtime.RequestOptions): Promise> {
+ if (requestParameters['platformKey'] == null) {
+ throw new runtime.RequiredError(
+ 'platformKey',
+ 'Required parameter "platformKey" was null or undefined when calling getIntegrationsBranding().'
+ );
+ }
+
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/integrations/{platformKey}/branding`.replace(`{${"platformKey"}}`, encodeURIComponent(String(requestParameters['platformKey']))),
+ method: 'GET',
+ operationId: 'get-integrations-branding',
+ errorStatuses: [401, 402, 403, 404, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ }, options);
+
+ return new runtime.JSONApiResponse(response, (jsonValue) => BrandingFromJSON(jsonValue));
+ }
+
+ /**
+ * Get branding for platform.
+ * Get branding
+ */
+ async getBranding(requestParameters: GetIntegrationsBrandingRequest, options?: runtime.RequestOptions): Promise {
+ const response = await this.getIntegrationsBrandingRaw(requestParameters, options);
+ return await response.value();
+ }
+
+ /**
+ * List your available integrations
+ * List integrations
+ */
+ private async listIntegrationsRaw(requestParameters: ListIntegrationsRequest, options?: runtime.RequestOptions): Promise> {
+ const queryParameters: any = {};
+
+ if (requestParameters['page'] != null) {
+ queryParameters['page'] = requestParameters['page'];
+ }
+ else {
+ queryParameters['page'] = 1;
+ }
+
+ if (requestParameters['pageSize'] != null) {
+ queryParameters['pageSize'] = requestParameters['pageSize'];
+ }
+ else {
+ queryParameters['pageSize'] = 100;
+ }
+
+ if (requestParameters['query'] != null) {
+ queryParameters['query'] = requestParameters['query'];
+ }
+
+ if (requestParameters['orderBy'] != null) {
+ queryParameters['orderBy'] = requestParameters['orderBy'];
+ }
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/integrations`,
+ method: 'GET',
+ operationId: 'list-integrations',
+ errorStatuses: [400, 401, 402, 403, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ }, options);
+
+ return new runtime.JSONApiResponse(response, (jsonValue) => IntegrationsFromJSON(jsonValue));
+ }
+
+ /**
+ * List your available integrations
+ * List integrations
+ */
+ async list(requestParameters: ListIntegrationsRequest = {}, options?: runtime.RequestOptions): Promise {
+ const response = await this.listIntegrationsRaw(requestParameters, options);
+ return await response.value();
+ }
+
+}
diff --git a/platform/src/apis/PushData.ts b/platform/src/apis/PushData.ts
new file mode 100644
index 000000000..a640bb229
--- /dev/null
+++ b/platform/src/apis/PushData.ts
@@ -0,0 +1,276 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Platform API
+ * An API for the common components of all of Codat\'s products. These end points cover creating and managing your companies, data connections, and integrations. [Read about the building blocks of Codat...](https://docs.codat.io/core-concepts/companies) | [See our OpenAPI spec](https://github.com/codatio/oas) --- ## Endpoints | Endpoints | Description | | :- |:- | | Companies | Create and manage your SMB users\' companies. | | Connections | Create new and manage existing data connections for a company. | | Connection management | Configure connection management UI and retrieve access tokens for authentication. | | Webhooks | Create and manage webhooks that listen to Codat\'s events. | | Integrations | Get a list of integrations supported by Codat and their logos. | | Refresh data | Initiate data refreshes, view pull status and history. | | Settings | Manage company profile configuration, sync settings, and API keys. | | Push data | Initiate and monitor Create, Update, and Delete operations. | | Supplemental data | Configure and pull additional data you can include in Codat\'s standard data types. | | Custom data type | Configure and pull additional data types that are not included in Codat\'s standardized data model. |
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@codat.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import type { Company } from '../sdk/models/index';
+import * as runtime from '../runtime';
+import type { SchemaDataType } from '../sdk/models/index';
+import type {
+ ErrorMessage,
+ PushOperation,
+ PushOperations,
+ PushOption,
+} from '../sdk/models/index';
+import {
+ ErrorMessageFromJSON,
+ ErrorMessageToJSON,
+ PushOperationFromJSON,
+ PushOperationToJSON,
+ PushOperationsFromJSON,
+ PushOperationsToJSON,
+ PushOptionFromJSON,
+ PushOptionToJSON,
+} from '../sdk/models/index';
+
+export interface GetCompanyPushHistoryRequest {
+ companyId: string;
+ page?: number;
+ pageSize?: number;
+ query?: string;
+ orderBy?: string;
+}
+
+export interface GetCreateUpdateModelOptionsByDataTypeRequest {
+ companyId: string;
+ connectionId: string;
+ dataType: SchemaDataType;
+}
+
+export interface GetPushOperationRequest {
+ companyId: string;
+ pushOperationKey: string;
+}
+
+/**
+ *
+ */
+export class PushData extends runtime.BaseAPI {
+
+ /**
+ * The **List push operations** endpoint returns a list of [push operations](/using-the-api/push) performed on the company. Write operations are actions that send requests to Codat, enabling the creation, updating, deletion of records, or uploading attachments in the connected accounting software.
+ * List push operations
+ */
+ private async getCompanyPushHistoryRaw(requestParameters: GetCompanyPushHistoryRequest, options?: runtime.RequestOptions): Promise> {
+ if (requestParameters['companyId'] == null) {
+ throw new runtime.RequiredError(
+ 'companyId',
+ 'Required parameter "companyId" was null or undefined when calling getCompanyPushHistory().'
+ );
+ }
+
+ const queryParameters: any = {};
+
+ if (requestParameters['page'] != null) {
+ queryParameters['page'] = requestParameters['page'];
+ }
+ else {
+ queryParameters['page'] = 1;
+ }
+
+ if (requestParameters['pageSize'] != null) {
+ queryParameters['pageSize'] = requestParameters['pageSize'];
+ }
+ else {
+ queryParameters['pageSize'] = 100;
+ }
+
+ if (requestParameters['query'] != null) {
+ queryParameters['query'] = requestParameters['query'];
+ }
+
+ if (requestParameters['orderBy'] != null) {
+ queryParameters['orderBy'] = requestParameters['orderBy'];
+ }
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/companies/{companyId}/push`.replace(`{${"companyId"}}`, encodeURIComponent(String(requestParameters['companyId']))),
+ method: 'GET',
+ operationId: 'get-company-push-history',
+ errorStatuses: [400, 401, 402, 403, 404, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ }, options);
+
+ return new runtime.JSONApiResponse(response, (jsonValue) => PushOperationsFromJSON(jsonValue));
+ }
+
+ /**
+ * The **List push operations** endpoint returns a list of [push operations](/using-the-api/push) performed on the company. Write operations are actions that send requests to Codat, enabling the creation, updating, deletion of records, or uploading attachments in the connected accounting software.
+ * List push operations
+ */
+ async listOperations(requestParameters: GetCompanyPushHistoryRequest, options?: runtime.RequestOptions): Promise {
+ const response = await this.getCompanyPushHistoryRaw(requestParameters, options);
+ return await response.value();
+ }
+
+ /**
+ * This is the generic documentation for creation and updating of data. See the equivalent endpoint for a given data type for more specific information. Before pushing data into accounting software, it is often necessary to collect some details from the user as to how they would like the data to be inserted. This includes names and amounts on transactional entities, but also factors such as categorisation of entities, which is often handled differently between different accounting software. A good example of this is specifying where on the balance sheet/profit and loss reports the user would like a newly-created nominal account to appear. Codat tries not to limit users to pushing to a very limited number of standard categories, so we have implemented \"options\" endpoints, which allow us to expose to our clients the fields which are required to be pushed for a specific linked company, and the options which may be selected for each field.
+ * Get push options
+ */
+ private async getCreateUpdateModelOptionsByDataTypeRaw(requestParameters: GetCreateUpdateModelOptionsByDataTypeRequest, options?: runtime.RequestOptions): Promise> {
+ if (requestParameters['companyId'] == null) {
+ throw new runtime.RequiredError(
+ 'companyId',
+ 'Required parameter "companyId" was null or undefined when calling getCreateUpdateModelOptionsByDataType().'
+ );
+ }
+
+ if (requestParameters['connectionId'] == null) {
+ throw new runtime.RequiredError(
+ 'connectionId',
+ 'Required parameter "connectionId" was null or undefined when calling getCreateUpdateModelOptionsByDataType().'
+ );
+ }
+
+ if (requestParameters['dataType'] == null) {
+ throw new runtime.RequiredError(
+ 'dataType',
+ 'Required parameter "dataType" was null or undefined when calling getCreateUpdateModelOptionsByDataType().'
+ );
+ }
+
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/companies/{companyId}/connections/{connectionId}/options/{dataType}`.replace(`{${"companyId"}}`, encodeURIComponent(String(requestParameters['companyId']))).replace(`{${"connectionId"}}`, encodeURIComponent(String(requestParameters['connectionId']))).replace(`{${"dataType"}}`, encodeURIComponent(String(requestParameters['dataType']))),
+ method: 'GET',
+ operationId: 'get-create-update-model-options-by-data-type',
+ errorStatuses: [401, 402, 403, 404, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ }, options);
+
+ return new runtime.JSONApiResponse(response, (jsonValue) => PushOptionFromJSON(jsonValue));
+ }
+
+ /**
+ * This is the generic documentation for creation and updating of data. See the equivalent endpoint for a given data type for more specific information. Before pushing data into accounting software, it is often necessary to collect some details from the user as to how they would like the data to be inserted. This includes names and amounts on transactional entities, but also factors such as categorisation of entities, which is often handled differently between different accounting software. A good example of this is specifying where on the balance sheet/profit and loss reports the user would like a newly-created nominal account to appear. Codat tries not to limit users to pushing to a very limited number of standard categories, so we have implemented \"options\" endpoints, which allow us to expose to our clients the fields which are required to be pushed for a specific linked company, and the options which may be selected for each field.
+ * Get push options
+ */
+ async getModelOptions(requestParameters: GetCreateUpdateModelOptionsByDataTypeRequest, options?: runtime.RequestOptions): Promise {
+ const response = await this.getCreateUpdateModelOptionsByDataTypeRaw(requestParameters, options);
+ return await response.value();
+ }
+
+ /**
+ * The **Get push operation** endpoint returns a specific [push operation](/using-the-api/push) identified by the `pushOperationKey` that was performed on the company. Write operations are actions that send requests to Codat, enabling the creation, updating, deletion of records, or uploading attachments in the connected accounting software.
+ * Get push operation
+ */
+ private async getPushOperationRaw(requestParameters: GetPushOperationRequest, options?: runtime.RequestOptions): Promise> {
+ if (requestParameters['companyId'] == null) {
+ throw new runtime.RequiredError(
+ 'companyId',
+ 'Required parameter "companyId" was null or undefined when calling getPushOperation().'
+ );
+ }
+
+ if (requestParameters['pushOperationKey'] == null) {
+ throw new runtime.RequiredError(
+ 'pushOperationKey',
+ 'Required parameter "pushOperationKey" was null or undefined when calling getPushOperation().'
+ );
+ }
+
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/companies/{companyId}/push/{pushOperationKey}`.replace(`{${"companyId"}}`, encodeURIComponent(String(requestParameters['companyId']))).replace(`{${"pushOperationKey"}}`, encodeURIComponent(String(requestParameters['pushOperationKey']))),
+ method: 'GET',
+ operationId: 'get-push-operation',
+ errorStatuses: [401, 402, 403, 404, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ }, options);
+
+ return new runtime.JSONApiResponse(response, (jsonValue) => PushOperationFromJSON(jsonValue));
+ }
+
+ /**
+ * The **Get push operation** endpoint returns a specific [push operation](/using-the-api/push) identified by the `pushOperationKey` that was performed on the company. Write operations are actions that send requests to Codat, enabling the creation, updating, deletion of records, or uploading attachments in the connected accounting software.
+ * Get push operation
+ */
+ async getOperation(requestParameters: GetPushOperationRequest, options?: runtime.RequestOptions): Promise {
+ const response = await this.getPushOperationRaw(requestParameters, options);
+ return await response.value();
+ }
+
+}
+
+/**
+ * @export
+ */
+export const GetCreateUpdateModelOptionsByDataTypeDataTypeEnum = {
+ AccountTransactions: 'accountTransactions',
+ BalanceSheet: 'balanceSheet',
+ BankAccounts: 'bankAccounts',
+ BankTransactions: 'bankTransactions',
+ BillCreditNotes: 'billCreditNotes',
+ BillPayments: 'billPayments',
+ Bills: 'bills',
+ CashFlowStatement: 'cashFlowStatement',
+ ChartOfAccounts: 'chartOfAccounts',
+ Company: 'company',
+ CreditNotes: 'creditNotes',
+ Customers: 'customers',
+ DirectCosts: 'directCosts',
+ DirectIncomes: 'directIncomes',
+ Invoices: 'invoices',
+ ItemReceipts: 'itemReceipts',
+ Items: 'items',
+ JournalEntries: 'journalEntries',
+ Journals: 'journals',
+ PaymentMethods: 'paymentMethods',
+ Payments: 'payments',
+ ProfitAndLoss: 'profitAndLoss',
+ PurchaseOrders: 'purchaseOrders',
+ SalesOrders: 'salesOrders',
+ Suppliers: 'suppliers',
+ TaxRates: 'taxRates',
+ TrackingCategories: 'trackingCategories',
+ Transfers: 'transfers',
+ BankingAccountBalances: 'banking-accountBalances',
+ BankingAccounts: 'banking-accounts',
+ BankingTransactionCategories: 'banking-transactionCategories',
+ BankingTransactions: 'banking-transactions',
+ CommerceCompanyInfo: 'commerce-companyInfo',
+ CommerceCustomers: 'commerce-customers',
+ CommerceDisputes: 'commerce-disputes',
+ CommerceLocations: 'commerce-locations',
+ CommerceOrders: 'commerce-orders',
+ CommercePaymentMethods: 'commerce-paymentMethods',
+ CommercePayments: 'commerce-payments',
+ CommerceProductCategories: 'commerce-productCategories',
+ CommerceProducts: 'commerce-products',
+ CommerceTaxComponents: 'commerce-taxComponents',
+ CommerceTransactions: 'commerce-transactions'
+} as const;
+export type GetCreateUpdateModelOptionsByDataTypeDataTypeEnum = typeof GetCreateUpdateModelOptionsByDataTypeDataTypeEnum[keyof typeof GetCreateUpdateModelOptionsByDataTypeDataTypeEnum];
diff --git a/platform/src/apis/ReadData.ts b/platform/src/apis/ReadData.ts
new file mode 100644
index 000000000..01a4eec68
--- /dev/null
+++ b/platform/src/apis/ReadData.ts
@@ -0,0 +1,86 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Platform API
+ * An API for the common components of all of Codat\'s products. These end points cover creating and managing your companies, data connections, and integrations. [Read about the building blocks of Codat...](https://docs.codat.io/core-concepts/companies) | [See our OpenAPI spec](https://github.com/codatio/oas) --- ## Endpoints | Endpoints | Description | | :- |:- | | Companies | Create and manage your SMB users\' companies. | | Connections | Create new and manage existing data connections for a company. | | Connection management | Configure connection management UI and retrieve access tokens for authentication. | | Webhooks | Create and manage webhooks that listen to Codat\'s events. | | Integrations | Get a list of integrations supported by Codat and their logos. | | Refresh data | Initiate data refreshes, view pull status and history. | | Settings | Manage company profile configuration, sync settings, and API keys. | | Push data | Initiate and monitor Create, Update, and Delete operations. | | Supplemental data | Configure and pull additional data you can include in Codat\'s standard data types. | | Custom data type | Configure and pull additional data types that are not included in Codat\'s standardized data model. |
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@codat.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+ ErrorMessage,
+ ValidationResult,
+} from '../sdk/models/index';
+import {
+ ErrorMessageFromJSON,
+ ErrorMessageToJSON,
+ ValidationResultFromJSON,
+ ValidationResultToJSON,
+} from '../sdk/models/index';
+
+export interface GetReadValidationResultsRequest {
+ companyId: string;
+ datasetId: string;
+}
+
+/**
+ *
+ */
+export class ReadData extends runtime.BaseAPI {
+
+ /**
+ * Use the **Get validation results** endpoint to review warnings and errors encountered during the data type validation phase. The validation result [schema](https://docs.codat.io/platform-api#/schemas/ValidationResult) contains two message arrays: - **`warnings`** array lists potential issues with the data type that may require attention but don\'t block usage. - **`errors`** array contains critical issues that must be resolved before the data type can be used.
+ * Get validation results
+ */
+ private async getReadValidationResultsRaw(requestParameters: GetReadValidationResultsRequest, options?: runtime.RequestOptions): Promise> {
+ if (requestParameters['companyId'] == null) {
+ throw new runtime.RequiredError(
+ 'companyId',
+ 'Required parameter "companyId" was null or undefined when calling getReadValidationResults().'
+ );
+ }
+
+ if (requestParameters['datasetId'] == null) {
+ throw new runtime.RequiredError(
+ 'datasetId',
+ 'Required parameter "datasetId" was null or undefined when calling getReadValidationResults().'
+ );
+ }
+
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/companies/{companyId}/sync/{datasetId}/validation`.replace(`{${"companyId"}}`, encodeURIComponent(String(requestParameters['companyId']))).replace(`{${"datasetId"}}`, encodeURIComponent(String(requestParameters['datasetId']))),
+ method: 'GET',
+ operationId: 'get-read-validation-results',
+ errorStatuses: [401, 402, 403, 404, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ }, options);
+
+ return new runtime.JSONApiResponse(response, (jsonValue) => ValidationResultFromJSON(jsonValue));
+ }
+
+ /**
+ * Use the **Get validation results** endpoint to review warnings and errors encountered during the data type validation phase. The validation result [schema](https://docs.codat.io/platform-api#/schemas/ValidationResult) contains two message arrays: - **`warnings`** array lists potential issues with the data type that may require attention but don\'t block usage. - **`errors`** array contains critical issues that must be resolved before the data type can be used.
+ * Get validation results
+ */
+ async getValidationResults(requestParameters: GetReadValidationResultsRequest, options?: runtime.RequestOptions): Promise {
+ const response = await this.getReadValidationResultsRaw(requestParameters, options);
+ return await response.value();
+ }
+
+}
diff --git a/platform/src/apis/RefreshData.ts b/platform/src/apis/RefreshData.ts
new file mode 100644
index 000000000..e283a4b4e
--- /dev/null
+++ b/platform/src/apis/RefreshData.ts
@@ -0,0 +1,362 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Platform API
+ * An API for the common components of all of Codat\'s products. These end points cover creating and managing your companies, data connections, and integrations. [Read about the building blocks of Codat...](https://docs.codat.io/core-concepts/companies) | [See our OpenAPI spec](https://github.com/codatio/oas) --- ## Endpoints | Endpoints | Description | | :- |:- | | Companies | Create and manage your SMB users\' companies. | | Connections | Create new and manage existing data connections for a company. | | Connection management | Configure connection management UI and retrieve access tokens for authentication. | | Webhooks | Create and manage webhooks that listen to Codat\'s events. | | Integrations | Get a list of integrations supported by Codat and their logos. | | Refresh data | Initiate data refreshes, view pull status and history. | | Settings | Manage company profile configuration, sync settings, and API keys. | | Push data | Initiate and monitor Create, Update, and Delete operations. | | Supplemental data | Configure and pull additional data you can include in Codat\'s standard data types. | | Custom data type | Configure and pull additional data types that are not included in Codat\'s standardized data model. |
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@codat.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import type { Company } from '../sdk/models/index';
+import * as runtime from '../runtime';
+import type { SchemaDataType } from '../sdk/models/index';
+import type {
+ DataStatuses,
+ ErrorMessage,
+ PullOperation,
+ PullOperations,
+} from '../sdk/models/index';
+import {
+ DataStatusesFromJSON,
+ DataStatusesToJSON,
+ ErrorMessageFromJSON,
+ ErrorMessageToJSON,
+ PullOperationFromJSON,
+ PullOperationToJSON,
+ PullOperationsFromJSON,
+ PullOperationsToJSON,
+} from '../sdk/models/index';
+
+export interface GetCompanyDataStatusRequest {
+ companyId: string;
+}
+
+export interface GetPullOperationRequest {
+ companyId: string;
+ datasetId: string;
+}
+
+export interface ListPullOperationsRequest {
+ companyId: string;
+ page?: number;
+ pageSize?: number;
+ query?: string;
+ orderBy?: string;
+}
+
+export interface RefreshCompanyDataRequest {
+ companyId: string;
+}
+
+export interface RefreshDataTypeRequest {
+ companyId: string;
+ dataType: SchemaDataType;
+ connectionId?: string;
+}
+
+/**
+ *
+ */
+export class RefreshData extends runtime.BaseAPI {
+
+ /**
+ * Get the state of each data type for a company
+ * Get data status
+ */
+ private async getCompanyDataStatusRaw(requestParameters: GetCompanyDataStatusRequest, options?: runtime.RequestOptions): Promise> {
+ if (requestParameters['companyId'] == null) {
+ throw new runtime.RequiredError(
+ 'companyId',
+ 'Required parameter "companyId" was null or undefined when calling getCompanyDataStatus().'
+ );
+ }
+
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/companies/{companyId}/dataStatus`.replace(`{${"companyId"}}`, encodeURIComponent(String(requestParameters['companyId']))),
+ method: 'GET',
+ operationId: 'get-company-data-status',
+ errorStatuses: [401, 402, 403, 404, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ }, options);
+
+ return new runtime.JSONApiResponse(response, (jsonValue) => DataStatusesFromJSON(jsonValue));
+ }
+
+ /**
+ * Get the state of each data type for a company
+ * Get data status
+ */
+ async get(requestParameters: GetCompanyDataStatusRequest, options?: runtime.RequestOptions): Promise {
+ const response = await this.getCompanyDataStatusRaw(requestParameters, options);
+ return await response.value();
+ }
+
+ /**
+ * Retrieve information about a single dataset or pull operation.
+ * Get pull operation
+ */
+ private async getPullOperationRaw(requestParameters: GetPullOperationRequest, options?: runtime.RequestOptions): Promise> {
+ if (requestParameters['companyId'] == null) {
+ throw new runtime.RequiredError(
+ 'companyId',
+ 'Required parameter "companyId" was null or undefined when calling getPullOperation().'
+ );
+ }
+
+ if (requestParameters['datasetId'] == null) {
+ throw new runtime.RequiredError(
+ 'datasetId',
+ 'Required parameter "datasetId" was null or undefined when calling getPullOperation().'
+ );
+ }
+
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/companies/{companyId}/data/history/{datasetId}`.replace(`{${"companyId"}}`, encodeURIComponent(String(requestParameters['companyId']))).replace(`{${"datasetId"}}`, encodeURIComponent(String(requestParameters['datasetId']))),
+ method: 'GET',
+ operationId: 'get-pull-operation',
+ errorStatuses: [401, 402, 403, 404, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ }, options);
+
+ return new runtime.JSONApiResponse(response, (jsonValue) => PullOperationFromJSON(jsonValue));
+ }
+
+ /**
+ * Retrieve information about a single dataset or pull operation.
+ * Get pull operation
+ */
+ async getPullOperation(requestParameters: GetPullOperationRequest, options?: runtime.RequestOptions): Promise {
+ const response = await this.getPullOperationRaw(requestParameters, options);
+ return await response.value();
+ }
+
+ /**
+ * Gets the pull operation history (datasets) for a given company.
+ * List pull operations
+ */
+ private async listPullOperationsRaw(requestParameters: ListPullOperationsRequest, options?: runtime.RequestOptions): Promise> {
+ if (requestParameters['companyId'] == null) {
+ throw new runtime.RequiredError(
+ 'companyId',
+ 'Required parameter "companyId" was null or undefined when calling listPullOperations().'
+ );
+ }
+
+ const queryParameters: any = {};
+
+ if (requestParameters['page'] != null) {
+ queryParameters['page'] = requestParameters['page'];
+ }
+ else {
+ queryParameters['page'] = 1;
+ }
+
+ if (requestParameters['pageSize'] != null) {
+ queryParameters['pageSize'] = requestParameters['pageSize'];
+ }
+ else {
+ queryParameters['pageSize'] = 100;
+ }
+
+ if (requestParameters['query'] != null) {
+ queryParameters['query'] = requestParameters['query'];
+ }
+
+ if (requestParameters['orderBy'] != null) {
+ queryParameters['orderBy'] = requestParameters['orderBy'];
+ }
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/companies/{companyId}/data/history`.replace(`{${"companyId"}}`, encodeURIComponent(String(requestParameters['companyId']))),
+ method: 'GET',
+ operationId: 'list-pull-operations',
+ errorStatuses: [400, 401, 402, 403, 404, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ }, options);
+
+ return new runtime.JSONApiResponse(response, (jsonValue) => PullOperationsFromJSON(jsonValue));
+ }
+
+ /**
+ * Gets the pull operation history (datasets) for a given company.
+ * List pull operations
+ */
+ async listPullOperations(requestParameters: ListPullOperationsRequest, options?: runtime.RequestOptions): Promise {
+ const response = await this.listPullOperationsRaw(requestParameters, options);
+ return await response.value();
+ }
+
+ /**
+ * Refreshes all data types with `fetch on first link` set to `true` for a given company. This is an asynchronous operation, and will bring updated data into Codat from the linked integration for you to view. [Read more](https://docs.codat.io/core-concepts/data-type-settings) about data type settings and `fetch on first link`.
+ * Refresh all data
+ */
+ private async refreshCompanyDataRaw(requestParameters: RefreshCompanyDataRequest, options?: runtime.RequestOptions): Promise> {
+ if (requestParameters['companyId'] == null) {
+ throw new runtime.RequiredError(
+ 'companyId',
+ 'Required parameter "companyId" was null or undefined when calling refreshCompanyData().'
+ );
+ }
+
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/companies/{companyId}/data/all`.replace(`{${"companyId"}}`, encodeURIComponent(String(requestParameters['companyId']))),
+ method: 'POST',
+ operationId: 'refresh-company-data',
+ errorStatuses: [400, 401, 402, 403, 404, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ }, options);
+
+ return new runtime.VoidApiResponse(response);
+ }
+
+ /**
+ * Refreshes all data types with `fetch on first link` set to `true` for a given company. This is an asynchronous operation, and will bring updated data into Codat from the linked integration for you to view. [Read more](https://docs.codat.io/core-concepts/data-type-settings) about data type settings and `fetch on first link`.
+ * Refresh all data
+ */
+ async all(requestParameters: RefreshCompanyDataRequest, options?: runtime.RequestOptions): Promise {
+ await this.refreshCompanyDataRaw(requestParameters, options);
+ }
+
+ /**
+ * Refreshes a given data type for a given company. This is an asynchronous operation, and will bring updated data into Codat from the linked integration for you to view.
+ * Refresh data type
+ */
+ private async refreshDataTypeRaw(requestParameters: RefreshDataTypeRequest, options?: runtime.RequestOptions): Promise> {
+ if (requestParameters['companyId'] == null) {
+ throw new runtime.RequiredError(
+ 'companyId',
+ 'Required parameter "companyId" was null or undefined when calling refreshDataType().'
+ );
+ }
+
+ if (requestParameters['dataType'] == null) {
+ throw new runtime.RequiredError(
+ 'dataType',
+ 'Required parameter "dataType" was null or undefined when calling refreshDataType().'
+ );
+ }
+
+ const queryParameters: any = {};
+
+ if (requestParameters['connectionId'] != null) {
+ queryParameters['connectionId'] = requestParameters['connectionId'];
+ }
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/companies/{companyId}/data/queue/{dataType}`.replace(`{${"companyId"}}`, encodeURIComponent(String(requestParameters['companyId']))).replace(`{${"dataType"}}`, encodeURIComponent(String(requestParameters['dataType']))),
+ method: 'POST',
+ operationId: 'refresh-data-type',
+ errorStatuses: [400, 401, 402, 403, 404, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ }, options);
+
+ return new runtime.JSONApiResponse(response, (jsonValue) => PullOperationFromJSON(jsonValue));
+ }
+
+ /**
+ * Refreshes a given data type for a given company. This is an asynchronous operation, and will bring updated data into Codat from the linked integration for you to view.
+ * Refresh data type
+ */
+ async byDataType(requestParameters: RefreshDataTypeRequest, options?: runtime.RequestOptions): Promise {
+ const response = await this.refreshDataTypeRaw(requestParameters, options);
+ return await response.value();
+ }
+
+}
+
+/**
+ * @export
+ */
+export const RefreshDataTypeDataTypeEnum = {
+ AccountTransactions: 'accountTransactions',
+ BalanceSheet: 'balanceSheet',
+ BankAccounts: 'bankAccounts',
+ BankTransactions: 'bankTransactions',
+ BillCreditNotes: 'billCreditNotes',
+ BillPayments: 'billPayments',
+ Bills: 'bills',
+ CashFlowStatement: 'cashFlowStatement',
+ ChartOfAccounts: 'chartOfAccounts',
+ Company: 'company',
+ CreditNotes: 'creditNotes',
+ Customers: 'customers',
+ DirectCosts: 'directCosts',
+ DirectIncomes: 'directIncomes',
+ Invoices: 'invoices',
+ ItemReceipts: 'itemReceipts',
+ Items: 'items',
+ JournalEntries: 'journalEntries',
+ Journals: 'journals',
+ PaymentMethods: 'paymentMethods',
+ Payments: 'payments',
+ ProfitAndLoss: 'profitAndLoss',
+ PurchaseOrders: 'purchaseOrders',
+ SalesOrders: 'salesOrders',
+ Suppliers: 'suppliers',
+ TaxRates: 'taxRates',
+ TrackingCategories: 'trackingCategories',
+ Transfers: 'transfers',
+ BankingAccountBalances: 'banking-accountBalances',
+ BankingAccounts: 'banking-accounts',
+ BankingTransactionCategories: 'banking-transactionCategories',
+ BankingTransactions: 'banking-transactions',
+ CommerceCompanyInfo: 'commerce-companyInfo',
+ CommerceCustomers: 'commerce-customers',
+ CommerceDisputes: 'commerce-disputes',
+ CommerceLocations: 'commerce-locations',
+ CommerceOrders: 'commerce-orders',
+ CommercePaymentMethods: 'commerce-paymentMethods',
+ CommercePayments: 'commerce-payments',
+ CommerceProductCategories: 'commerce-productCategories',
+ CommerceProducts: 'commerce-products',
+ CommerceTaxComponents: 'commerce-taxComponents',
+ CommerceTransactions: 'commerce-transactions'
+} as const;
+export type RefreshDataTypeDataTypeEnum = typeof RefreshDataTypeDataTypeEnum[keyof typeof RefreshDataTypeDataTypeEnum];
diff --git a/platform/src/apis/Settings.ts b/platform/src/apis/Settings.ts
new file mode 100644
index 000000000..0661ea669
--- /dev/null
+++ b/platform/src/apis/Settings.ts
@@ -0,0 +1,395 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Platform API
+ * An API for the common components of all of Codat\'s products. These end points cover creating and managing your companies, data connections, and integrations. [Read about the building blocks of Codat...](https://docs.codat.io/core-concepts/companies) | [See our OpenAPI spec](https://github.com/codatio/oas) --- ## Endpoints | Endpoints | Description | | :- |:- | | Companies | Create and manage your SMB users\' companies. | | Connections | Create new and manage existing data connections for a company. | | Connection management | Configure connection management UI and retrieve access tokens for authentication. | | Webhooks | Create and manage webhooks that listen to Codat\'s events. | | Integrations | Get a list of integrations supported by Codat and their logos. | | Refresh data | Initiate data refreshes, view pull status and history. | | Settings | Manage company profile configuration, sync settings, and API keys. | | Push data | Initiate and monitor Create, Update, and Delete operations. | | Supplemental data | Configure and pull additional data you can include in Codat\'s standard data types. | | Custom data type | Configure and pull additional data types that are not included in Codat\'s standardized data model. |
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@codat.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+ ApiKeyDetails,
+ ApiKeys,
+ ConnectionManagementAllowedOrigins,
+ CreateApiKey,
+ ErrorMessage,
+ Profile,
+ SyncSettings,
+ UpdateProfileSyncSettingsRequestBody,
+} from '../sdk/models/index';
+import {
+ ApiKeyDetailsFromJSON,
+ ApiKeyDetailsToJSON,
+ ApiKeysFromJSON,
+ ApiKeysToJSON,
+ ConnectionManagementAllowedOriginsFromJSON,
+ ConnectionManagementAllowedOriginsToJSON,
+ CreateApiKeyFromJSON,
+ CreateApiKeyToJSON,
+ ErrorMessageFromJSON,
+ ErrorMessageToJSON,
+ ProfileFromJSON,
+ ProfileToJSON,
+ SyncSettingsFromJSON,
+ SyncSettingsToJSON,
+ UpdateProfileSyncSettingsRequestBodyFromJSON,
+ UpdateProfileSyncSettingsRequestBodyToJSON,
+} from '../sdk/models/index';
+
+export interface CreateApiKeyRequest {
+ createApiKey?: CreateApiKey;
+}
+
+export interface DeleteApiKeyRequest {
+ apiKeyId: string;
+}
+
+export interface SetCorsSettingsRequest {
+ connectionManagementAllowedOrigins?: ConnectionManagementAllowedOrigins;
+}
+
+export interface UpdateProfileRequest {
+ profile?: Profile;
+}
+
+export interface UpdateProfileSyncSettingsRequest {
+ requestBody?: UpdateProfileSyncSettingsRequestBody;
+}
+
+/**
+ *
+ */
+export class Settings extends runtime.BaseAPI {
+
+ /**
+ * Use the *Create API keys* endpoint to generate a new API key for your client. [API keys](https://docs.codat.io/platform-api#/schemas/apiKeys) are tokens used to control access to the API. Include this token in the `Authorization` header parameter when making API calls, following the word \"Basic\" and a space with your API key. You can [read more](https://docs.codat.io/using-the-api/authentication) about authentication at Codat and managing API keys via the Portal UI or API. ### Tips and pitfalls * Your first API key is created for you. Access this key via [Codat\'s Portal](https://app.codat.io/developers/api-keys). * If you require multiple API keys, perform multiple calls to the *Create API keys* endpoint. * The number of API keys is limited to 10. If you have reached the maximum amount of keys, use the *Delete API key* endpoint to delete an unused key first.
+ * Create API key
+ */
+ private async createApiKeyRaw(requestParameters: CreateApiKeyRequest, options?: runtime.RequestOptions): Promise> {
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ headerParameters['Content-Type'] = 'application/json';
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/apiKeys`,
+ method: 'POST',
+ operationId: 'create-api-key',
+ errorStatuses: [400, 401, 402, 403, 409, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ body: CreateApiKeyToJSON(requestParameters['createApiKey']),
+ }, options);
+
+ return new runtime.JSONApiResponse(response, (jsonValue) => ApiKeyDetailsFromJSON(jsonValue));
+ }
+
+ /**
+ * Use the *Create API keys* endpoint to generate a new API key for your client. [API keys](https://docs.codat.io/platform-api#/schemas/apiKeys) are tokens used to control access to the API. Include this token in the `Authorization` header parameter when making API calls, following the word \"Basic\" and a space with your API key. You can [read more](https://docs.codat.io/using-the-api/authentication) about authentication at Codat and managing API keys via the Portal UI or API. ### Tips and pitfalls * Your first API key is created for you. Access this key via [Codat\'s Portal](https://app.codat.io/developers/api-keys). * If you require multiple API keys, perform multiple calls to the *Create API keys* endpoint. * The number of API keys is limited to 10. If you have reached the maximum amount of keys, use the *Delete API key* endpoint to delete an unused key first.
+ * Create API key
+ */
+ async createApiKey(createApiKey?: CreateApiKey, options?: runtime.RequestOptions): Promise {
+ const response = await this.createApiKeyRaw({ createApiKey: createApiKey }, options);
+ return await response.value();
+ }
+
+ /**
+ * Use the *Delete API keys* endpoint to delete an existing API key, providing its valid `id` as a parameter. Note that this operation is not reversible. [API keys](https://docs.codat.io/platform-api#/schemas/apiKeys) are tokens used to control access to the API. Include this token in the `Authorization` header parameter when making API calls, following the word \"Basic\" and a space with your API key. You can [read more](https://docs.codat.io/using-the-api/authentication) about authentication at Codat and managing API keys via the Portal UI or API. ### Tips and pitfalls * It is possible to delete the last remaining API key. If this happens, a new key can be created via the [API key management page](https://app.codat.io/developers/api-keys) of the Portal. * It is possible to delete the API key used to authenticate the *Delete API key* request.
+ * Delete API key
+ */
+ private async deleteApiKeyRaw(requestParameters: DeleteApiKeyRequest, options?: runtime.RequestOptions): Promise> {
+ if (requestParameters['apiKeyId'] == null) {
+ throw new runtime.RequiredError(
+ 'apiKeyId',
+ 'Required parameter "apiKeyId" was null or undefined when calling deleteApiKey().'
+ );
+ }
+
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/apiKeys/{apiKeyId}`.replace(`{${"apiKeyId"}}`, encodeURIComponent(String(requestParameters['apiKeyId']))),
+ method: 'DELETE',
+ operationId: 'delete-api-key',
+ errorStatuses: [401, 402, 403, 404, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ }, options);
+
+ return new runtime.JSONApiResponse(response, (jsonValue) => ErrorMessageFromJSON(jsonValue));
+ }
+
+ /**
+ * Use the *Delete API keys* endpoint to delete an existing API key, providing its valid `id` as a parameter. Note that this operation is not reversible. [API keys](https://docs.codat.io/platform-api#/schemas/apiKeys) are tokens used to control access to the API. Include this token in the `Authorization` header parameter when making API calls, following the word \"Basic\" and a space with your API key. You can [read more](https://docs.codat.io/using-the-api/authentication) about authentication at Codat and managing API keys via the Portal UI or API. ### Tips and pitfalls * It is possible to delete the last remaining API key. If this happens, a new key can be created via the [API key management page](https://app.codat.io/developers/api-keys) of the Portal. * It is possible to delete the API key used to authenticate the *Delete API key* request.
+ * Delete API key
+ */
+ async deleteApiKey(requestParameters: DeleteApiKeyRequest, options?: runtime.RequestOptions): Promise {
+ const response = await this.deleteApiKeyRaw(requestParameters, options);
+ return await response.value();
+ }
+
+ /**
+ * The *Get CORS settings* endpoint returns the allowed origins (i.e. your domains) you want to allow cross-origin resource sharing ([CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing)) with Codat. Enabling CORS with Codat is required by our embeddable UIs (such as [Connections SDK](https://docs.codat.io/auth-flow/optimize/connection-management) and [Link SDK](https://docs.codat.io/auth-flow/authorize-embedded-link)) to access Codat\'s API endpoints.
+ * Get CORS settings
+ */
+ private async getCorsSettingsRaw(options?: runtime.RequestOptions): Promise> {
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/corsSettings`,
+ method: 'GET',
+ operationId: 'get-cors-settings',
+ errorStatuses: [401, 402, 403, 404, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ }, options);
+
+ return new runtime.JSONApiResponse(response, (jsonValue) => ConnectionManagementAllowedOriginsFromJSON(jsonValue));
+ }
+
+ /**
+ * The *Get CORS settings* endpoint returns the allowed origins (i.e. your domains) you want to allow cross-origin resource sharing ([CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing)) with Codat. Enabling CORS with Codat is required by our embeddable UIs (such as [Connections SDK](https://docs.codat.io/auth-flow/optimize/connection-management) and [Link SDK](https://docs.codat.io/auth-flow/authorize-embedded-link)) to access Codat\'s API endpoints.
+ * Get CORS settings
+ */
+ async get(options?: runtime.RequestOptions): Promise {
+ const response = await this.getCorsSettingsRaw(options);
+ return await response.value();
+ }
+
+ /**
+ * Fetch your Codat profile.
+ * Get profile
+ */
+ private async getProfileRaw(options?: runtime.RequestOptions): Promise> {
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/profile`,
+ method: 'GET',
+ operationId: 'get-profile',
+ errorStatuses: [401, 402, 403, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ }, options);
+
+ return new runtime.JSONApiResponse(response, (jsonValue) => ProfileFromJSON(jsonValue));
+ }
+
+ /**
+ * Fetch your Codat profile.
+ * Get profile
+ */
+ async getProfile(options?: runtime.RequestOptions): Promise {
+ const response = await this.getProfileRaw(options);
+ return await response.value();
+ }
+
+ /**
+ * Retrieve the [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings) for your client. This includes how often data types should be queued to be updated, and how much history should be fetched.
+ * Get sync settings
+ */
+ private async getProfileSyncSettingsRaw(options?: runtime.RequestOptions): Promise> {
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/profile/syncSettings`,
+ method: 'GET',
+ operationId: 'get-profile-syncSettings',
+ errorStatuses: [401, 402, 403, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ }, options);
+
+ return new runtime.JSONApiResponse(response, (jsonValue) => SyncSettingsFromJSON(jsonValue));
+ }
+
+ /**
+ * Retrieve the [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings) for your client. This includes how often data types should be queued to be updated, and how much history should be fetched.
+ * Get sync settings
+ */
+ async getSyncSettings(options?: runtime.RequestOptions): Promise {
+ const response = await this.getProfileSyncSettingsRaw(options);
+ return await response.value();
+ }
+
+ /**
+ * Use the *List API keys* endpoint to return a list of all API keys that currently exist for your client. This includes keys created via the Portal UI or the *Create API keys* endpoint. [API keys](https://docs.codat.io/platform-api#/schemas/apiKeys) are tokens used to control access to the API. Include this token in the `Authorization` header parameter when making API calls, following the word \"Basic\" and a space with your API key. You can [read more](https://docs.codat.io/using-the-api/authentication) about authentication at Codat and managing API keys via the Portal UI or API.
+ * List API keys
+ */
+ private async listApiKeysRaw(options?: runtime.RequestOptions): Promise> {
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/apiKeys`,
+ method: 'GET',
+ operationId: 'list-api-keys',
+ errorStatuses: [401, 402, 403, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ }, options);
+
+ return new runtime.JSONApiResponse(response, (jsonValue) => ApiKeysFromJSON(jsonValue));
+ }
+
+ /**
+ * Use the *List API keys* endpoint to return a list of all API keys that currently exist for your client. This includes keys created via the Portal UI or the *Create API keys* endpoint. [API keys](https://docs.codat.io/platform-api#/schemas/apiKeys) are tokens used to control access to the API. Include this token in the `Authorization` header parameter when making API calls, following the word \"Basic\" and a space with your API key. You can [read more](https://docs.codat.io/using-the-api/authentication) about authentication at Codat and managing API keys via the Portal UI or API.
+ * List API keys
+ */
+ async listApiKeys(options?: runtime.RequestOptions): Promise {
+ const response = await this.listApiKeysRaw(options);
+ return await response.value();
+ }
+
+ /**
+ * The *Set CORS settings* endpoint allows you to register allowed origins (i.e. your domains) for use in cross-origin resource sharing ([CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing)). Enabling CORS with Codat is required by our embeddable UIs (such as [Connections SDK](https://docs.codat.io/auth-flow/optimize/connection-management) and [Link SDK](https://docs.codat.io/auth-flow/authorize-embedded-link)) to access Codat\'s API endpoints.
+ * Set CORS settings
+ */
+ private async setCorsSettingsRaw(requestParameters: SetCorsSettingsRequest, options?: runtime.RequestOptions): Promise> {
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ headerParameters['Content-Type'] = 'application/json';
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/corsSettings`,
+ method: 'POST',
+ operationId: 'set-cors-settings',
+ errorStatuses: [401, 402, 403, 404, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ body: ConnectionManagementAllowedOriginsToJSON(requestParameters['connectionManagementAllowedOrigins']),
+ }, options);
+
+ return new runtime.JSONApiResponse(response, (jsonValue) => ConnectionManagementAllowedOriginsFromJSON(jsonValue));
+ }
+
+ /**
+ * The *Set CORS settings* endpoint allows you to register allowed origins (i.e. your domains) for use in cross-origin resource sharing ([CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing)). Enabling CORS with Codat is required by our embeddable UIs (such as [Connections SDK](https://docs.codat.io/auth-flow/optimize/connection-management) and [Link SDK](https://docs.codat.io/auth-flow/authorize-embedded-link)) to access Codat\'s API endpoints.
+ * Set CORS settings
+ */
+ async set(connectionManagementAllowedOrigins?: ConnectionManagementAllowedOrigins, options?: runtime.RequestOptions): Promise {
+ const response = await this.setCorsSettingsRaw({ connectionManagementAllowedOrigins: connectionManagementAllowedOrigins }, options);
+ return await response.value();
+ }
+
+ /**
+ * Update your Codat profile
+ * Update profile
+ */
+ private async updateProfileRaw(requestParameters: UpdateProfileRequest, options?: runtime.RequestOptions): Promise> {
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ headerParameters['Content-Type'] = 'application/json';
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/profile`,
+ method: 'PUT',
+ operationId: 'update-profile',
+ errorStatuses: [401, 402, 403, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ body: ProfileToJSON(requestParameters['profile']),
+ }, options);
+
+ return new runtime.JSONApiResponse(response, (jsonValue) => ProfileFromJSON(jsonValue));
+ }
+
+ /**
+ * Update your Codat profile
+ * Update profile
+ */
+ async updateProfile(profile?: Profile, options?: runtime.RequestOptions): Promise {
+ const response = await this.updateProfileRaw({ profile: profile }, options);
+ return await response.value();
+ }
+
+ /**
+ * Update sync settings for all data types.
+ * Update all sync settings
+ */
+ private async updateProfileSyncSettingsRaw(requestParameters: UpdateProfileSyncSettingsRequest, options?: runtime.RequestOptions): Promise> {
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ headerParameters['Content-Type'] = 'application/json';
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/profile/syncSettings`,
+ method: 'POST',
+ operationId: 'update-profile-syncSettings',
+ errorStatuses: [401, 402, 403, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ body: UpdateProfileSyncSettingsRequestBodyToJSON(requestParameters['requestBody']),
+ }, options);
+
+ return new runtime.VoidApiResponse(response);
+ }
+
+ /**
+ * Update sync settings for all data types.
+ * Update all sync settings
+ */
+ async updateSyncSettings(requestBody?: UpdateProfileSyncSettingsRequestBody, options?: runtime.RequestOptions): Promise {
+ await this.updateProfileSyncSettingsRaw({ requestBody: requestBody }, options);
+ }
+
+}
diff --git a/platform/src/apis/SupplementalData.ts b/platform/src/apis/SupplementalData.ts
new file mode 100644
index 000000000..f9dcc532b
--- /dev/null
+++ b/platform/src/apis/SupplementalData.ts
@@ -0,0 +1,199 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Platform API
+ * An API for the common components of all of Codat\'s products. These end points cover creating and managing your companies, data connections, and integrations. [Read about the building blocks of Codat...](https://docs.codat.io/core-concepts/companies) | [See our OpenAPI spec](https://github.com/codatio/oas) --- ## Endpoints | Endpoints | Description | | :- |:- | | Companies | Create and manage your SMB users\' companies. | | Connections | Create new and manage existing data connections for a company. | | Connection management | Configure connection management UI and retrieve access tokens for authentication. | | Webhooks | Create and manage webhooks that listen to Codat\'s events. | | Integrations | Get a list of integrations supported by Codat and their logos. | | Refresh data | Initiate data refreshes, view pull status and history. | | Settings | Manage company profile configuration, sync settings, and API keys. | | Push data | Initiate and monitor Create, Update, and Delete operations. | | Supplemental data | Configure and pull additional data you can include in Codat\'s standard data types. | | Custom data type | Configure and pull additional data types that are not included in Codat\'s standardized data model. |
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@codat.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import type { Company } from '../sdk/models/index';
+import * as runtime from '../runtime';
+import type { DataType, PathParamDataType } from '../sdk/models/index';
+import type {
+ ErrorMessage,
+ SupplementalDataConfiguration,
+} from '../sdk/models/index';
+import {
+ ErrorMessageFromJSON,
+ ErrorMessageToJSON,
+ SupplementalDataConfigurationFromJSON,
+ SupplementalDataConfigurationToJSON,
+} from '../sdk/models/index';
+
+export interface ConfigureSupplementalDataRequest {
+ platformKey: string;
+ dataType: DataType;
+ supplementalDataConfiguration?: SupplementalDataConfiguration;
+}
+
+export interface GetSupplementalDataConfigurationRequest {
+ platformKey: string;
+ dataType: PathParamDataType;
+}
+
+/**
+ *
+ */
+export class SupplementalData extends runtime.BaseAPI {
+
+ /**
+ * The *Configure* endpoint allows you to maintain or change configuration required to return supplemental data for each integration and data type combination. [Supplemental data](https://docs.codat.io/using-the-api/supplemental-data/overview) is additional data you can include in Codat\'s standard data types. **Integration-specific behavior** See the *examples* for integration-specific frequently requested properties.
+ * Configure
+ */
+ private async configureSupplementalDataRaw(requestParameters: ConfigureSupplementalDataRequest, options?: runtime.RequestOptions): Promise> {
+ if (requestParameters['platformKey'] == null) {
+ throw new runtime.RequiredError(
+ 'platformKey',
+ 'Required parameter "platformKey" was null or undefined when calling configureSupplementalData().'
+ );
+ }
+
+ if (requestParameters['dataType'] == null) {
+ throw new runtime.RequiredError(
+ 'dataType',
+ 'Required parameter "dataType" was null or undefined when calling configureSupplementalData().'
+ );
+ }
+
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ headerParameters['Content-Type'] = 'application/json';
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/integrations/{platformKey}/dataTypes/{dataType}/supplementalDataConfig`.replace(`{${"platformKey"}}`, encodeURIComponent(String(requestParameters['platformKey']))).replace(`{${"dataType"}}`, encodeURIComponent(String(requestParameters['dataType']))),
+ method: 'PUT',
+ operationId: 'configure-supplemental-data',
+ errorStatuses: [401, 402, 403, 404, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ body: SupplementalDataConfigurationToJSON(requestParameters['supplementalDataConfiguration']),
+ }, options);
+
+ return new runtime.VoidApiResponse(response);
+ }
+
+ /**
+ * The *Configure* endpoint allows you to maintain or change configuration required to return supplemental data for each integration and data type combination. [Supplemental data](https://docs.codat.io/using-the-api/supplemental-data/overview) is additional data you can include in Codat\'s standard data types. **Integration-specific behavior** See the *examples* for integration-specific frequently requested properties.
+ * Configure
+ */
+ async configure(requestParameters: ConfigureSupplementalDataRequest, options?: runtime.RequestOptions): Promise {
+ await this.configureSupplementalDataRaw(requestParameters, options);
+ }
+
+ /**
+ * The *Get configuration* endpoint returns supplemental data configuration previously created for each integration and data type combination. [Supplemental data](https://docs.codat.io/using-the-api/supplemental-data/overview) is additional data you can include in Codat\'s standard data types.
+ * Get configuration
+ */
+ private async getSupplementalDataConfigurationRaw(requestParameters: GetSupplementalDataConfigurationRequest, options?: runtime.RequestOptions): Promise> {
+ if (requestParameters['platformKey'] == null) {
+ throw new runtime.RequiredError(
+ 'platformKey',
+ 'Required parameter "platformKey" was null or undefined when calling getSupplementalDataConfiguration().'
+ );
+ }
+
+ if (requestParameters['dataType'] == null) {
+ throw new runtime.RequiredError(
+ 'dataType',
+ 'Required parameter "dataType" was null or undefined when calling getSupplementalDataConfiguration().'
+ );
+ }
+
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/integrations/{platformKey}/dataTypes/{dataType}/supplementalDataConfig`.replace(`{${"platformKey"}}`, encodeURIComponent(String(requestParameters['platformKey']))).replace(`{${"dataType"}}`, encodeURIComponent(String(requestParameters['dataType']))),
+ method: 'GET',
+ operationId: 'get-supplemental-data-configuration',
+ errorStatuses: [401, 402, 403, 404, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ }, options);
+
+ return new runtime.JSONApiResponse(response, (jsonValue) => SupplementalDataConfigurationFromJSON(jsonValue));
+ }
+
+ /**
+ * The *Get configuration* endpoint returns supplemental data configuration previously created for each integration and data type combination. [Supplemental data](https://docs.codat.io/using-the-api/supplemental-data/overview) is additional data you can include in Codat\'s standard data types.
+ * Get configuration
+ */
+ async getConfiguration(requestParameters: GetSupplementalDataConfigurationRequest, options?: runtime.RequestOptions): Promise {
+ const response = await this.getSupplementalDataConfigurationRaw(requestParameters, options);
+ return await response.value();
+ }
+
+}
+
+/**
+ * @export
+ */
+export const ConfigureSupplementalDataDataTypeEnum = {
+ ChartOfAccounts: 'chartOfAccounts',
+ Bills: 'bills',
+ Company: 'company',
+ CreditNotes: 'creditNotes',
+ Customers: 'customers',
+ Invoices: 'invoices',
+ Items: 'items',
+ JournalEntries: 'journalEntries',
+ Suppliers: 'suppliers',
+ TaxRates: 'taxRates',
+ CommerceCompanyInfo: 'commerce-companyInfo',
+ CommerceCustomers: 'commerce-customers',
+ CommerceDisputes: 'commerce-disputes',
+ CommerceLocations: 'commerce-locations',
+ CommerceOrders: 'commerce-orders',
+ CommercePayments: 'commerce-payments',
+ CommercePaymentMethods: 'commerce-paymentMethods',
+ CommerceProducts: 'commerce-products',
+ CommerceProductCategories: 'commerce-productCategories',
+ CommerceTaxComponents: 'commerce-taxComponents',
+ CommerceTransactions: 'commerce-transactions'
+} as const;
+export type ConfigureSupplementalDataDataTypeEnum = typeof ConfigureSupplementalDataDataTypeEnum[keyof typeof ConfigureSupplementalDataDataTypeEnum];
+/**
+ * @export
+ */
+export const GetSupplementalDataConfigurationDataTypeEnum = {
+ ChartOfAccounts: 'chartOfAccounts',
+ Bills: 'bills',
+ Company: 'company',
+ CreditNotes: 'creditNotes',
+ Customers: 'customers',
+ Invoices: 'invoices',
+ Items: 'items',
+ JournalEntries: 'journalEntries',
+ Suppliers: 'suppliers',
+ TaxRates: 'taxRates',
+ CommerceCompanyInfo: 'commerce-companyInfo',
+ CommerceCustomers: 'commerce-customers',
+ CommerceDisputes: 'commerce-disputes',
+ CommerceLocations: 'commerce-locations',
+ CommerceOrders: 'commerce-orders',
+ CommercePayments: 'commerce-payments',
+ CommercePaymentMethods: 'commerce-paymentMethods',
+ CommerceProducts: 'commerce-products',
+ CommerceProductCategories: 'commerce-productCategories',
+ CommerceTaxComponents: 'commerce-taxComponents',
+ CommerceTransactions: 'commerce-transactions'
+} as const;
+export type GetSupplementalDataConfigurationDataTypeEnum = typeof GetSupplementalDataConfigurationDataTypeEnum[keyof typeof GetSupplementalDataConfigurationDataTypeEnum];
diff --git a/platform/src/apis/Webhooks.ts b/platform/src/apis/Webhooks.ts
new file mode 100644
index 000000000..1727d9fdd
--- /dev/null
+++ b/platform/src/apis/Webhooks.ts
@@ -0,0 +1,195 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Platform API
+ * An API for the common components of all of Codat\'s products. These end points cover creating and managing your companies, data connections, and integrations. [Read about the building blocks of Codat...](https://docs.codat.io/core-concepts/companies) | [See our OpenAPI spec](https://github.com/codatio/oas) --- ## Endpoints | Endpoints | Description | | :- |:- | | Companies | Create and manage your SMB users\' companies. | | Connections | Create new and manage existing data connections for a company. | | Connection management | Configure connection management UI and retrieve access tokens for authentication. | | Webhooks | Create and manage webhooks that listen to Codat\'s events. | | Integrations | Get a list of integrations supported by Codat and their logos. | | Refresh data | Initiate data refreshes, view pull status and history. | | Settings | Manage company profile configuration, sync settings, and API keys. | | Push data | Initiate and monitor Create, Update, and Delete operations. | | Supplemental data | Configure and pull additional data you can include in Codat\'s standard data types. | | Custom data type | Configure and pull additional data types that are not included in Codat\'s standardized data model. |
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@codat.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+ ErrorMessage,
+ WebhookConsumer,
+ WebhookConsumerPrototype,
+ WebhookConsumers,
+ WebhookZapierKey,
+} from '../sdk/models/index';
+import {
+ ErrorMessageFromJSON,
+ ErrorMessageToJSON,
+ WebhookConsumerFromJSON,
+ WebhookConsumerToJSON,
+ WebhookConsumerPrototypeFromJSON,
+ WebhookConsumerPrototypeToJSON,
+ WebhookConsumersFromJSON,
+ WebhookConsumersToJSON,
+ WebhookZapierKeyFromJSON,
+ WebhookZapierKeyToJSON,
+} from '../sdk/models/index';
+
+export interface CreateWebhookConsumerRequest {
+ webhookConsumerPrototype?: WebhookConsumerPrototype;
+}
+
+export interface DeleteWebhookConsumerRequest {
+ webhookId: string;
+}
+
+/**
+ *
+ */
+export class Webhooks extends runtime.BaseAPI {
+
+ /**
+ * Use the *Create webhook consumer* endpoint to create a new webhook consumer that will listen to messages we send you. [Webhook consumer](https://docs.codat.io/platform-api#/schemas/WebhookConsumer) is an HTTP endpoint that you configure to subscribe to specific events. See our documentation for more details on [Codat\'s webhook service](https://docs.codat.io/using-the-api/webhooks/overview). ### Tips and traps - The number of webhook consumers you can create is limited to 50. If you have reached the maximum number of consumers, use the [*Delete webhook consumer*](https://docs.codat.io/platform-api#/operations/delete-webhook-consumer) endpoint to delete an unused consumer first.
+ * Create webhook consumer
+ */
+ private async createWebhookConsumerRaw(requestParameters: CreateWebhookConsumerRequest, options?: runtime.RequestOptions): Promise> {
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ headerParameters['Content-Type'] = 'application/json';
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/webhooks`,
+ method: 'POST',
+ operationId: 'create-webhook-consumer',
+ errorStatuses: [400, 401, 402, 403, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ body: WebhookConsumerPrototypeToJSON(requestParameters['webhookConsumerPrototype']),
+ }, options);
+
+ return new runtime.JSONApiResponse(response, (jsonValue) => WebhookConsumerFromJSON(jsonValue));
+ }
+
+ /**
+ * Use the *Create webhook consumer* endpoint to create a new webhook consumer that will listen to messages we send you. [Webhook consumer](https://docs.codat.io/platform-api#/schemas/WebhookConsumer) is an HTTP endpoint that you configure to subscribe to specific events. See our documentation for more details on [Codat\'s webhook service](https://docs.codat.io/using-the-api/webhooks/overview). ### Tips and traps - The number of webhook consumers you can create is limited to 50. If you have reached the maximum number of consumers, use the [*Delete webhook consumer*](https://docs.codat.io/platform-api#/operations/delete-webhook-consumer) endpoint to delete an unused consumer first.
+ * Create webhook consumer
+ */
+ async createConsumer(webhookConsumerPrototype?: WebhookConsumerPrototype, options?: runtime.RequestOptions): Promise {
+ const response = await this.createWebhookConsumerRaw({ webhookConsumerPrototype: webhookConsumerPrototype }, options);
+ return await response.value();
+ }
+
+ /**
+ * Use the *Delete webhook consumer* endpoint to delete an existing webhoook consumer, providing its valid `id` as a parameter. [Webhook consumer](https://docs.codat.io/platform-api#/schemas/WebhookConsumer) is an HTTP endpoint that you configure to subscribe to specific events. See our documentation for more details on [Codat\'s webhook service](https://docs.codat.io/using-the-api/webhooks/overview).
+ * Delete webhook consumer
+ */
+ private async deleteWebhookConsumerRaw(requestParameters: DeleteWebhookConsumerRequest, options?: runtime.RequestOptions): Promise> {
+ if (requestParameters['webhookId'] == null) {
+ throw new runtime.RequiredError(
+ 'webhookId',
+ 'Required parameter "webhookId" was null or undefined when calling deleteWebhookConsumer().'
+ );
+ }
+
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/webhooks/{webhookId}`.replace(`{${"webhookId"}}`, encodeURIComponent(String(requestParameters['webhookId']))),
+ method: 'DELETE',
+ operationId: 'delete-webhook-consumer',
+ errorStatuses: [401, 402, 403, 404, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ }, options);
+
+ return new runtime.VoidApiResponse(response);
+ }
+
+ /**
+ * Use the *Delete webhook consumer* endpoint to delete an existing webhoook consumer, providing its valid `id` as a parameter. [Webhook consumer](https://docs.codat.io/platform-api#/schemas/WebhookConsumer) is an HTTP endpoint that you configure to subscribe to specific events. See our documentation for more details on [Codat\'s webhook service](https://docs.codat.io/using-the-api/webhooks/overview).
+ * Delete webhook consumer
+ */
+ async deleteConsumer(requestParameters: DeleteWebhookConsumerRequest, options?: runtime.RequestOptions): Promise {
+ await this.deleteWebhookConsumerRaw(requestParameters, options);
+ }
+
+ /**
+ * Use the *List webhook consumers* endpoint to return a list of all webhook consumers that currently exist for your client. [Webhook consumer](https://docs.codat.io/platform-api#/schemas/WebhookConsumer) is an HTTP endpoint that you configure to subscribe to specific events. See our documentation for more details on [Codat\'s webhook service](https://docs.codat.io/using-the-api/webhooks/overview).
+ * List webhook consumers
+ */
+ private async listWebhookConsumersRaw(options?: runtime.RequestOptions): Promise> {
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/webhooks`,
+ method: 'GET',
+ operationId: 'list-webhook-consumers',
+ errorStatuses: [400, 401, 402, 403, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ }, options);
+
+ return new runtime.JSONApiResponse(response, (jsonValue) => WebhookConsumersFromJSON(jsonValue));
+ }
+
+ /**
+ * Use the *List webhook consumers* endpoint to return a list of all webhook consumers that currently exist for your client. [Webhook consumer](https://docs.codat.io/platform-api#/schemas/WebhookConsumer) is an HTTP endpoint that you configure to subscribe to specific events. See our documentation for more details on [Codat\'s webhook service](https://docs.codat.io/using-the-api/webhooks/overview).
+ * List webhook consumers
+ */
+ async listConsumers(options?: runtime.RequestOptions): Promise {
+ const response = await this.listWebhookConsumersRaw(options);
+ return await response.value();
+ }
+
+ /**
+ * The *Rotate Zapier key* endpoint returns the Zapier integration key needed to configure Zaps triggered by Codat\'s webhooks. If a key has already been created, calling this will revoke that existing key. The key changes each time this endpoint is called. If you are already using our Zapier integration and called this endpoint again, you need to reauthenticate using the latest integration key returned in the response. Our Zapier integration makes it simple for you to set up and receive user notifications in your preferred ways, such as via email or Slack. See our [Zapier documentation](https://docs.codat.io/using-the-api/webhooks/zapier-integration) for detailed instructions on setting up this integration.
+ * Rotate Zapier key
+ */
+ private async rotateZapierKeyRaw(options?: runtime.RequestOptions): Promise> {
+ const queryParameters: any = {};
+
+ const headerParameters: runtime.HTTPHeaders = {};
+
+ if (this.configuration && this.configuration.apiKey) {
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth_header authentication
+ }
+
+ const response = await this.request({
+ path: `/webhooks/integrationKeys/zapier`,
+ method: 'POST',
+ operationId: 'rotate-zapier-key',
+ errorStatuses: [401, 402, 403, 429, 500, 503, ],
+ headers: headerParameters,
+ query: queryParameters,
+ }, options);
+
+ return new runtime.JSONApiResponse(response, (jsonValue) => WebhookZapierKeyFromJSON(jsonValue));
+ }
+
+ /**
+ * The *Rotate Zapier key* endpoint returns the Zapier integration key needed to configure Zaps triggered by Codat\'s webhooks. If a key has already been created, calling this will revoke that existing key. The key changes each time this endpoint is called. If you are already using our Zapier integration and called this endpoint again, you need to reauthenticate using the latest integration key returned in the response. Our Zapier integration makes it simple for you to set up and receive user notifications in your preferred ways, such as via email or Slack. See our [Zapier documentation](https://docs.codat.io/using-the-api/webhooks/zapier-integration) for detailed instructions on setting up this integration.
+ * Rotate Zapier key
+ */
+ async rotateZapierKey(options?: runtime.RequestOptions): Promise {
+ const response = await this.rotateZapierKeyRaw(options);
+ return await response.value();
+ }
+
+}
diff --git a/platform/src/apis/index.ts b/platform/src/apis/index.ts
new file mode 100644
index 000000000..e2f681789
--- /dev/null
+++ b/platform/src/apis/index.ts
@@ -0,0 +1,14 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './Companies';
+export * from './ConnectionManagement';
+export * from './Connections';
+export * from './Cors';
+export * from './CustomDataType';
+export * from './Integrations';
+export * from './PushData';
+export * from './ReadData';
+export * from './RefreshData';
+export * from './Settings';
+export * from './SupplementalData';
+export * from './Webhooks';
diff --git a/platform/src/core.ts b/platform/src/core.ts
index dee072a47..94c021335 100644
--- a/platform/src/core.ts
+++ b/platform/src/core.ts
@@ -1,13 +1,4 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
+/* tslint:disable */
+/* eslint-disable */
-import { ClientSDK } from "./lib/sdks.js";
-
-/**
- * A minimal client to use when calling standalone SDK functions. Typically, an
- * instance of this class would be instantiated once at the start of an
- * application and passed around through some dependency injection mechanism to
- * parts of an application that need to make SDK calls.
- */
-export class CodatPlatformCore extends ClientSDK {}
+export { CodatPlatform, CodatPlatform as CodatPlatformCore } from './sdk';
diff --git a/platform/src/funcs/_adapter.ts b/platform/src/funcs/_adapter.ts
new file mode 100644
index 000000000..56e5acd53
--- /dev/null
+++ b/platform/src/funcs/_adapter.ts
@@ -0,0 +1,13 @@
+/* tslint:disable */
+/* eslint-disable */
+
+import { OK, ERR } from "../sdk/types/fp";
+import type { Result } from "../sdk/types/fp";
+
+export async function toResult(call: () => Promise): Promise> {
+ try {
+ return OK(await call());
+ } catch (err) {
+ return ERR(err instanceof Error ? err : new Error(String(err)));
+ }
+}
diff --git a/platform/src/funcs/companiesAddProduct.ts b/platform/src/funcs/companiesAddProduct.ts
index 4bb693769..19f46e0ec 100644
--- a/platform/src/funcs/companiesAddProduct.ts
+++ b/platform/src/funcs/companiesAddProduct.ts
@@ -1,197 +1,17 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
+/* tslint:disable */
+/* eslint-disable */
-import * as z from "zod/v3";
-import { CodatPlatformCore } from "../core.js";
-import { encodeSimple } from "../lib/encodings.js";
-import { matchStatusCode } from "../lib/http.js";
-import * as M from "../lib/matchers.js";
-import { compactMap } from "../lib/primitives.js";
-import { safeParse } from "../lib/schemas.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
-import { pathToFunc } from "../lib/url.js";
-import { CodatPlatformError } from "../sdk/models/errors/codatplatformerror.js";
-import {
- ConnectionError,
- InvalidRequestError,
- RequestAbortedError,
- RequestTimeoutError,
- UnexpectedClientError,
-} from "../sdk/models/errors/httpclienterrors.js";
-import * as errors from "../sdk/models/errors/index.js";
-import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
-import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
-import * as operations from "../sdk/models/operations/index.js";
-import { APICall, APIPromise } from "../sdk/types/async.js";
-import { Result } from "../sdk/types/fp.js";
+import type { CodatPlatform, CodatPlatformCore } from "../core";
+import { APIPromise } from "../sdk/types/async";
+import type { Result } from "../sdk/types/fp";
+import { toResult } from "./_adapter";
-/**
- * Add product
- *
- * @remarks
- * Use the *Add product* endpoint to enable a product for the company specified by `companyId`.
- *
- * > Note: This feature is currently in alpha and available only to participants in the development program.
- */
-export function companiesAddProduct(
- client: CodatPlatformCore,
- request: operations.AddProductRequest,
- options?: RequestOptions,
-): APIPromise<
- Result<
- void,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >
-> {
- return new APIPromise($do(
- client,
- request,
- options,
- ));
-}
-
-async function $do(
- client: CodatPlatformCore,
- request: operations.AddProductRequest,
- options?: RequestOptions,
-): Promise<
- [
- Result<
- void,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >,
- APICall,
- ]
-> {
- const parsed = safeParse(
- request,
- (value) => operations.AddProductRequest$outboundSchema.parse(value),
- "Input validation failed",
- );
- if (!parsed.ok) {
- return [parsed, { status: "invalid" }];
- }
- const payload = parsed.value;
- const body = null;
-
- const pathParams = {
- companyId: encodeSimple("companyId", payload.companyId, {
- explode: false,
- charEncoding: "percent",
- }),
- productIdentifier: encodeSimple(
- "productIdentifier",
- payload.productIdentifier,
- { explode: false, charEncoding: "percent" },
- ),
- };
- const path = pathToFunc(
- "/companies/{companyId}/products/{productIdentifier}",
- )(pathParams);
-
- const headers = new Headers(compactMap({
- Accept: "application/json",
- }));
-
- const secConfig = await extractSecurity(client._options.authHeader);
- const securityInput = secConfig == null ? {} : { authHeader: secConfig };
- const requestSecurity = resolveGlobalSecurity(securityInput);
-
- const context = {
- options: client._options,
- baseURL: options?.serverURL ?? client._baseURL ?? "",
- operationID: "add-product",
- oAuth2Scopes: null,
+type Call = CodatPlatform["companies"]["addProduct"];
- resolvedSecurity: requestSecurity,
-
- securitySource: client._options.authHeader,
- retryConfig: options?.retries
- || client._options.retryConfig
- || {
- strategy: "backoff",
- backoff: {
- initialInterval: 500,
- maxInterval: 60000,
- exponent: 1.5,
- maxElapsedTime: 3600000,
- },
- retryConnectionErrors: true,
- }
- || { strategy: "none" },
- retryCodes: options?.retryCodes || ["408", "429", "5XX"],
- };
-
- const requestRes = client._createRequest(context, {
- security: requestSecurity,
- method: "PUT",
- baseURL: options?.serverURL,
- path: path,
- headers: headers,
- body: body,
- userAgent: client._options.userAgent,
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
- }, options);
- if (!requestRes.ok) {
- return [requestRes, { status: "invalid" }];
- }
- const req = requestRes.value;
-
- const doResult = await client._do(req, {
- context,
- isErrorStatusCode: (statusCode: number) =>
- matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
- retryConfig: context.retryConfig,
- retryCodes: context.retryCodes,
- });
- if (!doResult.ok) {
- return [doResult, { status: "request-error", request: req }];
- }
- const response = doResult.value;
-
- const responseFields = {
- HttpMeta: { Response: response, Request: req },
- };
-
- const [result] = await M.match<
- void,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >(
- M.nil(204, z.void()),
- M.jsonErr([401, 402, 403, 404, 429], errors.ErrorMessage$inboundSchema),
- M.jsonErr([500, 503], errors.ErrorMessage$inboundSchema),
- M.fail("4XX"),
- M.fail("5XX"),
- )(response, req, { extraFields: responseFields });
- if (!result.ok) {
- return [result, { status: "complete", request: req, response }];
- }
-
- return [result, { status: "complete", request: req, response }];
+export function companiesAddProduct(
+ client: CodatPlatformCore,
+ request: Parameters[0],
+ options?: Parameters[1],
+): APIPromise>, Error>> {
+ return new APIPromise(toResult(() => client.companies.addProduct(request, options)));
}
diff --git a/platform/src/funcs/companiesCreate.ts b/platform/src/funcs/companiesCreate.ts
index 274b8d339..4d14b90ef 100644
--- a/platform/src/funcs/companiesCreate.ts
+++ b/platform/src/funcs/companiesCreate.ts
@@ -1,189 +1,17 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
+/* tslint:disable */
+/* eslint-disable */
-import { CodatPlatformCore } from "../core.js";
-import { encodeJSON } from "../lib/encodings.js";
-import { matchStatusCode } from "../lib/http.js";
-import * as M from "../lib/matchers.js";
-import { compactMap } from "../lib/primitives.js";
-import { safeParse } from "../lib/schemas.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
-import { pathToFunc } from "../lib/url.js";
-import { CodatPlatformError } from "../sdk/models/errors/codatplatformerror.js";
-import {
- ConnectionError,
- InvalidRequestError,
- RequestAbortedError,
- RequestTimeoutError,
- UnexpectedClientError,
-} from "../sdk/models/errors/httpclienterrors.js";
-import * as errors from "../sdk/models/errors/index.js";
-import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
-import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
-import * as shared from "../sdk/models/shared/index.js";
-import { APICall, APIPromise } from "../sdk/types/async.js";
-import { Result } from "../sdk/types/fp.js";
+import type { CodatPlatform, CodatPlatformCore } from "../core";
+import { APIPromise } from "../sdk/types/async";
+import type { Result } from "../sdk/types/fp";
+import { toResult } from "./_adapter";
-/**
- * Create company
- *
- * @remarks
- * Use the *Create company* endpoint to create a new [company](https://docs.codat.io/platform-api#/schemas/Company) that represents your customer in Codat.
- *
- * A [company](https://docs.codat.io/platform-api#/schemas/Company) represents a business sharing access to their data.
- * Each company can have multiple [connections](https://docs.codat.io/platform-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.
- *
- * If forbidden characters (see `name` pattern) are present in the request, a company will be created with the forbidden characters removed. For example, `Company (Codat[1])` with be created as `Company Codat1`.
- */
-export function companiesCreate(
- client: CodatPlatformCore,
- request?: shared.CompanyRequestBody | undefined,
- options?: RequestOptions,
-): APIPromise<
- Result<
- shared.Company,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >
-> {
- return new APIPromise($do(
- client,
- request,
- options,
- ));
-}
-
-async function $do(
- client: CodatPlatformCore,
- request?: shared.CompanyRequestBody | undefined,
- options?: RequestOptions,
-): Promise<
- [
- Result<
- shared.Company,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >,
- APICall,
- ]
-> {
- const parsed = safeParse(
- request,
- (value) => shared.CompanyRequestBody$outboundSchema.optional().parse(value),
- "Input validation failed",
- );
- if (!parsed.ok) {
- return [parsed, { status: "invalid" }];
- }
- const payload = parsed.value;
- const body = payload === undefined
- ? null
- : encodeJSON("body", payload, { explode: true });
-
- const path = pathToFunc("/companies")();
-
- const headers = new Headers(compactMap({
- "Content-Type": "application/json",
- Accept: "application/json",
- }));
-
- const secConfig = await extractSecurity(client._options.authHeader);
- const securityInput = secConfig == null ? {} : { authHeader: secConfig };
- const requestSecurity = resolveGlobalSecurity(securityInput);
-
- const context = {
- options: client._options,
- baseURL: options?.serverURL ?? client._baseURL ?? "",
- operationID: "create-company",
- oAuth2Scopes: null,
+type Call = CodatPlatform["companies"]["create"];
- resolvedSecurity: requestSecurity,
-
- securitySource: client._options.authHeader,
- retryConfig: options?.retries
- || client._options.retryConfig
- || {
- strategy: "backoff",
- backoff: {
- initialInterval: 500,
- maxInterval: 60000,
- exponent: 1.5,
- maxElapsedTime: 3600000,
- },
- retryConnectionErrors: true,
- }
- || { strategy: "none" },
- retryCodes: options?.retryCodes || ["408", "429", "5XX"],
- };
-
- const requestRes = client._createRequest(context, {
- security: requestSecurity,
- method: "POST",
- baseURL: options?.serverURL,
- path: path,
- headers: headers,
- body: body,
- userAgent: client._options.userAgent,
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
- }, options);
- if (!requestRes.ok) {
- return [requestRes, { status: "invalid" }];
- }
- const req = requestRes.value;
-
- const doResult = await client._do(req, {
- context,
- isErrorStatusCode: (statusCode: number) =>
- matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
- retryConfig: context.retryConfig,
- retryCodes: context.retryCodes,
- });
- if (!doResult.ok) {
- return [doResult, { status: "request-error", request: req }];
- }
- const response = doResult.value;
-
- const responseFields = {
- HttpMeta: { Response: response, Request: req },
- };
-
- const [result] = await M.match<
- shared.Company,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >(
- M.json(200, shared.Company$inboundSchema),
- M.jsonErr([400, 401, 402, 403, 429], errors.ErrorMessage$inboundSchema),
- M.jsonErr([500, 503], errors.ErrorMessage$inboundSchema),
- M.fail("4XX"),
- M.fail("5XX"),
- )(response, req, { extraFields: responseFields });
- if (!result.ok) {
- return [result, { status: "complete", request: req, response }];
- }
-
- return [result, { status: "complete", request: req, response }];
+export function companiesCreate(
+ client: CodatPlatformCore,
+ request?: Parameters[0],
+ options?: Parameters[1],
+): APIPromise>, Error>> {
+ return new APIPromise(toResult(() => client.companies.create(request, options)));
}
diff --git a/platform/src/funcs/companiesDelete.ts b/platform/src/funcs/companiesDelete.ts
index 64e235414..1daf515df 100644
--- a/platform/src/funcs/companiesDelete.ts
+++ b/platform/src/funcs/companiesDelete.ts
@@ -1,191 +1,17 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
+/* tslint:disable */
+/* eslint-disable */
-import * as z from "zod/v3";
-import { CodatPlatformCore } from "../core.js";
-import { encodeSimple } from "../lib/encodings.js";
-import { matchStatusCode } from "../lib/http.js";
-import * as M from "../lib/matchers.js";
-import { compactMap } from "../lib/primitives.js";
-import { safeParse } from "../lib/schemas.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
-import { pathToFunc } from "../lib/url.js";
-import { CodatPlatformError } from "../sdk/models/errors/codatplatformerror.js";
-import {
- ConnectionError,
- InvalidRequestError,
- RequestAbortedError,
- RequestTimeoutError,
- UnexpectedClientError,
-} from "../sdk/models/errors/httpclienterrors.js";
-import * as errors from "../sdk/models/errors/index.js";
-import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
-import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
-import * as operations from "../sdk/models/operations/index.js";
-import { APICall, APIPromise } from "../sdk/types/async.js";
-import { Result } from "../sdk/types/fp.js";
+import type { CodatPlatform, CodatPlatformCore } from "../core";
+import { APIPromise } from "../sdk/types/async";
+import type { Result } from "../sdk/types/fp";
+import { toResult } from "./_adapter";
-/**
- * Delete a company
- *
- * @remarks
- * The *Delete company* endpoint permanently deletes a [company](https://docs.codat.io/platform-api#/schemas/Company), its [connections](https://docs.codat.io/platform-api#/schemas/Connection) and any cached data. This operation is irreversible.
- *
- * A [company](https://docs.codat.io/platform-api#/schemas/Company) represents a business sharing access to their data.
- * Each company can have multiple [connections](https://docs.codat.io/platform-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.
- */
-export function companiesDelete(
- client: CodatPlatformCore,
- request: operations.DeleteCompanyRequest,
- options?: RequestOptions,
-): APIPromise<
- Result<
- void,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >
-> {
- return new APIPromise($do(
- client,
- request,
- options,
- ));
-}
-
-async function $do(
- client: CodatPlatformCore,
- request: operations.DeleteCompanyRequest,
- options?: RequestOptions,
-): Promise<
- [
- Result<
- void,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >,
- APICall,
- ]
-> {
- const parsed = safeParse(
- request,
- (value) => operations.DeleteCompanyRequest$outboundSchema.parse(value),
- "Input validation failed",
- );
- if (!parsed.ok) {
- return [parsed, { status: "invalid" }];
- }
- const payload = parsed.value;
- const body = null;
-
- const pathParams = {
- companyId: encodeSimple("companyId", payload.companyId, {
- explode: false,
- charEncoding: "percent",
- }),
- };
- const path = pathToFunc("/companies/{companyId}")(pathParams);
-
- const headers = new Headers(compactMap({
- Accept: "application/json",
- }));
-
- const secConfig = await extractSecurity(client._options.authHeader);
- const securityInput = secConfig == null ? {} : { authHeader: secConfig };
- const requestSecurity = resolveGlobalSecurity(securityInput);
-
- const context = {
- options: client._options,
- baseURL: options?.serverURL ?? client._baseURL ?? "",
- operationID: "delete-company",
- oAuth2Scopes: null,
+type Call = CodatPlatform["companies"]["delete"];
- resolvedSecurity: requestSecurity,
-
- securitySource: client._options.authHeader,
- retryConfig: options?.retries
- || client._options.retryConfig
- || {
- strategy: "backoff",
- backoff: {
- initialInterval: 500,
- maxInterval: 60000,
- exponent: 1.5,
- maxElapsedTime: 3600000,
- },
- retryConnectionErrors: true,
- }
- || { strategy: "none" },
- retryCodes: options?.retryCodes || ["408", "429", "5XX"],
- };
-
- const requestRes = client._createRequest(context, {
- security: requestSecurity,
- method: "DELETE",
- baseURL: options?.serverURL,
- path: path,
- headers: headers,
- body: body,
- userAgent: client._options.userAgent,
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
- }, options);
- if (!requestRes.ok) {
- return [requestRes, { status: "invalid" }];
- }
- const req = requestRes.value;
-
- const doResult = await client._do(req, {
- context,
- isErrorStatusCode: (statusCode: number) =>
- matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
- retryConfig: context.retryConfig,
- retryCodes: context.retryCodes,
- });
- if (!doResult.ok) {
- return [doResult, { status: "request-error", request: req }];
- }
- const response = doResult.value;
-
- const responseFields = {
- HttpMeta: { Response: response, Request: req },
- };
-
- const [result] = await M.match<
- void,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >(
- M.nil(204, z.void()),
- M.jsonErr([401, 402, 403, 404, 429], errors.ErrorMessage$inboundSchema),
- M.jsonErr([500, 503], errors.ErrorMessage$inboundSchema),
- M.fail("4XX"),
- M.fail("5XX"),
- )(response, req, { extraFields: responseFields });
- if (!result.ok) {
- return [result, { status: "complete", request: req, response }];
- }
-
- return [result, { status: "complete", request: req, response }];
+export function companiesDelete(
+ client: CodatPlatformCore,
+ request: Parameters[0],
+ options?: Parameters[1],
+): APIPromise>, Error>> {
+ return new APIPromise(toResult(() => client.companies.delete(request, options)));
}
diff --git a/platform/src/funcs/companiesGet.ts b/platform/src/funcs/companiesGet.ts
index f764cdc17..d635b4e48 100644
--- a/platform/src/funcs/companiesGet.ts
+++ b/platform/src/funcs/companiesGet.ts
@@ -1,191 +1,17 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
+/* tslint:disable */
+/* eslint-disable */
-import { CodatPlatformCore } from "../core.js";
-import { encodeSimple } from "../lib/encodings.js";
-import { matchStatusCode } from "../lib/http.js";
-import * as M from "../lib/matchers.js";
-import { compactMap } from "../lib/primitives.js";
-import { safeParse } from "../lib/schemas.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
-import { pathToFunc } from "../lib/url.js";
-import { CodatPlatformError } from "../sdk/models/errors/codatplatformerror.js";
-import {
- ConnectionError,
- InvalidRequestError,
- RequestAbortedError,
- RequestTimeoutError,
- UnexpectedClientError,
-} from "../sdk/models/errors/httpclienterrors.js";
-import * as errors from "../sdk/models/errors/index.js";
-import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
-import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
-import * as operations from "../sdk/models/operations/index.js";
-import * as shared from "../sdk/models/shared/index.js";
-import { APICall, APIPromise } from "../sdk/types/async.js";
-import { Result } from "../sdk/types/fp.js";
+import type { CodatPlatform, CodatPlatformCore } from "../core";
+import { APIPromise } from "../sdk/types/async";
+import type { Result } from "../sdk/types/fp";
+import { toResult } from "./_adapter";
-/**
- * Get company
- *
- * @remarks
- * The *Get company* endpoint returns a single company for a given `companyId`.
- *
- * A [company](https://docs.codat.io/platform-api#/schemas/Company) represents a business sharing access to their data.
- * Each company can have multiple [connections](https://docs.codat.io/platform-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.
- */
-export function companiesGet(
- client: CodatPlatformCore,
- request: operations.GetCompanyRequest,
- options?: RequestOptions,
-): APIPromise<
- Result<
- shared.Company,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >
-> {
- return new APIPromise($do(
- client,
- request,
- options,
- ));
-}
-
-async function $do(
- client: CodatPlatformCore,
- request: operations.GetCompanyRequest,
- options?: RequestOptions,
-): Promise<
- [
- Result<
- shared.Company,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >,
- APICall,
- ]
-> {
- const parsed = safeParse(
- request,
- (value) => operations.GetCompanyRequest$outboundSchema.parse(value),
- "Input validation failed",
- );
- if (!parsed.ok) {
- return [parsed, { status: "invalid" }];
- }
- const payload = parsed.value;
- const body = null;
-
- const pathParams = {
- companyId: encodeSimple("companyId", payload.companyId, {
- explode: false,
- charEncoding: "percent",
- }),
- };
- const path = pathToFunc("/companies/{companyId}")(pathParams);
-
- const headers = new Headers(compactMap({
- Accept: "application/json",
- }));
-
- const secConfig = await extractSecurity(client._options.authHeader);
- const securityInput = secConfig == null ? {} : { authHeader: secConfig };
- const requestSecurity = resolveGlobalSecurity(securityInput);
-
- const context = {
- options: client._options,
- baseURL: options?.serverURL ?? client._baseURL ?? "",
- operationID: "get-company",
- oAuth2Scopes: null,
+type Call = CodatPlatform["companies"]["get"];
- resolvedSecurity: requestSecurity,
-
- securitySource: client._options.authHeader,
- retryConfig: options?.retries
- || client._options.retryConfig
- || {
- strategy: "backoff",
- backoff: {
- initialInterval: 500,
- maxInterval: 60000,
- exponent: 1.5,
- maxElapsedTime: 3600000,
- },
- retryConnectionErrors: true,
- }
- || { strategy: "none" },
- retryCodes: options?.retryCodes || ["408", "429", "5XX"],
- };
-
- const requestRes = client._createRequest(context, {
- security: requestSecurity,
- method: "GET",
- baseURL: options?.serverURL,
- path: path,
- headers: headers,
- body: body,
- userAgent: client._options.userAgent,
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
- }, options);
- if (!requestRes.ok) {
- return [requestRes, { status: "invalid" }];
- }
- const req = requestRes.value;
-
- const doResult = await client._do(req, {
- context,
- isErrorStatusCode: (statusCode: number) =>
- matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
- retryConfig: context.retryConfig,
- retryCodes: context.retryCodes,
- });
- if (!doResult.ok) {
- return [doResult, { status: "request-error", request: req }];
- }
- const response = doResult.value;
-
- const responseFields = {
- HttpMeta: { Response: response, Request: req },
- };
-
- const [result] = await M.match<
- shared.Company,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >(
- M.json(200, shared.Company$inboundSchema),
- M.jsonErr([401, 402, 403, 404, 429], errors.ErrorMessage$inboundSchema),
- M.jsonErr([500, 503], errors.ErrorMessage$inboundSchema),
- M.fail("4XX"),
- M.fail("5XX"),
- )(response, req, { extraFields: responseFields });
- if (!result.ok) {
- return [result, { status: "complete", request: req, response }];
- }
-
- return [result, { status: "complete", request: req, response }];
+export function companiesGet(
+ client: CodatPlatformCore,
+ request: Parameters[0],
+ options?: Parameters[1],
+): APIPromise>, Error>> {
+ return new APIPromise(toResult(() => client.companies.get(request, options)));
}
diff --git a/platform/src/funcs/companiesGetAccessToken.ts b/platform/src/funcs/companiesGetAccessToken.ts
index 3850551a4..bc3e9e1ff 100644
--- a/platform/src/funcs/companiesGetAccessToken.ts
+++ b/platform/src/funcs/companiesGetAccessToken.ts
@@ -1,191 +1,17 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
+/* tslint:disable */
+/* eslint-disable */
-import { CodatPlatformCore } from "../core.js";
-import { encodeSimple } from "../lib/encodings.js";
-import { matchStatusCode } from "../lib/http.js";
-import * as M from "../lib/matchers.js";
-import { compactMap } from "../lib/primitives.js";
-import { safeParse } from "../lib/schemas.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
-import { pathToFunc } from "../lib/url.js";
-import { CodatPlatformError } from "../sdk/models/errors/codatplatformerror.js";
-import {
- ConnectionError,
- InvalidRequestError,
- RequestAbortedError,
- RequestTimeoutError,
- UnexpectedClientError,
-} from "../sdk/models/errors/httpclienterrors.js";
-import * as errors from "../sdk/models/errors/index.js";
-import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
-import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
-import * as operations from "../sdk/models/operations/index.js";
-import * as shared from "../sdk/models/shared/index.js";
-import { APICall, APIPromise } from "../sdk/types/async.js";
-import { Result } from "../sdk/types/fp.js";
+import type { CodatPlatform, CodatPlatformCore } from "../core";
+import { APIPromise } from "../sdk/types/async";
+import type { Result } from "../sdk/types/fp";
+import { toResult } from "./_adapter";
-/**
- * Get company access token
- *
- * @remarks
- * Use the _Get company access token_ endpoint to return an access token for the specified company ID. The token is valid for one day.
- *
- * The token is required by Codat's embeddable UIs (such as [Connections SDK](https://docs.codat.io/auth-flow/optimize/connection-management) and [Link SDK](https://docs.codat.io/auth-flow/authorize-embedded-link)) to verify the identity of the user and improve the reliability of data provided by them.
- */
-export function companiesGetAccessToken(
- client: CodatPlatformCore,
- request: operations.GetCompanyAccessTokenRequest,
- options?: RequestOptions,
-): APIPromise<
- Result<
- shared.CompanyAccessToken,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >
-> {
- return new APIPromise($do(
- client,
- request,
- options,
- ));
-}
-
-async function $do(
- client: CodatPlatformCore,
- request: operations.GetCompanyAccessTokenRequest,
- options?: RequestOptions,
-): Promise<
- [
- Result<
- shared.CompanyAccessToken,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >,
- APICall,
- ]
-> {
- const parsed = safeParse(
- request,
- (value) =>
- operations.GetCompanyAccessTokenRequest$outboundSchema.parse(value),
- "Input validation failed",
- );
- if (!parsed.ok) {
- return [parsed, { status: "invalid" }];
- }
- const payload = parsed.value;
- const body = null;
-
- const pathParams = {
- companyId: encodeSimple("companyId", payload.companyId, {
- explode: false,
- charEncoding: "percent",
- }),
- };
- const path = pathToFunc("/companies/{companyId}/accessToken")(pathParams);
-
- const headers = new Headers(compactMap({
- Accept: "application/json",
- }));
-
- const secConfig = await extractSecurity(client._options.authHeader);
- const securityInput = secConfig == null ? {} : { authHeader: secConfig };
- const requestSecurity = resolveGlobalSecurity(securityInput);
-
- const context = {
- options: client._options,
- baseURL: options?.serverURL ?? client._baseURL ?? "",
- operationID: "get-company-access-token",
- oAuth2Scopes: null,
+type Call = CodatPlatform["companies"]["getAccessToken"];
- resolvedSecurity: requestSecurity,
-
- securitySource: client._options.authHeader,
- retryConfig: options?.retries
- || client._options.retryConfig
- || {
- strategy: "backoff",
- backoff: {
- initialInterval: 500,
- maxInterval: 60000,
- exponent: 1.5,
- maxElapsedTime: 3600000,
- },
- retryConnectionErrors: true,
- }
- || { strategy: "none" },
- retryCodes: options?.retryCodes || ["408", "429", "5XX"],
- };
-
- const requestRes = client._createRequest(context, {
- security: requestSecurity,
- method: "GET",
- baseURL: options?.serverURL,
- path: path,
- headers: headers,
- body: body,
- userAgent: client._options.userAgent,
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
- }, options);
- if (!requestRes.ok) {
- return [requestRes, { status: "invalid" }];
- }
- const req = requestRes.value;
-
- const doResult = await client._do(req, {
- context,
- isErrorStatusCode: (statusCode: number) =>
- matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
- retryConfig: context.retryConfig,
- retryCodes: context.retryCodes,
- });
- if (!doResult.ok) {
- return [doResult, { status: "request-error", request: req }];
- }
- const response = doResult.value;
-
- const responseFields = {
- HttpMeta: { Response: response, Request: req },
- };
-
- const [result] = await M.match<
- shared.CompanyAccessToken,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >(
- M.json(200, shared.CompanyAccessToken$inboundSchema),
- M.jsonErr([401, 402, 403, 404, 429], errors.ErrorMessage$inboundSchema),
- M.jsonErr([500, 503], errors.ErrorMessage$inboundSchema),
- M.fail("4XX"),
- M.fail("5XX"),
- )(response, req, { extraFields: responseFields });
- if (!result.ok) {
- return [result, { status: "complete", request: req, response }];
- }
-
- return [result, { status: "complete", request: req, response }];
+export function companiesGetAccessToken(
+ client: CodatPlatformCore,
+ request: Parameters[0],
+ options?: Parameters[1],
+): APIPromise>, Error>> {
+ return new APIPromise(toResult(() => client.companies.getAccessToken(request, options)));
}
diff --git a/platform/src/funcs/companiesGetCompanySyncSettings.ts b/platform/src/funcs/companiesGetCompanySyncSettings.ts
index dcf62f317..9527086ea 100644
--- a/platform/src/funcs/companiesGetCompanySyncSettings.ts
+++ b/platform/src/funcs/companiesGetCompanySyncSettings.ts
@@ -1,189 +1,17 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
+/* tslint:disable */
+/* eslint-disable */
-import { CodatPlatformCore } from "../core.js";
-import { encodeSimple } from "../lib/encodings.js";
-import { matchStatusCode } from "../lib/http.js";
-import * as M from "../lib/matchers.js";
-import { compactMap } from "../lib/primitives.js";
-import { safeParse } from "../lib/schemas.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
-import { pathToFunc } from "../lib/url.js";
-import { CodatPlatformError } from "../sdk/models/errors/codatplatformerror.js";
-import {
- ConnectionError,
- InvalidRequestError,
- RequestAbortedError,
- RequestTimeoutError,
- UnexpectedClientError,
-} from "../sdk/models/errors/httpclienterrors.js";
-import * as errors from "../sdk/models/errors/index.js";
-import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
-import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
-import * as operations from "../sdk/models/operations/index.js";
-import * as shared from "../sdk/models/shared/index.js";
-import { APICall, APIPromise } from "../sdk/types/async.js";
-import { Result } from "../sdk/types/fp.js";
+import type { CodatPlatform, CodatPlatformCore } from "../core";
+import { APIPromise } from "../sdk/types/async";
+import type { Result } from "../sdk/types/fp";
+import { toResult } from "./_adapter";
-/**
- * Get company sync settings
- *
- * @remarks
- * Retrieve the [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings) for a specific company. This includes how often data types should be queued to be updated, and how much history should be fetched.
- */
-export function companiesGetCompanySyncSettings(
- client: CodatPlatformCore,
- request: operations.GetCompanySyncSettingsRequest,
- options?: RequestOptions,
-): APIPromise<
- Result<
- shared.CompanySyncSettings,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >
-> {
- return new APIPromise($do(
- client,
- request,
- options,
- ));
-}
-
-async function $do(
- client: CodatPlatformCore,
- request: operations.GetCompanySyncSettingsRequest,
- options?: RequestOptions,
-): Promise<
- [
- Result<
- shared.CompanySyncSettings,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >,
- APICall,
- ]
-> {
- const parsed = safeParse(
- request,
- (value) =>
- operations.GetCompanySyncSettingsRequest$outboundSchema.parse(value),
- "Input validation failed",
- );
- if (!parsed.ok) {
- return [parsed, { status: "invalid" }];
- }
- const payload = parsed.value;
- const body = null;
-
- const pathParams = {
- companyId: encodeSimple("companyId", payload.companyId, {
- explode: false,
- charEncoding: "percent",
- }),
- };
- const path = pathToFunc("/companies/{companyId}/syncSettings")(pathParams);
-
- const headers = new Headers(compactMap({
- Accept: "application/json",
- }));
-
- const secConfig = await extractSecurity(client._options.authHeader);
- const securityInput = secConfig == null ? {} : { authHeader: secConfig };
- const requestSecurity = resolveGlobalSecurity(securityInput);
-
- const context = {
- options: client._options,
- baseURL: options?.serverURL ?? client._baseURL ?? "",
- operationID: "get-company-syncSettings",
- oAuth2Scopes: null,
+type Call = CodatPlatform["companies"]["getCompanySyncSettings"];
- resolvedSecurity: requestSecurity,
-
- securitySource: client._options.authHeader,
- retryConfig: options?.retries
- || client._options.retryConfig
- || {
- strategy: "backoff",
- backoff: {
- initialInterval: 500,
- maxInterval: 60000,
- exponent: 1.5,
- maxElapsedTime: 3600000,
- },
- retryConnectionErrors: true,
- }
- || { strategy: "none" },
- retryCodes: options?.retryCodes || ["408", "429", "5XX"],
- };
-
- const requestRes = client._createRequest(context, {
- security: requestSecurity,
- method: "GET",
- baseURL: options?.serverURL,
- path: path,
- headers: headers,
- body: body,
- userAgent: client._options.userAgent,
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
- }, options);
- if (!requestRes.ok) {
- return [requestRes, { status: "invalid" }];
- }
- const req = requestRes.value;
-
- const doResult = await client._do(req, {
- context,
- isErrorStatusCode: (statusCode: number) =>
- matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
- retryConfig: context.retryConfig,
- retryCodes: context.retryCodes,
- });
- if (!doResult.ok) {
- return [doResult, { status: "request-error", request: req }];
- }
- const response = doResult.value;
-
- const responseFields = {
- HttpMeta: { Response: response, Request: req },
- };
-
- const [result] = await M.match<
- shared.CompanySyncSettings,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >(
- M.json(200, shared.CompanySyncSettings$inboundSchema),
- M.jsonErr([401, 402, 403, 404, 429], errors.ErrorMessage$inboundSchema),
- M.jsonErr([500, 503], errors.ErrorMessage$inboundSchema),
- M.fail("4XX"),
- M.fail("5XX"),
- )(response, req, { extraFields: responseFields });
- if (!result.ok) {
- return [result, { status: "complete", request: req, response }];
- }
-
- return [result, { status: "complete", request: req, response }];
+export function companiesGetCompanySyncSettings(
+ client: CodatPlatformCore,
+ request: Parameters[0],
+ options?: Parameters[1],
+): APIPromise>, Error>> {
+ return new APIPromise(toResult(() => client.companies.getCompanySyncSettings(request, options)));
}
diff --git a/platform/src/funcs/companiesList.ts b/platform/src/funcs/companiesList.ts
index d746453e0..9dbe21065 100644
--- a/platform/src/funcs/companiesList.ts
+++ b/platform/src/funcs/companiesList.ts
@@ -1,211 +1,17 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
+/* tslint:disable */
+/* eslint-disable */
-import { CodatPlatformCore } from "../core.js";
-import { encodeFormQuery } from "../lib/encodings.js";
-import { matchStatusCode } from "../lib/http.js";
-import * as M from "../lib/matchers.js";
-import { compactMap } from "../lib/primitives.js";
-import { safeParse } from "../lib/schemas.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
-import { pathToFunc } from "../lib/url.js";
-import { CodatPlatformError } from "../sdk/models/errors/codatplatformerror.js";
-import {
- ConnectionError,
- InvalidRequestError,
- RequestAbortedError,
- RequestTimeoutError,
- UnexpectedClientError,
-} from "../sdk/models/errors/httpclienterrors.js";
-import * as errors from "../sdk/models/errors/index.js";
-import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
-import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
-import * as operations from "../sdk/models/operations/index.js";
-import * as shared from "../sdk/models/shared/index.js";
-import { APICall, APIPromise } from "../sdk/types/async.js";
-import { Result } from "../sdk/types/fp.js";
+import type { CodatPlatform, CodatPlatformCore } from "../core";
+import { APIPromise } from "../sdk/types/async";
+import type { Result } from "../sdk/types/fp";
+import { toResult } from "./_adapter";
-/**
- * List companies
- *
- * @remarks
- * The *List companies* endpoint returns a list of [companies](https://docs.codat.io/platform-api#/schemas/Company) associated to your instances.
- *
- * A [company](https://docs.codat.io/platform-api#/schemas/Company) represents a business sharing access to their data.
- * Each company can have multiple [connections](https://docs.codat.io/platform-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.
- *
- * ## Filter by tags
- *
- * The *List companies* endpoint supports the filtering of companies using [tags](https://docs.codat.io/using-the-api/managing-companies#add-metadata-to-a-company). It supports the following operators with [Codat’s query language](https://docs.codat.io/using-the-api/querying):
- *
- * - equals (`=`)
- * - not equals (`!=`)
- * - contains (`~`)
- *
- * For example, you can use the querying to filter companies tagged with a specific foreign key, region, or owning team:
- * - Foreign key: `uid = {yourCustomerId}`
- * - Region: `region != uk`
- * - Owning team and region: `region = uk && owningTeam = invoice-finance`
- */
-export function companiesList(
- client: CodatPlatformCore,
- request?: operations.ListCompaniesRequest | undefined,
- options?: RequestOptions,
-): APIPromise<
- Result<
- shared.Companies,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >
-> {
- return new APIPromise($do(
- client,
- request,
- options,
- ));
-}
-
-async function $do(
- client: CodatPlatformCore,
- request?: operations.ListCompaniesRequest | undefined,
- options?: RequestOptions,
-): Promise<
- [
- Result<
- shared.Companies,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >,
- APICall,
- ]
-> {
- const parsed = safeParse(
- request,
- (value) =>
- operations.ListCompaniesRequest$outboundSchema.optional().parse(value),
- "Input validation failed",
- );
- if (!parsed.ok) {
- return [parsed, { status: "invalid" }];
- }
- const payload = parsed.value;
- const body = null;
-
- const path = pathToFunc("/companies")();
-
- const query = encodeFormQuery({
- "orderBy": payload?.orderBy,
- "page": payload?.page,
- "pageSize": payload?.pageSize,
- "query": payload?.query,
- "tags": payload?.tags,
- });
-
- const headers = new Headers(compactMap({
- Accept: "application/json",
- }));
-
- const secConfig = await extractSecurity(client._options.authHeader);
- const securityInput = secConfig == null ? {} : { authHeader: secConfig };
- const requestSecurity = resolveGlobalSecurity(securityInput);
-
- const context = {
- options: client._options,
- baseURL: options?.serverURL ?? client._baseURL ?? "",
- operationID: "list-companies",
- oAuth2Scopes: null,
+type Call = CodatPlatform["companies"]["list"];
- resolvedSecurity: requestSecurity,
-
- securitySource: client._options.authHeader,
- retryConfig: options?.retries
- || client._options.retryConfig
- || {
- strategy: "backoff",
- backoff: {
- initialInterval: 500,
- maxInterval: 60000,
- exponent: 1.5,
- maxElapsedTime: 3600000,
- },
- retryConnectionErrors: true,
- }
- || { strategy: "none" },
- retryCodes: options?.retryCodes || ["408", "429", "5XX"],
- };
-
- const requestRes = client._createRequest(context, {
- security: requestSecurity,
- method: "GET",
- baseURL: options?.serverURL,
- path: path,
- headers: headers,
- query: query,
- body: body,
- userAgent: client._options.userAgent,
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
- }, options);
- if (!requestRes.ok) {
- return [requestRes, { status: "invalid" }];
- }
- const req = requestRes.value;
-
- const doResult = await client._do(req, {
- context,
- isErrorStatusCode: (statusCode: number) =>
- matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
- retryConfig: context.retryConfig,
- retryCodes: context.retryCodes,
- });
- if (!doResult.ok) {
- return [doResult, { status: "request-error", request: req }];
- }
- const response = doResult.value;
-
- const responseFields = {
- HttpMeta: { Response: response, Request: req },
- };
-
- const [result] = await M.match<
- shared.Companies,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >(
- M.json(200, shared.Companies$inboundSchema),
- M.jsonErr(
- [400, 401, 402, 403, 404, 429],
- errors.ErrorMessage$inboundSchema,
- ),
- M.jsonErr([500, 503], errors.ErrorMessage$inboundSchema),
- M.fail("4XX"),
- M.fail("5XX"),
- )(response, req, { extraFields: responseFields });
- if (!result.ok) {
- return [result, { status: "complete", request: req, response }];
- }
-
- return [result, { status: "complete", request: req, response }];
+export function companiesList(
+ client: CodatPlatformCore,
+ request?: Parameters[0],
+ options?: Parameters[1],
+): APIPromise>, Error>> {
+ return new APIPromise(toResult(() => client.companies.list(request, options)));
}
diff --git a/platform/src/funcs/companiesRefreshProductData.ts b/platform/src/funcs/companiesRefreshProductData.ts
index a27cf9149..0b30c4544 100644
--- a/platform/src/funcs/companiesRefreshProductData.ts
+++ b/platform/src/funcs/companiesRefreshProductData.ts
@@ -1,207 +1,17 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
+/* tslint:disable */
+/* eslint-disable */
-import * as z from "zod/v3";
-import { CodatPlatformCore } from "../core.js";
-import { encodeJSON, encodeSimple } from "../lib/encodings.js";
-import { matchStatusCode } from "../lib/http.js";
-import * as M from "../lib/matchers.js";
-import { compactMap } from "../lib/primitives.js";
-import { safeParse } from "../lib/schemas.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
-import { pathToFunc } from "../lib/url.js";
-import { CodatPlatformError } from "../sdk/models/errors/codatplatformerror.js";
-import {
- ConnectionError,
- InvalidRequestError,
- RequestAbortedError,
- RequestTimeoutError,
- UnexpectedClientError,
-} from "../sdk/models/errors/httpclienterrors.js";
-import * as errors from "../sdk/models/errors/index.js";
-import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
-import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
-import * as operations from "../sdk/models/operations/index.js";
-import { APICall, APIPromise } from "../sdk/types/async.js";
-import { Result } from "../sdk/types/fp.js";
+import type { CodatPlatform, CodatPlatformCore } from "../core";
+import { APIPromise } from "../sdk/types/async";
+import type { Result } from "../sdk/types/fp";
+import { toResult } from "./_adapter";
-/**
- * Refresh product data
- *
- * @remarks
- * Use the **Refresh product data** endpoint to manually refresh data for a custom product for a specific company.
- *
- * ### Tips and traps
- *
- * - This endpoint only supports refreshing data for **custom products** and can't be used for Codat's standard solutions. Refer to [individual solutions' documentation](https://docs.codat.io/) instead.
- * - If a data sync is already in progress for a custom product, the refresh request will return a `Bad request (400)` response.
- * - If a company has multiple custom products enabled, you can refresh data for each product individually.
- * - Optionally include a request body with `dataTypes` to refresh only selected data types for the specified product. If omitted, the product's scheduled refresh is triggered as usual.
- * - When specifying `dataTypes`, each value must be a valid data type supported by the product. Invalid values will result in a `Bad request (400)` response listing valid options.
- */
-export function companiesRefreshProductData(
- client: CodatPlatformCore,
- request: operations.RefreshProductDataRequest,
- options?: RequestOptions,
-): APIPromise<
- Result<
- void,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >
-> {
- return new APIPromise($do(
- client,
- request,
- options,
- ));
-}
-
-async function $do(
- client: CodatPlatformCore,
- request: operations.RefreshProductDataRequest,
- options?: RequestOptions,
-): Promise<
- [
- Result<
- void,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >,
- APICall,
- ]
-> {
- const parsed = safeParse(
- request,
- (value) => operations.RefreshProductDataRequest$outboundSchema.parse(value),
- "Input validation failed",
- );
- if (!parsed.ok) {
- return [parsed, { status: "invalid" }];
- }
- const payload = parsed.value;
- const body = encodeJSON("body", payload.RequestBody, { explode: true });
-
- const pathParams = {
- companyId: encodeSimple("companyId", payload.companyId, {
- explode: false,
- charEncoding: "percent",
- }),
- productIdentifier: encodeSimple(
- "productIdentifier",
- payload.productIdentifier,
- { explode: false, charEncoding: "percent" },
- ),
- };
- const path = pathToFunc(
- "/companies/{companyId}/products/{productIdentifier}/refresh",
- )(pathParams);
-
- const headers = new Headers(compactMap({
- "Content-Type": "application/json",
- Accept: "application/json",
- }));
-
- const secConfig = await extractSecurity(client._options.authHeader);
- const securityInput = secConfig == null ? {} : { authHeader: secConfig };
- const requestSecurity = resolveGlobalSecurity(securityInput);
-
- const context = {
- options: client._options,
- baseURL: options?.serverURL ?? client._baseURL ?? "",
- operationID: "refresh-product-data",
- oAuth2Scopes: null,
+type Call = CodatPlatform["companies"]["refreshProductData"];
- resolvedSecurity: requestSecurity,
-
- securitySource: client._options.authHeader,
- retryConfig: options?.retries
- || client._options.retryConfig
- || {
- strategy: "backoff",
- backoff: {
- initialInterval: 500,
- maxInterval: 60000,
- exponent: 1.5,
- maxElapsedTime: 3600000,
- },
- retryConnectionErrors: true,
- }
- || { strategy: "none" },
- retryCodes: options?.retryCodes || ["408", "429", "5XX"],
- };
-
- const requestRes = client._createRequest(context, {
- security: requestSecurity,
- method: "POST",
- baseURL: options?.serverURL,
- path: path,
- headers: headers,
- body: body,
- userAgent: client._options.userAgent,
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
- }, options);
- if (!requestRes.ok) {
- return [requestRes, { status: "invalid" }];
- }
- const req = requestRes.value;
-
- const doResult = await client._do(req, {
- context,
- isErrorStatusCode: (statusCode: number) =>
- matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
- retryConfig: context.retryConfig,
- retryCodes: context.retryCodes,
- });
- if (!doResult.ok) {
- return [doResult, { status: "request-error", request: req }];
- }
- const response = doResult.value;
-
- const responseFields = {
- HttpMeta: { Response: response, Request: req },
- };
-
- const [result] = await M.match<
- void,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >(
- M.nil(202, z.void()),
- M.jsonErr(
- [400, 401, 402, 403, 404, 429],
- errors.ErrorMessage$inboundSchema,
- ),
- M.jsonErr([500, 503], errors.ErrorMessage$inboundSchema),
- M.fail("4XX"),
- M.fail("5XX"),
- )(response, req, { extraFields: responseFields });
- if (!result.ok) {
- return [result, { status: "complete", request: req, response }];
- }
-
- return [result, { status: "complete", request: req, response }];
+export function companiesRefreshProductData(
+ client: CodatPlatformCore,
+ request: Parameters[0],
+ options?: Parameters[1],
+): APIPromise>, Error>> {
+ return new APIPromise(toResult(() => client.companies.refreshProductData(request, options)));
}
diff --git a/platform/src/funcs/companiesRemoveProduct.ts b/platform/src/funcs/companiesRemoveProduct.ts
index 41f892c79..151da8380 100644
--- a/platform/src/funcs/companiesRemoveProduct.ts
+++ b/platform/src/funcs/companiesRemoveProduct.ts
@@ -1,197 +1,17 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
+/* tslint:disable */
+/* eslint-disable */
-import * as z from "zod/v3";
-import { CodatPlatformCore } from "../core.js";
-import { encodeSimple } from "../lib/encodings.js";
-import { matchStatusCode } from "../lib/http.js";
-import * as M from "../lib/matchers.js";
-import { compactMap } from "../lib/primitives.js";
-import { safeParse } from "../lib/schemas.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
-import { pathToFunc } from "../lib/url.js";
-import { CodatPlatformError } from "../sdk/models/errors/codatplatformerror.js";
-import {
- ConnectionError,
- InvalidRequestError,
- RequestAbortedError,
- RequestTimeoutError,
- UnexpectedClientError,
-} from "../sdk/models/errors/httpclienterrors.js";
-import * as errors from "../sdk/models/errors/index.js";
-import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
-import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
-import * as operations from "../sdk/models/operations/index.js";
-import { APICall, APIPromise } from "../sdk/types/async.js";
-import { Result } from "../sdk/types/fp.js";
+import type { CodatPlatform, CodatPlatformCore } from "../core";
+import { APIPromise } from "../sdk/types/async";
+import type { Result } from "../sdk/types/fp";
+import { toResult } from "./_adapter";
-/**
- * Remove product
- *
- * @remarks
- * Use the *Remove product* endpoint to disable a product for the company specified by `companyId`.
- *
- * > Note: This feature is currently in alpha and available only to participants in the development program.
- */
-export function companiesRemoveProduct(
- client: CodatPlatformCore,
- request: operations.RemoveProductRequest,
- options?: RequestOptions,
-): APIPromise<
- Result<
- void,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >
-> {
- return new APIPromise($do(
- client,
- request,
- options,
- ));
-}
-
-async function $do(
- client: CodatPlatformCore,
- request: operations.RemoveProductRequest,
- options?: RequestOptions,
-): Promise<
- [
- Result<
- void,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >,
- APICall,
- ]
-> {
- const parsed = safeParse(
- request,
- (value) => operations.RemoveProductRequest$outboundSchema.parse(value),
- "Input validation failed",
- );
- if (!parsed.ok) {
- return [parsed, { status: "invalid" }];
- }
- const payload = parsed.value;
- const body = null;
-
- const pathParams = {
- companyId: encodeSimple("companyId", payload.companyId, {
- explode: false,
- charEncoding: "percent",
- }),
- productIdentifier: encodeSimple(
- "productIdentifier",
- payload.productIdentifier,
- { explode: false, charEncoding: "percent" },
- ),
- };
- const path = pathToFunc(
- "/companies/{companyId}/products/{productIdentifier}",
- )(pathParams);
-
- const headers = new Headers(compactMap({
- Accept: "application/json",
- }));
-
- const secConfig = await extractSecurity(client._options.authHeader);
- const securityInput = secConfig == null ? {} : { authHeader: secConfig };
- const requestSecurity = resolveGlobalSecurity(securityInput);
-
- const context = {
- options: client._options,
- baseURL: options?.serverURL ?? client._baseURL ?? "",
- operationID: "remove-product",
- oAuth2Scopes: null,
+type Call = CodatPlatform["companies"]["removeProduct"];
- resolvedSecurity: requestSecurity,
-
- securitySource: client._options.authHeader,
- retryConfig: options?.retries
- || client._options.retryConfig
- || {
- strategy: "backoff",
- backoff: {
- initialInterval: 500,
- maxInterval: 60000,
- exponent: 1.5,
- maxElapsedTime: 3600000,
- },
- retryConnectionErrors: true,
- }
- || { strategy: "none" },
- retryCodes: options?.retryCodes || ["408", "429", "5XX"],
- };
-
- const requestRes = client._createRequest(context, {
- security: requestSecurity,
- method: "DELETE",
- baseURL: options?.serverURL,
- path: path,
- headers: headers,
- body: body,
- userAgent: client._options.userAgent,
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
- }, options);
- if (!requestRes.ok) {
- return [requestRes, { status: "invalid" }];
- }
- const req = requestRes.value;
-
- const doResult = await client._do(req, {
- context,
- isErrorStatusCode: (statusCode: number) =>
- matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
- retryConfig: context.retryConfig,
- retryCodes: context.retryCodes,
- });
- if (!doResult.ok) {
- return [doResult, { status: "request-error", request: req }];
- }
- const response = doResult.value;
-
- const responseFields = {
- HttpMeta: { Response: response, Request: req },
- };
-
- const [result] = await M.match<
- void,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >(
- M.nil(204, z.void()),
- M.jsonErr([401, 402, 403, 404, 429], errors.ErrorMessage$inboundSchema),
- M.jsonErr([500, 503], errors.ErrorMessage$inboundSchema),
- M.fail("4XX"),
- M.fail("5XX"),
- )(response, req, { extraFields: responseFields });
- if (!result.ok) {
- return [result, { status: "complete", request: req, response }];
- }
-
- return [result, { status: "complete", request: req, response }];
+export function companiesRemoveProduct(
+ client: CodatPlatformCore,
+ request: Parameters[0],
+ options?: Parameters[1],
+): APIPromise>, Error>> {
+ return new APIPromise(toResult(() => client.companies.removeProduct(request, options)));
}
diff --git a/platform/src/funcs/companiesReplace.ts b/platform/src/funcs/companiesReplace.ts
index dd5f90a3f..f56c34b4f 100644
--- a/platform/src/funcs/companiesReplace.ts
+++ b/platform/src/funcs/companiesReplace.ts
@@ -1,194 +1,17 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
+/* tslint:disable */
+/* eslint-disable */
-import { CodatPlatformCore } from "../core.js";
-import { encodeJSON, encodeSimple } from "../lib/encodings.js";
-import { matchStatusCode } from "../lib/http.js";
-import * as M from "../lib/matchers.js";
-import { compactMap } from "../lib/primitives.js";
-import { safeParse } from "../lib/schemas.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
-import { pathToFunc } from "../lib/url.js";
-import { CodatPlatformError } from "../sdk/models/errors/codatplatformerror.js";
-import {
- ConnectionError,
- InvalidRequestError,
- RequestAbortedError,
- RequestTimeoutError,
- UnexpectedClientError,
-} from "../sdk/models/errors/httpclienterrors.js";
-import * as errors from "../sdk/models/errors/index.js";
-import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
-import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
-import * as operations from "../sdk/models/operations/index.js";
-import * as shared from "../sdk/models/shared/index.js";
-import { APICall, APIPromise } from "../sdk/types/async.js";
-import { Result } from "../sdk/types/fp.js";
+import type { CodatPlatform, CodatPlatformCore } from "../core";
+import { APIPromise } from "../sdk/types/async";
+import type { Result } from "../sdk/types/fp";
+import { toResult } from "./_adapter";
-/**
- * Replace company
- *
- * @remarks
- * Use the *Replace company* endpoint to replace the existing name, description, and tags of the company. Calling the endpoint will replace existing values even if new values haven't been defined in the payload.
- *
- * A [company](https://docs.codat.io/platform-api#/schemas/Company) represents a business sharing access to their data.
- * Each company can have multiple [connections](https://docs.codat.io/platform-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.
- */
-export function companiesReplace(
- client: CodatPlatformCore,
- request: operations.ReplaceCompanyRequest,
- options?: RequestOptions,
-): APIPromise<
- Result<
- shared.Company,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >
-> {
- return new APIPromise($do(
- client,
- request,
- options,
- ));
-}
-
-async function $do(
- client: CodatPlatformCore,
- request: operations.ReplaceCompanyRequest,
- options?: RequestOptions,
-): Promise<
- [
- Result<
- shared.Company,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >,
- APICall,
- ]
-> {
- const parsed = safeParse(
- request,
- (value) => operations.ReplaceCompanyRequest$outboundSchema.parse(value),
- "Input validation failed",
- );
- if (!parsed.ok) {
- return [parsed, { status: "invalid" }];
- }
- const payload = parsed.value;
- const body = encodeJSON("body", payload.CompanyRequestBody, {
- explode: true,
- });
-
- const pathParams = {
- companyId: encodeSimple("companyId", payload.companyId, {
- explode: false,
- charEncoding: "percent",
- }),
- };
- const path = pathToFunc("/companies/{companyId}")(pathParams);
-
- const headers = new Headers(compactMap({
- "Content-Type": "application/json",
- Accept: "application/json",
- }));
-
- const secConfig = await extractSecurity(client._options.authHeader);
- const securityInput = secConfig == null ? {} : { authHeader: secConfig };
- const requestSecurity = resolveGlobalSecurity(securityInput);
-
- const context = {
- options: client._options,
- baseURL: options?.serverURL ?? client._baseURL ?? "",
- operationID: "replace-company",
- oAuth2Scopes: null,
+type Call = CodatPlatform["companies"]["replace"];
- resolvedSecurity: requestSecurity,
-
- securitySource: client._options.authHeader,
- retryConfig: options?.retries
- || client._options.retryConfig
- || {
- strategy: "backoff",
- backoff: {
- initialInterval: 500,
- maxInterval: 60000,
- exponent: 1.5,
- maxElapsedTime: 3600000,
- },
- retryConnectionErrors: true,
- }
- || { strategy: "none" },
- retryCodes: options?.retryCodes || ["408", "429", "5XX"],
- };
-
- const requestRes = client._createRequest(context, {
- security: requestSecurity,
- method: "PUT",
- baseURL: options?.serverURL,
- path: path,
- headers: headers,
- body: body,
- userAgent: client._options.userAgent,
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
- }, options);
- if (!requestRes.ok) {
- return [requestRes, { status: "invalid" }];
- }
- const req = requestRes.value;
-
- const doResult = await client._do(req, {
- context,
- isErrorStatusCode: (statusCode: number) =>
- matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
- retryConfig: context.retryConfig,
- retryCodes: context.retryCodes,
- });
- if (!doResult.ok) {
- return [doResult, { status: "request-error", request: req }];
- }
- const response = doResult.value;
-
- const responseFields = {
- HttpMeta: { Response: response, Request: req },
- };
-
- const [result] = await M.match<
- shared.Company,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >(
- M.json(200, shared.Company$inboundSchema),
- M.jsonErr([401, 402, 403, 404, 429], errors.ErrorMessage$inboundSchema),
- M.jsonErr([500, 503], errors.ErrorMessage$inboundSchema),
- M.fail("4XX"),
- M.fail("5XX"),
- )(response, req, { extraFields: responseFields });
- if (!result.ok) {
- return [result, { status: "complete", request: req, response }];
- }
-
- return [result, { status: "complete", request: req, response }];
+export function companiesReplace(
+ client: CodatPlatformCore,
+ request: Parameters[0],
+ options?: Parameters[1],
+): APIPromise>, Error>> {
+ return new APIPromise(toResult(() => client.companies.replace(request, options)));
}
diff --git a/platform/src/funcs/companiesSetCompanySyncSettings.ts b/platform/src/funcs/companiesSetCompanySyncSettings.ts
index 5d72c86a6..b5b2ba6b0 100644
--- a/platform/src/funcs/companiesSetCompanySyncSettings.ts
+++ b/platform/src/funcs/companiesSetCompanySyncSettings.ts
@@ -1,193 +1,17 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
+/* tslint:disable */
+/* eslint-disable */
-import * as z from "zod/v3";
-import { CodatPlatformCore } from "../core.js";
-import { encodeJSON, encodeSimple } from "../lib/encodings.js";
-import { matchStatusCode } from "../lib/http.js";
-import * as M from "../lib/matchers.js";
-import { compactMap } from "../lib/primitives.js";
-import { safeParse } from "../lib/schemas.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
-import { pathToFunc } from "../lib/url.js";
-import { CodatPlatformError } from "../sdk/models/errors/codatplatformerror.js";
-import {
- ConnectionError,
- InvalidRequestError,
- RequestAbortedError,
- RequestTimeoutError,
- UnexpectedClientError,
-} from "../sdk/models/errors/httpclienterrors.js";
-import * as errors from "../sdk/models/errors/index.js";
-import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
-import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
-import * as operations from "../sdk/models/operations/index.js";
-import { APICall, APIPromise } from "../sdk/types/async.js";
-import { Result } from "../sdk/types/fp.js";
+import type { CodatPlatform, CodatPlatformCore } from "../core";
+import { APIPromise } from "../sdk/types/async";
+import type { Result } from "../sdk/types/fp";
+import { toResult } from "./_adapter";
-/**
- * Set company sync settings
- *
- * @remarks
- * Set the sync settings for a specific company.
- */
-export function companiesSetCompanySyncSettings(
- client: CodatPlatformCore,
- request: operations.SetCompanySyncSettingsRequest,
- options?: RequestOptions,
-): APIPromise<
- Result<
- void,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >
-> {
- return new APIPromise($do(
- client,
- request,
- options,
- ));
-}
-
-async function $do(
- client: CodatPlatformCore,
- request: operations.SetCompanySyncSettingsRequest,
- options?: RequestOptions,
-): Promise<
- [
- Result<
- void,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >,
- APICall,
- ]
-> {
- const parsed = safeParse(
- request,
- (value) =>
- operations.SetCompanySyncSettingsRequest$outboundSchema.parse(value),
- "Input validation failed",
- );
- if (!parsed.ok) {
- return [parsed, { status: "invalid" }];
- }
- const payload = parsed.value;
- const body = encodeJSON("body", payload.RequestBody, { explode: true });
-
- const pathParams = {
- companyId: encodeSimple("companyId", payload.companyId, {
- explode: false,
- charEncoding: "percent",
- }),
- };
- const path = pathToFunc("/companies/{companyId}/syncSettings")(pathParams);
-
- const headers = new Headers(compactMap({
- "Content-Type": "application/json",
- Accept: "application/json",
- }));
-
- const secConfig = await extractSecurity(client._options.authHeader);
- const securityInput = secConfig == null ? {} : { authHeader: secConfig };
- const requestSecurity = resolveGlobalSecurity(securityInput);
-
- const context = {
- options: client._options,
- baseURL: options?.serverURL ?? client._baseURL ?? "",
- operationID: "set-company-syncSettings",
- oAuth2Scopes: null,
+type Call = CodatPlatform["companies"]["setCompanySyncSettings"];
- resolvedSecurity: requestSecurity,
-
- securitySource: client._options.authHeader,
- retryConfig: options?.retries
- || client._options.retryConfig
- || {
- strategy: "backoff",
- backoff: {
- initialInterval: 500,
- maxInterval: 60000,
- exponent: 1.5,
- maxElapsedTime: 3600000,
- },
- retryConnectionErrors: true,
- }
- || { strategy: "none" },
- retryCodes: options?.retryCodes || ["408", "429", "5XX"],
- };
-
- const requestRes = client._createRequest(context, {
- security: requestSecurity,
- method: "POST",
- baseURL: options?.serverURL,
- path: path,
- headers: headers,
- body: body,
- userAgent: client._options.userAgent,
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
- }, options);
- if (!requestRes.ok) {
- return [requestRes, { status: "invalid" }];
- }
- const req = requestRes.value;
-
- const doResult = await client._do(req, {
- context,
- isErrorStatusCode: (statusCode: number) =>
- matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
- retryConfig: context.retryConfig,
- retryCodes: context.retryCodes,
- });
- if (!doResult.ok) {
- return [doResult, { status: "request-error", request: req }];
- }
- const response = doResult.value;
-
- const responseFields = {
- HttpMeta: { Response: response, Request: req },
- };
-
- const [result] = await M.match<
- void,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >(
- M.nil(204, z.void()),
- M.jsonErr(
- [400, 401, 402, 403, 404, 429],
- errors.ErrorMessage$inboundSchema,
- ),
- M.jsonErr([500, 503], errors.ErrorMessage$inboundSchema),
- M.fail("4XX"),
- M.fail("5XX"),
- )(response, req, { extraFields: responseFields });
- if (!result.ok) {
- return [result, { status: "complete", request: req, response }];
- }
-
- return [result, { status: "complete", request: req, response }];
+export function companiesSetCompanySyncSettings(
+ client: CodatPlatformCore,
+ request: Parameters[0],
+ options?: Parameters[1],
+): APIPromise>, Error>> {
+ return new APIPromise(toResult(() => client.companies.setCompanySyncSettings(request, options)));
}
diff --git a/platform/src/funcs/companiesUpdate.ts b/platform/src/funcs/companiesUpdate.ts
index d62c51598..0fd8be476 100644
--- a/platform/src/funcs/companiesUpdate.ts
+++ b/platform/src/funcs/companiesUpdate.ts
@@ -1,195 +1,17 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
+/* tslint:disable */
+/* eslint-disable */
-import { CodatPlatformCore } from "../core.js";
-import { encodeJSON, encodeSimple } from "../lib/encodings.js";
-import { matchStatusCode } from "../lib/http.js";
-import * as M from "../lib/matchers.js";
-import { compactMap } from "../lib/primitives.js";
-import { safeParse } from "../lib/schemas.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
-import { pathToFunc } from "../lib/url.js";
-import { CodatPlatformError } from "../sdk/models/errors/codatplatformerror.js";
-import {
- ConnectionError,
- InvalidRequestError,
- RequestAbortedError,
- RequestTimeoutError,
- UnexpectedClientError,
-} from "../sdk/models/errors/httpclienterrors.js";
-import * as errors from "../sdk/models/errors/index.js";
-import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
-import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
-import * as operations from "../sdk/models/operations/index.js";
-import * as shared from "../sdk/models/shared/index.js";
-import { APICall, APIPromise } from "../sdk/types/async.js";
-import { Result } from "../sdk/types/fp.js";
+import type { CodatPlatform, CodatPlatformCore } from "../core";
+import { APIPromise } from "../sdk/types/async";
+import type { Result } from "../sdk/types/fp";
+import { toResult } from "./_adapter";
-/**
- * Update company
- *
- * @remarks
- * Use the *Update company* endpoint to update the name, description, or tags of the company.
- *
- * The *Update company* endpoint doesn't have any required fields. If any of the fields provided are `null` or not provided, they won't be included in the update.
- *
- * A [company](https://docs.codat.io/platform-api#/schemas/Company) represents a business sharing access to their data.
- */
-export function companiesUpdate(
- client: CodatPlatformCore,
- request: operations.UpdateCompanyRequest,
- options?: RequestOptions,
-): APIPromise<
- Result<
- shared.Company,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >
-> {
- return new APIPromise($do(
- client,
- request,
- options,
- ));
-}
-
-async function $do(
- client: CodatPlatformCore,
- request: operations.UpdateCompanyRequest,
- options?: RequestOptions,
-): Promise<
- [
- Result<
- shared.Company,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >,
- APICall,
- ]
-> {
- const parsed = safeParse(
- request,
- (value) => operations.UpdateCompanyRequest$outboundSchema.parse(value),
- "Input validation failed",
- );
- if (!parsed.ok) {
- return [parsed, { status: "invalid" }];
- }
- const payload = parsed.value;
- const body = encodeJSON("body", payload.CompanyUpdateRequest, {
- explode: true,
- });
-
- const pathParams = {
- companyId: encodeSimple("companyId", payload.companyId, {
- explode: false,
- charEncoding: "percent",
- }),
- };
- const path = pathToFunc("/companies/{companyId}")(pathParams);
-
- const headers = new Headers(compactMap({
- "Content-Type": "application/json",
- Accept: "application/json",
- }));
-
- const secConfig = await extractSecurity(client._options.authHeader);
- const securityInput = secConfig == null ? {} : { authHeader: secConfig };
- const requestSecurity = resolveGlobalSecurity(securityInput);
-
- const context = {
- options: client._options,
- baseURL: options?.serverURL ?? client._baseURL ?? "",
- operationID: "update-company",
- oAuth2Scopes: null,
+type Call = CodatPlatform["companies"]["update"];
- resolvedSecurity: requestSecurity,
-
- securitySource: client._options.authHeader,
- retryConfig: options?.retries
- || client._options.retryConfig
- || {
- strategy: "backoff",
- backoff: {
- initialInterval: 500,
- maxInterval: 60000,
- exponent: 1.5,
- maxElapsedTime: 3600000,
- },
- retryConnectionErrors: true,
- }
- || { strategy: "none" },
- retryCodes: options?.retryCodes || ["408", "429", "5XX"],
- };
-
- const requestRes = client._createRequest(context, {
- security: requestSecurity,
- method: "PATCH",
- baseURL: options?.serverURL,
- path: path,
- headers: headers,
- body: body,
- userAgent: client._options.userAgent,
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
- }, options);
- if (!requestRes.ok) {
- return [requestRes, { status: "invalid" }];
- }
- const req = requestRes.value;
-
- const doResult = await client._do(req, {
- context,
- isErrorStatusCode: (statusCode: number) =>
- matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
- retryConfig: context.retryConfig,
- retryCodes: context.retryCodes,
- });
- if (!doResult.ok) {
- return [doResult, { status: "request-error", request: req }];
- }
- const response = doResult.value;
-
- const responseFields = {
- HttpMeta: { Response: response, Request: req },
- };
-
- const [result] = await M.match<
- shared.Company,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >(
- M.json(200, shared.Company$inboundSchema),
- M.jsonErr([401, 402, 403, 404, 429], errors.ErrorMessage$inboundSchema),
- M.jsonErr([500, 503], errors.ErrorMessage$inboundSchema),
- M.fail("4XX"),
- M.fail("5XX"),
- )(response, req, { extraFields: responseFields });
- if (!result.ok) {
- return [result, { status: "complete", request: req, response }];
- }
-
- return [result, { status: "complete", request: req, response }];
+export function companiesUpdate(
+ client: CodatPlatformCore,
+ request: Parameters[0],
+ options?: Parameters[1],
+): APIPromise>, Error>> {
+ return new APIPromise(toResult(() => client.companies.update(request, options)));
}
diff --git a/platform/src/funcs/connectionManagementGet.ts b/platform/src/funcs/connectionManagementGet.ts
index f027fc777..b7b32e4ab 100644
--- a/platform/src/funcs/connectionManagementGet.ts
+++ b/platform/src/funcs/connectionManagementGet.ts
@@ -1,198 +1,17 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
+/* tslint:disable */
+/* eslint-disable */
-import { CodatPlatformCore } from "../core.js";
-import { encodeSimple } from "../lib/encodings.js";
-import { matchStatusCode } from "../lib/http.js";
-import * as M from "../lib/matchers.js";
-import { compactMap } from "../lib/primitives.js";
-import { safeParse } from "../lib/schemas.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
-import { pathToFunc } from "../lib/url.js";
-import { CodatPlatformError } from "../sdk/models/errors/codatplatformerror.js";
-import {
- ConnectionError,
- InvalidRequestError,
- RequestAbortedError,
- RequestTimeoutError,
- UnexpectedClientError,
-} from "../sdk/models/errors/httpclienterrors.js";
-import * as errors from "../sdk/models/errors/index.js";
-import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
-import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
-import * as operations from "../sdk/models/operations/index.js";
-import * as shared from "../sdk/models/shared/index.js";
-import { APICall, APIPromise } from "../sdk/types/async.js";
-import { Result } from "../sdk/types/fp.js";
+import type { CodatPlatform, CodatPlatformCore } from "../core";
+import { APIPromise } from "../sdk/types/async";
+import type { Result } from "../sdk/types/fp";
+import { toResult } from "./_adapter";
-/**
- * Get access token (old)
- *
- * @remarks
- * The new [Get company access token](https://docs.codat.io/platform-api#/operations/get-company-access-token) endpoint replaces this endpoint and includes additional functionality.
- *
- * @deprecated method: The endpoint for generating company-specific connection management access tokens has been deprecated.
-Codat now supports a global company access token, providing seamless access across multiple products.
-Update your integration to use the global token for improved efficiency and consistency.
-. Use getAccessToken instead.
- */
-export function connectionManagementGet(
- client: CodatPlatformCore,
- request: operations.GetConnectionManagementAccessTokenRequest,
- options?: RequestOptions,
-): APIPromise<
- Result<
- shared.ConnectionManagementAccessToken,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >
-> {
- return new APIPromise($do(
- client,
- request,
- options,
- ));
-}
-
-async function $do(
- client: CodatPlatformCore,
- request: operations.GetConnectionManagementAccessTokenRequest,
- options?: RequestOptions,
-): Promise<
- [
- Result<
- shared.ConnectionManagementAccessToken,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >,
- APICall,
- ]
-> {
- const parsed = safeParse(
- request,
- (value) =>
- operations.GetConnectionManagementAccessTokenRequest$outboundSchema.parse(
- value,
- ),
- "Input validation failed",
- );
- if (!parsed.ok) {
- return [parsed, { status: "invalid" }];
- }
- const payload = parsed.value;
- const body = null;
-
- const pathParams = {
- companyId: encodeSimple("companyId", payload.companyId, {
- explode: false,
- charEncoding: "percent",
- }),
- };
- const path = pathToFunc(
- "/companies/{companyId}/connectionManagement/accessToken",
- )(pathParams);
-
- const headers = new Headers(compactMap({
- Accept: "application/json",
- }));
-
- const secConfig = await extractSecurity(client._options.authHeader);
- const securityInput = secConfig == null ? {} : { authHeader: secConfig };
- const requestSecurity = resolveGlobalSecurity(securityInput);
-
- const context = {
- options: client._options,
- baseURL: options?.serverURL ?? client._baseURL ?? "",
- operationID: "get-connection-management-access-token",
- oAuth2Scopes: null,
+type Call = CodatPlatform["connectionManagement"]["get"];
- resolvedSecurity: requestSecurity,
-
- securitySource: client._options.authHeader,
- retryConfig: options?.retries
- || client._options.retryConfig
- || {
- strategy: "backoff",
- backoff: {
- initialInterval: 500,
- maxInterval: 60000,
- exponent: 1.5,
- maxElapsedTime: 3600000,
- },
- retryConnectionErrors: true,
- }
- || { strategy: "none" },
- retryCodes: options?.retryCodes || ["408", "429", "5XX"],
- };
-
- const requestRes = client._createRequest(context, {
- security: requestSecurity,
- method: "GET",
- baseURL: options?.serverURL,
- path: path,
- headers: headers,
- body: body,
- userAgent: client._options.userAgent,
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
- }, options);
- if (!requestRes.ok) {
- return [requestRes, { status: "invalid" }];
- }
- const req = requestRes.value;
-
- const doResult = await client._do(req, {
- context,
- isErrorStatusCode: (statusCode: number) =>
- matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
- retryConfig: context.retryConfig,
- retryCodes: context.retryCodes,
- });
- if (!doResult.ok) {
- return [doResult, { status: "request-error", request: req }];
- }
- const response = doResult.value;
-
- const responseFields = {
- HttpMeta: { Response: response, Request: req },
- };
-
- const [result] = await M.match<
- shared.ConnectionManagementAccessToken,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >(
- M.json(200, shared.ConnectionManagementAccessToken$inboundSchema),
- M.jsonErr([401, 402, 403, 404, 429], errors.ErrorMessage$inboundSchema),
- M.jsonErr([500, 503], errors.ErrorMessage$inboundSchema),
- M.fail("4XX"),
- M.fail("5XX"),
- )(response, req, { extraFields: responseFields });
- if (!result.ok) {
- return [result, { status: "complete", request: req, response }];
- }
-
- return [result, { status: "complete", request: req, response }];
+export function connectionManagementGet(
+ client: CodatPlatformCore,
+ request: Parameters[0],
+ options?: Parameters[1],
+): APIPromise>, Error>> {
+ return new APIPromise(toResult(() => client.connectionManagement.get(request, options)));
}
diff --git a/platform/src/funcs/connectionsCreate.ts b/platform/src/funcs/connectionsCreate.ts
index c9b0b221b..3519c1977 100644
--- a/platform/src/funcs/connectionsCreate.ts
+++ b/platform/src/funcs/connectionsCreate.ts
@@ -1,191 +1,17 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
+/* tslint:disable */
+/* eslint-disable */
-import { CodatPlatformCore } from "../core.js";
-import { encodeJSON, encodeSimple } from "../lib/encodings.js";
-import { matchStatusCode } from "../lib/http.js";
-import * as M from "../lib/matchers.js";
-import { compactMap } from "../lib/primitives.js";
-import { safeParse } from "../lib/schemas.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
-import { pathToFunc } from "../lib/url.js";
-import { CodatPlatformError } from "../sdk/models/errors/codatplatformerror.js";
-import {
- ConnectionError,
- InvalidRequestError,
- RequestAbortedError,
- RequestTimeoutError,
- UnexpectedClientError,
-} from "../sdk/models/errors/httpclienterrors.js";
-import * as errors from "../sdk/models/errors/index.js";
-import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
-import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
-import * as operations from "../sdk/models/operations/index.js";
-import * as shared from "../sdk/models/shared/index.js";
-import { APICall, APIPromise } from "../sdk/types/async.js";
-import { Result } from "../sdk/types/fp.js";
+import type { CodatPlatform, CodatPlatformCore } from "../core";
+import { APIPromise } from "../sdk/types/async";
+import type { Result } from "../sdk/types/fp";
+import { toResult } from "./_adapter";
-/**
- * Create connection
- *
- * @remarks
- * Creates a connection for the company by providing a valid `platformKey`.
- *
- * Use the [List Integrations](https://docs.codat.io/platform-api#/operations/list-integrations) endpoint to access valid platform keys.
- */
-export function connectionsCreate(
- client: CodatPlatformCore,
- request: operations.CreateConnectionRequest,
- options?: RequestOptions,
-): APIPromise<
- Result<
- shared.Connection,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >
-> {
- return new APIPromise($do(
- client,
- request,
- options,
- ));
-}
-
-async function $do(
- client: CodatPlatformCore,
- request: operations.CreateConnectionRequest,
- options?: RequestOptions,
-): Promise<
- [
- Result<
- shared.Connection,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >,
- APICall,
- ]
-> {
- const parsed = safeParse(
- request,
- (value) => operations.CreateConnectionRequest$outboundSchema.parse(value),
- "Input validation failed",
- );
- if (!parsed.ok) {
- return [parsed, { status: "invalid" }];
- }
- const payload = parsed.value;
- const body = encodeJSON("body", payload.RequestBody, { explode: true });
-
- const pathParams = {
- companyId: encodeSimple("companyId", payload.companyId, {
- explode: false,
- charEncoding: "percent",
- }),
- };
- const path = pathToFunc("/companies/{companyId}/connections")(pathParams);
-
- const headers = new Headers(compactMap({
- "Content-Type": "application/json",
- Accept: "application/json",
- }));
-
- const secConfig = await extractSecurity(client._options.authHeader);
- const securityInput = secConfig == null ? {} : { authHeader: secConfig };
- const requestSecurity = resolveGlobalSecurity(securityInput);
-
- const context = {
- options: client._options,
- baseURL: options?.serverURL ?? client._baseURL ?? "",
- operationID: "create-connection",
- oAuth2Scopes: null,
+type Call = CodatPlatform["connections"]["create"];
- resolvedSecurity: requestSecurity,
-
- securitySource: client._options.authHeader,
- retryConfig: options?.retries
- || client._options.retryConfig
- || {
- strategy: "backoff",
- backoff: {
- initialInterval: 500,
- maxInterval: 60000,
- exponent: 1.5,
- maxElapsedTime: 3600000,
- },
- retryConnectionErrors: true,
- }
- || { strategy: "none" },
- retryCodes: options?.retryCodes || ["408", "429", "5XX"],
- };
-
- const requestRes = client._createRequest(context, {
- security: requestSecurity,
- method: "POST",
- baseURL: options?.serverURL,
- path: path,
- headers: headers,
- body: body,
- userAgent: client._options.userAgent,
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
- }, options);
- if (!requestRes.ok) {
- return [requestRes, { status: "invalid" }];
- }
- const req = requestRes.value;
-
- const doResult = await client._do(req, {
- context,
- isErrorStatusCode: (statusCode: number) =>
- matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
- retryConfig: context.retryConfig,
- retryCodes: context.retryCodes,
- });
- if (!doResult.ok) {
- return [doResult, { status: "request-error", request: req }];
- }
- const response = doResult.value;
-
- const responseFields = {
- HttpMeta: { Response: response, Request: req },
- };
-
- const [result] = await M.match<
- shared.Connection,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >(
- M.json(200, shared.Connection$inboundSchema),
- M.jsonErr([401, 402, 403, 404, 429], errors.ErrorMessage$inboundSchema),
- M.jsonErr([500, 503], errors.ErrorMessage$inboundSchema),
- M.fail("4XX"),
- M.fail("5XX"),
- )(response, req, { extraFields: responseFields });
- if (!result.ok) {
- return [result, { status: "complete", request: req, response }];
- }
-
- return [result, { status: "complete", request: req, response }];
+export function connectionsCreate(
+ client: CodatPlatformCore,
+ request: Parameters[0],
+ options?: Parameters[1],
+): APIPromise>, Error>> {
+ return new APIPromise(toResult(() => client.connections.create(request, options)));
}
diff --git a/platform/src/funcs/connectionsDelete.ts b/platform/src/funcs/connectionsDelete.ts
index 299934900..fcc7f76ae 100644
--- a/platform/src/funcs/connectionsDelete.ts
+++ b/platform/src/funcs/connectionsDelete.ts
@@ -1,195 +1,17 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
+/* tslint:disable */
+/* eslint-disable */
-import * as z from "zod/v3";
-import { CodatPlatformCore } from "../core.js";
-import { encodeSimple } from "../lib/encodings.js";
-import { matchStatusCode } from "../lib/http.js";
-import * as M from "../lib/matchers.js";
-import { compactMap } from "../lib/primitives.js";
-import { safeParse } from "../lib/schemas.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
-import { pathToFunc } from "../lib/url.js";
-import { CodatPlatformError } from "../sdk/models/errors/codatplatformerror.js";
-import {
- ConnectionError,
- InvalidRequestError,
- RequestAbortedError,
- RequestTimeoutError,
- UnexpectedClientError,
-} from "../sdk/models/errors/httpclienterrors.js";
-import * as errors from "../sdk/models/errors/index.js";
-import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
-import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
-import * as operations from "../sdk/models/operations/index.js";
-import { APICall, APIPromise } from "../sdk/types/async.js";
-import { Result } from "../sdk/types/fp.js";
+import type { CodatPlatform, CodatPlatformCore } from "../core";
+import { APIPromise } from "../sdk/types/async";
+import type { Result } from "../sdk/types/fp";
+import { toResult } from "./_adapter";
-/**
- * Delete connection
- *
- * @remarks
- * Revoke and remove a connection from a company.
- * This operation is not reversible. The end user would need to reauthorize a new data connection if you wish to view new data for this company.
- */
-export function connectionsDelete(
- client: CodatPlatformCore,
- request: operations.DeleteConnectionRequest,
- options?: RequestOptions,
-): APIPromise<
- Result<
- void,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >
-> {
- return new APIPromise($do(
- client,
- request,
- options,
- ));
-}
-
-async function $do(
- client: CodatPlatformCore,
- request: operations.DeleteConnectionRequest,
- options?: RequestOptions,
-): Promise<
- [
- Result<
- void,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >,
- APICall,
- ]
-> {
- const parsed = safeParse(
- request,
- (value) => operations.DeleteConnectionRequest$outboundSchema.parse(value),
- "Input validation failed",
- );
- if (!parsed.ok) {
- return [parsed, { status: "invalid" }];
- }
- const payload = parsed.value;
- const body = null;
-
- const pathParams = {
- companyId: encodeSimple("companyId", payload.companyId, {
- explode: false,
- charEncoding: "percent",
- }),
- connectionId: encodeSimple("connectionId", payload.connectionId, {
- explode: false,
- charEncoding: "percent",
- }),
- };
- const path = pathToFunc("/companies/{companyId}/connections/{connectionId}")(
- pathParams,
- );
-
- const headers = new Headers(compactMap({
- Accept: "application/json",
- }));
-
- const secConfig = await extractSecurity(client._options.authHeader);
- const securityInput = secConfig == null ? {} : { authHeader: secConfig };
- const requestSecurity = resolveGlobalSecurity(securityInput);
-
- const context = {
- options: client._options,
- baseURL: options?.serverURL ?? client._baseURL ?? "",
- operationID: "delete-connection",
- oAuth2Scopes: null,
+type Call = CodatPlatform["connections"]["delete"];
- resolvedSecurity: requestSecurity,
-
- securitySource: client._options.authHeader,
- retryConfig: options?.retries
- || client._options.retryConfig
- || {
- strategy: "backoff",
- backoff: {
- initialInterval: 500,
- maxInterval: 60000,
- exponent: 1.5,
- maxElapsedTime: 3600000,
- },
- retryConnectionErrors: true,
- }
- || { strategy: "none" },
- retryCodes: options?.retryCodes || ["408", "429", "5XX"],
- };
-
- const requestRes = client._createRequest(context, {
- security: requestSecurity,
- method: "DELETE",
- baseURL: options?.serverURL,
- path: path,
- headers: headers,
- body: body,
- userAgent: client._options.userAgent,
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
- }, options);
- if (!requestRes.ok) {
- return [requestRes, { status: "invalid" }];
- }
- const req = requestRes.value;
-
- const doResult = await client._do(req, {
- context,
- isErrorStatusCode: (statusCode: number) =>
- matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
- retryConfig: context.retryConfig,
- retryCodes: context.retryCodes,
- });
- if (!doResult.ok) {
- return [doResult, { status: "request-error", request: req }];
- }
- const response = doResult.value;
-
- const responseFields = {
- HttpMeta: { Response: response, Request: req },
- };
-
- const [result] = await M.match<
- void,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >(
- M.nil(200, z.void()),
- M.jsonErr([401, 402, 403, 404, 429], errors.ErrorMessage$inboundSchema),
- M.jsonErr([500, 503], errors.ErrorMessage$inboundSchema),
- M.fail("4XX"),
- M.fail("5XX"),
- )(response, req, { extraFields: responseFields });
- if (!result.ok) {
- return [result, { status: "complete", request: req, response }];
- }
-
- return [result, { status: "complete", request: req, response }];
+export function connectionsDelete(
+ client: CodatPlatformCore,
+ request: Parameters[0],
+ options?: Parameters[1],
+): APIPromise>, Error>> {
+ return new APIPromise(toResult(() => client.connections.delete(request, options)));
}
diff --git a/platform/src/funcs/connectionsGet.ts b/platform/src/funcs/connectionsGet.ts
index 5a72755ed..b7052f0b4 100644
--- a/platform/src/funcs/connectionsGet.ts
+++ b/platform/src/funcs/connectionsGet.ts
@@ -1,194 +1,17 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
+/* tslint:disable */
+/* eslint-disable */
-import { CodatPlatformCore } from "../core.js";
-import { encodeSimple } from "../lib/encodings.js";
-import { matchStatusCode } from "../lib/http.js";
-import * as M from "../lib/matchers.js";
-import { compactMap } from "../lib/primitives.js";
-import { safeParse } from "../lib/schemas.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
-import { pathToFunc } from "../lib/url.js";
-import { CodatPlatformError } from "../sdk/models/errors/codatplatformerror.js";
-import {
- ConnectionError,
- InvalidRequestError,
- RequestAbortedError,
- RequestTimeoutError,
- UnexpectedClientError,
-} from "../sdk/models/errors/httpclienterrors.js";
-import * as errors from "../sdk/models/errors/index.js";
-import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
-import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
-import * as operations from "../sdk/models/operations/index.js";
-import * as shared from "../sdk/models/shared/index.js";
-import { APICall, APIPromise } from "../sdk/types/async.js";
-import { Result } from "../sdk/types/fp.js";
+import type { CodatPlatform, CodatPlatformCore } from "../core";
+import { APIPromise } from "../sdk/types/async";
+import type { Result } from "../sdk/types/fp";
+import { toResult } from "./_adapter";
-/**
- * Get connection
- *
- * @remarks
- * Returns a specific connection for a company when valid identifiers are provided. If the identifiers are for a deleted company and/or connection, a not found response is returned.
- */
-export function connectionsGet(
- client: CodatPlatformCore,
- request: operations.GetConnectionRequest,
- options?: RequestOptions,
-): APIPromise<
- Result<
- shared.Connection,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >
-> {
- return new APIPromise($do(
- client,
- request,
- options,
- ));
-}
-
-async function $do(
- client: CodatPlatformCore,
- request: operations.GetConnectionRequest,
- options?: RequestOptions,
-): Promise<
- [
- Result<
- shared.Connection,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >,
- APICall,
- ]
-> {
- const parsed = safeParse(
- request,
- (value) => operations.GetConnectionRequest$outboundSchema.parse(value),
- "Input validation failed",
- );
- if (!parsed.ok) {
- return [parsed, { status: "invalid" }];
- }
- const payload = parsed.value;
- const body = null;
-
- const pathParams = {
- companyId: encodeSimple("companyId", payload.companyId, {
- explode: false,
- charEncoding: "percent",
- }),
- connectionId: encodeSimple("connectionId", payload.connectionId, {
- explode: false,
- charEncoding: "percent",
- }),
- };
- const path = pathToFunc("/companies/{companyId}/connections/{connectionId}")(
- pathParams,
- );
-
- const headers = new Headers(compactMap({
- Accept: "application/json",
- }));
-
- const secConfig = await extractSecurity(client._options.authHeader);
- const securityInput = secConfig == null ? {} : { authHeader: secConfig };
- const requestSecurity = resolveGlobalSecurity(securityInput);
-
- const context = {
- options: client._options,
- baseURL: options?.serverURL ?? client._baseURL ?? "",
- operationID: "get-connection",
- oAuth2Scopes: null,
+type Call = CodatPlatform["connections"]["get"];
- resolvedSecurity: requestSecurity,
-
- securitySource: client._options.authHeader,
- retryConfig: options?.retries
- || client._options.retryConfig
- || {
- strategy: "backoff",
- backoff: {
- initialInterval: 500,
- maxInterval: 60000,
- exponent: 1.5,
- maxElapsedTime: 3600000,
- },
- retryConnectionErrors: true,
- }
- || { strategy: "none" },
- retryCodes: options?.retryCodes || ["408", "429", "5XX"],
- };
-
- const requestRes = client._createRequest(context, {
- security: requestSecurity,
- method: "GET",
- baseURL: options?.serverURL,
- path: path,
- headers: headers,
- body: body,
- userAgent: client._options.userAgent,
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
- }, options);
- if (!requestRes.ok) {
- return [requestRes, { status: "invalid" }];
- }
- const req = requestRes.value;
-
- const doResult = await client._do(req, {
- context,
- isErrorStatusCode: (statusCode: number) =>
- matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
- retryConfig: context.retryConfig,
- retryCodes: context.retryCodes,
- });
- if (!doResult.ok) {
- return [doResult, { status: "request-error", request: req }];
- }
- const response = doResult.value;
-
- const responseFields = {
- HttpMeta: { Response: response, Request: req },
- };
-
- const [result] = await M.match<
- shared.Connection,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >(
- M.json(200, shared.Connection$inboundSchema),
- M.jsonErr([401, 402, 403, 404, 429], errors.ErrorMessage$inboundSchema),
- M.jsonErr([500, 503], errors.ErrorMessage$inboundSchema),
- M.fail("4XX"),
- M.fail("5XX"),
- )(response, req, { extraFields: responseFields });
- if (!result.ok) {
- return [result, { status: "complete", request: req, response }];
- }
-
- return [result, { status: "complete", request: req, response }];
+export function connectionsGet(
+ client: CodatPlatformCore,
+ request: Parameters[0],
+ options?: Parameters[1],
+): APIPromise>, Error>> {
+ return new APIPromise(toResult(() => client.connections.get(request, options)));
}
diff --git a/platform/src/funcs/connectionsList.ts b/platform/src/funcs/connectionsList.ts
index 4df8cda66..e6b714624 100644
--- a/platform/src/funcs/connectionsList.ts
+++ b/platform/src/funcs/connectionsList.ts
@@ -1,199 +1,17 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
+/* tslint:disable */
+/* eslint-disable */
-import { CodatPlatformCore } from "../core.js";
-import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
-import { matchStatusCode } from "../lib/http.js";
-import * as M from "../lib/matchers.js";
-import { compactMap } from "../lib/primitives.js";
-import { safeParse } from "../lib/schemas.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
-import { pathToFunc } from "../lib/url.js";
-import { CodatPlatformError } from "../sdk/models/errors/codatplatformerror.js";
-import {
- ConnectionError,
- InvalidRequestError,
- RequestAbortedError,
- RequestTimeoutError,
- UnexpectedClientError,
-} from "../sdk/models/errors/httpclienterrors.js";
-import * as errors from "../sdk/models/errors/index.js";
-import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
-import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
-import * as operations from "../sdk/models/operations/index.js";
-import * as shared from "../sdk/models/shared/index.js";
-import { APICall, APIPromise } from "../sdk/types/async.js";
-import { Result } from "../sdk/types/fp.js";
+import type { CodatPlatform, CodatPlatformCore } from "../core";
+import { APIPromise } from "../sdk/types/async";
+import type { Result } from "../sdk/types/fp";
+import { toResult } from "./_adapter";
-/**
- * List connections
- *
- * @remarks
- * List the connections for a company.
- */
-export function connectionsList(
- client: CodatPlatformCore,
- request: operations.ListConnectionsRequest,
- options?: RequestOptions,
-): APIPromise<
- Result<
- shared.Connections,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >
-> {
- return new APIPromise($do(
- client,
- request,
- options,
- ));
-}
-
-async function $do(
- client: CodatPlatformCore,
- request: operations.ListConnectionsRequest,
- options?: RequestOptions,
-): Promise<
- [
- Result<
- shared.Connections,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >,
- APICall,
- ]
-> {
- const parsed = safeParse(
- request,
- (value) => operations.ListConnectionsRequest$outboundSchema.parse(value),
- "Input validation failed",
- );
- if (!parsed.ok) {
- return [parsed, { status: "invalid" }];
- }
- const payload = parsed.value;
- const body = null;
-
- const pathParams = {
- companyId: encodeSimple("companyId", payload.companyId, {
- explode: false,
- charEncoding: "percent",
- }),
- };
- const path = pathToFunc("/companies/{companyId}/connections")(pathParams);
-
- const query = encodeFormQuery({
- "orderBy": payload.orderBy,
- "page": payload.page,
- "pageSize": payload.pageSize,
- "query": payload.query,
- });
-
- const headers = new Headers(compactMap({
- Accept: "application/json",
- }));
-
- const secConfig = await extractSecurity(client._options.authHeader);
- const securityInput = secConfig == null ? {} : { authHeader: secConfig };
- const requestSecurity = resolveGlobalSecurity(securityInput);
-
- const context = {
- options: client._options,
- baseURL: options?.serverURL ?? client._baseURL ?? "",
- operationID: "list-connections",
- oAuth2Scopes: null,
+type Call = CodatPlatform["connections"]["list"];
- resolvedSecurity: requestSecurity,
-
- securitySource: client._options.authHeader,
- retryConfig: options?.retries
- || client._options.retryConfig
- || {
- strategy: "backoff",
- backoff: {
- initialInterval: 500,
- maxInterval: 60000,
- exponent: 1.5,
- maxElapsedTime: 3600000,
- },
- retryConnectionErrors: true,
- }
- || { strategy: "none" },
- retryCodes: options?.retryCodes || ["408", "429", "5XX"],
- };
-
- const requestRes = client._createRequest(context, {
- security: requestSecurity,
- method: "GET",
- baseURL: options?.serverURL,
- path: path,
- headers: headers,
- query: query,
- body: body,
- userAgent: client._options.userAgent,
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
- }, options);
- if (!requestRes.ok) {
- return [requestRes, { status: "invalid" }];
- }
- const req = requestRes.value;
-
- const doResult = await client._do(req, {
- context,
- isErrorStatusCode: (statusCode: number) =>
- matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
- retryConfig: context.retryConfig,
- retryCodes: context.retryCodes,
- });
- if (!doResult.ok) {
- return [doResult, { status: "request-error", request: req }];
- }
- const response = doResult.value;
-
- const responseFields = {
- HttpMeta: { Response: response, Request: req },
- };
-
- const [result] = await M.match<
- shared.Connections,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >(
- M.json(200, shared.Connections$inboundSchema),
- M.jsonErr(
- [400, 401, 402, 403, 404, 429],
- errors.ErrorMessage$inboundSchema,
- ),
- M.jsonErr([500, 503], errors.ErrorMessage$inboundSchema),
- M.fail("4XX"),
- M.fail("5XX"),
- )(response, req, { extraFields: responseFields });
- if (!result.ok) {
- return [result, { status: "complete", request: req, response }];
- }
-
- return [result, { status: "complete", request: req, response }];
+export function connectionsList(
+ client: CodatPlatformCore,
+ request: Parameters[0],
+ options?: Parameters[1],
+): APIPromise>, Error>> {
+ return new APIPromise(toResult(() => client.connections.list(request, options)));
}
diff --git a/platform/src/funcs/connectionsUnlink.ts b/platform/src/funcs/connectionsUnlink.ts
index 25deda120..e8e1327cc 100644
--- a/platform/src/funcs/connectionsUnlink.ts
+++ b/platform/src/funcs/connectionsUnlink.ts
@@ -1,197 +1,17 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
+/* tslint:disable */
+/* eslint-disable */
-import { CodatPlatformCore } from "../core.js";
-import { encodeJSON, encodeSimple } from "../lib/encodings.js";
-import { matchStatusCode } from "../lib/http.js";
-import * as M from "../lib/matchers.js";
-import { compactMap } from "../lib/primitives.js";
-import { safeParse } from "../lib/schemas.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
-import { pathToFunc } from "../lib/url.js";
-import { CodatPlatformError } from "../sdk/models/errors/codatplatformerror.js";
-import {
- ConnectionError,
- InvalidRequestError,
- RequestAbortedError,
- RequestTimeoutError,
- UnexpectedClientError,
-} from "../sdk/models/errors/httpclienterrors.js";
-import * as errors from "../sdk/models/errors/index.js";
-import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
-import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
-import * as operations from "../sdk/models/operations/index.js";
-import * as shared from "../sdk/models/shared/index.js";
-import { APICall, APIPromise } from "../sdk/types/async.js";
-import { Result } from "../sdk/types/fp.js";
+import type { CodatPlatform, CodatPlatformCore } from "../core";
+import { APIPromise } from "../sdk/types/async";
+import type { Result } from "../sdk/types/fp";
+import { toResult } from "./_adapter";
-/**
- * Unlink connection
- *
- * @remarks
- * This allows you to deauthorize a connection, without deleting it from Codat. This means you can still view any data that has previously been pulled into Codat, and also lets you re-authorize in future if your customer wishes to resume sharing their data.
- */
-export function connectionsUnlink(
- client: CodatPlatformCore,
- request: operations.UnlinkConnectionRequest,
- options?: RequestOptions,
-): APIPromise<
- Result<
- shared.Connection,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >
-> {
- return new APIPromise($do(
- client,
- request,
- options,
- ));
-}
-
-async function $do(
- client: CodatPlatformCore,
- request: operations.UnlinkConnectionRequest,
- options?: RequestOptions,
-): Promise<
- [
- Result<
- shared.Connection,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >,
- APICall,
- ]
-> {
- const parsed = safeParse(
- request,
- (value) => operations.UnlinkConnectionRequest$outboundSchema.parse(value),
- "Input validation failed",
- );
- if (!parsed.ok) {
- return [parsed, { status: "invalid" }];
- }
- const payload = parsed.value;
- const body = encodeJSON("body", payload.UpdateConnectionStatus, {
- explode: true,
- });
-
- const pathParams = {
- companyId: encodeSimple("companyId", payload.companyId, {
- explode: false,
- charEncoding: "percent",
- }),
- connectionId: encodeSimple("connectionId", payload.connectionId, {
- explode: false,
- charEncoding: "percent",
- }),
- };
- const path = pathToFunc("/companies/{companyId}/connections/{connectionId}")(
- pathParams,
- );
-
- const headers = new Headers(compactMap({
- "Content-Type": "application/json",
- Accept: "application/json",
- }));
-
- const secConfig = await extractSecurity(client._options.authHeader);
- const securityInput = secConfig == null ? {} : { authHeader: secConfig };
- const requestSecurity = resolveGlobalSecurity(securityInput);
-
- const context = {
- options: client._options,
- baseURL: options?.serverURL ?? client._baseURL ?? "",
- operationID: "unlink-connection",
- oAuth2Scopes: null,
+type Call = CodatPlatform["connections"]["unlink"];
- resolvedSecurity: requestSecurity,
-
- securitySource: client._options.authHeader,
- retryConfig: options?.retries
- || client._options.retryConfig
- || {
- strategy: "backoff",
- backoff: {
- initialInterval: 500,
- maxInterval: 60000,
- exponent: 1.5,
- maxElapsedTime: 3600000,
- },
- retryConnectionErrors: true,
- }
- || { strategy: "none" },
- retryCodes: options?.retryCodes || ["408", "429", "5XX"],
- };
-
- const requestRes = client._createRequest(context, {
- security: requestSecurity,
- method: "PATCH",
- baseURL: options?.serverURL,
- path: path,
- headers: headers,
- body: body,
- userAgent: client._options.userAgent,
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
- }, options);
- if (!requestRes.ok) {
- return [requestRes, { status: "invalid" }];
- }
- const req = requestRes.value;
-
- const doResult = await client._do(req, {
- context,
- isErrorStatusCode: (statusCode: number) =>
- matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
- retryConfig: context.retryConfig,
- retryCodes: context.retryCodes,
- });
- if (!doResult.ok) {
- return [doResult, { status: "request-error", request: req }];
- }
- const response = doResult.value;
-
- const responseFields = {
- HttpMeta: { Response: response, Request: req },
- };
-
- const [result] = await M.match<
- shared.Connection,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >(
- M.json(200, shared.Connection$inboundSchema),
- M.jsonErr([401, 402, 403, 404, 429], errors.ErrorMessage$inboundSchema),
- M.jsonErr([500, 503], errors.ErrorMessage$inboundSchema),
- M.fail("4XX"),
- M.fail("5XX"),
- )(response, req, { extraFields: responseFields });
- if (!result.ok) {
- return [result, { status: "complete", request: req, response }];
- }
-
- return [result, { status: "complete", request: req, response }];
+export function connectionsUnlink(
+ client: CodatPlatformCore,
+ request: Parameters[0],
+ options?: Parameters[1],
+): APIPromise>, Error>> {
+ return new APIPromise(toResult(() => client.connections.unlink(request, options)));
}
diff --git a/platform/src/funcs/connectionsUpdateAuthorization.ts b/platform/src/funcs/connectionsUpdateAuthorization.ts
index 8b80d8ab7..c1aaece06 100644
--- a/platform/src/funcs/connectionsUpdateAuthorization.ts
+++ b/platform/src/funcs/connectionsUpdateAuthorization.ts
@@ -1,198 +1,17 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
+/* tslint:disable */
+/* eslint-disable */
-import { CodatPlatformCore } from "../core.js";
-import { encodeJSON, encodeSimple } from "../lib/encodings.js";
-import { matchStatusCode } from "../lib/http.js";
-import * as M from "../lib/matchers.js";
-import { compactMap } from "../lib/primitives.js";
-import { safeParse } from "../lib/schemas.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
-import { pathToFunc } from "../lib/url.js";
-import { CodatPlatformError } from "../sdk/models/errors/codatplatformerror.js";
-import {
- ConnectionError,
- InvalidRequestError,
- RequestAbortedError,
- RequestTimeoutError,
- UnexpectedClientError,
-} from "../sdk/models/errors/httpclienterrors.js";
-import * as errors from "../sdk/models/errors/index.js";
-import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
-import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
-import * as operations from "../sdk/models/operations/index.js";
-import * as shared from "../sdk/models/shared/index.js";
-import { APICall, APIPromise } from "../sdk/types/async.js";
-import { Result } from "../sdk/types/fp.js";
+import type { CodatPlatform, CodatPlatformCore } from "../core";
+import { APIPromise } from "../sdk/types/async";
+import type { Result } from "../sdk/types/fp";
+import { toResult } from "./_adapter";
-/**
- * Update authorization
- *
- * @remarks
- * Update data connection's authorization.
- */
-export function connectionsUpdateAuthorization(
- client: CodatPlatformCore,
- request: operations.UpdateConnectionAuthorizationRequest,
- options?: RequestOptions,
-): APIPromise<
- Result<
- shared.Connection,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >
-> {
- return new APIPromise($do(
- client,
- request,
- options,
- ));
-}
-
-async function $do(
- client: CodatPlatformCore,
- request: operations.UpdateConnectionAuthorizationRequest,
- options?: RequestOptions,
-): Promise<
- [
- Result<
- shared.Connection,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >,
- APICall,
- ]
-> {
- const parsed = safeParse(
- request,
- (value) =>
- operations.UpdateConnectionAuthorizationRequest$outboundSchema.parse(
- value,
- ),
- "Input validation failed",
- );
- if (!parsed.ok) {
- return [parsed, { status: "invalid" }];
- }
- const payload = parsed.value;
- const body = encodeJSON("body", payload.RequestBody, { explode: true });
-
- const pathParams = {
- companyId: encodeSimple("companyId", payload.companyId, {
- explode: false,
- charEncoding: "percent",
- }),
- connectionId: encodeSimple("connectionId", payload.connectionId, {
- explode: false,
- charEncoding: "percent",
- }),
- };
- const path = pathToFunc(
- "/companies/{companyId}/connections/{connectionId}/authorization",
- )(pathParams);
-
- const headers = new Headers(compactMap({
- "Content-Type": "application/json",
- Accept: "application/json",
- }));
-
- const secConfig = await extractSecurity(client._options.authHeader);
- const securityInput = secConfig == null ? {} : { authHeader: secConfig };
- const requestSecurity = resolveGlobalSecurity(securityInput);
-
- const context = {
- options: client._options,
- baseURL: options?.serverURL ?? client._baseURL ?? "",
- operationID: "update-connection-authorization",
- oAuth2Scopes: null,
+type Call = CodatPlatform["connections"]["updateAuthorization"];
- resolvedSecurity: requestSecurity,
-
- securitySource: client._options.authHeader,
- retryConfig: options?.retries
- || client._options.retryConfig
- || {
- strategy: "backoff",
- backoff: {
- initialInterval: 500,
- maxInterval: 60000,
- exponent: 1.5,
- maxElapsedTime: 3600000,
- },
- retryConnectionErrors: true,
- }
- || { strategy: "none" },
- retryCodes: options?.retryCodes || ["408", "429", "5XX"],
- };
-
- const requestRes = client._createRequest(context, {
- security: requestSecurity,
- method: "PUT",
- baseURL: options?.serverURL,
- path: path,
- headers: headers,
- body: body,
- userAgent: client._options.userAgent,
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
- }, options);
- if (!requestRes.ok) {
- return [requestRes, { status: "invalid" }];
- }
- const req = requestRes.value;
-
- const doResult = await client._do(req, {
- context,
- isErrorStatusCode: (statusCode: number) =>
- matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
- retryConfig: context.retryConfig,
- retryCodes: context.retryCodes,
- });
- if (!doResult.ok) {
- return [doResult, { status: "request-error", request: req }];
- }
- const response = doResult.value;
-
- const responseFields = {
- HttpMeta: { Response: response, Request: req },
- };
-
- const [result] = await M.match<
- shared.Connection,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >(
- M.json(200, shared.Connection$inboundSchema),
- M.jsonErr([401, 402, 403, 404, 429], errors.ErrorMessage$inboundSchema),
- M.jsonErr([500, 503], errors.ErrorMessage$inboundSchema),
- M.fail("4XX"),
- M.fail("5XX"),
- )(response, req, { extraFields: responseFields });
- if (!result.ok) {
- return [result, { status: "complete", request: req, response }];
- }
-
- return [result, { status: "complete", request: req, response }];
+export function connectionsUpdateAuthorization(
+ client: CodatPlatformCore,
+ request: Parameters[0],
+ options?: Parameters[1],
+): APIPromise>, Error>> {
+ return new APIPromise(toResult(() => client.connections.updateAuthorization(request, options)));
}
diff --git a/platform/src/funcs/corsGet.ts b/platform/src/funcs/corsGet.ts
index 68e859302..2ec3bdd0b 100644
--- a/platform/src/funcs/corsGet.ts
+++ b/platform/src/funcs/corsGet.ts
@@ -1,170 +1,18 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
+/* tslint:disable */
+/* eslint-disable */
-import { CodatPlatformCore } from "../core.js";
-import { matchStatusCode } from "../lib/http.js";
-import * as M from "../lib/matchers.js";
-import { compactMap } from "../lib/primitives.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
-import { pathToFunc } from "../lib/url.js";
-import { CodatPlatformError } from "../sdk/models/errors/codatplatformerror.js";
-import {
- ConnectionError,
- InvalidRequestError,
- RequestAbortedError,
- RequestTimeoutError,
- UnexpectedClientError,
-} from "../sdk/models/errors/httpclienterrors.js";
-import * as errors from "../sdk/models/errors/index.js";
-import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
-import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
-import * as shared from "../sdk/models/shared/index.js";
-import { APICall, APIPromise } from "../sdk/types/async.js";
-import { Result } from "../sdk/types/fp.js";
+import type { CodatPlatform, CodatPlatformCore } from "../core";
+import { APIPromise } from "../sdk/types/async";
+import type { Result } from "../sdk/types/fp";
+import { toResult } from "./_adapter";
-/**
- * Get CORS settings (old)
- *
- * @remarks
- * The *Get CORS settings* endpoint returns the allowed origins (i.e. your domains) you want to allow cross-origin resource sharing ([CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing)) with Codat.
- *
- * Enabling CORS with Codat is required by our embeddable UIs (such as [Connections SDK](https://docs.codat.io/auth-flow/optimize/connection-management) and [Link SDK](https://docs.codat.io/auth-flow/authorize-embedded-link)) to access Codat's API endpoints.
- *
- * @deprecated method: The new [Get CORS settings](https://docs.codat.io/platform-api#/operations/get-cors-settings) endpoint replaces this endpoint and includes additional functionality.
-Update your integrations to use the new path `/corsSettings` as the existing route will be removed in a future release.
-. Use get instead.
- */
-export function corsGet(
- client: CodatPlatformCore,
- options?: RequestOptions,
-): APIPromise<
- Result<
- shared.ConnectionManagementAllowedOrigins,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >
-> {
- return new APIPromise($do(
- client,
- options,
- ));
-}
-
-async function $do(
- client: CodatPlatformCore,
- options?: RequestOptions,
-): Promise<
- [
- Result<
- shared.ConnectionManagementAllowedOrigins,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >,
- APICall,
- ]
-> {
- const path = pathToFunc("/connectionManagement/corsSettings")();
-
- const headers = new Headers(compactMap({
- Accept: "application/json",
- }));
-
- const secConfig = await extractSecurity(client._options.authHeader);
- const securityInput = secConfig == null ? {} : { authHeader: secConfig };
- const requestSecurity = resolveGlobalSecurity(securityInput);
-
- const context = {
- options: client._options,
- baseURL: options?.serverURL ?? client._baseURL ?? "",
- operationID: "get-connection-management-cors-settings",
- oAuth2Scopes: null,
-
- resolvedSecurity: requestSecurity,
+type Call = CodatPlatform["cors"]["get"];
- securitySource: client._options.authHeader,
- retryConfig: options?.retries
- || client._options.retryConfig
- || {
- strategy: "backoff",
- backoff: {
- initialInterval: 500,
- maxInterval: 60000,
- exponent: 1.5,
- maxElapsedTime: 3600000,
- },
- retryConnectionErrors: true,
- }
- || { strategy: "none" },
- retryCodes: options?.retryCodes || ["408", "429", "5XX"],
- };
-
- const requestRes = client._createRequest(context, {
- security: requestSecurity,
- method: "GET",
- baseURL: options?.serverURL,
- path: path,
- headers: headers,
- userAgent: client._options.userAgent,
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
- }, options);
- if (!requestRes.ok) {
- return [requestRes, { status: "invalid" }];
- }
- const req = requestRes.value;
-
- const doResult = await client._do(req, {
- context,
- isErrorStatusCode: (statusCode: number) =>
- matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
- retryConfig: context.retryConfig,
- retryCodes: context.retryCodes,
- });
- if (!doResult.ok) {
- return [doResult, { status: "request-error", request: req }];
- }
- const response = doResult.value;
-
- const responseFields = {
- HttpMeta: { Response: response, Request: req },
- };
-
- const [result] = await M.match<
- shared.ConnectionManagementAllowedOrigins,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >(
- M.json(200, shared.ConnectionManagementAllowedOrigins$inboundSchema),
- M.jsonErr([401, 402, 403, 404, 429], errors.ErrorMessage$inboundSchema),
- M.jsonErr([500, 503], errors.ErrorMessage$inboundSchema),
- M.fail("4XX"),
- M.fail("5XX"),
- )(response, req, { extraFields: responseFields });
- if (!result.ok) {
- return [result, { status: "complete", request: req, response }];
- }
-
- return [result, { status: "complete", request: req, response }];
+export function corsGet(
+ client: CodatPlatformCore,
+ request?: Record,
+ options?: Parameters[0],
+): APIPromise>, Error>> {
+ void request;
+ return new APIPromise(toResult(() => client.cors.get(options)));
}
diff --git a/platform/src/funcs/corsSet.ts b/platform/src/funcs/corsSet.ts
index 5037527df..0fe259658 100644
--- a/platform/src/funcs/corsSet.ts
+++ b/platform/src/funcs/corsSet.ts
@@ -1,193 +1,17 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
+/* tslint:disable */
+/* eslint-disable */
-import { CodatPlatformCore } from "../core.js";
-import { encodeJSON } from "../lib/encodings.js";
-import { matchStatusCode } from "../lib/http.js";
-import * as M from "../lib/matchers.js";
-import { compactMap } from "../lib/primitives.js";
-import { safeParse } from "../lib/schemas.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
-import { pathToFunc } from "../lib/url.js";
-import { CodatPlatformError } from "../sdk/models/errors/codatplatformerror.js";
-import {
- ConnectionError,
- InvalidRequestError,
- RequestAbortedError,
- RequestTimeoutError,
- UnexpectedClientError,
-} from "../sdk/models/errors/httpclienterrors.js";
-import * as errors from "../sdk/models/errors/index.js";
-import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
-import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
-import * as shared from "../sdk/models/shared/index.js";
-import { APICall, APIPromise } from "../sdk/types/async.js";
-import { Result } from "../sdk/types/fp.js";
+import type { CodatPlatform, CodatPlatformCore } from "../core";
+import { APIPromise } from "../sdk/types/async";
+import type { Result } from "../sdk/types/fp";
+import { toResult } from "./_adapter";
-/**
- * Set CORS settings (old)
- *
- * @remarks
- * The *Set CORS settings* endpoint allows you to register allowed origins (i.e. your domains) for use in cross-origin resource sharing ([CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing)).
- *
- * Enabling CORS with Codat is required by our embeddable UIs (such as [Connections SDK](https://docs.codat.io/auth-flow/optimize/connection-management) and [Link SDK](https://docs.codat.io/auth-flow/authorize-embedded-link)) to access Codat's API endpoints.
- *
- * @deprecated method: The new [Set CORS settings](https://docs.codat.io/platform-api#/operations/set-cors-settings) endpoint replaces this endpoint and includes additional functionality.
-Update your integrations to use the new path `/corsSettings` as the existing route will be removed in a future release.
-. Use set instead.
- */
-export function corsSet(
- client: CodatPlatformCore,
- request?: shared.ConnectionManagementAllowedOrigins | undefined,
- options?: RequestOptions,
-): APIPromise<
- Result<
- shared.ConnectionManagementAllowedOrigins,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >
-> {
- return new APIPromise($do(
- client,
- request,
- options,
- ));
-}
-
-async function $do(
- client: CodatPlatformCore,
- request?: shared.ConnectionManagementAllowedOrigins | undefined,
- options?: RequestOptions,
-): Promise<
- [
- Result<
- shared.ConnectionManagementAllowedOrigins,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >,
- APICall,
- ]
-> {
- const parsed = safeParse(
- request,
- (value) =>
- shared.ConnectionManagementAllowedOrigins$outboundSchema.optional().parse(
- value,
- ),
- "Input validation failed",
- );
- if (!parsed.ok) {
- return [parsed, { status: "invalid" }];
- }
- const payload = parsed.value;
- const body = payload === undefined
- ? null
- : encodeJSON("body", payload, { explode: true });
-
- const path = pathToFunc("/connectionManagement/corsSettings")();
-
- const headers = new Headers(compactMap({
- "Content-Type": "application/json",
- Accept: "application/json",
- }));
-
- const secConfig = await extractSecurity(client._options.authHeader);
- const securityInput = secConfig == null ? {} : { authHeader: secConfig };
- const requestSecurity = resolveGlobalSecurity(securityInput);
-
- const context = {
- options: client._options,
- baseURL: options?.serverURL ?? client._baseURL ?? "",
- operationID: "set-connection-management-cors-settings",
- oAuth2Scopes: null,
+type Call = CodatPlatform["cors"]["set"];
- resolvedSecurity: requestSecurity,
-
- securitySource: client._options.authHeader,
- retryConfig: options?.retries
- || client._options.retryConfig
- || {
- strategy: "backoff",
- backoff: {
- initialInterval: 500,
- maxInterval: 60000,
- exponent: 1.5,
- maxElapsedTime: 3600000,
- },
- retryConnectionErrors: true,
- }
- || { strategy: "none" },
- retryCodes: options?.retryCodes || ["408", "429", "5XX"],
- };
-
- const requestRes = client._createRequest(context, {
- security: requestSecurity,
- method: "POST",
- baseURL: options?.serverURL,
- path: path,
- headers: headers,
- body: body,
- userAgent: client._options.userAgent,
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
- }, options);
- if (!requestRes.ok) {
- return [requestRes, { status: "invalid" }];
- }
- const req = requestRes.value;
-
- const doResult = await client._do(req, {
- context,
- isErrorStatusCode: (statusCode: number) =>
- matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
- retryConfig: context.retryConfig,
- retryCodes: context.retryCodes,
- });
- if (!doResult.ok) {
- return [doResult, { status: "request-error", request: req }];
- }
- const response = doResult.value;
-
- const responseFields = {
- HttpMeta: { Response: response, Request: req },
- };
-
- const [result] = await M.match<
- shared.ConnectionManagementAllowedOrigins,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >(
- M.json(200, shared.ConnectionManagementAllowedOrigins$inboundSchema),
- M.jsonErr([401, 402, 403, 404, 429], errors.ErrorMessage$inboundSchema),
- M.jsonErr([500, 503], errors.ErrorMessage$inboundSchema),
- M.fail("4XX"),
- M.fail("5XX"),
- )(response, req, { extraFields: responseFields });
- if (!result.ok) {
- return [result, { status: "complete", request: req, response }];
- }
-
- return [result, { status: "complete", request: req, response }];
+export function corsSet(
+ client: CodatPlatformCore,
+ request?: Parameters[0],
+ options?: Parameters[1],
+): APIPromise>, Error>> {
+ return new APIPromise(toResult(() => client.cors.set(request, options)));
}
diff --git a/platform/src/funcs/customDataTypeConfigure.ts b/platform/src/funcs/customDataTypeConfigure.ts
index b22b80f81..4540c1cff 100644
--- a/platform/src/funcs/customDataTypeConfigure.ts
+++ b/platform/src/funcs/customDataTypeConfigure.ts
@@ -1,209 +1,17 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
+/* tslint:disable */
+/* eslint-disable */
-import { CodatPlatformCore } from "../core.js";
-import { encodeJSON, encodeSimple } from "../lib/encodings.js";
-import { matchStatusCode } from "../lib/http.js";
-import * as M from "../lib/matchers.js";
-import { compactMap } from "../lib/primitives.js";
-import { safeParse } from "../lib/schemas.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
-import { pathToFunc } from "../lib/url.js";
-import { CodatPlatformError } from "../sdk/models/errors/codatplatformerror.js";
-import {
- ConnectionError,
- InvalidRequestError,
- RequestAbortedError,
- RequestTimeoutError,
- UnexpectedClientError,
-} from "../sdk/models/errors/httpclienterrors.js";
-import * as errors from "../sdk/models/errors/index.js";
-import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
-import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
-import * as operations from "../sdk/models/operations/index.js";
-import * as shared from "../sdk/models/shared/index.js";
-import { APICall, APIPromise } from "../sdk/types/async.js";
-import { Result } from "../sdk/types/fp.js";
+import type { CodatPlatform, CodatPlatformCore } from "../core";
+import { APIPromise } from "../sdk/types/async";
+import type { Result } from "../sdk/types/fp";
+import { toResult } from "./_adapter";
-/**
- * Configure custom data type
- *
- * @remarks
- * The *Configure custom data type* endpoint allows you to maintain or change the configuration required to return a custom data type for a specific integration.
- *
- * A [custom data type](https://docs.codat.io/using-the-api/custom-data) is an additional data type you can create that is not included in Codat's standardized data model.
- *
- * ### Tips and traps
- *
- * - You can only configure a single custom data type for a single platform at a time. Use the endpoint multiple times if you need to configure it for multiple platforms.
- *
- * - You can only indicate a single data source for each customer data type.
- *
- * - Make your custom configuration as similar as possible to our standard data types so you can interact with them in exactly the same way.
- */
-export function customDataTypeConfigure(
- client: CodatPlatformCore,
- request: operations.ConfigureCustomDataTypeRequest,
- options?: RequestOptions,
-): APIPromise<
- Result<
- shared.CustomDataTypeConfiguration,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >
-> {
- return new APIPromise($do(
- client,
- request,
- options,
- ));
-}
-
-async function $do(
- client: CodatPlatformCore,
- request: operations.ConfigureCustomDataTypeRequest,
- options?: RequestOptions,
-): Promise<
- [
- Result<
- shared.CustomDataTypeConfiguration,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >,
- APICall,
- ]
-> {
- const parsed = safeParse(
- request,
- (value) =>
- operations.ConfigureCustomDataTypeRequest$outboundSchema.parse(value),
- "Input validation failed",
- );
- if (!parsed.ok) {
- return [parsed, { status: "invalid" }];
- }
- const payload = parsed.value;
- const body = encodeJSON("body", payload.CustomDataTypeConfiguration, {
- explode: true,
- });
-
- const pathParams = {
- customDataIdentifier: encodeSimple(
- "customDataIdentifier",
- payload.customDataIdentifier,
- { explode: false, charEncoding: "percent" },
- ),
- platformKey: encodeSimple("platformKey", payload.platformKey, {
- explode: false,
- charEncoding: "percent",
- }),
- };
- const path = pathToFunc(
- "/integrations/{platformKey}/dataTypes/custom/{customDataIdentifier}",
- )(pathParams);
-
- const headers = new Headers(compactMap({
- "Content-Type": "application/json",
- Accept: "application/json",
- }));
-
- const secConfig = await extractSecurity(client._options.authHeader);
- const securityInput = secConfig == null ? {} : { authHeader: secConfig };
- const requestSecurity = resolveGlobalSecurity(securityInput);
-
- const context = {
- options: client._options,
- baseURL: options?.serverURL ?? client._baseURL ?? "",
- operationID: "configure-custom-data-type",
- oAuth2Scopes: null,
+type Call = CodatPlatform["customDataType"]["configure"];
- resolvedSecurity: requestSecurity,
-
- securitySource: client._options.authHeader,
- retryConfig: options?.retries
- || client._options.retryConfig
- || {
- strategy: "backoff",
- backoff: {
- initialInterval: 500,
- maxInterval: 60000,
- exponent: 1.5,
- maxElapsedTime: 3600000,
- },
- retryConnectionErrors: true,
- }
- || { strategy: "none" },
- retryCodes: options?.retryCodes || ["408", "429", "5XX"],
- };
-
- const requestRes = client._createRequest(context, {
- security: requestSecurity,
- method: "PUT",
- baseURL: options?.serverURL,
- path: path,
- headers: headers,
- body: body,
- userAgent: client._options.userAgent,
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
- }, options);
- if (!requestRes.ok) {
- return [requestRes, { status: "invalid" }];
- }
- const req = requestRes.value;
-
- const doResult = await client._do(req, {
- context,
- isErrorStatusCode: (statusCode: number) =>
- matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
- retryConfig: context.retryConfig,
- retryCodes: context.retryCodes,
- });
- if (!doResult.ok) {
- return [doResult, { status: "request-error", request: req }];
- }
- const response = doResult.value;
-
- const responseFields = {
- HttpMeta: { Response: response, Request: req },
- };
-
- const [result] = await M.match<
- shared.CustomDataTypeConfiguration,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >(
- M.json(200, shared.CustomDataTypeConfiguration$inboundSchema),
- M.jsonErr([401, 402, 403, 404, 429], errors.ErrorMessage$inboundSchema),
- M.jsonErr([500, 503], errors.ErrorMessage$inboundSchema),
- M.fail("4XX"),
- M.fail("5XX"),
- )(response, req, { extraFields: responseFields });
- if (!result.ok) {
- return [result, { status: "complete", request: req, response }];
- }
-
- return [result, { status: "complete", request: req, response }];
+export function customDataTypeConfigure(
+ client: CodatPlatformCore,
+ request: Parameters[0],
+ options?: Parameters[1],
+): APIPromise>, Error>> {
+ return new APIPromise(toResult(() => client.customDataType.configure(request, options)));
}
diff --git a/platform/src/funcs/customDataTypeGetConfiguration.ts b/platform/src/funcs/customDataTypeGetConfiguration.ts
index 8cd5b199b..1792f274c 100644
--- a/platform/src/funcs/customDataTypeGetConfiguration.ts
+++ b/platform/src/funcs/customDataTypeGetConfiguration.ts
@@ -1,200 +1,17 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
+/* tslint:disable */
+/* eslint-disable */
-import { CodatPlatformCore } from "../core.js";
-import { encodeSimple } from "../lib/encodings.js";
-import { matchStatusCode } from "../lib/http.js";
-import * as M from "../lib/matchers.js";
-import { compactMap } from "../lib/primitives.js";
-import { safeParse } from "../lib/schemas.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
-import { pathToFunc } from "../lib/url.js";
-import { CodatPlatformError } from "../sdk/models/errors/codatplatformerror.js";
-import {
- ConnectionError,
- InvalidRequestError,
- RequestAbortedError,
- RequestTimeoutError,
- UnexpectedClientError,
-} from "../sdk/models/errors/httpclienterrors.js";
-import * as errors from "../sdk/models/errors/index.js";
-import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
-import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
-import * as operations from "../sdk/models/operations/index.js";
-import * as shared from "../sdk/models/shared/index.js";
-import { APICall, APIPromise } from "../sdk/types/async.js";
-import { Result } from "../sdk/types/fp.js";
+import type { CodatPlatform, CodatPlatformCore } from "../core";
+import { APIPromise } from "../sdk/types/async";
+import type { Result } from "../sdk/types/fp";
+import { toResult } from "./_adapter";
-/**
- * Get custom data configuration
- *
- * @remarks
- * The *Get custom data configuration* endpoint returns existing configuration details for the specified custom data type and integration pair you previously configured.
- *
- * A [custom data type](https://docs.codat.io/using-the-api/custom-data) is an additional data type you can create that is not included in Codat's standardized data model.
- */
-export function customDataTypeGetConfiguration(
- client: CodatPlatformCore,
- request: operations.GetCustomDataTypeConfigurationRequest,
- options?: RequestOptions,
-): APIPromise<
- Result<
- shared.CustomDataTypeRecords,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >
-> {
- return new APIPromise($do(
- client,
- request,
- options,
- ));
-}
-
-async function $do(
- client: CodatPlatformCore,
- request: operations.GetCustomDataTypeConfigurationRequest,
- options?: RequestOptions,
-): Promise<
- [
- Result<
- shared.CustomDataTypeRecords,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >,
- APICall,
- ]
-> {
- const parsed = safeParse(
- request,
- (value) =>
- operations.GetCustomDataTypeConfigurationRequest$outboundSchema.parse(
- value,
- ),
- "Input validation failed",
- );
- if (!parsed.ok) {
- return [parsed, { status: "invalid" }];
- }
- const payload = parsed.value;
- const body = null;
-
- const pathParams = {
- customDataIdentifier: encodeSimple(
- "customDataIdentifier",
- payload.customDataIdentifier,
- { explode: false, charEncoding: "percent" },
- ),
- platformKey: encodeSimple("platformKey", payload.platformKey, {
- explode: false,
- charEncoding: "percent",
- }),
- };
- const path = pathToFunc(
- "/integrations/{platformKey}/dataTypes/custom/{customDataIdentifier}",
- )(pathParams);
-
- const headers = new Headers(compactMap({
- Accept: "application/json",
- }));
-
- const secConfig = await extractSecurity(client._options.authHeader);
- const securityInput = secConfig == null ? {} : { authHeader: secConfig };
- const requestSecurity = resolveGlobalSecurity(securityInput);
-
- const context = {
- options: client._options,
- baseURL: options?.serverURL ?? client._baseURL ?? "",
- operationID: "get-custom-data-type-configuration",
- oAuth2Scopes: null,
+type Call = CodatPlatform["customDataType"]["getConfiguration"];
- resolvedSecurity: requestSecurity,
-
- securitySource: client._options.authHeader,
- retryConfig: options?.retries
- || client._options.retryConfig
- || {
- strategy: "backoff",
- backoff: {
- initialInterval: 500,
- maxInterval: 60000,
- exponent: 1.5,
- maxElapsedTime: 3600000,
- },
- retryConnectionErrors: true,
- }
- || { strategy: "none" },
- retryCodes: options?.retryCodes || ["408", "429", "5XX"],
- };
-
- const requestRes = client._createRequest(context, {
- security: requestSecurity,
- method: "GET",
- baseURL: options?.serverURL,
- path: path,
- headers: headers,
- body: body,
- userAgent: client._options.userAgent,
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
- }, options);
- if (!requestRes.ok) {
- return [requestRes, { status: "invalid" }];
- }
- const req = requestRes.value;
-
- const doResult = await client._do(req, {
- context,
- isErrorStatusCode: (statusCode: number) =>
- matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
- retryConfig: context.retryConfig,
- retryCodes: context.retryCodes,
- });
- if (!doResult.ok) {
- return [doResult, { status: "request-error", request: req }];
- }
- const response = doResult.value;
-
- const responseFields = {
- HttpMeta: { Response: response, Request: req },
- };
-
- const [result] = await M.match<
- shared.CustomDataTypeRecords,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >(
- M.json(200, shared.CustomDataTypeRecords$inboundSchema),
- M.jsonErr([401, 402, 403, 404, 429], errors.ErrorMessage$inboundSchema),
- M.jsonErr([500, 503], errors.ErrorMessage$inboundSchema),
- M.fail("4XX"),
- M.fail("5XX"),
- )(response, req, { extraFields: responseFields });
- if (!result.ok) {
- return [result, { status: "complete", request: req, response }];
- }
-
- return [result, { status: "complete", request: req, response }];
+export function customDataTypeGetConfiguration(
+ client: CodatPlatformCore,
+ request: Parameters[0],
+ options?: Parameters[1],
+): APIPromise>, Error>> {
+ return new APIPromise(toResult(() => client.customDataType.getConfiguration(request, options)));
}
diff --git a/platform/src/funcs/customDataTypeList.ts b/platform/src/funcs/customDataTypeList.ts
index 83bc71508..c1e89b946 100644
--- a/platform/src/funcs/customDataTypeList.ts
+++ b/platform/src/funcs/customDataTypeList.ts
@@ -1,211 +1,17 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
+/* tslint:disable */
+/* eslint-disable */
-import { CodatPlatformCore } from "../core.js";
-import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
-import { matchStatusCode } from "../lib/http.js";
-import * as M from "../lib/matchers.js";
-import { compactMap } from "../lib/primitives.js";
-import { safeParse } from "../lib/schemas.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
-import { pathToFunc } from "../lib/url.js";
-import { CodatPlatformError } from "../sdk/models/errors/codatplatformerror.js";
-import {
- ConnectionError,
- InvalidRequestError,
- RequestAbortedError,
- RequestTimeoutError,
- UnexpectedClientError,
-} from "../sdk/models/errors/httpclienterrors.js";
-import * as errors from "../sdk/models/errors/index.js";
-import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
-import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
-import * as operations from "../sdk/models/operations/index.js";
-import * as shared from "../sdk/models/shared/index.js";
-import { APICall, APIPromise } from "../sdk/types/async.js";
-import { Result } from "../sdk/types/fp.js";
+import type { CodatPlatform, CodatPlatformCore } from "../core";
+import { APIPromise } from "../sdk/types/async";
+import type { Result } from "../sdk/types/fp";
+import { toResult } from "./_adapter";
-/**
- * List custom data type records
- *
- * @remarks
- * The *List custom data type records* endpoint returns a paginated list of records pulled for the specified custom data type you previously configured.
- *
- * A [custom data type](https://docs.codat.io/using-the-api/custom-data) is an additional data type you can create that is not included in Codat's standardized data model.s endpoint returns a paginated list of records whose schema is defined [Configure custom data type](https://docs.codat.io/platform-api#/operations/configure-custom-data-type)
- */
-export function customDataTypeList(
- client: CodatPlatformCore,
- request: operations.ListCustomDataTypeRecordsRequest,
- options?: RequestOptions,
-): APIPromise<
- Result<
- shared.CustomDataTypeRecords,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >
-> {
- return new APIPromise($do(
- client,
- request,
- options,
- ));
-}
-
-async function $do(
- client: CodatPlatformCore,
- request: operations.ListCustomDataTypeRecordsRequest,
- options?: RequestOptions,
-): Promise<
- [
- Result<
- shared.CustomDataTypeRecords,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >,
- APICall,
- ]
-> {
- const parsed = safeParse(
- request,
- (value) =>
- operations.ListCustomDataTypeRecordsRequest$outboundSchema.parse(value),
- "Input validation failed",
- );
- if (!parsed.ok) {
- return [parsed, { status: "invalid" }];
- }
- const payload = parsed.value;
- const body = null;
-
- const pathParams = {
- companyId: encodeSimple("companyId", payload.companyId, {
- explode: false,
- charEncoding: "percent",
- }),
- connectionId: encodeSimple("connectionId", payload.connectionId, {
- explode: false,
- charEncoding: "percent",
- }),
- customDataIdentifier: encodeSimple(
- "customDataIdentifier",
- payload.customDataIdentifier,
- { explode: false, charEncoding: "percent" },
- ),
- };
- const path = pathToFunc(
- "/companies/{companyId}/connections/{connectionId}/data/custom/{customDataIdentifier}",
- )(pathParams);
-
- const query = encodeFormQuery({
- "page": payload.page,
- "pageSize": payload.pageSize,
- });
-
- const headers = new Headers(compactMap({
- Accept: "application/json",
- }));
-
- const secConfig = await extractSecurity(client._options.authHeader);
- const securityInput = secConfig == null ? {} : { authHeader: secConfig };
- const requestSecurity = resolveGlobalSecurity(securityInput);
-
- const context = {
- options: client._options,
- baseURL: options?.serverURL ?? client._baseURL ?? "",
- operationID: "list-custom-data-type-records",
- oAuth2Scopes: null,
+type Call = CodatPlatform["customDataType"]["list"];
- resolvedSecurity: requestSecurity,
-
- securitySource: client._options.authHeader,
- retryConfig: options?.retries
- || client._options.retryConfig
- || {
- strategy: "backoff",
- backoff: {
- initialInterval: 500,
- maxInterval: 60000,
- exponent: 1.5,
- maxElapsedTime: 3600000,
- },
- retryConnectionErrors: true,
- }
- || { strategy: "none" },
- retryCodes: options?.retryCodes || ["408", "429", "5XX"],
- };
-
- const requestRes = client._createRequest(context, {
- security: requestSecurity,
- method: "GET",
- baseURL: options?.serverURL,
- path: path,
- headers: headers,
- query: query,
- body: body,
- userAgent: client._options.userAgent,
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
- }, options);
- if (!requestRes.ok) {
- return [requestRes, { status: "invalid" }];
- }
- const req = requestRes.value;
-
- const doResult = await client._do(req, {
- context,
- isErrorStatusCode: (statusCode: number) =>
- matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
- retryConfig: context.retryConfig,
- retryCodes: context.retryCodes,
- });
- if (!doResult.ok) {
- return [doResult, { status: "request-error", request: req }];
- }
- const response = doResult.value;
-
- const responseFields = {
- HttpMeta: { Response: response, Request: req },
- };
-
- const [result] = await M.match<
- shared.CustomDataTypeRecords,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >(
- M.json(200, shared.CustomDataTypeRecords$inboundSchema),
- M.jsonErr(
- [400, 401, 402, 403, 404, 429, 451],
- errors.ErrorMessage$inboundSchema,
- ),
- M.jsonErr([500, 503], errors.ErrorMessage$inboundSchema),
- M.fail("4XX"),
- M.fail("5XX"),
- )(response, req, { extraFields: responseFields });
- if (!result.ok) {
- return [result, { status: "complete", request: req, response }];
- }
-
- return [result, { status: "complete", request: req, response }];
+export function customDataTypeList(
+ client: CodatPlatformCore,
+ request: Parameters[0],
+ options?: Parameters[1],
+): APIPromise>, Error>> {
+ return new APIPromise(toResult(() => client.customDataType.list(request, options)));
}
diff --git a/platform/src/funcs/customDataTypeRefresh.ts b/platform/src/funcs/customDataTypeRefresh.ts
index 71b3728a4..08f6990e6 100644
--- a/platform/src/funcs/customDataTypeRefresh.ts
+++ b/platform/src/funcs/customDataTypeRefresh.ts
@@ -1,203 +1,17 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
+/* tslint:disable */
+/* eslint-disable */
-import { CodatPlatformCore } from "../core.js";
-import { encodeSimple } from "../lib/encodings.js";
-import { matchStatusCode } from "../lib/http.js";
-import * as M from "../lib/matchers.js";
-import { compactMap } from "../lib/primitives.js";
-import { safeParse } from "../lib/schemas.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
-import { pathToFunc } from "../lib/url.js";
-import { CodatPlatformError } from "../sdk/models/errors/codatplatformerror.js";
-import {
- ConnectionError,
- InvalidRequestError,
- RequestAbortedError,
- RequestTimeoutError,
- UnexpectedClientError,
-} from "../sdk/models/errors/httpclienterrors.js";
-import * as errors from "../sdk/models/errors/index.js";
-import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
-import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
-import * as operations from "../sdk/models/operations/index.js";
-import * as shared from "../sdk/models/shared/index.js";
-import { APICall, APIPromise } from "../sdk/types/async.js";
-import { Result } from "../sdk/types/fp.js";
+import type { CodatPlatform, CodatPlatformCore } from "../core";
+import { APIPromise } from "../sdk/types/async";
+import type { Result } from "../sdk/types/fp";
+import { toResult } from "./_adapter";
-/**
- * Refresh custom data type
- *
- * @remarks
- * The *Refresh custom data type* endpoint refreshes the specified custom data type for a given company. This is an asynchronous operation that will sync updated data from the linked integration into Codat for you to view.
- */
-export function customDataTypeRefresh(
- client: CodatPlatformCore,
- request: operations.RefreshCustomDataTypeRequest,
- options?: RequestOptions,
-): APIPromise<
- Result<
- shared.PullOperation,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >
-> {
- return new APIPromise($do(
- client,
- request,
- options,
- ));
-}
-
-async function $do(
- client: CodatPlatformCore,
- request: operations.RefreshCustomDataTypeRequest,
- options?: RequestOptions,
-): Promise<
- [
- Result<
- shared.PullOperation,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >,
- APICall,
- ]
-> {
- const parsed = safeParse(
- request,
- (value) =>
- operations.RefreshCustomDataTypeRequest$outboundSchema.parse(value),
- "Input validation failed",
- );
- if (!parsed.ok) {
- return [parsed, { status: "invalid" }];
- }
- const payload = parsed.value;
- const body = null;
-
- const pathParams = {
- companyId: encodeSimple("companyId", payload.companyId, {
- explode: false,
- charEncoding: "percent",
- }),
- connectionId: encodeSimple("connectionId", payload.connectionId, {
- explode: false,
- charEncoding: "percent",
- }),
- customDataIdentifier: encodeSimple(
- "customDataIdentifier",
- payload.customDataIdentifier,
- { explode: false, charEncoding: "percent" },
- ),
- };
- const path = pathToFunc(
- "/companies/{companyId}/connections/{connectionId}/data/queue/custom/{customDataIdentifier}",
- )(pathParams);
-
- const headers = new Headers(compactMap({
- Accept: "application/json",
- }));
-
- const secConfig = await extractSecurity(client._options.authHeader);
- const securityInput = secConfig == null ? {} : { authHeader: secConfig };
- const requestSecurity = resolveGlobalSecurity(securityInput);
-
- const context = {
- options: client._options,
- baseURL: options?.serverURL ?? client._baseURL ?? "",
- operationID: "refresh-custom-data-type",
- oAuth2Scopes: null,
+type Call = CodatPlatform["customDataType"]["refresh"];
- resolvedSecurity: requestSecurity,
-
- securitySource: client._options.authHeader,
- retryConfig: options?.retries
- || client._options.retryConfig
- || {
- strategy: "backoff",
- backoff: {
- initialInterval: 500,
- maxInterval: 60000,
- exponent: 1.5,
- maxElapsedTime: 3600000,
- },
- retryConnectionErrors: true,
- }
- || { strategy: "none" },
- retryCodes: options?.retryCodes || ["408", "429", "5XX"],
- };
-
- const requestRes = client._createRequest(context, {
- security: requestSecurity,
- method: "POST",
- baseURL: options?.serverURL,
- path: path,
- headers: headers,
- body: body,
- userAgent: client._options.userAgent,
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
- }, options);
- if (!requestRes.ok) {
- return [requestRes, { status: "invalid" }];
- }
- const req = requestRes.value;
-
- const doResult = await client._do(req, {
- context,
- isErrorStatusCode: (statusCode: number) =>
- matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
- retryConfig: context.retryConfig,
- retryCodes: context.retryCodes,
- });
- if (!doResult.ok) {
- return [doResult, { status: "request-error", request: req }];
- }
- const response = doResult.value;
-
- const responseFields = {
- HttpMeta: { Response: response, Request: req },
- };
-
- const [result] = await M.match<
- shared.PullOperation,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >(
- M.json(200, shared.PullOperation$inboundSchema),
- M.jsonErr(
- [401, 402, 403, 404, 429, 451],
- errors.ErrorMessage$inboundSchema,
- ),
- M.jsonErr([500, 503], errors.ErrorMessage$inboundSchema),
- M.fail("4XX"),
- M.fail("5XX"),
- )(response, req, { extraFields: responseFields });
- if (!result.ok) {
- return [result, { status: "complete", request: req, response }];
- }
-
- return [result, { status: "complete", request: req, response }];
+export function customDataTypeRefresh(
+ client: CodatPlatformCore,
+ request: Parameters[0],
+ options?: Parameters[1],
+): APIPromise>, Error>> {
+ return new APIPromise(toResult(() => client.customDataType.refresh(request, options)));
}
diff --git a/platform/src/funcs/integrationsGet.ts b/platform/src/funcs/integrationsGet.ts
index af1459141..d2dc53622 100644
--- a/platform/src/funcs/integrationsGet.ts
+++ b/platform/src/funcs/integrationsGet.ts
@@ -1,188 +1,17 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
+/* tslint:disable */
+/* eslint-disable */
-import { CodatPlatformCore } from "../core.js";
-import { encodeSimple } from "../lib/encodings.js";
-import { matchStatusCode } from "../lib/http.js";
-import * as M from "../lib/matchers.js";
-import { compactMap } from "../lib/primitives.js";
-import { safeParse } from "../lib/schemas.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
-import { pathToFunc } from "../lib/url.js";
-import { CodatPlatformError } from "../sdk/models/errors/codatplatformerror.js";
-import {
- ConnectionError,
- InvalidRequestError,
- RequestAbortedError,
- RequestTimeoutError,
- UnexpectedClientError,
-} from "../sdk/models/errors/httpclienterrors.js";
-import * as errors from "../sdk/models/errors/index.js";
-import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
-import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
-import * as operations from "../sdk/models/operations/index.js";
-import * as shared from "../sdk/models/shared/index.js";
-import { APICall, APIPromise } from "../sdk/types/async.js";
-import { Result } from "../sdk/types/fp.js";
+import type { CodatPlatform, CodatPlatformCore } from "../core";
+import { APIPromise } from "../sdk/types/async";
+import type { Result } from "../sdk/types/fp";
+import { toResult } from "./_adapter";
-/**
- * Get integration
- *
- * @remarks
- * Get single integration, by platformKey
- */
-export function integrationsGet(
- client: CodatPlatformCore,
- request: operations.GetIntegrationRequest,
- options?: RequestOptions,
-): APIPromise<
- Result<
- shared.Integration,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >
-> {
- return new APIPromise($do(
- client,
- request,
- options,
- ));
-}
-
-async function $do(
- client: CodatPlatformCore,
- request: operations.GetIntegrationRequest,
- options?: RequestOptions,
-): Promise<
- [
- Result<
- shared.Integration,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >,
- APICall,
- ]
-> {
- const parsed = safeParse(
- request,
- (value) => operations.GetIntegrationRequest$outboundSchema.parse(value),
- "Input validation failed",
- );
- if (!parsed.ok) {
- return [parsed, { status: "invalid" }];
- }
- const payload = parsed.value;
- const body = null;
-
- const pathParams = {
- platformKey: encodeSimple("platformKey", payload.platformKey, {
- explode: false,
- charEncoding: "percent",
- }),
- };
- const path = pathToFunc("/integrations/{platformKey}")(pathParams);
-
- const headers = new Headers(compactMap({
- Accept: "application/json",
- }));
-
- const secConfig = await extractSecurity(client._options.authHeader);
- const securityInput = secConfig == null ? {} : { authHeader: secConfig };
- const requestSecurity = resolveGlobalSecurity(securityInput);
-
- const context = {
- options: client._options,
- baseURL: options?.serverURL ?? client._baseURL ?? "",
- operationID: "get-integration",
- oAuth2Scopes: null,
+type Call = CodatPlatform["integrations"]["get"];
- resolvedSecurity: requestSecurity,
-
- securitySource: client._options.authHeader,
- retryConfig: options?.retries
- || client._options.retryConfig
- || {
- strategy: "backoff",
- backoff: {
- initialInterval: 500,
- maxInterval: 60000,
- exponent: 1.5,
- maxElapsedTime: 3600000,
- },
- retryConnectionErrors: true,
- }
- || { strategy: "none" },
- retryCodes: options?.retryCodes || ["408", "429", "5XX"],
- };
-
- const requestRes = client._createRequest(context, {
- security: requestSecurity,
- method: "GET",
- baseURL: options?.serverURL,
- path: path,
- headers: headers,
- body: body,
- userAgent: client._options.userAgent,
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
- }, options);
- if (!requestRes.ok) {
- return [requestRes, { status: "invalid" }];
- }
- const req = requestRes.value;
-
- const doResult = await client._do(req, {
- context,
- isErrorStatusCode: (statusCode: number) =>
- matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
- retryConfig: context.retryConfig,
- retryCodes: context.retryCodes,
- });
- if (!doResult.ok) {
- return [doResult, { status: "request-error", request: req }];
- }
- const response = doResult.value;
-
- const responseFields = {
- HttpMeta: { Response: response, Request: req },
- };
-
- const [result] = await M.match<
- shared.Integration,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >(
- M.json(200, shared.Integration$inboundSchema),
- M.jsonErr([401, 402, 403, 404, 429], errors.ErrorMessage$inboundSchema),
- M.jsonErr([500, 503], errors.ErrorMessage$inboundSchema),
- M.fail("4XX"),
- M.fail("5XX"),
- )(response, req, { extraFields: responseFields });
- if (!result.ok) {
- return [result, { status: "complete", request: req, response }];
- }
-
- return [result, { status: "complete", request: req, response }];
+export function integrationsGet(
+ client: CodatPlatformCore,
+ request: Parameters[0],
+ options?: Parameters[1],
+): APIPromise>, Error>> {
+ return new APIPromise(toResult(() => client.integrations.get(request, options)));
}
diff --git a/platform/src/funcs/integrationsGetBranding.ts b/platform/src/funcs/integrationsGetBranding.ts
index 6a251d15e..587b1941c 100644
--- a/platform/src/funcs/integrationsGetBranding.ts
+++ b/platform/src/funcs/integrationsGetBranding.ts
@@ -1,189 +1,17 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
+/* tslint:disable */
+/* eslint-disable */
-import { CodatPlatformCore } from "../core.js";
-import { encodeSimple } from "../lib/encodings.js";
-import { matchStatusCode } from "../lib/http.js";
-import * as M from "../lib/matchers.js";
-import { compactMap } from "../lib/primitives.js";
-import { safeParse } from "../lib/schemas.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
-import { pathToFunc } from "../lib/url.js";
-import { CodatPlatformError } from "../sdk/models/errors/codatplatformerror.js";
-import {
- ConnectionError,
- InvalidRequestError,
- RequestAbortedError,
- RequestTimeoutError,
- UnexpectedClientError,
-} from "../sdk/models/errors/httpclienterrors.js";
-import * as errors from "../sdk/models/errors/index.js";
-import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
-import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
-import * as operations from "../sdk/models/operations/index.js";
-import * as shared from "../sdk/models/shared/index.js";
-import { APICall, APIPromise } from "../sdk/types/async.js";
-import { Result } from "../sdk/types/fp.js";
+import type { CodatPlatform, CodatPlatformCore } from "../core";
+import { APIPromise } from "../sdk/types/async";
+import type { Result } from "../sdk/types/fp";
+import { toResult } from "./_adapter";
-/**
- * Get branding
- *
- * @remarks
- * Get branding for platform.
- */
-export function integrationsGetBranding(
- client: CodatPlatformCore,
- request: operations.GetIntegrationsBrandingRequest,
- options?: RequestOptions,
-): APIPromise<
- Result<
- shared.Branding,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >
-> {
- return new APIPromise($do(
- client,
- request,
- options,
- ));
-}
-
-async function $do(
- client: CodatPlatformCore,
- request: operations.GetIntegrationsBrandingRequest,
- options?: RequestOptions,
-): Promise<
- [
- Result<
- shared.Branding,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >,
- APICall,
- ]
-> {
- const parsed = safeParse(
- request,
- (value) =>
- operations.GetIntegrationsBrandingRequest$outboundSchema.parse(value),
- "Input validation failed",
- );
- if (!parsed.ok) {
- return [parsed, { status: "invalid" }];
- }
- const payload = parsed.value;
- const body = null;
-
- const pathParams = {
- platformKey: encodeSimple("platformKey", payload.platformKey, {
- explode: false,
- charEncoding: "percent",
- }),
- };
- const path = pathToFunc("/integrations/{platformKey}/branding")(pathParams);
-
- const headers = new Headers(compactMap({
- Accept: "application/json",
- }));
-
- const secConfig = await extractSecurity(client._options.authHeader);
- const securityInput = secConfig == null ? {} : { authHeader: secConfig };
- const requestSecurity = resolveGlobalSecurity(securityInput);
-
- const context = {
- options: client._options,
- baseURL: options?.serverURL ?? client._baseURL ?? "",
- operationID: "get-integrations-branding",
- oAuth2Scopes: null,
+type Call = CodatPlatform["integrations"]["getBranding"];
- resolvedSecurity: requestSecurity,
-
- securitySource: client._options.authHeader,
- retryConfig: options?.retries
- || client._options.retryConfig
- || {
- strategy: "backoff",
- backoff: {
- initialInterval: 500,
- maxInterval: 60000,
- exponent: 1.5,
- maxElapsedTime: 3600000,
- },
- retryConnectionErrors: true,
- }
- || { strategy: "none" },
- retryCodes: options?.retryCodes || ["408", "429", "5XX"],
- };
-
- const requestRes = client._createRequest(context, {
- security: requestSecurity,
- method: "GET",
- baseURL: options?.serverURL,
- path: path,
- headers: headers,
- body: body,
- userAgent: client._options.userAgent,
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
- }, options);
- if (!requestRes.ok) {
- return [requestRes, { status: "invalid" }];
- }
- const req = requestRes.value;
-
- const doResult = await client._do(req, {
- context,
- isErrorStatusCode: (statusCode: number) =>
- matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
- retryConfig: context.retryConfig,
- retryCodes: context.retryCodes,
- });
- if (!doResult.ok) {
- return [doResult, { status: "request-error", request: req }];
- }
- const response = doResult.value;
-
- const responseFields = {
- HttpMeta: { Response: response, Request: req },
- };
-
- const [result] = await M.match<
- shared.Branding,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >(
- M.json(200, shared.Branding$inboundSchema),
- M.jsonErr([401, 402, 403, 404, 429], errors.ErrorMessage$inboundSchema),
- M.jsonErr([500, 503], errors.ErrorMessage$inboundSchema),
- M.fail("4XX"),
- M.fail("5XX"),
- )(response, req, { extraFields: responseFields });
- if (!result.ok) {
- return [result, { status: "complete", request: req, response }];
- }
-
- return [result, { status: "complete", request: req, response }];
+export function integrationsGetBranding(
+ client: CodatPlatformCore,
+ request: Parameters[0],
+ options?: Parameters[1],
+): APIPromise>, Error>> {
+ return new APIPromise(toResult(() => client.integrations.getBranding(request, options)));
}
diff --git a/platform/src/funcs/integrationsList.ts b/platform/src/funcs/integrationsList.ts
index acd0e0a45..d376b15cd 100644
--- a/platform/src/funcs/integrationsList.ts
+++ b/platform/src/funcs/integrationsList.ts
@@ -1,191 +1,17 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
+/* tslint:disable */
+/* eslint-disable */
-import { CodatPlatformCore } from "../core.js";
-import { encodeFormQuery } from "../lib/encodings.js";
-import { matchStatusCode } from "../lib/http.js";
-import * as M from "../lib/matchers.js";
-import { compactMap } from "../lib/primitives.js";
-import { safeParse } from "../lib/schemas.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
-import { pathToFunc } from "../lib/url.js";
-import { CodatPlatformError } from "../sdk/models/errors/codatplatformerror.js";
-import {
- ConnectionError,
- InvalidRequestError,
- RequestAbortedError,
- RequestTimeoutError,
- UnexpectedClientError,
-} from "../sdk/models/errors/httpclienterrors.js";
-import * as errors from "../sdk/models/errors/index.js";
-import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
-import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
-import * as operations from "../sdk/models/operations/index.js";
-import * as shared from "../sdk/models/shared/index.js";
-import { APICall, APIPromise } from "../sdk/types/async.js";
-import { Result } from "../sdk/types/fp.js";
+import type { CodatPlatform, CodatPlatformCore } from "../core";
+import { APIPromise } from "../sdk/types/async";
+import type { Result } from "../sdk/types/fp";
+import { toResult } from "./_adapter";
-/**
- * List integrations
- *
- * @remarks
- * List your available integrations
- */
-export function integrationsList(
- client: CodatPlatformCore,
- request?: operations.ListIntegrationsRequest | undefined,
- options?: RequestOptions,
-): APIPromise<
- Result<
- shared.Integrations,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >
-> {
- return new APIPromise($do(
- client,
- request,
- options,
- ));
-}
-
-async function $do(
- client: CodatPlatformCore,
- request?: operations.ListIntegrationsRequest | undefined,
- options?: RequestOptions,
-): Promise<
- [
- Result<
- shared.Integrations,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >,
- APICall,
- ]
-> {
- const parsed = safeParse(
- request,
- (value) =>
- operations.ListIntegrationsRequest$outboundSchema.optional().parse(value),
- "Input validation failed",
- );
- if (!parsed.ok) {
- return [parsed, { status: "invalid" }];
- }
- const payload = parsed.value;
- const body = null;
-
- const path = pathToFunc("/integrations")();
-
- const query = encodeFormQuery({
- "orderBy": payload?.orderBy,
- "page": payload?.page,
- "pageSize": payload?.pageSize,
- "query": payload?.query,
- });
-
- const headers = new Headers(compactMap({
- Accept: "application/json",
- }));
-
- const secConfig = await extractSecurity(client._options.authHeader);
- const securityInput = secConfig == null ? {} : { authHeader: secConfig };
- const requestSecurity = resolveGlobalSecurity(securityInput);
-
- const context = {
- options: client._options,
- baseURL: options?.serverURL ?? client._baseURL ?? "",
- operationID: "list-integrations",
- oAuth2Scopes: null,
+type Call = CodatPlatform["integrations"]["list"];
- resolvedSecurity: requestSecurity,
-
- securitySource: client._options.authHeader,
- retryConfig: options?.retries
- || client._options.retryConfig
- || {
- strategy: "backoff",
- backoff: {
- initialInterval: 500,
- maxInterval: 60000,
- exponent: 1.5,
- maxElapsedTime: 3600000,
- },
- retryConnectionErrors: true,
- }
- || { strategy: "none" },
- retryCodes: options?.retryCodes || ["408", "429", "5XX"],
- };
-
- const requestRes = client._createRequest(context, {
- security: requestSecurity,
- method: "GET",
- baseURL: options?.serverURL,
- path: path,
- headers: headers,
- query: query,
- body: body,
- userAgent: client._options.userAgent,
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
- }, options);
- if (!requestRes.ok) {
- return [requestRes, { status: "invalid" }];
- }
- const req = requestRes.value;
-
- const doResult = await client._do(req, {
- context,
- isErrorStatusCode: (statusCode: number) =>
- matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
- retryConfig: context.retryConfig,
- retryCodes: context.retryCodes,
- });
- if (!doResult.ok) {
- return [doResult, { status: "request-error", request: req }];
- }
- const response = doResult.value;
-
- const responseFields = {
- HttpMeta: { Response: response, Request: req },
- };
-
- const [result] = await M.match<
- shared.Integrations,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >(
- M.json(200, shared.Integrations$inboundSchema),
- M.jsonErr([400, 401, 402, 403, 429], errors.ErrorMessage$inboundSchema),
- M.jsonErr([500, 503], errors.ErrorMessage$inboundSchema),
- M.fail("4XX"),
- M.fail("5XX"),
- )(response, req, { extraFields: responseFields });
- if (!result.ok) {
- return [result, { status: "complete", request: req, response }];
- }
-
- return [result, { status: "complete", request: req, response }];
+export function integrationsList(
+ client: CodatPlatformCore,
+ request?: Parameters[0],
+ options?: Parameters[1],
+): APIPromise>, Error>> {
+ return new APIPromise(toResult(() => client.integrations.list(request, options)));
}
diff --git a/platform/src/funcs/pushDataGetModelOptions.ts b/platform/src/funcs/pushDataGetModelOptions.ts
index 13f18b844..8fb004c68 100644
--- a/platform/src/funcs/pushDataGetModelOptions.ts
+++ b/platform/src/funcs/pushDataGetModelOptions.ts
@@ -1,204 +1,17 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
+/* tslint:disable */
+/* eslint-disable */
-import { CodatPlatformCore } from "../core.js";
-import { encodeSimple } from "../lib/encodings.js";
-import { matchStatusCode } from "../lib/http.js";
-import * as M from "../lib/matchers.js";
-import { compactMap } from "../lib/primitives.js";
-import { safeParse } from "../lib/schemas.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
-import { pathToFunc } from "../lib/url.js";
-import { CodatPlatformError } from "../sdk/models/errors/codatplatformerror.js";
-import {
- ConnectionError,
- InvalidRequestError,
- RequestAbortedError,
- RequestTimeoutError,
- UnexpectedClientError,
-} from "../sdk/models/errors/httpclienterrors.js";
-import * as errors from "../sdk/models/errors/index.js";
-import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
-import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
-import * as operations from "../sdk/models/operations/index.js";
-import * as shared from "../sdk/models/shared/index.js";
-import { APICall, APIPromise } from "../sdk/types/async.js";
-import { Result } from "../sdk/types/fp.js";
+import type { CodatPlatform, CodatPlatformCore } from "../core";
+import { APIPromise } from "../sdk/types/async";
+import type { Result } from "../sdk/types/fp";
+import { toResult } from "./_adapter";
-/**
- * Get push options
- *
- * @remarks
- * This is the generic documentation for creation and updating of data. See the equivalent endpoint for a given data type for more specific information.
- *
- * Before pushing data into accounting software, it is often necessary to collect some details from the user as to how they would like the data to be inserted. This includes names and amounts on transactional entities, but also factors such as categorisation of entities, which is often handled differently between different accounting software. A good example of this is specifying where on the balance sheet/profit and loss reports the user would like a newly-created nominal account to appear.
- *
- * Codat tries not to limit users to pushing to a very limited number of standard categories, so we have implemented "options" endpoints, which allow us to expose to our clients the fields which are required to be pushed for a specific linked company, and the options which may be selected for each field.
- */
-export function pushDataGetModelOptions(
- client: CodatPlatformCore,
- request: operations.GetCreateUpdateModelOptionsByDataTypeRequest,
- options?: RequestOptions,
-): APIPromise<
- Result<
- shared.PushOption,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >
-> {
- return new APIPromise($do(
- client,
- request,
- options,
- ));
-}
-
-async function $do(
- client: CodatPlatformCore,
- request: operations.GetCreateUpdateModelOptionsByDataTypeRequest,
- options?: RequestOptions,
-): Promise<
- [
- Result<
- shared.PushOption,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >,
- APICall,
- ]
-> {
- const parsed = safeParse(
- request,
- (value) =>
- operations.GetCreateUpdateModelOptionsByDataTypeRequest$outboundSchema
- .parse(value),
- "Input validation failed",
- );
- if (!parsed.ok) {
- return [parsed, { status: "invalid" }];
- }
- const payload = parsed.value;
- const body = null;
-
- const pathParams = {
- companyId: encodeSimple("companyId", payload.companyId, {
- explode: false,
- charEncoding: "percent",
- }),
- connectionId: encodeSimple("connectionId", payload.connectionId, {
- explode: false,
- charEncoding: "percent",
- }),
- dataType: encodeSimple("dataType", payload.dataType, {
- explode: false,
- charEncoding: "percent",
- }),
- };
- const path = pathToFunc(
- "/companies/{companyId}/connections/{connectionId}/options/{dataType}",
- )(pathParams);
-
- const headers = new Headers(compactMap({
- Accept: "application/json",
- }));
-
- const secConfig = await extractSecurity(client._options.authHeader);
- const securityInput = secConfig == null ? {} : { authHeader: secConfig };
- const requestSecurity = resolveGlobalSecurity(securityInput);
-
- const context = {
- options: client._options,
- baseURL: options?.serverURL ?? client._baseURL ?? "",
- operationID: "get-create-update-model-options-by-data-type",
- oAuth2Scopes: null,
+type Call = CodatPlatform["pushData"]["getModelOptions"];
- resolvedSecurity: requestSecurity,
-
- securitySource: client._options.authHeader,
- retryConfig: options?.retries
- || client._options.retryConfig
- || {
- strategy: "backoff",
- backoff: {
- initialInterval: 500,
- maxInterval: 60000,
- exponent: 1.5,
- maxElapsedTime: 3600000,
- },
- retryConnectionErrors: true,
- }
- || { strategy: "none" },
- retryCodes: options?.retryCodes || ["408", "429", "5XX"],
- };
-
- const requestRes = client._createRequest(context, {
- security: requestSecurity,
- method: "GET",
- baseURL: options?.serverURL,
- path: path,
- headers: headers,
- body: body,
- userAgent: client._options.userAgent,
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
- }, options);
- if (!requestRes.ok) {
- return [requestRes, { status: "invalid" }];
- }
- const req = requestRes.value;
-
- const doResult = await client._do(req, {
- context,
- isErrorStatusCode: (statusCode: number) =>
- matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
- retryConfig: context.retryConfig,
- retryCodes: context.retryCodes,
- });
- if (!doResult.ok) {
- return [doResult, { status: "request-error", request: req }];
- }
- const response = doResult.value;
-
- const responseFields = {
- HttpMeta: { Response: response, Request: req },
- };
-
- const [result] = await M.match<
- shared.PushOption,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >(
- M.json(200, shared.PushOption$inboundSchema),
- M.jsonErr([401, 402, 403, 404, 429], errors.ErrorMessage$inboundSchema),
- M.jsonErr([500, 503], errors.ErrorMessage$inboundSchema),
- M.fail("4XX"),
- M.fail("5XX"),
- )(response, req, { extraFields: responseFields });
- if (!result.ok) {
- return [result, { status: "complete", request: req, response }];
- }
-
- return [result, { status: "complete", request: req, response }];
+export function pushDataGetModelOptions(
+ client: CodatPlatformCore,
+ request: Parameters[0],
+ options?: Parameters[1],
+): APIPromise>, Error>> {
+ return new APIPromise(toResult(() => client.pushData.getModelOptions(request, options)));
}
diff --git a/platform/src/funcs/pushDataGetOperation.ts b/platform/src/funcs/pushDataGetOperation.ts
index 23fa87087..7776ee320 100644
--- a/platform/src/funcs/pushDataGetOperation.ts
+++ b/platform/src/funcs/pushDataGetOperation.ts
@@ -1,197 +1,17 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
+/* tslint:disable */
+/* eslint-disable */
-import { CodatPlatformCore } from "../core.js";
-import { encodeSimple } from "../lib/encodings.js";
-import { matchStatusCode } from "../lib/http.js";
-import * as M from "../lib/matchers.js";
-import { compactMap } from "../lib/primitives.js";
-import { safeParse } from "../lib/schemas.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
-import { pathToFunc } from "../lib/url.js";
-import { CodatPlatformError } from "../sdk/models/errors/codatplatformerror.js";
-import {
- ConnectionError,
- InvalidRequestError,
- RequestAbortedError,
- RequestTimeoutError,
- UnexpectedClientError,
-} from "../sdk/models/errors/httpclienterrors.js";
-import * as errors from "../sdk/models/errors/index.js";
-import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
-import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
-import * as operations from "../sdk/models/operations/index.js";
-import * as shared from "../sdk/models/shared/index.js";
-import { APICall, APIPromise } from "../sdk/types/async.js";
-import { Result } from "../sdk/types/fp.js";
+import type { CodatPlatform, CodatPlatformCore } from "../core";
+import { APIPromise } from "../sdk/types/async";
+import type { Result } from "../sdk/types/fp";
+import { toResult } from "./_adapter";
-/**
- * Get push operation
- *
- * @remarks
- * The **Get push operation** endpoint returns a specific [push operation](/using-the-api/push) identified by the `pushOperationKey` that was performed on the company.
- *
- * Write operations are actions that send requests to Codat, enabling the creation, updating, deletion of records, or uploading attachments in the connected accounting software.
- */
-export function pushDataGetOperation(
- client: CodatPlatformCore,
- request: operations.GetPushOperationRequest,
- options?: RequestOptions,
-): APIPromise<
- Result<
- shared.PushOperation,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >
-> {
- return new APIPromise($do(
- client,
- request,
- options,
- ));
-}
-
-async function $do(
- client: CodatPlatformCore,
- request: operations.GetPushOperationRequest,
- options?: RequestOptions,
-): Promise<
- [
- Result<
- shared.PushOperation,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >,
- APICall,
- ]
-> {
- const parsed = safeParse(
- request,
- (value) => operations.GetPushOperationRequest$outboundSchema.parse(value),
- "Input validation failed",
- );
- if (!parsed.ok) {
- return [parsed, { status: "invalid" }];
- }
- const payload = parsed.value;
- const body = null;
-
- const pathParams = {
- companyId: encodeSimple("companyId", payload.companyId, {
- explode: false,
- charEncoding: "percent",
- }),
- pushOperationKey: encodeSimple(
- "pushOperationKey",
- payload.pushOperationKey,
- { explode: false, charEncoding: "percent" },
- ),
- };
- const path = pathToFunc("/companies/{companyId}/push/{pushOperationKey}")(
- pathParams,
- );
-
- const headers = new Headers(compactMap({
- Accept: "application/json",
- }));
-
- const secConfig = await extractSecurity(client._options.authHeader);
- const securityInput = secConfig == null ? {} : { authHeader: secConfig };
- const requestSecurity = resolveGlobalSecurity(securityInput);
-
- const context = {
- options: client._options,
- baseURL: options?.serverURL ?? client._baseURL ?? "",
- operationID: "get-push-operation",
- oAuth2Scopes: null,
+type Call = CodatPlatform["pushData"]["getOperation"];
- resolvedSecurity: requestSecurity,
-
- securitySource: client._options.authHeader,
- retryConfig: options?.retries
- || client._options.retryConfig
- || {
- strategy: "backoff",
- backoff: {
- initialInterval: 500,
- maxInterval: 60000,
- exponent: 1.5,
- maxElapsedTime: 3600000,
- },
- retryConnectionErrors: true,
- }
- || { strategy: "none" },
- retryCodes: options?.retryCodes || ["408", "429", "5XX"],
- };
-
- const requestRes = client._createRequest(context, {
- security: requestSecurity,
- method: "GET",
- baseURL: options?.serverURL,
- path: path,
- headers: headers,
- body: body,
- userAgent: client._options.userAgent,
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
- }, options);
- if (!requestRes.ok) {
- return [requestRes, { status: "invalid" }];
- }
- const req = requestRes.value;
-
- const doResult = await client._do(req, {
- context,
- isErrorStatusCode: (statusCode: number) =>
- matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
- retryConfig: context.retryConfig,
- retryCodes: context.retryCodes,
- });
- if (!doResult.ok) {
- return [doResult, { status: "request-error", request: req }];
- }
- const response = doResult.value;
-
- const responseFields = {
- HttpMeta: { Response: response, Request: req },
- };
-
- const [result] = await M.match<
- shared.PushOperation,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >(
- M.json(200, shared.PushOperation$inboundSchema),
- M.jsonErr([401, 402, 403, 404, 429], errors.ErrorMessage$inboundSchema),
- M.jsonErr([500, 503], errors.ErrorMessage$inboundSchema),
- M.fail("4XX"),
- M.fail("5XX"),
- )(response, req, { extraFields: responseFields });
- if (!result.ok) {
- return [result, { status: "complete", request: req, response }];
- }
-
- return [result, { status: "complete", request: req, response }];
+export function pushDataGetOperation(
+ client: CodatPlatformCore,
+ request: Parameters[0],
+ options?: Parameters[1],
+): APIPromise>, Error>> {
+ return new APIPromise(toResult(() => client.pushData.getOperation(request, options)));
}
diff --git a/platform/src/funcs/pushDataListOperations.ts b/platform/src/funcs/pushDataListOperations.ts
index 0d0871181..617dd2705 100644
--- a/platform/src/funcs/pushDataListOperations.ts
+++ b/platform/src/funcs/pushDataListOperations.ts
@@ -1,202 +1,17 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
+/* tslint:disable */
+/* eslint-disable */
-import { CodatPlatformCore } from "../core.js";
-import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
-import { matchStatusCode } from "../lib/http.js";
-import * as M from "../lib/matchers.js";
-import { compactMap } from "../lib/primitives.js";
-import { safeParse } from "../lib/schemas.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
-import { pathToFunc } from "../lib/url.js";
-import { CodatPlatformError } from "../sdk/models/errors/codatplatformerror.js";
-import {
- ConnectionError,
- InvalidRequestError,
- RequestAbortedError,
- RequestTimeoutError,
- UnexpectedClientError,
-} from "../sdk/models/errors/httpclienterrors.js";
-import * as errors from "../sdk/models/errors/index.js";
-import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
-import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
-import * as operations from "../sdk/models/operations/index.js";
-import * as shared from "../sdk/models/shared/index.js";
-import { APICall, APIPromise } from "../sdk/types/async.js";
-import { Result } from "../sdk/types/fp.js";
+import type { CodatPlatform, CodatPlatformCore } from "../core";
+import { APIPromise } from "../sdk/types/async";
+import type { Result } from "../sdk/types/fp";
+import { toResult } from "./_adapter";
-/**
- * List push operations
- *
- * @remarks
- * The **List push operations** endpoint returns a list of [push operations](/using-the-api/push) performed on the company.
- *
- * Write operations are actions that send requests to Codat, enabling the creation, updating, deletion of records, or uploading attachments in the connected accounting software.
- */
-export function pushDataListOperations(
- client: CodatPlatformCore,
- request: operations.GetCompanyPushHistoryRequest,
- options?: RequestOptions,
-): APIPromise<
- Result<
- shared.PushOperations,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >
-> {
- return new APIPromise($do(
- client,
- request,
- options,
- ));
-}
-
-async function $do(
- client: CodatPlatformCore,
- request: operations.GetCompanyPushHistoryRequest,
- options?: RequestOptions,
-): Promise<
- [
- Result<
- shared.PushOperations,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >,
- APICall,
- ]
-> {
- const parsed = safeParse(
- request,
- (value) =>
- operations.GetCompanyPushHistoryRequest$outboundSchema.parse(value),
- "Input validation failed",
- );
- if (!parsed.ok) {
- return [parsed, { status: "invalid" }];
- }
- const payload = parsed.value;
- const body = null;
-
- const pathParams = {
- companyId: encodeSimple("companyId", payload.companyId, {
- explode: false,
- charEncoding: "percent",
- }),
- };
- const path = pathToFunc("/companies/{companyId}/push")(pathParams);
-
- const query = encodeFormQuery({
- "orderBy": payload.orderBy,
- "page": payload.page,
- "pageSize": payload.pageSize,
- "query": payload.query,
- });
-
- const headers = new Headers(compactMap({
- Accept: "application/json",
- }));
-
- const secConfig = await extractSecurity(client._options.authHeader);
- const securityInput = secConfig == null ? {} : { authHeader: secConfig };
- const requestSecurity = resolveGlobalSecurity(securityInput);
-
- const context = {
- options: client._options,
- baseURL: options?.serverURL ?? client._baseURL ?? "",
- operationID: "get-company-push-history",
- oAuth2Scopes: null,
+type Call = CodatPlatform["pushData"]["listOperations"];
- resolvedSecurity: requestSecurity,
-
- securitySource: client._options.authHeader,
- retryConfig: options?.retries
- || client._options.retryConfig
- || {
- strategy: "backoff",
- backoff: {
- initialInterval: 500,
- maxInterval: 60000,
- exponent: 1.5,
- maxElapsedTime: 3600000,
- },
- retryConnectionErrors: true,
- }
- || { strategy: "none" },
- retryCodes: options?.retryCodes || ["408", "429", "5XX"],
- };
-
- const requestRes = client._createRequest(context, {
- security: requestSecurity,
- method: "GET",
- baseURL: options?.serverURL,
- path: path,
- headers: headers,
- query: query,
- body: body,
- userAgent: client._options.userAgent,
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
- }, options);
- if (!requestRes.ok) {
- return [requestRes, { status: "invalid" }];
- }
- const req = requestRes.value;
-
- const doResult = await client._do(req, {
- context,
- isErrorStatusCode: (statusCode: number) =>
- matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
- retryConfig: context.retryConfig,
- retryCodes: context.retryCodes,
- });
- if (!doResult.ok) {
- return [doResult, { status: "request-error", request: req }];
- }
- const response = doResult.value;
-
- const responseFields = {
- HttpMeta: { Response: response, Request: req },
- };
-
- const [result] = await M.match<
- shared.PushOperations,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >(
- M.json(200, shared.PushOperations$inboundSchema),
- M.jsonErr(
- [400, 401, 402, 403, 404, 429],
- errors.ErrorMessage$inboundSchema,
- ),
- M.jsonErr([500, 503], errors.ErrorMessage$inboundSchema),
- M.fail("4XX"),
- M.fail("5XX"),
- )(response, req, { extraFields: responseFields });
- if (!result.ok) {
- return [result, { status: "complete", request: req, response }];
- }
-
- return [result, { status: "complete", request: req, response }];
+export function pushDataListOperations(
+ client: CodatPlatformCore,
+ request: Parameters[0],
+ options?: Parameters[1],
+): APIPromise>, Error>> {
+ return new APIPromise(toResult(() => client.pushData.listOperations(request, options)));
}
diff --git a/platform/src/funcs/readDataGetValidationResults.ts b/platform/src/funcs/readDataGetValidationResults.ts
index b669f6d6c..86174ebbf 100644
--- a/platform/src/funcs/readDataGetValidationResults.ts
+++ b/platform/src/funcs/readDataGetValidationResults.ts
@@ -1,200 +1,17 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
+/* tslint:disable */
+/* eslint-disable */
-import { CodatPlatformCore } from "../core.js";
-import { encodeSimple } from "../lib/encodings.js";
-import { matchStatusCode } from "../lib/http.js";
-import * as M from "../lib/matchers.js";
-import { compactMap } from "../lib/primitives.js";
-import { safeParse } from "../lib/schemas.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
-import { pathToFunc } from "../lib/url.js";
-import { CodatPlatformError } from "../sdk/models/errors/codatplatformerror.js";
-import {
- ConnectionError,
- InvalidRequestError,
- RequestAbortedError,
- RequestTimeoutError,
- UnexpectedClientError,
-} from "../sdk/models/errors/httpclienterrors.js";
-import * as errors from "../sdk/models/errors/index.js";
-import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
-import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
-import * as operations from "../sdk/models/operations/index.js";
-import * as shared from "../sdk/models/shared/index.js";
-import { APICall, APIPromise } from "../sdk/types/async.js";
-import { Result } from "../sdk/types/fp.js";
+import type { CodatPlatform, CodatPlatformCore } from "../core";
+import { APIPromise } from "../sdk/types/async";
+import type { Result } from "../sdk/types/fp";
+import { toResult } from "./_adapter";
-/**
- * Get validation results
- *
- * @remarks
- * Use the **Get validation results** endpoint to review warnings and errors encountered during the data type validation phase.
- *
- * The validation result [schema](https://docs.codat.io/platform-api#/schemas/ValidationResult) contains two message arrays:
- *
- * - **`warnings`** array lists potential issues with the data type that may require attention but don't block usage.
- * - **`errors`** array contains critical issues that must be resolved before the data type can be used.
- */
-export function readDataGetValidationResults(
- client: CodatPlatformCore,
- request: operations.GetReadValidationResultsRequest,
- options?: RequestOptions,
-): APIPromise<
- Result<
- shared.ValidationResult,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >
-> {
- return new APIPromise($do(
- client,
- request,
- options,
- ));
-}
-
-async function $do(
- client: CodatPlatformCore,
- request: operations.GetReadValidationResultsRequest,
- options?: RequestOptions,
-): Promise<
- [
- Result<
- shared.ValidationResult,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >,
- APICall,
- ]
-> {
- const parsed = safeParse(
- request,
- (value) =>
- operations.GetReadValidationResultsRequest$outboundSchema.parse(value),
- "Input validation failed",
- );
- if (!parsed.ok) {
- return [parsed, { status: "invalid" }];
- }
- const payload = parsed.value;
- const body = null;
-
- const pathParams = {
- companyId: encodeSimple("companyId", payload.companyId, {
- explode: false,
- charEncoding: "percent",
- }),
- datasetId: encodeSimple("datasetId", payload.datasetId, {
- explode: false,
- charEncoding: "percent",
- }),
- };
- const path = pathToFunc("/companies/{companyId}/sync/{datasetId}/validation")(
- pathParams,
- );
-
- const headers = new Headers(compactMap({
- Accept: "application/json",
- }));
-
- const secConfig = await extractSecurity(client._options.authHeader);
- const securityInput = secConfig == null ? {} : { authHeader: secConfig };
- const requestSecurity = resolveGlobalSecurity(securityInput);
-
- const context = {
- options: client._options,
- baseURL: options?.serverURL ?? client._baseURL ?? "",
- operationID: "get-read-validation-results",
- oAuth2Scopes: null,
+type Call = CodatPlatform["readData"]["getValidationResults"];
- resolvedSecurity: requestSecurity,
-
- securitySource: client._options.authHeader,
- retryConfig: options?.retries
- || client._options.retryConfig
- || {
- strategy: "backoff",
- backoff: {
- initialInterval: 500,
- maxInterval: 60000,
- exponent: 1.5,
- maxElapsedTime: 3600000,
- },
- retryConnectionErrors: true,
- }
- || { strategy: "none" },
- retryCodes: options?.retryCodes || ["408", "429", "5XX"],
- };
-
- const requestRes = client._createRequest(context, {
- security: requestSecurity,
- method: "GET",
- baseURL: options?.serverURL,
- path: path,
- headers: headers,
- body: body,
- userAgent: client._options.userAgent,
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
- }, options);
- if (!requestRes.ok) {
- return [requestRes, { status: "invalid" }];
- }
- const req = requestRes.value;
-
- const doResult = await client._do(req, {
- context,
- isErrorStatusCode: (statusCode: number) =>
- matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
- retryConfig: context.retryConfig,
- retryCodes: context.retryCodes,
- });
- if (!doResult.ok) {
- return [doResult, { status: "request-error", request: req }];
- }
- const response = doResult.value;
-
- const responseFields = {
- HttpMeta: { Response: response, Request: req },
- };
-
- const [result] = await M.match<
- shared.ValidationResult,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >(
- M.json(200, shared.ValidationResult$inboundSchema),
- M.jsonErr([401, 402, 403, 404, 429], errors.ErrorMessage$inboundSchema),
- M.jsonErr([500, 503], errors.ErrorMessage$inboundSchema),
- M.fail("4XX"),
- M.fail("5XX"),
- )(response, req, { extraFields: responseFields });
- if (!result.ok) {
- return [result, { status: "complete", request: req, response }];
- }
-
- return [result, { status: "complete", request: req, response }];
+export function readDataGetValidationResults(
+ client: CodatPlatformCore,
+ request: Parameters[0],
+ options?: Parameters[1],
+): APIPromise>, Error>> {
+ return new APIPromise(toResult(() => client.readData.getValidationResults(request, options)));
}
diff --git a/platform/src/funcs/refreshDataAll.ts b/platform/src/funcs/refreshDataAll.ts
index 8199dd6e7..4359d7d9c 100644
--- a/platform/src/funcs/refreshDataAll.ts
+++ b/platform/src/funcs/refreshDataAll.ts
@@ -1,195 +1,17 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
+/* tslint:disable */
+/* eslint-disable */
-import * as z from "zod/v3";
-import { CodatPlatformCore } from "../core.js";
-import { encodeSimple } from "../lib/encodings.js";
-import { matchStatusCode } from "../lib/http.js";
-import * as M from "../lib/matchers.js";
-import { compactMap } from "../lib/primitives.js";
-import { safeParse } from "../lib/schemas.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
-import { pathToFunc } from "../lib/url.js";
-import { CodatPlatformError } from "../sdk/models/errors/codatplatformerror.js";
-import {
- ConnectionError,
- InvalidRequestError,
- RequestAbortedError,
- RequestTimeoutError,
- UnexpectedClientError,
-} from "../sdk/models/errors/httpclienterrors.js";
-import * as errors from "../sdk/models/errors/index.js";
-import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
-import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
-import * as operations from "../sdk/models/operations/index.js";
-import { APICall, APIPromise } from "../sdk/types/async.js";
-import { Result } from "../sdk/types/fp.js";
+import type { CodatPlatform, CodatPlatformCore } from "../core";
+import { APIPromise } from "../sdk/types/async";
+import type { Result } from "../sdk/types/fp";
+import { toResult } from "./_adapter";
-/**
- * Refresh all data
- *
- * @remarks
- * Refreshes all data types with `fetch on first link` set to `true` for a given company.
- *
- * This is an asynchronous operation, and will bring updated data into Codat from the linked integration for you to view.
- *
- * [Read more](https://docs.codat.io/core-concepts/data-type-settings) about data type settings and `fetch on first link`.
- */
-export function refreshDataAll(
- client: CodatPlatformCore,
- request: operations.RefreshCompanyDataRequest,
- options?: RequestOptions,
-): APIPromise<
- Result<
- void,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >
-> {
- return new APIPromise($do(
- client,
- request,
- options,
- ));
-}
-
-async function $do(
- client: CodatPlatformCore,
- request: operations.RefreshCompanyDataRequest,
- options?: RequestOptions,
-): Promise<
- [
- Result<
- void,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >,
- APICall,
- ]
-> {
- const parsed = safeParse(
- request,
- (value) => operations.RefreshCompanyDataRequest$outboundSchema.parse(value),
- "Input validation failed",
- );
- if (!parsed.ok) {
- return [parsed, { status: "invalid" }];
- }
- const payload = parsed.value;
- const body = null;
-
- const pathParams = {
- companyId: encodeSimple("companyId", payload.companyId, {
- explode: false,
- charEncoding: "percent",
- }),
- };
- const path = pathToFunc("/companies/{companyId}/data/all")(pathParams);
-
- const headers = new Headers(compactMap({
- Accept: "application/json",
- }));
-
- const secConfig = await extractSecurity(client._options.authHeader);
- const securityInput = secConfig == null ? {} : { authHeader: secConfig };
- const requestSecurity = resolveGlobalSecurity(securityInput);
-
- const context = {
- options: client._options,
- baseURL: options?.serverURL ?? client._baseURL ?? "",
- operationID: "refresh-company-data",
- oAuth2Scopes: null,
+type Call = CodatPlatform["refreshData"]["all"];
- resolvedSecurity: requestSecurity,
-
- securitySource: client._options.authHeader,
- retryConfig: options?.retries
- || client._options.retryConfig
- || {
- strategy: "backoff",
- backoff: {
- initialInterval: 500,
- maxInterval: 60000,
- exponent: 1.5,
- maxElapsedTime: 3600000,
- },
- retryConnectionErrors: true,
- }
- || { strategy: "none" },
- retryCodes: options?.retryCodes || ["408", "429", "5XX"],
- };
-
- const requestRes = client._createRequest(context, {
- security: requestSecurity,
- method: "POST",
- baseURL: options?.serverURL,
- path: path,
- headers: headers,
- body: body,
- userAgent: client._options.userAgent,
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
- }, options);
- if (!requestRes.ok) {
- return [requestRes, { status: "invalid" }];
- }
- const req = requestRes.value;
-
- const doResult = await client._do(req, {
- context,
- isErrorStatusCode: (statusCode: number) =>
- matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
- retryConfig: context.retryConfig,
- retryCodes: context.retryCodes,
- });
- if (!doResult.ok) {
- return [doResult, { status: "request-error", request: req }];
- }
- const response = doResult.value;
-
- const responseFields = {
- HttpMeta: { Response: response, Request: req },
- };
-
- const [result] = await M.match<
- void,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >(
- M.nil(204, z.void()),
- M.jsonErr(
- [400, 401, 402, 403, 404, 429],
- errors.ErrorMessage$inboundSchema,
- ),
- M.jsonErr([500, 503], errors.ErrorMessage$inboundSchema),
- M.fail("4XX"),
- M.fail("5XX"),
- )(response, req, { extraFields: responseFields });
- if (!result.ok) {
- return [result, { status: "complete", request: req, response }];
- }
-
- return [result, { status: "complete", request: req, response }];
+export function refreshDataAll(
+ client: CodatPlatformCore,
+ request: Parameters[0],
+ options?: Parameters[1],
+): APIPromise>, Error>> {
+ return new APIPromise(toResult(() => client.refreshData.all(request, options)));
}
diff --git a/platform/src/funcs/refreshDataByDataType.ts b/platform/src/funcs/refreshDataByDataType.ts
index 891959ef1..6f5ec94f3 100644
--- a/platform/src/funcs/refreshDataByDataType.ts
+++ b/platform/src/funcs/refreshDataByDataType.ts
@@ -1,204 +1,17 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
+/* tslint:disable */
+/* eslint-disable */
-import { CodatPlatformCore } from "../core.js";
-import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
-import { matchStatusCode } from "../lib/http.js";
-import * as M from "../lib/matchers.js";
-import { compactMap } from "../lib/primitives.js";
-import { safeParse } from "../lib/schemas.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
-import { pathToFunc } from "../lib/url.js";
-import { CodatPlatformError } from "../sdk/models/errors/codatplatformerror.js";
-import {
- ConnectionError,
- InvalidRequestError,
- RequestAbortedError,
- RequestTimeoutError,
- UnexpectedClientError,
-} from "../sdk/models/errors/httpclienterrors.js";
-import * as errors from "../sdk/models/errors/index.js";
-import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
-import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
-import * as operations from "../sdk/models/operations/index.js";
-import * as shared from "../sdk/models/shared/index.js";
-import { APICall, APIPromise } from "../sdk/types/async.js";
-import { Result } from "../sdk/types/fp.js";
+import type { CodatPlatform, CodatPlatformCore } from "../core";
+import { APIPromise } from "../sdk/types/async";
+import type { Result } from "../sdk/types/fp";
+import { toResult } from "./_adapter";
-/**
- * Refresh data type
- *
- * @remarks
- * Refreshes a given data type for a given company.
- *
- * This is an asynchronous operation, and will bring updated data into Codat from the linked integration for you to view.
- */
-export function refreshDataByDataType(
- client: CodatPlatformCore,
- request: operations.RefreshDataTypeRequest,
- options?: RequestOptions,
-): APIPromise<
- Result<
- shared.PullOperation,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >
-> {
- return new APIPromise($do(
- client,
- request,
- options,
- ));
-}
-
-async function $do(
- client: CodatPlatformCore,
- request: operations.RefreshDataTypeRequest,
- options?: RequestOptions,
-): Promise<
- [
- Result<
- shared.PullOperation,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >,
- APICall,
- ]
-> {
- const parsed = safeParse(
- request,
- (value) => operations.RefreshDataTypeRequest$outboundSchema.parse(value),
- "Input validation failed",
- );
- if (!parsed.ok) {
- return [parsed, { status: "invalid" }];
- }
- const payload = parsed.value;
- const body = null;
-
- const pathParams = {
- companyId: encodeSimple("companyId", payload.companyId, {
- explode: false,
- charEncoding: "percent",
- }),
- dataType: encodeSimple("dataType", payload.dataType, {
- explode: false,
- charEncoding: "percent",
- }),
- };
- const path = pathToFunc("/companies/{companyId}/data/queue/{dataType}")(
- pathParams,
- );
-
- const query = encodeFormQuery({
- "connectionId": payload.connectionId,
- });
-
- const headers = new Headers(compactMap({
- Accept: "application/json",
- }));
-
- const secConfig = await extractSecurity(client._options.authHeader);
- const securityInput = secConfig == null ? {} : { authHeader: secConfig };
- const requestSecurity = resolveGlobalSecurity(securityInput);
-
- const context = {
- options: client._options,
- baseURL: options?.serverURL ?? client._baseURL ?? "",
- operationID: "refresh-data-type",
- oAuth2Scopes: null,
+type Call = CodatPlatform["refreshData"]["byDataType"];
- resolvedSecurity: requestSecurity,
-
- securitySource: client._options.authHeader,
- retryConfig: options?.retries
- || client._options.retryConfig
- || {
- strategy: "backoff",
- backoff: {
- initialInterval: 500,
- maxInterval: 60000,
- exponent: 1.5,
- maxElapsedTime: 3600000,
- },
- retryConnectionErrors: true,
- }
- || { strategy: "none" },
- retryCodes: options?.retryCodes || ["408", "429", "5XX"],
- };
-
- const requestRes = client._createRequest(context, {
- security: requestSecurity,
- method: "POST",
- baseURL: options?.serverURL,
- path: path,
- headers: headers,
- query: query,
- body: body,
- userAgent: client._options.userAgent,
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
- }, options);
- if (!requestRes.ok) {
- return [requestRes, { status: "invalid" }];
- }
- const req = requestRes.value;
-
- const doResult = await client._do(req, {
- context,
- isErrorStatusCode: (statusCode: number) =>
- matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
- retryConfig: context.retryConfig,
- retryCodes: context.retryCodes,
- });
- if (!doResult.ok) {
- return [doResult, { status: "request-error", request: req }];
- }
- const response = doResult.value;
-
- const responseFields = {
- HttpMeta: { Response: response, Request: req },
- };
-
- const [result] = await M.match<
- shared.PullOperation,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >(
- M.json(200, shared.PullOperation$inboundSchema),
- M.jsonErr(
- [400, 401, 402, 403, 404, 429],
- errors.ErrorMessage$inboundSchema,
- ),
- M.jsonErr([500, 503], errors.ErrorMessage$inboundSchema),
- M.fail("4XX"),
- M.fail("5XX"),
- )(response, req, { extraFields: responseFields });
- if (!result.ok) {
- return [result, { status: "complete", request: req, response }];
- }
-
- return [result, { status: "complete", request: req, response }];
+export function refreshDataByDataType(
+ client: CodatPlatformCore,
+ request: Parameters[0],
+ options?: Parameters[1],
+): APIPromise>, Error>> {
+ return new APIPromise(toResult(() => client.refreshData.byDataType(request, options)));
}
diff --git a/platform/src/funcs/refreshDataGet.ts b/platform/src/funcs/refreshDataGet.ts
index c87e650e4..e6d582305 100644
--- a/platform/src/funcs/refreshDataGet.ts
+++ b/platform/src/funcs/refreshDataGet.ts
@@ -1,189 +1,17 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
+/* tslint:disable */
+/* eslint-disable */
-import { CodatPlatformCore } from "../core.js";
-import { encodeSimple } from "../lib/encodings.js";
-import { matchStatusCode } from "../lib/http.js";
-import * as M from "../lib/matchers.js";
-import { compactMap } from "../lib/primitives.js";
-import { safeParse } from "../lib/schemas.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
-import { pathToFunc } from "../lib/url.js";
-import { CodatPlatformError } from "../sdk/models/errors/codatplatformerror.js";
-import {
- ConnectionError,
- InvalidRequestError,
- RequestAbortedError,
- RequestTimeoutError,
- UnexpectedClientError,
-} from "../sdk/models/errors/httpclienterrors.js";
-import * as errors from "../sdk/models/errors/index.js";
-import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
-import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
-import * as operations from "../sdk/models/operations/index.js";
-import * as shared from "../sdk/models/shared/index.js";
-import { APICall, APIPromise } from "../sdk/types/async.js";
-import { Result } from "../sdk/types/fp.js";
+import type { CodatPlatform, CodatPlatformCore } from "../core";
+import { APIPromise } from "../sdk/types/async";
+import type { Result } from "../sdk/types/fp";
+import { toResult } from "./_adapter";
-/**
- * Get data status
- *
- * @remarks
- * Get the state of each data type for a company
- */
-export function refreshDataGet(
- client: CodatPlatformCore,
- request: operations.GetCompanyDataStatusRequest,
- options?: RequestOptions,
-): APIPromise<
- Result<
- shared.DataStatuses,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >
-> {
- return new APIPromise($do(
- client,
- request,
- options,
- ));
-}
-
-async function $do(
- client: CodatPlatformCore,
- request: operations.GetCompanyDataStatusRequest,
- options?: RequestOptions,
-): Promise<
- [
- Result<
- shared.DataStatuses,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >,
- APICall,
- ]
-> {
- const parsed = safeParse(
- request,
- (value) =>
- operations.GetCompanyDataStatusRequest$outboundSchema.parse(value),
- "Input validation failed",
- );
- if (!parsed.ok) {
- return [parsed, { status: "invalid" }];
- }
- const payload = parsed.value;
- const body = null;
-
- const pathParams = {
- companyId: encodeSimple("companyId", payload.companyId, {
- explode: false,
- charEncoding: "percent",
- }),
- };
- const path = pathToFunc("/companies/{companyId}/dataStatus")(pathParams);
-
- const headers = new Headers(compactMap({
- Accept: "application/json",
- }));
-
- const secConfig = await extractSecurity(client._options.authHeader);
- const securityInput = secConfig == null ? {} : { authHeader: secConfig };
- const requestSecurity = resolveGlobalSecurity(securityInput);
-
- const context = {
- options: client._options,
- baseURL: options?.serverURL ?? client._baseURL ?? "",
- operationID: "get-company-data-status",
- oAuth2Scopes: null,
+type Call = CodatPlatform["refreshData"]["get"];
- resolvedSecurity: requestSecurity,
-
- securitySource: client._options.authHeader,
- retryConfig: options?.retries
- || client._options.retryConfig
- || {
- strategy: "backoff",
- backoff: {
- initialInterval: 500,
- maxInterval: 60000,
- exponent: 1.5,
- maxElapsedTime: 3600000,
- },
- retryConnectionErrors: true,
- }
- || { strategy: "none" },
- retryCodes: options?.retryCodes || ["408", "429", "5XX"],
- };
-
- const requestRes = client._createRequest(context, {
- security: requestSecurity,
- method: "GET",
- baseURL: options?.serverURL,
- path: path,
- headers: headers,
- body: body,
- userAgent: client._options.userAgent,
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
- }, options);
- if (!requestRes.ok) {
- return [requestRes, { status: "invalid" }];
- }
- const req = requestRes.value;
-
- const doResult = await client._do(req, {
- context,
- isErrorStatusCode: (statusCode: number) =>
- matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
- retryConfig: context.retryConfig,
- retryCodes: context.retryCodes,
- });
- if (!doResult.ok) {
- return [doResult, { status: "request-error", request: req }];
- }
- const response = doResult.value;
-
- const responseFields = {
- HttpMeta: { Response: response, Request: req },
- };
-
- const [result] = await M.match<
- shared.DataStatuses,
- | errors.ErrorMessage
- | CodatPlatformError
- | ResponseValidationError
- | ConnectionError
- | RequestAbortedError
- | RequestTimeoutError
- | InvalidRequestError
- | UnexpectedClientError
- | SDKValidationError
- >(
- M.json(200, shared.DataStatuses$inboundSchema),
- M.jsonErr([401, 402, 403, 404, 429], errors.ErrorMessage$inboundSchema),
- M.jsonErr([500, 503], errors.ErrorMessage$inboundSchema),
- M.fail("4XX"),
- M.fail("5XX"),
- )(response, req, { extraFields: responseFields });
- if (!result.ok) {
- return [result, { status: "complete", request: req, response }];
- }
-
- return [result, { status: "complete", request: req, response }];
+export function refreshDataGet(
+ client: CodatPlatformCore,
+ request: Parameters[0],
+ options?: Parameters[1],
+): APIPromise