@unified-api/typescript-sdk 2.9.14 → 2.9.16
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +24 -0
- package/docs/sdks/comment/README.md +501 -0
- package/docs/sdks/payment/README.md +494 -0
- package/docs/sdks/subscription/README.md +501 -0
- package/docs/sdks/task/README.md +494 -0
- package/funcs/commentCreateTaskComment.d.ts +13 -0
- package/funcs/commentCreateTaskComment.d.ts.map +1 -0
- package/funcs/commentCreateTaskComment.js +103 -0
- package/funcs/commentCreateTaskComment.js.map +1 -0
- package/funcs/commentGetTaskComment.d.ts +13 -0
- package/funcs/commentGetTaskComment.d.ts.map +1 -0
- package/funcs/commentGetTaskComment.js +106 -0
- package/funcs/commentGetTaskComment.js.map +1 -0
- package/funcs/commentListTaskComments.d.ts +13 -0
- package/funcs/commentListTaskComments.d.ts.map +1 -0
- package/funcs/commentListTaskComments.js +110 -0
- package/funcs/commentListTaskComments.js.map +1 -0
- package/funcs/commentPatchTaskComment.d.ts +13 -0
- package/funcs/commentPatchTaskComment.d.ts.map +1 -0
- package/funcs/commentPatchTaskComment.js +107 -0
- package/funcs/commentPatchTaskComment.js.map +1 -0
- package/funcs/commentRemoveTaskComment.d.ts +12 -0
- package/funcs/commentRemoveTaskComment.d.ts.map +1 -0
- package/funcs/commentRemoveTaskComment.js +104 -0
- package/funcs/commentRemoveTaskComment.js.map +1 -0
- package/funcs/commentUpdateTaskComment.d.ts +13 -0
- package/funcs/commentUpdateTaskComment.d.ts.map +1 -0
- package/funcs/commentUpdateTaskComment.js +107 -0
- package/funcs/commentUpdateTaskComment.js.map +1 -0
- package/funcs/paymentCreatePaymentSubscription.d.ts +13 -0
- package/funcs/paymentCreatePaymentSubscription.d.ts.map +1 -0
- package/funcs/paymentCreatePaymentSubscription.js +105 -0
- package/funcs/paymentCreatePaymentSubscription.js.map +1 -0
- package/funcs/paymentGetPaymentSubscription.d.ts +13 -0
- package/funcs/paymentGetPaymentSubscription.d.ts.map +1 -0
- package/funcs/paymentGetPaymentSubscription.js +106 -0
- package/funcs/paymentGetPaymentSubscription.js.map +1 -0
- package/funcs/paymentListPaymentSubscriptions.d.ts +13 -0
- package/funcs/paymentListPaymentSubscriptions.d.ts.map +1 -0
- package/funcs/paymentListPaymentSubscriptions.js +110 -0
- package/funcs/paymentListPaymentSubscriptions.js.map +1 -0
- package/funcs/paymentPatchPaymentSubscription.d.ts +13 -0
- package/funcs/paymentPatchPaymentSubscription.d.ts.map +1 -0
- package/funcs/paymentPatchPaymentSubscription.js +109 -0
- package/funcs/paymentPatchPaymentSubscription.js.map +1 -0
- package/funcs/paymentRemovePaymentSubscription.d.ts +12 -0
- package/funcs/paymentRemovePaymentSubscription.d.ts.map +1 -0
- package/funcs/paymentRemovePaymentSubscription.js +104 -0
- package/funcs/paymentRemovePaymentSubscription.js.map +1 -0
- package/funcs/paymentUpdatePaymentSubscription.d.ts +13 -0
- package/funcs/paymentUpdatePaymentSubscription.d.ts.map +1 -0
- package/funcs/paymentUpdatePaymentSubscription.js +109 -0
- package/funcs/paymentUpdatePaymentSubscription.js.map +1 -0
- package/funcs/subscriptionCreatePaymentSubscription.d.ts +13 -0
- package/funcs/subscriptionCreatePaymentSubscription.d.ts.map +1 -0
- package/funcs/subscriptionCreatePaymentSubscription.js +105 -0
- package/funcs/subscriptionCreatePaymentSubscription.js.map +1 -0
- package/funcs/subscriptionGetPaymentSubscription.d.ts +13 -0
- package/funcs/subscriptionGetPaymentSubscription.d.ts.map +1 -0
- package/funcs/subscriptionGetPaymentSubscription.js +106 -0
- package/funcs/subscriptionGetPaymentSubscription.js.map +1 -0
- package/funcs/subscriptionListPaymentSubscriptions.d.ts +13 -0
- package/funcs/subscriptionListPaymentSubscriptions.d.ts.map +1 -0
- package/funcs/subscriptionListPaymentSubscriptions.js +110 -0
- package/funcs/subscriptionListPaymentSubscriptions.js.map +1 -0
- package/funcs/subscriptionPatchPaymentSubscription.d.ts +13 -0
- package/funcs/subscriptionPatchPaymentSubscription.d.ts.map +1 -0
- package/funcs/subscriptionPatchPaymentSubscription.js +109 -0
- package/funcs/subscriptionPatchPaymentSubscription.js.map +1 -0
- package/funcs/subscriptionRemovePaymentSubscription.d.ts +12 -0
- package/funcs/subscriptionRemovePaymentSubscription.d.ts.map +1 -0
- package/funcs/subscriptionRemovePaymentSubscription.js +104 -0
- package/funcs/subscriptionRemovePaymentSubscription.js.map +1 -0
- package/funcs/subscriptionUpdatePaymentSubscription.d.ts +13 -0
- package/funcs/subscriptionUpdatePaymentSubscription.d.ts.map +1 -0
- package/funcs/subscriptionUpdatePaymentSubscription.js +109 -0
- package/funcs/subscriptionUpdatePaymentSubscription.js.map +1 -0
- package/funcs/taskCreateTaskComment.d.ts +13 -0
- package/funcs/taskCreateTaskComment.d.ts.map +1 -0
- package/funcs/taskCreateTaskComment.js +103 -0
- package/funcs/taskCreateTaskComment.js.map +1 -0
- package/funcs/taskGetTaskComment.d.ts +13 -0
- package/funcs/taskGetTaskComment.d.ts.map +1 -0
- package/funcs/taskGetTaskComment.js +106 -0
- package/funcs/taskGetTaskComment.js.map +1 -0
- package/funcs/taskListTaskComments.d.ts +13 -0
- package/funcs/taskListTaskComments.d.ts.map +1 -0
- package/funcs/taskListTaskComments.js +110 -0
- package/funcs/taskListTaskComments.js.map +1 -0
- package/funcs/taskPatchTaskComment.d.ts +13 -0
- package/funcs/taskPatchTaskComment.d.ts.map +1 -0
- package/funcs/taskPatchTaskComment.js +107 -0
- package/funcs/taskPatchTaskComment.js.map +1 -0
- package/funcs/taskRemoveTaskComment.d.ts +12 -0
- package/funcs/taskRemoveTaskComment.d.ts.map +1 -0
- package/funcs/taskRemoveTaskComment.js +104 -0
- package/funcs/taskRemoveTaskComment.js.map +1 -0
- package/funcs/taskUpdateTaskComment.d.ts +13 -0
- package/funcs/taskUpdateTaskComment.d.ts.map +1 -0
- package/funcs/taskUpdateTaskComment.js +107 -0
- package/funcs/taskUpdateTaskComment.js.map +1 -0
- package/lib/config.d.ts +2 -2
- package/lib/config.js +2 -2
- package/package.json +1 -1
- package/sdk/comment.d.ts +30 -0
- package/sdk/comment.d.ts.map +1 -0
- package/sdk/comment.js +54 -0
- package/sdk/comment.js.map +1 -0
- package/sdk/models/operations/createpaymentsubscription.d.ts +40 -0
- package/sdk/models/operations/createpaymentsubscription.d.ts.map +1 -0
- package/sdk/models/operations/createpaymentsubscription.js +75 -0
- package/sdk/models/operations/createpaymentsubscription.js.map +1 -0
- package/sdk/models/operations/createtaskcomment.d.ts +40 -0
- package/sdk/models/operations/createtaskcomment.d.ts.map +1 -0
- package/sdk/models/operations/createtaskcomment.js +75 -0
- package/sdk/models/operations/createtaskcomment.js.map +1 -0
- package/sdk/models/operations/getpaymentsubscription.d.ts +42 -0
- package/sdk/models/operations/getpaymentsubscription.d.ts.map +1 -0
- package/sdk/models/operations/getpaymentsubscription.js +72 -0
- package/sdk/models/operations/getpaymentsubscription.js.map +1 -0
- package/sdk/models/operations/gettaskcomment.d.ts +42 -0
- package/sdk/models/operations/gettaskcomment.d.ts.map +1 -0
- package/sdk/models/operations/gettaskcomment.js +72 -0
- package/sdk/models/operations/gettaskcomment.js.map +1 -0
- package/sdk/models/operations/getunifiedintegrationauth.d.ts +12 -0
- package/sdk/models/operations/getunifiedintegrationauth.d.ts.map +1 -1
- package/sdk/models/operations/getunifiedintegrationauth.js +4 -0
- package/sdk/models/operations/getunifiedintegrationauth.js.map +1 -1
- package/sdk/models/operations/index.d.ts +12 -0
- package/sdk/models/operations/index.d.ts.map +1 -1
- package/sdk/models/operations/index.js +12 -0
- package/sdk/models/operations/index.js.map +1 -1
- package/sdk/models/operations/listpaymentsubscriptions.d.ts +57 -0
- package/sdk/models/operations/listpaymentsubscriptions.d.ts.map +1 -0
- package/sdk/models/operations/listpaymentsubscriptions.js +89 -0
- package/sdk/models/operations/listpaymentsubscriptions.js.map +1 -0
- package/sdk/models/operations/listtaskcomments.d.ts +57 -0
- package/sdk/models/operations/listtaskcomments.d.ts.map +1 -0
- package/sdk/models/operations/listtaskcomments.js +89 -0
- package/sdk/models/operations/listtaskcomments.js.map +1 -0
- package/sdk/models/operations/patchpaymentsubscription.d.ts +45 -0
- package/sdk/models/operations/patchpaymentsubscription.d.ts.map +1 -0
- package/sdk/models/operations/patchpaymentsubscription.js +77 -0
- package/sdk/models/operations/patchpaymentsubscription.js.map +1 -0
- package/sdk/models/operations/patchtaskcomment.d.ts +45 -0
- package/sdk/models/operations/patchtaskcomment.d.ts.map +1 -0
- package/sdk/models/operations/patchtaskcomment.js +77 -0
- package/sdk/models/operations/patchtaskcomment.js.map +1 -0
- package/sdk/models/operations/removepaymentsubscription.d.ts +66 -0
- package/sdk/models/operations/removepaymentsubscription.d.ts.map +1 -0
- package/sdk/models/operations/removepaymentsubscription.js +105 -0
- package/sdk/models/operations/removepaymentsubscription.js.map +1 -0
- package/sdk/models/operations/removetaskcomment.d.ts +66 -0
- package/sdk/models/operations/removetaskcomment.d.ts.map +1 -0
- package/sdk/models/operations/removetaskcomment.js +105 -0
- package/sdk/models/operations/removetaskcomment.js.map +1 -0
- package/sdk/models/operations/updatepaymentsubscription.d.ts +45 -0
- package/sdk/models/operations/updatepaymentsubscription.d.ts.map +1 -0
- package/sdk/models/operations/updatepaymentsubscription.js +77 -0
- package/sdk/models/operations/updatepaymentsubscription.js.map +1 -0
- package/sdk/models/operations/updatetaskcomment.d.ts +45 -0
- package/sdk/models/operations/updatetaskcomment.d.ts.map +1 -0
- package/sdk/models/operations/updatetaskcomment.js +77 -0
- package/sdk/models/operations/updatetaskcomment.js.map +1 -0
- package/sdk/models/shared/accountingjournal.d.ts +2 -2
- package/sdk/models/shared/accountingjournal.d.ts.map +1 -1
- package/sdk/models/shared/accountingjournal.js +6 -4
- package/sdk/models/shared/accountingjournal.js.map +1 -1
- package/sdk/models/shared/index.d.ts +3 -1
- package/sdk/models/shared/index.d.ts.map +1 -1
- package/sdk/models/shared/index.js +3 -1
- package/sdk/models/shared/index.js.map +1 -1
- package/sdk/models/shared/{paymentlinklineitem.d.ts → paymentlineitem.d.ts} +14 -14
- package/sdk/models/shared/paymentlineitem.d.ts.map +1 -0
- package/sdk/models/shared/{paymentlinklineitem.js → paymentlineitem.js} +17 -17
- package/sdk/models/shared/paymentlineitem.js.map +1 -0
- package/sdk/models/shared/paymentlink.d.ts +3 -3
- package/sdk/models/shared/paymentlink.d.ts.map +1 -1
- package/sdk/models/shared/paymentlink.js +3 -3
- package/sdk/models/shared/paymentlink.js.map +1 -1
- package/sdk/models/shared/paymentrefund.d.ts +2 -2
- package/sdk/models/shared/paymentrefund.d.ts.map +1 -1
- package/sdk/models/shared/paymentrefund.js +6 -4
- package/sdk/models/shared/paymentrefund.js.map +1 -1
- package/sdk/models/shared/paymentsubscription.d.ts +135 -0
- package/sdk/models/shared/paymentsubscription.d.ts.map +1 -0
- package/sdk/models/shared/paymentsubscription.js +176 -0
- package/sdk/models/shared/paymentsubscription.js.map +1 -0
- package/sdk/models/shared/propertyconnectionpermissions.d.ts +12 -0
- package/sdk/models/shared/propertyconnectionpermissions.d.ts.map +1 -1
- package/sdk/models/shared/propertyconnectionpermissions.js +4 -0
- package/sdk/models/shared/propertyconnectionpermissions.js.map +1 -1
- package/sdk/models/shared/propertycrmeventemail.d.ts +2 -2
- package/sdk/models/shared/repoorganization.d.ts +4 -4
- package/sdk/models/shared/repoorganization.d.ts.map +1 -1
- package/sdk/models/shared/repoorganization.js +8 -6
- package/sdk/models/shared/repoorganization.js.map +1 -1
- package/sdk/models/shared/taskcomment.d.ts +47 -0
- package/sdk/models/shared/taskcomment.d.ts.map +1 -0
- package/sdk/models/shared/taskcomment.js +92 -0
- package/sdk/models/shared/taskcomment.js.map +1 -0
- package/sdk/models/shared/tasktask.d.ts +5 -0
- package/sdk/models/shared/tasktask.d.ts.map +1 -1
- package/sdk/models/shared/tasktask.js +4 -0
- package/sdk/models/shared/tasktask.js.map +1 -1
- package/sdk/models/shared/ticketingnote.d.ts +1 -1
- package/sdk/models/shared/ticketingnote.d.ts.map +1 -1
- package/sdk/models/shared/ticketingnote.js +3 -2
- package/sdk/models/shared/ticketingnote.js.map +1 -1
- package/sdk/models/shared/webhook.d.ts +6 -0
- package/sdk/models/shared/webhook.d.ts.map +1 -1
- package/sdk/models/shared/webhook.js +2 -0
- package/sdk/models/shared/webhook.js.map +1 -1
- package/sdk/payment.d.ts +24 -0
- package/sdk/payment.d.ts.map +1 -1
- package/sdk/payment.js +42 -0
- package/sdk/payment.js.map +1 -1
- package/sdk/sdk.d.ts +6 -0
- package/sdk/sdk.d.ts.map +1 -1
- package/sdk/sdk.js +8 -0
- package/sdk/sdk.js.map +1 -1
- package/sdk/subscription.d.ts +30 -0
- package/sdk/subscription.d.ts.map +1 -0
- package/sdk/subscription.js +54 -0
- package/sdk/subscription.js.map +1 -0
- package/sdk/task.d.ts +24 -0
- package/sdk/task.d.ts.map +1 -1
- package/sdk/task.js +42 -0
- package/sdk/task.js.map +1 -1
- package/src/funcs/commentCreateTaskComment.ts +133 -0
- package/src/funcs/commentGetTaskComment.ts +136 -0
- package/src/funcs/commentListTaskComments.ts +140 -0
- package/src/funcs/commentPatchTaskComment.ts +137 -0
- package/src/funcs/commentRemoveTaskComment.ts +139 -0
- package/src/funcs/commentUpdateTaskComment.ts +137 -0
- package/src/funcs/paymentCreatePaymentSubscription.ts +136 -0
- package/src/funcs/paymentGetPaymentSubscription.ts +139 -0
- package/src/funcs/paymentListPaymentSubscriptions.ts +141 -0
- package/src/funcs/paymentPatchPaymentSubscription.ts +142 -0
- package/src/funcs/paymentRemovePaymentSubscription.ts +145 -0
- package/src/funcs/paymentUpdatePaymentSubscription.ts +142 -0
- package/src/funcs/subscriptionCreatePaymentSubscription.ts +136 -0
- package/src/funcs/subscriptionGetPaymentSubscription.ts +139 -0
- package/src/funcs/subscriptionListPaymentSubscriptions.ts +141 -0
- package/src/funcs/subscriptionPatchPaymentSubscription.ts +142 -0
- package/src/funcs/subscriptionRemovePaymentSubscription.ts +145 -0
- package/src/funcs/subscriptionUpdatePaymentSubscription.ts +142 -0
- package/src/funcs/taskCreateTaskComment.ts +133 -0
- package/src/funcs/taskGetTaskComment.ts +136 -0
- package/src/funcs/taskListTaskComments.ts +140 -0
- package/src/funcs/taskPatchTaskComment.ts +137 -0
- package/src/funcs/taskRemoveTaskComment.ts +139 -0
- package/src/funcs/taskUpdateTaskComment.ts +137 -0
- package/src/lib/config.ts +2 -2
- package/src/sdk/comment.ts +100 -0
- package/src/sdk/models/operations/createpaymentsubscription.ts +94 -0
- package/src/sdk/models/operations/createtaskcomment.ts +92 -0
- package/src/sdk/models/operations/getpaymentsubscription.ts +94 -0
- package/src/sdk/models/operations/gettaskcomment.ts +92 -0
- package/src/sdk/models/operations/getunifiedintegrationauth.ts +4 -0
- package/src/sdk/models/operations/index.ts +12 -0
- package/src/sdk/models/operations/listpaymentsubscriptions.ts +126 -0
- package/src/sdk/models/operations/listtaskcomments.ts +124 -0
- package/src/sdk/models/operations/patchpaymentsubscription.ts +101 -0
- package/src/sdk/models/operations/patchtaskcomment.ts +99 -0
- package/src/sdk/models/operations/removepaymentsubscription.ts +156 -0
- package/src/sdk/models/operations/removetaskcomment.ts +151 -0
- package/src/sdk/models/operations/updatepaymentsubscription.ts +101 -0
- package/src/sdk/models/operations/updatetaskcomment.ts +99 -0
- package/src/sdk/models/shared/accountingjournal.ts +8 -6
- package/src/sdk/models/shared/index.ts +3 -1
- package/src/sdk/models/shared/{paymentlinklineitem.ts → paymentlineitem.ts} +21 -23
- package/src/sdk/models/shared/paymentlink.ts +9 -9
- package/src/sdk/models/shared/paymentrefund.ts +8 -6
- package/src/sdk/models/shared/paymentsubscription.ts +247 -0
- package/src/sdk/models/shared/propertyconnectionpermissions.ts +4 -0
- package/src/sdk/models/shared/propertycrmeventemail.ts +2 -2
- package/src/sdk/models/shared/repoorganization.ts +12 -10
- package/src/sdk/models/shared/taskcomment.ts +109 -0
- package/src/sdk/models/shared/tasktask.ts +9 -0
- package/src/sdk/models/shared/ticketingnote.ts +4 -3
- package/src/sdk/models/shared/webhook.ts +2 -0
- package/src/sdk/payment.ts +90 -0
- package/src/sdk/sdk.ts +12 -0
- package/src/sdk/subscription.ts +100 -0
- package/src/sdk/task.ts +90 -0
- package/sdk/models/shared/paymentlinklineitem.d.ts.map +0 -1
- package/sdk/models/shared/paymentlinklineitem.js.map +0 -1
package/README.md
CHANGED
|
@@ -584,6 +584,12 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
584
584
|
- [`collectionPatchCommerceCollection`](docs/sdks/collection/README.md#patchcommercecollection) - Update a collection
|
|
585
585
|
- [`collectionRemoveCommerceCollection`](docs/sdks/collection/README.md#removecommercecollection) - Remove a collection
|
|
586
586
|
- [`collectionUpdateCommerceCollection`](docs/sdks/collection/README.md#updatecommercecollection) - Update a collection
|
|
587
|
+
- [`commentCreateTaskComment`](docs/sdks/comment/README.md#createtaskcomment) - Create a comment
|
|
588
|
+
- [`commentGetTaskComment`](docs/sdks/comment/README.md#gettaskcomment) - Retrieve a comment
|
|
589
|
+
- [`commentListTaskComments`](docs/sdks/comment/README.md#listtaskcomments) - List all comments
|
|
590
|
+
- [`commentPatchTaskComment`](docs/sdks/comment/README.md#patchtaskcomment) - Update a comment
|
|
591
|
+
- [`commentRemoveTaskComment`](docs/sdks/comment/README.md#removetaskcomment) - Remove a comment
|
|
592
|
+
- [`commentUpdateTaskComment`](docs/sdks/comment/README.md#updatetaskcomment) - Update a comment
|
|
587
593
|
- [`commerceCreateCommerceCollection`](docs/sdks/commerce/README.md#createcommercecollection) - Create a collection
|
|
588
594
|
- [`commerceCreateCommerceInventory`](docs/sdks/commerce/README.md#createcommerceinventory) - Create an inventory
|
|
589
595
|
- [`commerceCreateCommerceItem`](docs/sdks/commerce/README.md#createcommerceitem) - Create an item
|
|
@@ -963,20 +969,26 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
963
969
|
- [`passthroughUpdatePassthroughRaw`](docs/sdks/passthrough/README.md#updatepassthroughraw) - Passthrough PUT
|
|
964
970
|
- [`paymentCreatePaymentLink`](docs/sdks/payment/README.md#createpaymentlink) - Create a link
|
|
965
971
|
- [`paymentCreatePaymentPayment`](docs/sdks/payment/README.md#createpaymentpayment) - Create a payment
|
|
972
|
+
- [`paymentCreatePaymentSubscription`](docs/sdks/payment/README.md#createpaymentsubscription) - Create a subscription
|
|
966
973
|
- [`paymentGetPaymentLink`](docs/sdks/payment/README.md#getpaymentlink) - Retrieve a link
|
|
967
974
|
- [`paymentGetPaymentPayment`](docs/sdks/payment/README.md#getpaymentpayment) - Retrieve a payment
|
|
968
975
|
- [`paymentGetPaymentPayout`](docs/sdks/payment/README.md#getpaymentpayout) - Retrieve a payout
|
|
969
976
|
- [`paymentGetPaymentRefund`](docs/sdks/payment/README.md#getpaymentrefund) - Retrieve a refund
|
|
977
|
+
- [`paymentGetPaymentSubscription`](docs/sdks/payment/README.md#getpaymentsubscription) - Retrieve a subscription
|
|
970
978
|
- [`paymentListPaymentLinks`](docs/sdks/payment/README.md#listpaymentlinks) - List all links
|
|
971
979
|
- [`paymentListPaymentPayments`](docs/sdks/payment/README.md#listpaymentpayments) - List all payments
|
|
972
980
|
- [`paymentListPaymentPayouts`](docs/sdks/payment/README.md#listpaymentpayouts) - List all payouts
|
|
973
981
|
- [`paymentListPaymentRefunds`](docs/sdks/payment/README.md#listpaymentrefunds) - List all refunds
|
|
982
|
+
- [`paymentListPaymentSubscriptions`](docs/sdks/payment/README.md#listpaymentsubscriptions) - List all subscriptions
|
|
974
983
|
- [`paymentPatchPaymentLink`](docs/sdks/payment/README.md#patchpaymentlink) - Update a link
|
|
975
984
|
- [`paymentPatchPaymentPayment`](docs/sdks/payment/README.md#patchpaymentpayment) - Update a payment
|
|
985
|
+
- [`paymentPatchPaymentSubscription`](docs/sdks/payment/README.md#patchpaymentsubscription) - Update a subscription
|
|
976
986
|
- [`paymentRemovePaymentLink`](docs/sdks/payment/README.md#removepaymentlink) - Remove a link
|
|
977
987
|
- [`paymentRemovePaymentPayment`](docs/sdks/payment/README.md#removepaymentpayment) - Remove a payment
|
|
988
|
+
- [`paymentRemovePaymentSubscription`](docs/sdks/payment/README.md#removepaymentsubscription) - Remove a subscription
|
|
978
989
|
- [`paymentUpdatePaymentLink`](docs/sdks/payment/README.md#updatepaymentlink) - Update a link
|
|
979
990
|
- [`paymentUpdatePaymentPayment`](docs/sdks/payment/README.md#updatepaymentpayment) - Update a payment
|
|
991
|
+
- [`paymentUpdatePaymentSubscription`](docs/sdks/payment/README.md#updatepaymentsubscription) - Update a subscription
|
|
980
992
|
- [`payoutGetPaymentPayout`](docs/sdks/payout/README.md#getpaymentpayout) - Retrieve a payout
|
|
981
993
|
- [`payoutListPaymentPayouts`](docs/sdks/payout/README.md#listpaymentpayouts) - List all payouts
|
|
982
994
|
- [`payslipGetHrisPayslip`](docs/sdks/payslip/README.md#gethrispayslip) - Retrieve a payslip
|
|
@@ -1075,16 +1087,28 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
1075
1087
|
- [`studentPatchLmsStudent`](docs/sdks/student/README.md#patchlmsstudent) - Update a student
|
|
1076
1088
|
- [`studentRemoveLmsStudent`](docs/sdks/student/README.md#removelmsstudent) - Remove a student
|
|
1077
1089
|
- [`studentUpdateLmsStudent`](docs/sdks/student/README.md#updatelmsstudent) - Update a student
|
|
1090
|
+
- [`subscriptionCreatePaymentSubscription`](docs/sdks/subscription/README.md#createpaymentsubscription) - Create a subscription
|
|
1091
|
+
- [`subscriptionGetPaymentSubscription`](docs/sdks/subscription/README.md#getpaymentsubscription) - Retrieve a subscription
|
|
1092
|
+
- [`subscriptionListPaymentSubscriptions`](docs/sdks/subscription/README.md#listpaymentsubscriptions) - List all subscriptions
|
|
1093
|
+
- [`subscriptionPatchPaymentSubscription`](docs/sdks/subscription/README.md#patchpaymentsubscription) - Update a subscription
|
|
1094
|
+
- [`subscriptionRemovePaymentSubscription`](docs/sdks/subscription/README.md#removepaymentsubscription) - Remove a subscription
|
|
1095
|
+
- [`subscriptionUpdatePaymentSubscription`](docs/sdks/subscription/README.md#updatepaymentsubscription) - Update a subscription
|
|
1096
|
+
- [`taskCreateTaskComment`](docs/sdks/task/README.md#createtaskcomment) - Create a comment
|
|
1078
1097
|
- [`taskCreateTaskProject`](docs/sdks/task/README.md#createtaskproject) - Create a project
|
|
1079
1098
|
- [`taskCreateTaskTask`](docs/sdks/task/README.md#createtasktask) - Create a task
|
|
1099
|
+
- [`taskGetTaskComment`](docs/sdks/task/README.md#gettaskcomment) - Retrieve a comment
|
|
1080
1100
|
- [`taskGetTaskProject`](docs/sdks/task/README.md#gettaskproject) - Retrieve a project
|
|
1081
1101
|
- [`taskGetTaskTask`](docs/sdks/task/README.md#gettasktask) - Retrieve a task
|
|
1102
|
+
- [`taskListTaskComments`](docs/sdks/task/README.md#listtaskcomments) - List all comments
|
|
1082
1103
|
- [`taskListTaskProjects`](docs/sdks/task/README.md#listtaskprojects) - List all projects
|
|
1083
1104
|
- [`taskListTaskTasks`](docs/sdks/task/README.md#listtasktasks) - List all tasks
|
|
1105
|
+
- [`taskPatchTaskComment`](docs/sdks/task/README.md#patchtaskcomment) - Update a comment
|
|
1084
1106
|
- [`taskPatchTaskProject`](docs/sdks/task/README.md#patchtaskproject) - Update a project
|
|
1085
1107
|
- [`taskPatchTaskTask`](docs/sdks/task/README.md#patchtasktask) - Update a task
|
|
1108
|
+
- [`taskRemoveTaskComment`](docs/sdks/task/README.md#removetaskcomment) - Remove a comment
|
|
1086
1109
|
- [`taskRemoveTaskProject`](docs/sdks/task/README.md#removetaskproject) - Remove a project
|
|
1087
1110
|
- [`taskRemoveTaskTask`](docs/sdks/task/README.md#removetasktask) - Remove a task
|
|
1111
|
+
- [`taskUpdateTaskComment`](docs/sdks/task/README.md#updatetaskcomment) - Update a comment
|
|
1088
1112
|
- [`taskUpdateTaskProject`](docs/sdks/task/README.md#updatetaskproject) - Update a project
|
|
1089
1113
|
- [`taskUpdateTaskTask`](docs/sdks/task/README.md#updatetasktask) - Update a task
|
|
1090
1114
|
- [`taxrateCreateAccountingTaxrate`](docs/sdks/taxrate/README.md#createaccountingtaxrate) - Create a taxrate
|
|
@@ -0,0 +1,501 @@
|
|
|
1
|
+
# Comment
|
|
2
|
+
(*comment*)
|
|
3
|
+
|
|
4
|
+
## Overview
|
|
5
|
+
|
|
6
|
+
### Available Operations
|
|
7
|
+
|
|
8
|
+
* [createTaskComment](#createtaskcomment) - Create a comment
|
|
9
|
+
* [getTaskComment](#gettaskcomment) - Retrieve a comment
|
|
10
|
+
* [listTaskComments](#listtaskcomments) - List all comments
|
|
11
|
+
* [patchTaskComment](#patchtaskcomment) - Update a comment
|
|
12
|
+
* [removeTaskComment](#removetaskcomment) - Remove a comment
|
|
13
|
+
* [updateTaskComment](#updatetaskcomment) - Update a comment
|
|
14
|
+
|
|
15
|
+
## createTaskComment
|
|
16
|
+
|
|
17
|
+
Create a comment
|
|
18
|
+
|
|
19
|
+
### Example Usage
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
23
|
+
|
|
24
|
+
const unifiedTo = new UnifiedTo({
|
|
25
|
+
security: {
|
|
26
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
27
|
+
},
|
|
28
|
+
});
|
|
29
|
+
|
|
30
|
+
async function run() {
|
|
31
|
+
const result = await unifiedTo.comment.createTaskComment({
|
|
32
|
+
connectionId: "<id>",
|
|
33
|
+
});
|
|
34
|
+
|
|
35
|
+
// Handle the result
|
|
36
|
+
console.log(result);
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
run();
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
### Standalone function
|
|
43
|
+
|
|
44
|
+
The standalone function version of this method:
|
|
45
|
+
|
|
46
|
+
```typescript
|
|
47
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
48
|
+
import { commentCreateTaskComment } from "@unified-api/typescript-sdk/funcs/commentCreateTaskComment.js";
|
|
49
|
+
|
|
50
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
51
|
+
// You can create one instance of it to use across an application.
|
|
52
|
+
const unifiedTo = new UnifiedToCore({
|
|
53
|
+
security: {
|
|
54
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
55
|
+
},
|
|
56
|
+
});
|
|
57
|
+
|
|
58
|
+
async function run() {
|
|
59
|
+
const res = await commentCreateTaskComment(unifiedTo, {
|
|
60
|
+
connectionId: "<id>",
|
|
61
|
+
});
|
|
62
|
+
|
|
63
|
+
if (!res.ok) {
|
|
64
|
+
throw res.error;
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
const { value: result } = res;
|
|
68
|
+
|
|
69
|
+
// Handle the result
|
|
70
|
+
console.log(result);
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
run();
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
### Parameters
|
|
77
|
+
|
|
78
|
+
| Parameter | Type | Required | Description |
|
|
79
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
80
|
+
| `request` | [operations.CreateTaskCommentRequest](../../sdk/models/operations/createtaskcommentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
81
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
82
|
+
| `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. |
|
|
83
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
84
|
+
|
|
85
|
+
### Response
|
|
86
|
+
|
|
87
|
+
**Promise\<[shared.TaskComment](../../sdk/models/shared/taskcomment.md)\>**
|
|
88
|
+
|
|
89
|
+
### Errors
|
|
90
|
+
|
|
91
|
+
| Error Type | Status Code | Content Type |
|
|
92
|
+
| --------------- | --------------- | --------------- |
|
|
93
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
94
|
+
|
|
95
|
+
## getTaskComment
|
|
96
|
+
|
|
97
|
+
Retrieve a comment
|
|
98
|
+
|
|
99
|
+
### Example Usage
|
|
100
|
+
|
|
101
|
+
```typescript
|
|
102
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
103
|
+
|
|
104
|
+
const unifiedTo = new UnifiedTo({
|
|
105
|
+
security: {
|
|
106
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
107
|
+
},
|
|
108
|
+
});
|
|
109
|
+
|
|
110
|
+
async function run() {
|
|
111
|
+
const result = await unifiedTo.comment.getTaskComment({
|
|
112
|
+
connectionId: "<id>",
|
|
113
|
+
id: "<id>",
|
|
114
|
+
});
|
|
115
|
+
|
|
116
|
+
// Handle the result
|
|
117
|
+
console.log(result);
|
|
118
|
+
}
|
|
119
|
+
|
|
120
|
+
run();
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
### Standalone function
|
|
124
|
+
|
|
125
|
+
The standalone function version of this method:
|
|
126
|
+
|
|
127
|
+
```typescript
|
|
128
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
129
|
+
import { commentGetTaskComment } from "@unified-api/typescript-sdk/funcs/commentGetTaskComment.js";
|
|
130
|
+
|
|
131
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
132
|
+
// You can create one instance of it to use across an application.
|
|
133
|
+
const unifiedTo = new UnifiedToCore({
|
|
134
|
+
security: {
|
|
135
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
136
|
+
},
|
|
137
|
+
});
|
|
138
|
+
|
|
139
|
+
async function run() {
|
|
140
|
+
const res = await commentGetTaskComment(unifiedTo, {
|
|
141
|
+
connectionId: "<id>",
|
|
142
|
+
id: "<id>",
|
|
143
|
+
});
|
|
144
|
+
|
|
145
|
+
if (!res.ok) {
|
|
146
|
+
throw res.error;
|
|
147
|
+
}
|
|
148
|
+
|
|
149
|
+
const { value: result } = res;
|
|
150
|
+
|
|
151
|
+
// Handle the result
|
|
152
|
+
console.log(result);
|
|
153
|
+
}
|
|
154
|
+
|
|
155
|
+
run();
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
### Parameters
|
|
159
|
+
|
|
160
|
+
| Parameter | Type | Required | Description |
|
|
161
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
162
|
+
| `request` | [operations.GetTaskCommentRequest](../../sdk/models/operations/gettaskcommentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
163
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
164
|
+
| `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. |
|
|
165
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
166
|
+
|
|
167
|
+
### Response
|
|
168
|
+
|
|
169
|
+
**Promise\<[shared.TaskComment](../../sdk/models/shared/taskcomment.md)\>**
|
|
170
|
+
|
|
171
|
+
### Errors
|
|
172
|
+
|
|
173
|
+
| Error Type | Status Code | Content Type |
|
|
174
|
+
| --------------- | --------------- | --------------- |
|
|
175
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
176
|
+
|
|
177
|
+
## listTaskComments
|
|
178
|
+
|
|
179
|
+
List all comments
|
|
180
|
+
|
|
181
|
+
### Example Usage
|
|
182
|
+
|
|
183
|
+
```typescript
|
|
184
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
185
|
+
|
|
186
|
+
const unifiedTo = new UnifiedTo({
|
|
187
|
+
security: {
|
|
188
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
189
|
+
},
|
|
190
|
+
});
|
|
191
|
+
|
|
192
|
+
async function run() {
|
|
193
|
+
const result = await unifiedTo.comment.listTaskComments({
|
|
194
|
+
connectionId: "<id>",
|
|
195
|
+
});
|
|
196
|
+
|
|
197
|
+
// Handle the result
|
|
198
|
+
console.log(result);
|
|
199
|
+
}
|
|
200
|
+
|
|
201
|
+
run();
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
### Standalone function
|
|
205
|
+
|
|
206
|
+
The standalone function version of this method:
|
|
207
|
+
|
|
208
|
+
```typescript
|
|
209
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
210
|
+
import { commentListTaskComments } from "@unified-api/typescript-sdk/funcs/commentListTaskComments.js";
|
|
211
|
+
|
|
212
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
213
|
+
// You can create one instance of it to use across an application.
|
|
214
|
+
const unifiedTo = new UnifiedToCore({
|
|
215
|
+
security: {
|
|
216
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
217
|
+
},
|
|
218
|
+
});
|
|
219
|
+
|
|
220
|
+
async function run() {
|
|
221
|
+
const res = await commentListTaskComments(unifiedTo, {
|
|
222
|
+
connectionId: "<id>",
|
|
223
|
+
});
|
|
224
|
+
|
|
225
|
+
if (!res.ok) {
|
|
226
|
+
throw res.error;
|
|
227
|
+
}
|
|
228
|
+
|
|
229
|
+
const { value: result } = res;
|
|
230
|
+
|
|
231
|
+
// Handle the result
|
|
232
|
+
console.log(result);
|
|
233
|
+
}
|
|
234
|
+
|
|
235
|
+
run();
|
|
236
|
+
```
|
|
237
|
+
|
|
238
|
+
### Parameters
|
|
239
|
+
|
|
240
|
+
| Parameter | Type | Required | Description |
|
|
241
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
242
|
+
| `request` | [operations.ListTaskCommentsRequest](../../sdk/models/operations/listtaskcommentsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
243
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
244
|
+
| `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. |
|
|
245
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
246
|
+
|
|
247
|
+
### Response
|
|
248
|
+
|
|
249
|
+
**Promise\<[shared.TaskComment[]](../../models/.md)\>**
|
|
250
|
+
|
|
251
|
+
### Errors
|
|
252
|
+
|
|
253
|
+
| Error Type | Status Code | Content Type |
|
|
254
|
+
| --------------- | --------------- | --------------- |
|
|
255
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
256
|
+
|
|
257
|
+
## patchTaskComment
|
|
258
|
+
|
|
259
|
+
Update a comment
|
|
260
|
+
|
|
261
|
+
### Example Usage
|
|
262
|
+
|
|
263
|
+
```typescript
|
|
264
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
265
|
+
|
|
266
|
+
const unifiedTo = new UnifiedTo({
|
|
267
|
+
security: {
|
|
268
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
269
|
+
},
|
|
270
|
+
});
|
|
271
|
+
|
|
272
|
+
async function run() {
|
|
273
|
+
const result = await unifiedTo.comment.patchTaskComment({
|
|
274
|
+
connectionId: "<id>",
|
|
275
|
+
id: "<id>",
|
|
276
|
+
});
|
|
277
|
+
|
|
278
|
+
// Handle the result
|
|
279
|
+
console.log(result);
|
|
280
|
+
}
|
|
281
|
+
|
|
282
|
+
run();
|
|
283
|
+
```
|
|
284
|
+
|
|
285
|
+
### Standalone function
|
|
286
|
+
|
|
287
|
+
The standalone function version of this method:
|
|
288
|
+
|
|
289
|
+
```typescript
|
|
290
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
291
|
+
import { commentPatchTaskComment } from "@unified-api/typescript-sdk/funcs/commentPatchTaskComment.js";
|
|
292
|
+
|
|
293
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
294
|
+
// You can create one instance of it to use across an application.
|
|
295
|
+
const unifiedTo = new UnifiedToCore({
|
|
296
|
+
security: {
|
|
297
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
298
|
+
},
|
|
299
|
+
});
|
|
300
|
+
|
|
301
|
+
async function run() {
|
|
302
|
+
const res = await commentPatchTaskComment(unifiedTo, {
|
|
303
|
+
connectionId: "<id>",
|
|
304
|
+
id: "<id>",
|
|
305
|
+
});
|
|
306
|
+
|
|
307
|
+
if (!res.ok) {
|
|
308
|
+
throw res.error;
|
|
309
|
+
}
|
|
310
|
+
|
|
311
|
+
const { value: result } = res;
|
|
312
|
+
|
|
313
|
+
// Handle the result
|
|
314
|
+
console.log(result);
|
|
315
|
+
}
|
|
316
|
+
|
|
317
|
+
run();
|
|
318
|
+
```
|
|
319
|
+
|
|
320
|
+
### Parameters
|
|
321
|
+
|
|
322
|
+
| Parameter | Type | Required | Description |
|
|
323
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
324
|
+
| `request` | [operations.PatchTaskCommentRequest](../../sdk/models/operations/patchtaskcommentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
325
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
326
|
+
| `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. |
|
|
327
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
328
|
+
|
|
329
|
+
### Response
|
|
330
|
+
|
|
331
|
+
**Promise\<[shared.TaskComment](../../sdk/models/shared/taskcomment.md)\>**
|
|
332
|
+
|
|
333
|
+
### Errors
|
|
334
|
+
|
|
335
|
+
| Error Type | Status Code | Content Type |
|
|
336
|
+
| --------------- | --------------- | --------------- |
|
|
337
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
338
|
+
|
|
339
|
+
## removeTaskComment
|
|
340
|
+
|
|
341
|
+
Remove a comment
|
|
342
|
+
|
|
343
|
+
### Example Usage
|
|
344
|
+
|
|
345
|
+
```typescript
|
|
346
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
347
|
+
|
|
348
|
+
const unifiedTo = new UnifiedTo({
|
|
349
|
+
security: {
|
|
350
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
351
|
+
},
|
|
352
|
+
});
|
|
353
|
+
|
|
354
|
+
async function run() {
|
|
355
|
+
const result = await unifiedTo.comment.removeTaskComment({
|
|
356
|
+
connectionId: "<id>",
|
|
357
|
+
id: "<id>",
|
|
358
|
+
});
|
|
359
|
+
|
|
360
|
+
// Handle the result
|
|
361
|
+
console.log(result);
|
|
362
|
+
}
|
|
363
|
+
|
|
364
|
+
run();
|
|
365
|
+
```
|
|
366
|
+
|
|
367
|
+
### Standalone function
|
|
368
|
+
|
|
369
|
+
The standalone function version of this method:
|
|
370
|
+
|
|
371
|
+
```typescript
|
|
372
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
373
|
+
import { commentRemoveTaskComment } from "@unified-api/typescript-sdk/funcs/commentRemoveTaskComment.js";
|
|
374
|
+
|
|
375
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
376
|
+
// You can create one instance of it to use across an application.
|
|
377
|
+
const unifiedTo = new UnifiedToCore({
|
|
378
|
+
security: {
|
|
379
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
380
|
+
},
|
|
381
|
+
});
|
|
382
|
+
|
|
383
|
+
async function run() {
|
|
384
|
+
const res = await commentRemoveTaskComment(unifiedTo, {
|
|
385
|
+
connectionId: "<id>",
|
|
386
|
+
id: "<id>",
|
|
387
|
+
});
|
|
388
|
+
|
|
389
|
+
if (!res.ok) {
|
|
390
|
+
throw res.error;
|
|
391
|
+
}
|
|
392
|
+
|
|
393
|
+
const { value: result } = res;
|
|
394
|
+
|
|
395
|
+
// Handle the result
|
|
396
|
+
console.log(result);
|
|
397
|
+
}
|
|
398
|
+
|
|
399
|
+
run();
|
|
400
|
+
```
|
|
401
|
+
|
|
402
|
+
### Parameters
|
|
403
|
+
|
|
404
|
+
| Parameter | Type | Required | Description |
|
|
405
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
406
|
+
| `request` | [operations.RemoveTaskCommentRequest](../../sdk/models/operations/removetaskcommentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
407
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
408
|
+
| `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. |
|
|
409
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
410
|
+
|
|
411
|
+
### Response
|
|
412
|
+
|
|
413
|
+
**Promise\<[operations.RemoveTaskCommentResponse](../../sdk/models/operations/removetaskcommentresponse.md)\>**
|
|
414
|
+
|
|
415
|
+
### Errors
|
|
416
|
+
|
|
417
|
+
| Error Type | Status Code | Content Type |
|
|
418
|
+
| --------------- | --------------- | --------------- |
|
|
419
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
420
|
+
|
|
421
|
+
## updateTaskComment
|
|
422
|
+
|
|
423
|
+
Update a comment
|
|
424
|
+
|
|
425
|
+
### Example Usage
|
|
426
|
+
|
|
427
|
+
```typescript
|
|
428
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
429
|
+
|
|
430
|
+
const unifiedTo = new UnifiedTo({
|
|
431
|
+
security: {
|
|
432
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
433
|
+
},
|
|
434
|
+
});
|
|
435
|
+
|
|
436
|
+
async function run() {
|
|
437
|
+
const result = await unifiedTo.comment.updateTaskComment({
|
|
438
|
+
connectionId: "<id>",
|
|
439
|
+
id: "<id>",
|
|
440
|
+
});
|
|
441
|
+
|
|
442
|
+
// Handle the result
|
|
443
|
+
console.log(result);
|
|
444
|
+
}
|
|
445
|
+
|
|
446
|
+
run();
|
|
447
|
+
```
|
|
448
|
+
|
|
449
|
+
### Standalone function
|
|
450
|
+
|
|
451
|
+
The standalone function version of this method:
|
|
452
|
+
|
|
453
|
+
```typescript
|
|
454
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
455
|
+
import { commentUpdateTaskComment } from "@unified-api/typescript-sdk/funcs/commentUpdateTaskComment.js";
|
|
456
|
+
|
|
457
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
458
|
+
// You can create one instance of it to use across an application.
|
|
459
|
+
const unifiedTo = new UnifiedToCore({
|
|
460
|
+
security: {
|
|
461
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
462
|
+
},
|
|
463
|
+
});
|
|
464
|
+
|
|
465
|
+
async function run() {
|
|
466
|
+
const res = await commentUpdateTaskComment(unifiedTo, {
|
|
467
|
+
connectionId: "<id>",
|
|
468
|
+
id: "<id>",
|
|
469
|
+
});
|
|
470
|
+
|
|
471
|
+
if (!res.ok) {
|
|
472
|
+
throw res.error;
|
|
473
|
+
}
|
|
474
|
+
|
|
475
|
+
const { value: result } = res;
|
|
476
|
+
|
|
477
|
+
// Handle the result
|
|
478
|
+
console.log(result);
|
|
479
|
+
}
|
|
480
|
+
|
|
481
|
+
run();
|
|
482
|
+
```
|
|
483
|
+
|
|
484
|
+
### Parameters
|
|
485
|
+
|
|
486
|
+
| Parameter | Type | Required | Description |
|
|
487
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
488
|
+
| `request` | [operations.UpdateTaskCommentRequest](../../sdk/models/operations/updatetaskcommentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
489
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
490
|
+
| `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. |
|
|
491
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
492
|
+
|
|
493
|
+
### Response
|
|
494
|
+
|
|
495
|
+
**Promise\<[shared.TaskComment](../../sdk/models/shared/taskcomment.md)\>**
|
|
496
|
+
|
|
497
|
+
### Errors
|
|
498
|
+
|
|
499
|
+
| Error Type | Status Code | Content Type |
|
|
500
|
+
| --------------- | --------------- | --------------- |
|
|
501
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|