@thera-hr/api-sdk 0.0.1-prerelease2950-dev → 0.0.1-prerelease2953-production
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/api/resources/api/resources/aiprise/resources/aipriseWebhookApi/client/Client.js +1 -1
- package/api/resources/api/resources/dev/resources/dev/client/Client.js +1 -1
- package/api/resources/api/resources/external/resources/externalApi/client/Client.js +1 -1
- package/api/resources/api/resources/services/resources/file/client/Client.js +5 -5
- package/api/resources/api/resources/thera/resources/accounting/resources/accountingApi/client/Client.js +4 -4
- package/api/resources/api/resources/thera/resources/bank/resources/bankApi/client/Client.js +33 -33
- package/api/resources/api/resources/thera/resources/bridge/resources/bridgeApi/client/Client.js +24 -24
- package/api/resources/api/resources/thera/resources/company/resources/companyApi/client/Client.js +18 -18
- package/api/resources/api/resources/thera/resources/company/resources/companyW2PayrollApi/client/Client.js +3 -3
- package/api/resources/api/resources/thera/resources/contractor/resources/contractorApi/client/Client.js +3 -3
- package/api/resources/api/resources/thera/resources/disbursement/resources/disbursementApi/client/Client.js +7 -7
- package/api/resources/api/resources/thera/resources/disbursement/resources/disbursementWebhookApi/client/Client.js +1 -1
- package/api/resources/api/resources/thera/resources/document/resources/documentApi/client/Client.js +3 -3
- package/api/resources/api/resources/thera/resources/email/resources/emailApi/client/Client.js +2 -2
- package/api/resources/api/resources/thera/resources/employment/resources/employmentApi/client/Client.js +5 -5
- package/api/resources/api/resources/thera/resources/eor/resources/eorTrackerApi/client/Client.js +3 -3
- package/api/resources/api/resources/thera/resources/misc/resources/misc/client/Client.js +7 -7
- package/api/resources/api/resources/thera/resources/payroll/resources/offcycleApi/client/Client.js +1 -1
- package/api/resources/api/resources/thera/resources/payroll/resources/oncycleApi/client/Client.js +3 -3
- package/api/resources/api/resources/thera/resources/timeoff/resources/timeoffApi/client/Client.js +14 -14
- package/api/resources/api/resources/thera/resources/timetracking/resources/timetrackingApi/client/Client.js +9 -9
- package/api/resources/api/resources/thera/resources/tp/resources/tpApi/client/Client.js +11 -11
- package/api/resources/api/resources/thera/resources/user/resources/userApi/client/Client.js +3 -3
- package/dist/api/resources/api/resources/aiprise/resources/aipriseWebhookApi/client/Client.js +1 -1
- package/dist/api/resources/api/resources/dev/resources/dev/client/Client.js +1 -1
- package/dist/api/resources/api/resources/external/resources/externalApi/client/Client.js +1 -1
- package/dist/api/resources/api/resources/services/resources/file/client/Client.js +5 -5
- package/dist/api/resources/api/resources/thera/resources/accounting/resources/accountingApi/client/Client.js +4 -4
- package/dist/api/resources/api/resources/thera/resources/bank/resources/bankApi/client/Client.js +33 -33
- package/dist/api/resources/api/resources/thera/resources/bridge/resources/bridgeApi/client/Client.js +24 -24
- package/dist/api/resources/api/resources/thera/resources/company/resources/companyApi/client/Client.js +18 -18
- package/dist/api/resources/api/resources/thera/resources/company/resources/companyW2PayrollApi/client/Client.js +3 -3
- package/dist/api/resources/api/resources/thera/resources/contractor/resources/contractorApi/client/Client.js +3 -3
- package/dist/api/resources/api/resources/thera/resources/disbursement/resources/disbursementApi/client/Client.js +7 -7
- package/dist/api/resources/api/resources/thera/resources/disbursement/resources/disbursementWebhookApi/client/Client.js +1 -1
- package/dist/api/resources/api/resources/thera/resources/document/resources/documentApi/client/Client.js +3 -3
- package/dist/api/resources/api/resources/thera/resources/email/resources/emailApi/client/Client.js +2 -2
- package/dist/api/resources/api/resources/thera/resources/employment/resources/employmentApi/client/Client.js +5 -5
- package/dist/api/resources/api/resources/thera/resources/eor/resources/eorTrackerApi/client/Client.js +3 -3
- package/dist/api/resources/api/resources/thera/resources/misc/resources/misc/client/Client.js +7 -7
- package/dist/api/resources/api/resources/thera/resources/payroll/resources/offcycleApi/client/Client.js +1 -1
- package/dist/api/resources/api/resources/thera/resources/payroll/resources/oncycleApi/client/Client.js +3 -3
- package/dist/api/resources/api/resources/thera/resources/timeoff/resources/timeoffApi/client/Client.js +14 -14
- package/dist/api/resources/api/resources/thera/resources/timetracking/resources/timetrackingApi/client/Client.js +9 -9
- package/dist/api/resources/api/resources/thera/resources/tp/resources/tpApi/client/Client.js +11 -11
- package/dist/api/resources/api/resources/thera/resources/user/resources/userApi/client/Client.js +3 -3
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
- package/reference.md +0 -3034
- package/version.d.ts +1 -1
- package/version.js +1 -1
package/reference.md
CHANGED
|
@@ -8544,3037 +8544,3 @@ await client.api.thera.payroll.oncycleApi.getOnCycleChecks("string");
|
|
|
8544
8544
|
|
|
8545
8545
|
</dd>
|
|
8546
8546
|
</dl>
|
|
8547
|
-
</details>
|
|
8548
|
-
|
|
8549
|
-
<details><summary><code>client.api.thera.payroll.oncycleApi.<a href="/src/api/resources/api/resources/thera/resources/payroll/resources/oncycleApi/client/Client.ts">cancelCurrentAutopilotPayroll</a>(companyId) -> void</code></summary>
|
|
8550
|
-
<dl>
|
|
8551
|
-
<dd>
|
|
8552
|
-
|
|
8553
|
-
#### 📝 Description
|
|
8554
|
-
|
|
8555
|
-
<dl>
|
|
8556
|
-
<dd>
|
|
8557
|
-
|
|
8558
|
-
<dl>
|
|
8559
|
-
<dd>
|
|
8560
|
-
|
|
8561
|
-
</dd>
|
|
8562
|
-
</dl>
|
|
8563
|
-
</dd>
|
|
8564
|
-
</dl>
|
|
8565
|
-
|
|
8566
|
-
#### 🔌 Usage
|
|
8567
|
-
|
|
8568
|
-
<dl>
|
|
8569
|
-
<dd>
|
|
8570
|
-
|
|
8571
|
-
<dl>
|
|
8572
|
-
<dd>
|
|
8573
|
-
|
|
8574
|
-
```typescript
|
|
8575
|
-
await client.api.thera.payroll.oncycleApi.cancelCurrentAutopilotPayroll("string");
|
|
8576
|
-
```
|
|
8577
|
-
|
|
8578
|
-
</dd>
|
|
8579
|
-
</dl>
|
|
8580
|
-
</dd>
|
|
8581
|
-
</dl>
|
|
8582
|
-
|
|
8583
|
-
#### ⚙️ Parameters
|
|
8584
|
-
|
|
8585
|
-
<dl>
|
|
8586
|
-
<dd>
|
|
8587
|
-
|
|
8588
|
-
<dl>
|
|
8589
|
-
<dd>
|
|
8590
|
-
|
|
8591
|
-
**companyId:** `string`
|
|
8592
|
-
|
|
8593
|
-
</dd>
|
|
8594
|
-
</dl>
|
|
8595
|
-
|
|
8596
|
-
<dl>
|
|
8597
|
-
<dd>
|
|
8598
|
-
|
|
8599
|
-
**requestOptions:** `OncycleApi.RequestOptions`
|
|
8600
|
-
|
|
8601
|
-
</dd>
|
|
8602
|
-
</dl>
|
|
8603
|
-
</dd>
|
|
8604
|
-
</dl>
|
|
8605
|
-
|
|
8606
|
-
</dd>
|
|
8607
|
-
</dl>
|
|
8608
|
-
</details>
|
|
8609
|
-
|
|
8610
|
-
## Time Off Management
|
|
8611
|
-
|
|
8612
|
-
<details><summary><code>client.api.thera.timeoff.timeoffApi.<a href="/src/api/resources/api/resources/thera/resources/timeoff/resources/timeoffApi/client/Client.ts">calculatePtoDeduction</a>(companyId, { ...params }) -> TheraApi.SuggestedDeductionResponse</code></summary>
|
|
8613
|
-
<dl>
|
|
8614
|
-
<dd>
|
|
8615
|
-
|
|
8616
|
-
#### 📝 Description
|
|
8617
|
-
|
|
8618
|
-
<dl>
|
|
8619
|
-
<dd>
|
|
8620
|
-
|
|
8621
|
-
<dl>
|
|
8622
|
-
<dd>
|
|
8623
|
-
|
|
8624
|
-
Calculates suggested deduction amount for PTO exceeding accrual limits for Fixed Rate contacts
|
|
8625
|
-
|
|
8626
|
-
</dd>
|
|
8627
|
-
</dl>
|
|
8628
|
-
</dd>
|
|
8629
|
-
</dl>
|
|
8630
|
-
|
|
8631
|
-
#### 🔌 Usage
|
|
8632
|
-
|
|
8633
|
-
<dl>
|
|
8634
|
-
<dd>
|
|
8635
|
-
|
|
8636
|
-
<dl>
|
|
8637
|
-
<dd>
|
|
8638
|
-
|
|
8639
|
-
```typescript
|
|
8640
|
-
await client.api.thera.timeoff.timeoffApi.calculatePtoDeduction("string", {
|
|
8641
|
-
invoiceId: "string",
|
|
8642
|
-
timeOffRequestId: "string",
|
|
8643
|
-
});
|
|
8644
|
-
```
|
|
8645
|
-
|
|
8646
|
-
</dd>
|
|
8647
|
-
</dl>
|
|
8648
|
-
</dd>
|
|
8649
|
-
</dl>
|
|
8650
|
-
|
|
8651
|
-
#### ⚙️ Parameters
|
|
8652
|
-
|
|
8653
|
-
<dl>
|
|
8654
|
-
<dd>
|
|
8655
|
-
|
|
8656
|
-
<dl>
|
|
8657
|
-
<dd>
|
|
8658
|
-
|
|
8659
|
-
**companyId:** `string`
|
|
8660
|
-
|
|
8661
|
-
</dd>
|
|
8662
|
-
</dl>
|
|
8663
|
-
|
|
8664
|
-
<dl>
|
|
8665
|
-
<dd>
|
|
8666
|
-
|
|
8667
|
-
**request:** `TheraApi.api.thera.timeoff.CalculatePtoDeductionRequest`
|
|
8668
|
-
|
|
8669
|
-
</dd>
|
|
8670
|
-
</dl>
|
|
8671
|
-
|
|
8672
|
-
<dl>
|
|
8673
|
-
<dd>
|
|
8674
|
-
|
|
8675
|
-
**requestOptions:** `TimeoffApi.RequestOptions`
|
|
8676
|
-
|
|
8677
|
-
</dd>
|
|
8678
|
-
</dl>
|
|
8679
|
-
</dd>
|
|
8680
|
-
</dl>
|
|
8681
|
-
|
|
8682
|
-
</dd>
|
|
8683
|
-
</dl>
|
|
8684
|
-
</details>
|
|
8685
|
-
|
|
8686
|
-
<details><summary><code>client.api.thera.timeoff.timeoffApi.<a href="/src/api/resources/api/resources/thera/resources/timeoff/resources/timeoffApi/client/Client.ts">associateTimeOffPolicyToContractor</a>(companyId, policyId, { ...params }) -> void</code></summary>
|
|
8687
|
-
<dl>
|
|
8688
|
-
<dd>
|
|
8689
|
-
|
|
8690
|
-
#### 📝 Description
|
|
8691
|
-
|
|
8692
|
-
<dl>
|
|
8693
|
-
<dd>
|
|
8694
|
-
|
|
8695
|
-
<dl>
|
|
8696
|
-
<dd>
|
|
8697
|
-
|
|
8698
|
-
Submit a list of complete contractors to be associated to the policy. Contractors not in the request are then automatically removed from the policy.
|
|
8699
|
-
|
|
8700
|
-
</dd>
|
|
8701
|
-
</dl>
|
|
8702
|
-
</dd>
|
|
8703
|
-
</dl>
|
|
8704
|
-
|
|
8705
|
-
#### 🔌 Usage
|
|
8706
|
-
|
|
8707
|
-
<dl>
|
|
8708
|
-
<dd>
|
|
8709
|
-
|
|
8710
|
-
<dl>
|
|
8711
|
-
<dd>
|
|
8712
|
-
|
|
8713
|
-
```typescript
|
|
8714
|
-
await client.api.thera.timeoff.timeoffApi.associateTimeOffPolicyToContractor("string", "string", {
|
|
8715
|
-
contractIds: ["string"],
|
|
8716
|
-
});
|
|
8717
|
-
```
|
|
8718
|
-
|
|
8719
|
-
</dd>
|
|
8720
|
-
</dl>
|
|
8721
|
-
</dd>
|
|
8722
|
-
</dl>
|
|
8723
|
-
|
|
8724
|
-
#### ⚙️ Parameters
|
|
8725
|
-
|
|
8726
|
-
<dl>
|
|
8727
|
-
<dd>
|
|
8728
|
-
|
|
8729
|
-
<dl>
|
|
8730
|
-
<dd>
|
|
8731
|
-
|
|
8732
|
-
**companyId:** `string`
|
|
8733
|
-
|
|
8734
|
-
</dd>
|
|
8735
|
-
</dl>
|
|
8736
|
-
|
|
8737
|
-
<dl>
|
|
8738
|
-
<dd>
|
|
8739
|
-
|
|
8740
|
-
**policyId:** `string`
|
|
8741
|
-
|
|
8742
|
-
</dd>
|
|
8743
|
-
</dl>
|
|
8744
|
-
|
|
8745
|
-
<dl>
|
|
8746
|
-
<dd>
|
|
8747
|
-
|
|
8748
|
-
**request:** `TheraApi.AssociateTimeOffPoliciesToContractorRequest`
|
|
8749
|
-
|
|
8750
|
-
</dd>
|
|
8751
|
-
</dl>
|
|
8752
|
-
|
|
8753
|
-
<dl>
|
|
8754
|
-
<dd>
|
|
8755
|
-
|
|
8756
|
-
**requestOptions:** `TimeoffApi.RequestOptions`
|
|
8757
|
-
|
|
8758
|
-
</dd>
|
|
8759
|
-
</dl>
|
|
8760
|
-
</dd>
|
|
8761
|
-
</dl>
|
|
8762
|
-
|
|
8763
|
-
</dd>
|
|
8764
|
-
</dl>
|
|
8765
|
-
</details>
|
|
8766
|
-
|
|
8767
|
-
<details><summary><code>client.api.thera.timeoff.timeoffApi.<a href="/src/api/resources/api/resources/thera/resources/timeoff/resources/timeoffApi/client/Client.ts">requestPtoForContractor</a>(companyId, policyId, { ...params }) -> void</code></summary>
|
|
8768
|
-
<dl>
|
|
8769
|
-
<dd>
|
|
8770
|
-
|
|
8771
|
-
#### 📝 Description
|
|
8772
|
-
|
|
8773
|
-
<dl>
|
|
8774
|
-
<dd>
|
|
8775
|
-
|
|
8776
|
-
<dl>
|
|
8777
|
-
<dd>
|
|
8778
|
-
|
|
8779
|
-
</dd>
|
|
8780
|
-
</dl>
|
|
8781
|
-
</dd>
|
|
8782
|
-
</dl>
|
|
8783
|
-
|
|
8784
|
-
#### 🔌 Usage
|
|
8785
|
-
|
|
8786
|
-
<dl>
|
|
8787
|
-
<dd>
|
|
8788
|
-
|
|
8789
|
-
<dl>
|
|
8790
|
-
<dd>
|
|
8791
|
-
|
|
8792
|
-
```typescript
|
|
8793
|
-
await client.api.thera.timeoff.timeoffApi.requestPtoForContractor("string", "string", {
|
|
8794
|
-
contractId: "string",
|
|
8795
|
-
ptoRequest: {
|
|
8796
|
-
description: "string",
|
|
8797
|
-
dates: {
|
|
8798
|
-
"2023-01-15": {
|
|
8799
|
-
timeOffLength: "FULL_DAY",
|
|
8800
|
-
},
|
|
8801
|
-
},
|
|
8802
|
-
attachmentFileId: "string",
|
|
8803
|
-
},
|
|
8804
|
-
});
|
|
8805
|
-
```
|
|
8806
|
-
|
|
8807
|
-
</dd>
|
|
8808
|
-
</dl>
|
|
8809
|
-
</dd>
|
|
8810
|
-
</dl>
|
|
8811
|
-
|
|
8812
|
-
#### ⚙️ Parameters
|
|
8813
|
-
|
|
8814
|
-
<dl>
|
|
8815
|
-
<dd>
|
|
8816
|
-
|
|
8817
|
-
<dl>
|
|
8818
|
-
<dd>
|
|
8819
|
-
|
|
8820
|
-
**companyId:** `string`
|
|
8821
|
-
|
|
8822
|
-
</dd>
|
|
8823
|
-
</dl>
|
|
8824
|
-
|
|
8825
|
-
<dl>
|
|
8826
|
-
<dd>
|
|
8827
|
-
|
|
8828
|
-
**policyId:** `string`
|
|
8829
|
-
|
|
8830
|
-
</dd>
|
|
8831
|
-
</dl>
|
|
8832
|
-
|
|
8833
|
-
<dl>
|
|
8834
|
-
<dd>
|
|
8835
|
-
|
|
8836
|
-
**request:** `TheraApi.CreatePtoForContractorRequest`
|
|
8837
|
-
|
|
8838
|
-
</dd>
|
|
8839
|
-
</dl>
|
|
8840
|
-
|
|
8841
|
-
<dl>
|
|
8842
|
-
<dd>
|
|
8843
|
-
|
|
8844
|
-
**requestOptions:** `TimeoffApi.RequestOptions`
|
|
8845
|
-
|
|
8846
|
-
</dd>
|
|
8847
|
-
</dl>
|
|
8848
|
-
</dd>
|
|
8849
|
-
</dl>
|
|
8850
|
-
|
|
8851
|
-
</dd>
|
|
8852
|
-
</dl>
|
|
8853
|
-
</details>
|
|
8854
|
-
|
|
8855
|
-
<details><summary><code>client.api.thera.timeoff.timeoffApi.<a href="/src/api/resources/api/resources/thera/resources/timeoff/resources/timeoffApi/client/Client.ts">addTimeOffPolicy</a>(companyId, { ...params }) -> unknown</code></summary>
|
|
8856
|
-
<dl>
|
|
8857
|
-
<dd>
|
|
8858
|
-
|
|
8859
|
-
#### 📝 Description
|
|
8860
|
-
|
|
8861
|
-
<dl>
|
|
8862
|
-
<dd>
|
|
8863
|
-
|
|
8864
|
-
<dl>
|
|
8865
|
-
<dd>
|
|
8866
|
-
|
|
8867
|
-
Adds a timeoff policy to company
|
|
8868
|
-
|
|
8869
|
-
</dd>
|
|
8870
|
-
</dl>
|
|
8871
|
-
</dd>
|
|
8872
|
-
</dl>
|
|
8873
|
-
|
|
8874
|
-
#### 🔌 Usage
|
|
8875
|
-
|
|
8876
|
-
<dl>
|
|
8877
|
-
<dd>
|
|
8878
|
-
|
|
8879
|
-
<dl>
|
|
8880
|
-
<dd>
|
|
8881
|
-
|
|
8882
|
-
```typescript
|
|
8883
|
-
await client.api.thera.timeoff.timeoffApi.addTimeOffPolicy("string", {
|
|
8884
|
-
policyName: "string",
|
|
8885
|
-
allowanceType: {
|
|
8886
|
-
type: "limitedAllowance",
|
|
8887
|
-
},
|
|
8888
|
-
midYearJoiningAllowance: "FULL_AMOUNT",
|
|
8889
|
-
payType: "UNPAID",
|
|
8890
|
-
leaveType: "string",
|
|
8891
|
-
isDefaultPolicy: true,
|
|
8892
|
-
contractIds: new Set(["string"]),
|
|
8893
|
-
accrualType: {
|
|
8894
|
-
["EMPLOYEE"]: "MONTHLY",
|
|
8895
|
-
},
|
|
8896
|
-
autoDeductEnabled: {
|
|
8897
|
-
["EMPLOYEE"]: true,
|
|
8898
|
-
},
|
|
8899
|
-
addPolicyFor: new Set(["EMPLOYEE"]),
|
|
8900
|
-
});
|
|
8901
|
-
```
|
|
8902
|
-
|
|
8903
|
-
</dd>
|
|
8904
|
-
</dl>
|
|
8905
|
-
</dd>
|
|
8906
|
-
</dl>
|
|
8907
|
-
|
|
8908
|
-
#### ⚙️ Parameters
|
|
8909
|
-
|
|
8910
|
-
<dl>
|
|
8911
|
-
<dd>
|
|
8912
|
-
|
|
8913
|
-
<dl>
|
|
8914
|
-
<dd>
|
|
8915
|
-
|
|
8916
|
-
**companyId:** `string`
|
|
8917
|
-
|
|
8918
|
-
</dd>
|
|
8919
|
-
</dl>
|
|
8920
|
-
|
|
8921
|
-
<dl>
|
|
8922
|
-
<dd>
|
|
8923
|
-
|
|
8924
|
-
**request:** `TheraApi.AddTimeOffPolicyRequest`
|
|
8925
|
-
|
|
8926
|
-
</dd>
|
|
8927
|
-
</dl>
|
|
8928
|
-
|
|
8929
|
-
<dl>
|
|
8930
|
-
<dd>
|
|
8931
|
-
|
|
8932
|
-
**requestOptions:** `TimeoffApi.RequestOptions`
|
|
8933
|
-
|
|
8934
|
-
</dd>
|
|
8935
|
-
</dl>
|
|
8936
|
-
</dd>
|
|
8937
|
-
</dl>
|
|
8938
|
-
|
|
8939
|
-
</dd>
|
|
8940
|
-
</dl>
|
|
8941
|
-
</details>
|
|
8942
|
-
|
|
8943
|
-
<details><summary><code>client.api.thera.timeoff.timeoffApi.<a href="/src/api/resources/api/resources/thera/resources/timeoff/resources/timeoffApi/client/Client.ts">getTimeOffPolicy</a>(companyId, policyId) -> TheraApi.TimeOffPolicy</code></summary>
|
|
8944
|
-
<dl>
|
|
8945
|
-
<dd>
|
|
8946
|
-
|
|
8947
|
-
#### 📝 Description
|
|
8948
|
-
|
|
8949
|
-
<dl>
|
|
8950
|
-
<dd>
|
|
8951
|
-
|
|
8952
|
-
<dl>
|
|
8953
|
-
<dd>
|
|
8954
|
-
|
|
8955
|
-
Gets a timeoff policy from company
|
|
8956
|
-
|
|
8957
|
-
</dd>
|
|
8958
|
-
</dl>
|
|
8959
|
-
</dd>
|
|
8960
|
-
</dl>
|
|
8961
|
-
|
|
8962
|
-
#### 🔌 Usage
|
|
8963
|
-
|
|
8964
|
-
<dl>
|
|
8965
|
-
<dd>
|
|
8966
|
-
|
|
8967
|
-
<dl>
|
|
8968
|
-
<dd>
|
|
8969
|
-
|
|
8970
|
-
```typescript
|
|
8971
|
-
await client.api.thera.timeoff.timeoffApi.getTimeOffPolicy("string", "string");
|
|
8972
|
-
```
|
|
8973
|
-
|
|
8974
|
-
</dd>
|
|
8975
|
-
</dl>
|
|
8976
|
-
</dd>
|
|
8977
|
-
</dl>
|
|
8978
|
-
|
|
8979
|
-
#### ⚙️ Parameters
|
|
8980
|
-
|
|
8981
|
-
<dl>
|
|
8982
|
-
<dd>
|
|
8983
|
-
|
|
8984
|
-
<dl>
|
|
8985
|
-
<dd>
|
|
8986
|
-
|
|
8987
|
-
**companyId:** `string`
|
|
8988
|
-
|
|
8989
|
-
</dd>
|
|
8990
|
-
</dl>
|
|
8991
|
-
|
|
8992
|
-
<dl>
|
|
8993
|
-
<dd>
|
|
8994
|
-
|
|
8995
|
-
**policyId:** `string`
|
|
8996
|
-
|
|
8997
|
-
</dd>
|
|
8998
|
-
</dl>
|
|
8999
|
-
|
|
9000
|
-
<dl>
|
|
9001
|
-
<dd>
|
|
9002
|
-
|
|
9003
|
-
**requestOptions:** `TimeoffApi.RequestOptions`
|
|
9004
|
-
|
|
9005
|
-
</dd>
|
|
9006
|
-
</dl>
|
|
9007
|
-
</dd>
|
|
9008
|
-
</dl>
|
|
9009
|
-
|
|
9010
|
-
</dd>
|
|
9011
|
-
</dl>
|
|
9012
|
-
</details>
|
|
9013
|
-
|
|
9014
|
-
<details><summary><code>client.api.thera.timeoff.timeoffApi.<a href="/src/api/resources/api/resources/thera/resources/timeoff/resources/timeoffApi/client/Client.ts">updateTimeOffPolicy</a>(companyId, policyId, { ...params }) -> unknown</code></summary>
|
|
9015
|
-
<dl>
|
|
9016
|
-
<dd>
|
|
9017
|
-
|
|
9018
|
-
#### 📝 Description
|
|
9019
|
-
|
|
9020
|
-
<dl>
|
|
9021
|
-
<dd>
|
|
9022
|
-
|
|
9023
|
-
<dl>
|
|
9024
|
-
<dd>
|
|
9025
|
-
|
|
9026
|
-
Modifys a timeoff policy to company
|
|
9027
|
-
|
|
9028
|
-
</dd>
|
|
9029
|
-
</dl>
|
|
9030
|
-
</dd>
|
|
9031
|
-
</dl>
|
|
9032
|
-
|
|
9033
|
-
#### 🔌 Usage
|
|
9034
|
-
|
|
9035
|
-
<dl>
|
|
9036
|
-
<dd>
|
|
9037
|
-
|
|
9038
|
-
<dl>
|
|
9039
|
-
<dd>
|
|
9040
|
-
|
|
9041
|
-
```typescript
|
|
9042
|
-
await client.api.thera.timeoff.timeoffApi.updateTimeOffPolicy("string", "string", {
|
|
9043
|
-
policyName: "string",
|
|
9044
|
-
allowanceType: {
|
|
9045
|
-
type: "limitedAllowance",
|
|
9046
|
-
},
|
|
9047
|
-
midYearJoiningAllowance: "FULL_AMOUNT",
|
|
9048
|
-
payType: "UNPAID",
|
|
9049
|
-
leaveType: "string",
|
|
9050
|
-
isDefaultPolicy: true,
|
|
9051
|
-
contractIds: new Set(["string"]),
|
|
9052
|
-
accrualType: {
|
|
9053
|
-
["EMPLOYEE"]: "MONTHLY",
|
|
9054
|
-
},
|
|
9055
|
-
autoDeductEnabled: {
|
|
9056
|
-
["EMPLOYEE"]: true,
|
|
9057
|
-
},
|
|
9058
|
-
addPolicyFor: new Set(["EMPLOYEE"]),
|
|
9059
|
-
});
|
|
9060
|
-
```
|
|
9061
|
-
|
|
9062
|
-
</dd>
|
|
9063
|
-
</dl>
|
|
9064
|
-
</dd>
|
|
9065
|
-
</dl>
|
|
9066
|
-
|
|
9067
|
-
#### ⚙️ Parameters
|
|
9068
|
-
|
|
9069
|
-
<dl>
|
|
9070
|
-
<dd>
|
|
9071
|
-
|
|
9072
|
-
<dl>
|
|
9073
|
-
<dd>
|
|
9074
|
-
|
|
9075
|
-
**companyId:** `string`
|
|
9076
|
-
|
|
9077
|
-
</dd>
|
|
9078
|
-
</dl>
|
|
9079
|
-
|
|
9080
|
-
<dl>
|
|
9081
|
-
<dd>
|
|
9082
|
-
|
|
9083
|
-
**policyId:** `string`
|
|
9084
|
-
|
|
9085
|
-
</dd>
|
|
9086
|
-
</dl>
|
|
9087
|
-
|
|
9088
|
-
<dl>
|
|
9089
|
-
<dd>
|
|
9090
|
-
|
|
9091
|
-
**request:** `TheraApi.UpdateTimeOffPolicyRequest`
|
|
9092
|
-
|
|
9093
|
-
</dd>
|
|
9094
|
-
</dl>
|
|
9095
|
-
|
|
9096
|
-
<dl>
|
|
9097
|
-
<dd>
|
|
9098
|
-
|
|
9099
|
-
**requestOptions:** `TimeoffApi.RequestOptions`
|
|
9100
|
-
|
|
9101
|
-
</dd>
|
|
9102
|
-
</dl>
|
|
9103
|
-
</dd>
|
|
9104
|
-
</dl>
|
|
9105
|
-
|
|
9106
|
-
</dd>
|
|
9107
|
-
</dl>
|
|
9108
|
-
</details>
|
|
9109
|
-
|
|
9110
|
-
<details><summary><code>client.api.thera.timeoff.timeoffApi.<a href="/src/api/resources/api/resources/thera/resources/timeoff/resources/timeoffApi/client/Client.ts">deleteTimeOffPolicy</a>(companyId, policyId) -> unknown</code></summary>
|
|
9111
|
-
<dl>
|
|
9112
|
-
<dd>
|
|
9113
|
-
|
|
9114
|
-
#### 📝 Description
|
|
9115
|
-
|
|
9116
|
-
<dl>
|
|
9117
|
-
<dd>
|
|
9118
|
-
|
|
9119
|
-
<dl>
|
|
9120
|
-
<dd>
|
|
9121
|
-
|
|
9122
|
-
Deletes a timeoff policy from company
|
|
9123
|
-
|
|
9124
|
-
</dd>
|
|
9125
|
-
</dl>
|
|
9126
|
-
</dd>
|
|
9127
|
-
</dl>
|
|
9128
|
-
|
|
9129
|
-
#### 🔌 Usage
|
|
9130
|
-
|
|
9131
|
-
<dl>
|
|
9132
|
-
<dd>
|
|
9133
|
-
|
|
9134
|
-
<dl>
|
|
9135
|
-
<dd>
|
|
9136
|
-
|
|
9137
|
-
```typescript
|
|
9138
|
-
await client.api.thera.timeoff.timeoffApi.deleteTimeOffPolicy("string", "string");
|
|
9139
|
-
```
|
|
9140
|
-
|
|
9141
|
-
</dd>
|
|
9142
|
-
</dl>
|
|
9143
|
-
</dd>
|
|
9144
|
-
</dl>
|
|
9145
|
-
|
|
9146
|
-
#### ⚙️ Parameters
|
|
9147
|
-
|
|
9148
|
-
<dl>
|
|
9149
|
-
<dd>
|
|
9150
|
-
|
|
9151
|
-
<dl>
|
|
9152
|
-
<dd>
|
|
9153
|
-
|
|
9154
|
-
**companyId:** `string`
|
|
9155
|
-
|
|
9156
|
-
</dd>
|
|
9157
|
-
</dl>
|
|
9158
|
-
|
|
9159
|
-
<dl>
|
|
9160
|
-
<dd>
|
|
9161
|
-
|
|
9162
|
-
**policyId:** `string`
|
|
9163
|
-
|
|
9164
|
-
</dd>
|
|
9165
|
-
</dl>
|
|
9166
|
-
|
|
9167
|
-
<dl>
|
|
9168
|
-
<dd>
|
|
9169
|
-
|
|
9170
|
-
**requestOptions:** `TimeoffApi.RequestOptions`
|
|
9171
|
-
|
|
9172
|
-
</dd>
|
|
9173
|
-
</dl>
|
|
9174
|
-
</dd>
|
|
9175
|
-
</dl>
|
|
9176
|
-
|
|
9177
|
-
</dd>
|
|
9178
|
-
</dl>
|
|
9179
|
-
</details>
|
|
9180
|
-
|
|
9181
|
-
<details><summary><code>client.api.thera.timeoff.timeoffApi.<a href="/src/api/resources/api/resources/thera/resources/timeoff/resources/timeoffApi/client/Client.ts">getContractorsTimeOffHistoryByCompany</a>(companyId, { ...params }) -> TheraApi.GetContractorsTimeOffsByCompany</code></summary>
|
|
9182
|
-
<dl>
|
|
9183
|
-
<dd>
|
|
9184
|
-
|
|
9185
|
-
#### 📝 Description
|
|
9186
|
-
|
|
9187
|
-
<dl>
|
|
9188
|
-
<dd>
|
|
9189
|
-
|
|
9190
|
-
<dl>
|
|
9191
|
-
<dd>
|
|
9192
|
-
|
|
9193
|
-
Get All Contractors' Time Offs by Company
|
|
9194
|
-
|
|
9195
|
-
</dd>
|
|
9196
|
-
</dl>
|
|
9197
|
-
</dd>
|
|
9198
|
-
</dl>
|
|
9199
|
-
|
|
9200
|
-
#### 🔌 Usage
|
|
9201
|
-
|
|
9202
|
-
<dl>
|
|
9203
|
-
<dd>
|
|
9204
|
-
|
|
9205
|
-
<dl>
|
|
9206
|
-
<dd>
|
|
9207
|
-
|
|
9208
|
-
```typescript
|
|
9209
|
-
await client.api.thera.timeoff.timeoffApi.getContractorsTimeOffHistoryByCompany("string", {
|
|
9210
|
-
timeOffStatus: "IN_REVIEW",
|
|
9211
|
-
timeOffPolicyId: "string",
|
|
9212
|
-
});
|
|
9213
|
-
```
|
|
9214
|
-
|
|
9215
|
-
</dd>
|
|
9216
|
-
</dl>
|
|
9217
|
-
</dd>
|
|
9218
|
-
</dl>
|
|
9219
|
-
|
|
9220
|
-
#### ⚙️ Parameters
|
|
9221
|
-
|
|
9222
|
-
<dl>
|
|
9223
|
-
<dd>
|
|
9224
|
-
|
|
9225
|
-
<dl>
|
|
9226
|
-
<dd>
|
|
9227
|
-
|
|
9228
|
-
**companyId:** `string`
|
|
9229
|
-
|
|
9230
|
-
</dd>
|
|
9231
|
-
</dl>
|
|
9232
|
-
|
|
9233
|
-
<dl>
|
|
9234
|
-
<dd>
|
|
9235
|
-
|
|
9236
|
-
**request:** `TheraApi.api.thera.timeoff.GetAllContractorsTimeOffHistoryByCompanyRequest`
|
|
9237
|
-
|
|
9238
|
-
</dd>
|
|
9239
|
-
</dl>
|
|
9240
|
-
|
|
9241
|
-
<dl>
|
|
9242
|
-
<dd>
|
|
9243
|
-
|
|
9244
|
-
**requestOptions:** `TimeoffApi.RequestOptions`
|
|
9245
|
-
|
|
9246
|
-
</dd>
|
|
9247
|
-
</dl>
|
|
9248
|
-
</dd>
|
|
9249
|
-
</dl>
|
|
9250
|
-
|
|
9251
|
-
</dd>
|
|
9252
|
-
</dl>
|
|
9253
|
-
</details>
|
|
9254
|
-
|
|
9255
|
-
<details><summary><code>client.api.thera.timeoff.timeoffApi.<a href="/src/api/resources/api/resources/thera/resources/timeoff/resources/timeoffApi/client/Client.ts">getTimeOffHistoryByContractor</a>(companyId, userId) -> TheraApi.GetTimeOffHistoryByContractorResponse</code></summary>
|
|
9256
|
-
<dl>
|
|
9257
|
-
<dd>
|
|
9258
|
-
|
|
9259
|
-
#### 📝 Description
|
|
9260
|
-
|
|
9261
|
-
<dl>
|
|
9262
|
-
<dd>
|
|
9263
|
-
|
|
9264
|
-
<dl>
|
|
9265
|
-
<dd>
|
|
9266
|
-
|
|
9267
|
-
Get Time Off History By Contractor
|
|
9268
|
-
|
|
9269
|
-
</dd>
|
|
9270
|
-
</dl>
|
|
9271
|
-
</dd>
|
|
9272
|
-
</dl>
|
|
9273
|
-
|
|
9274
|
-
#### 🔌 Usage
|
|
9275
|
-
|
|
9276
|
-
<dl>
|
|
9277
|
-
<dd>
|
|
9278
|
-
|
|
9279
|
-
<dl>
|
|
9280
|
-
<dd>
|
|
9281
|
-
|
|
9282
|
-
```typescript
|
|
9283
|
-
await client.api.thera.timeoff.timeoffApi.getTimeOffHistoryByContractor("string", "string");
|
|
9284
|
-
```
|
|
9285
|
-
|
|
9286
|
-
</dd>
|
|
9287
|
-
</dl>
|
|
9288
|
-
</dd>
|
|
9289
|
-
</dl>
|
|
9290
|
-
|
|
9291
|
-
#### ⚙️ Parameters
|
|
9292
|
-
|
|
9293
|
-
<dl>
|
|
9294
|
-
<dd>
|
|
9295
|
-
|
|
9296
|
-
<dl>
|
|
9297
|
-
<dd>
|
|
9298
|
-
|
|
9299
|
-
**companyId:** `string`
|
|
9300
|
-
|
|
9301
|
-
</dd>
|
|
9302
|
-
</dl>
|
|
9303
|
-
|
|
9304
|
-
<dl>
|
|
9305
|
-
<dd>
|
|
9306
|
-
|
|
9307
|
-
**userId:** `string`
|
|
9308
|
-
|
|
9309
|
-
</dd>
|
|
9310
|
-
</dl>
|
|
9311
|
-
|
|
9312
|
-
<dl>
|
|
9313
|
-
<dd>
|
|
9314
|
-
|
|
9315
|
-
**requestOptions:** `TimeoffApi.RequestOptions`
|
|
9316
|
-
|
|
9317
|
-
</dd>
|
|
9318
|
-
</dl>
|
|
9319
|
-
</dd>
|
|
9320
|
-
</dl>
|
|
9321
|
-
|
|
9322
|
-
</dd>
|
|
9323
|
-
</dl>
|
|
9324
|
-
</details>
|
|
9325
|
-
|
|
9326
|
-
<details><summary><code>client.api.thera.timeoff.timeoffApi.<a href="/src/api/resources/api/resources/thera/resources/timeoff/resources/timeoffApi/client/Client.ts">getContractorsPoliciesDetailsByPolicy</a>(companyId, policyId, { ...params }) -> TheraApi.GetContractorPoliciesDetailsByPolicy</code></summary>
|
|
9327
|
-
<dl>
|
|
9328
|
-
<dd>
|
|
9329
|
-
|
|
9330
|
-
#### 📝 Description
|
|
9331
|
-
|
|
9332
|
-
<dl>
|
|
9333
|
-
<dd>
|
|
9334
|
-
|
|
9335
|
-
<dl>
|
|
9336
|
-
<dd>
|
|
9337
|
-
|
|
9338
|
-
Get Contractor Policies' Details By Policy
|
|
9339
|
-
|
|
9340
|
-
</dd>
|
|
9341
|
-
</dl>
|
|
9342
|
-
</dd>
|
|
9343
|
-
</dl>
|
|
9344
|
-
|
|
9345
|
-
#### 🔌 Usage
|
|
9346
|
-
|
|
9347
|
-
<dl>
|
|
9348
|
-
<dd>
|
|
9349
|
-
|
|
9350
|
-
<dl>
|
|
9351
|
-
<dd>
|
|
9352
|
-
|
|
9353
|
-
```typescript
|
|
9354
|
-
await client.api.thera.timeoff.timeoffApi.getContractorsPoliciesDetailsByPolicy("string", "string", {
|
|
9355
|
-
year: 1,
|
|
9356
|
-
});
|
|
9357
|
-
```
|
|
9358
|
-
|
|
9359
|
-
</dd>
|
|
9360
|
-
</dl>
|
|
9361
|
-
</dd>
|
|
9362
|
-
</dl>
|
|
9363
|
-
|
|
9364
|
-
#### ⚙️ Parameters
|
|
9365
|
-
|
|
9366
|
-
<dl>
|
|
9367
|
-
<dd>
|
|
9368
|
-
|
|
9369
|
-
<dl>
|
|
9370
|
-
<dd>
|
|
9371
|
-
|
|
9372
|
-
**companyId:** `string`
|
|
9373
|
-
|
|
9374
|
-
</dd>
|
|
9375
|
-
</dl>
|
|
9376
|
-
|
|
9377
|
-
<dl>
|
|
9378
|
-
<dd>
|
|
9379
|
-
|
|
9380
|
-
**policyId:** `string`
|
|
9381
|
-
|
|
9382
|
-
</dd>
|
|
9383
|
-
</dl>
|
|
9384
|
-
|
|
9385
|
-
<dl>
|
|
9386
|
-
<dd>
|
|
9387
|
-
|
|
9388
|
-
**request:** `TheraApi.api.thera.timeoff.GetContractorsPoliciesDetailByPolicyRequest`
|
|
9389
|
-
|
|
9390
|
-
</dd>
|
|
9391
|
-
</dl>
|
|
9392
|
-
|
|
9393
|
-
<dl>
|
|
9394
|
-
<dd>
|
|
9395
|
-
|
|
9396
|
-
**requestOptions:** `TimeoffApi.RequestOptions`
|
|
9397
|
-
|
|
9398
|
-
</dd>
|
|
9399
|
-
</dl>
|
|
9400
|
-
</dd>
|
|
9401
|
-
</dl>
|
|
9402
|
-
|
|
9403
|
-
</dd>
|
|
9404
|
-
</dl>
|
|
9405
|
-
</details>
|
|
9406
|
-
|
|
9407
|
-
<details><summary><code>client.api.thera.timeoff.timeoffApi.<a href="/src/api/resources/api/resources/thera/resources/timeoff/resources/timeoffApi/client/Client.ts">getContractorsPoliciesDetailsByContractor</a>(companyId, userId, { ...params }) -> TheraApi.GetContractorPoliciesDetailsByContractor</code></summary>
|
|
9408
|
-
<dl>
|
|
9409
|
-
<dd>
|
|
9410
|
-
|
|
9411
|
-
#### 📝 Description
|
|
9412
|
-
|
|
9413
|
-
<dl>
|
|
9414
|
-
<dd>
|
|
9415
|
-
|
|
9416
|
-
<dl>
|
|
9417
|
-
<dd>
|
|
9418
|
-
|
|
9419
|
-
Get Contractor's Policies Details
|
|
9420
|
-
|
|
9421
|
-
</dd>
|
|
9422
|
-
</dl>
|
|
9423
|
-
</dd>
|
|
9424
|
-
</dl>
|
|
9425
|
-
|
|
9426
|
-
#### 🔌 Usage
|
|
9427
|
-
|
|
9428
|
-
<dl>
|
|
9429
|
-
<dd>
|
|
9430
|
-
|
|
9431
|
-
<dl>
|
|
9432
|
-
<dd>
|
|
9433
|
-
|
|
9434
|
-
```typescript
|
|
9435
|
-
await client.api.thera.timeoff.timeoffApi.getContractorsPoliciesDetailsByContractor("string", "string", {
|
|
9436
|
-
year: 1,
|
|
9437
|
-
});
|
|
9438
|
-
```
|
|
9439
|
-
|
|
9440
|
-
</dd>
|
|
9441
|
-
</dl>
|
|
9442
|
-
</dd>
|
|
9443
|
-
</dl>
|
|
9444
|
-
|
|
9445
|
-
#### ⚙️ Parameters
|
|
9446
|
-
|
|
9447
|
-
<dl>
|
|
9448
|
-
<dd>
|
|
9449
|
-
|
|
9450
|
-
<dl>
|
|
9451
|
-
<dd>
|
|
9452
|
-
|
|
9453
|
-
**companyId:** `string`
|
|
9454
|
-
|
|
9455
|
-
</dd>
|
|
9456
|
-
</dl>
|
|
9457
|
-
|
|
9458
|
-
<dl>
|
|
9459
|
-
<dd>
|
|
9460
|
-
|
|
9461
|
-
**userId:** `string`
|
|
9462
|
-
|
|
9463
|
-
</dd>
|
|
9464
|
-
</dl>
|
|
9465
|
-
|
|
9466
|
-
<dl>
|
|
9467
|
-
<dd>
|
|
9468
|
-
|
|
9469
|
-
**request:** `TheraApi.api.thera.timeoff.GetContractorsPoliciesDetailByContractor`
|
|
9470
|
-
|
|
9471
|
-
</dd>
|
|
9472
|
-
</dl>
|
|
9473
|
-
|
|
9474
|
-
<dl>
|
|
9475
|
-
<dd>
|
|
9476
|
-
|
|
9477
|
-
**requestOptions:** `TimeoffApi.RequestOptions`
|
|
9478
|
-
|
|
9479
|
-
</dd>
|
|
9480
|
-
</dl>
|
|
9481
|
-
</dd>
|
|
9482
|
-
</dl>
|
|
9483
|
-
|
|
9484
|
-
</dd>
|
|
9485
|
-
</dl>
|
|
9486
|
-
</details>
|
|
9487
|
-
|
|
9488
|
-
<details><summary><code>client.api.thera.timeoff.timeoffApi.<a href="/src/api/resources/api/resources/thera/resources/timeoff/resources/timeoffApi/client/Client.ts">modifyTimeOffStatus</a>(companyId, policyId, timeOffId, { ...params }) -> TheraApi.User</code></summary>
|
|
9489
|
-
<dl>
|
|
9490
|
-
<dd>
|
|
9491
|
-
|
|
9492
|
-
#### 📝 Description
|
|
9493
|
-
|
|
9494
|
-
<dl>
|
|
9495
|
-
<dd>
|
|
9496
|
-
|
|
9497
|
-
<dl>
|
|
9498
|
-
<dd>
|
|
9499
|
-
|
|
9500
|
-
Modify Time Off Status
|
|
9501
|
-
|
|
9502
|
-
</dd>
|
|
9503
|
-
</dl>
|
|
9504
|
-
</dd>
|
|
9505
|
-
</dl>
|
|
9506
|
-
|
|
9507
|
-
#### 🔌 Usage
|
|
9508
|
-
|
|
9509
|
-
<dl>
|
|
9510
|
-
<dd>
|
|
9511
|
-
|
|
9512
|
-
<dl>
|
|
9513
|
-
<dd>
|
|
9514
|
-
|
|
9515
|
-
```typescript
|
|
9516
|
-
await client.api.thera.timeoff.timeoffApi.modifyTimeOffStatus("string", "string", "string", {
|
|
9517
|
-
userId: "string",
|
|
9518
|
-
status: "IN_REVIEW",
|
|
9519
|
-
});
|
|
9520
|
-
```
|
|
9521
|
-
|
|
9522
|
-
</dd>
|
|
9523
|
-
</dl>
|
|
9524
|
-
</dd>
|
|
9525
|
-
</dl>
|
|
9526
|
-
|
|
9527
|
-
#### ⚙️ Parameters
|
|
9528
|
-
|
|
9529
|
-
<dl>
|
|
9530
|
-
<dd>
|
|
9531
|
-
|
|
9532
|
-
<dl>
|
|
9533
|
-
<dd>
|
|
9534
|
-
|
|
9535
|
-
**companyId:** `string`
|
|
9536
|
-
|
|
9537
|
-
</dd>
|
|
9538
|
-
</dl>
|
|
9539
|
-
|
|
9540
|
-
<dl>
|
|
9541
|
-
<dd>
|
|
9542
|
-
|
|
9543
|
-
**policyId:** `string`
|
|
9544
|
-
|
|
9545
|
-
</dd>
|
|
9546
|
-
</dl>
|
|
9547
|
-
|
|
9548
|
-
<dl>
|
|
9549
|
-
<dd>
|
|
9550
|
-
|
|
9551
|
-
**timeOffId:** `string`
|
|
9552
|
-
|
|
9553
|
-
</dd>
|
|
9554
|
-
</dl>
|
|
9555
|
-
|
|
9556
|
-
<dl>
|
|
9557
|
-
<dd>
|
|
9558
|
-
|
|
9559
|
-
**request:** `TheraApi.ModifyTimeOffStatusRequest`
|
|
9560
|
-
|
|
9561
|
-
</dd>
|
|
9562
|
-
</dl>
|
|
9563
|
-
|
|
9564
|
-
<dl>
|
|
9565
|
-
<dd>
|
|
9566
|
-
|
|
9567
|
-
**requestOptions:** `TimeoffApi.RequestOptions`
|
|
9568
|
-
|
|
9569
|
-
</dd>
|
|
9570
|
-
</dl>
|
|
9571
|
-
</dd>
|
|
9572
|
-
</dl>
|
|
9573
|
-
|
|
9574
|
-
</dd>
|
|
9575
|
-
</dl>
|
|
9576
|
-
</details>
|
|
9577
|
-
|
|
9578
|
-
<details><summary><code>client.api.thera.timeoff.timeoffApi.<a href="/src/api/resources/api/resources/thera/resources/timeoff/resources/timeoffApi/client/Client.ts">bulkModifyTimeOffStatuses</a>(companyId, status, { ...params }) -> void</code></summary>
|
|
9579
|
-
<dl>
|
|
9580
|
-
<dd>
|
|
9581
|
-
|
|
9582
|
-
#### 📝 Description
|
|
9583
|
-
|
|
9584
|
-
<dl>
|
|
9585
|
-
<dd>
|
|
9586
|
-
|
|
9587
|
-
<dl>
|
|
9588
|
-
<dd>
|
|
9589
|
-
|
|
9590
|
-
Bulk Modify Time Off Statuses
|
|
9591
|
-
|
|
9592
|
-
</dd>
|
|
9593
|
-
</dl>
|
|
9594
|
-
</dd>
|
|
9595
|
-
</dl>
|
|
9596
|
-
|
|
9597
|
-
#### 🔌 Usage
|
|
9598
|
-
|
|
9599
|
-
<dl>
|
|
9600
|
-
<dd>
|
|
9601
|
-
|
|
9602
|
-
<dl>
|
|
9603
|
-
<dd>
|
|
9604
|
-
|
|
9605
|
-
```typescript
|
|
9606
|
-
await client.api.thera.timeoff.timeoffApi.bulkModifyTimeOffStatuses("string", "string", [
|
|
9607
|
-
{
|
|
9608
|
-
userId: "string",
|
|
9609
|
-
timeoffId: "string",
|
|
9610
|
-
},
|
|
9611
|
-
]);
|
|
9612
|
-
```
|
|
9613
|
-
|
|
9614
|
-
</dd>
|
|
9615
|
-
</dl>
|
|
9616
|
-
</dd>
|
|
9617
|
-
</dl>
|
|
9618
|
-
|
|
9619
|
-
#### ⚙️ Parameters
|
|
9620
|
-
|
|
9621
|
-
<dl>
|
|
9622
|
-
<dd>
|
|
9623
|
-
|
|
9624
|
-
<dl>
|
|
9625
|
-
<dd>
|
|
9626
|
-
|
|
9627
|
-
**companyId:** `string`
|
|
9628
|
-
|
|
9629
|
-
</dd>
|
|
9630
|
-
</dl>
|
|
9631
|
-
|
|
9632
|
-
<dl>
|
|
9633
|
-
<dd>
|
|
9634
|
-
|
|
9635
|
-
**status:** `string`
|
|
9636
|
-
|
|
9637
|
-
</dd>
|
|
9638
|
-
</dl>
|
|
9639
|
-
|
|
9640
|
-
<dl>
|
|
9641
|
-
<dd>
|
|
9642
|
-
|
|
9643
|
-
**request:** `TheraApi.BulkModifyTimeOffStatusesRequest[]`
|
|
9644
|
-
|
|
9645
|
-
</dd>
|
|
9646
|
-
</dl>
|
|
9647
|
-
|
|
9648
|
-
<dl>
|
|
9649
|
-
<dd>
|
|
9650
|
-
|
|
9651
|
-
**requestOptions:** `TimeoffApi.RequestOptions`
|
|
9652
|
-
|
|
9653
|
-
</dd>
|
|
9654
|
-
</dl>
|
|
9655
|
-
</dd>
|
|
9656
|
-
</dl>
|
|
9657
|
-
|
|
9658
|
-
</dd>
|
|
9659
|
-
</dl>
|
|
9660
|
-
</details>
|
|
9661
|
-
|
|
9662
|
-
<details><summary><code>client.api.thera.timeoff.timeoffApi.<a href="/src/api/resources/api/resources/thera/resources/timeoff/resources/timeoffApi/client/Client.ts">updatePtoForContractor</a>(companyId, userId, timeOffId, { ...params }) -> unknown</code></summary>
|
|
9663
|
-
<dl>
|
|
9664
|
-
<dd>
|
|
9665
|
-
|
|
9666
|
-
#### 📝 Description
|
|
9667
|
-
|
|
9668
|
-
<dl>
|
|
9669
|
-
<dd>
|
|
9670
|
-
|
|
9671
|
-
<dl>
|
|
9672
|
-
<dd>
|
|
9673
|
-
|
|
9674
|
-
Update PTO For Contractor
|
|
9675
|
-
|
|
9676
|
-
</dd>
|
|
9677
|
-
</dl>
|
|
9678
|
-
</dd>
|
|
9679
|
-
</dl>
|
|
9680
|
-
|
|
9681
|
-
#### 🔌 Usage
|
|
9682
|
-
|
|
9683
|
-
<dl>
|
|
9684
|
-
<dd>
|
|
9685
|
-
|
|
9686
|
-
<dl>
|
|
9687
|
-
<dd>
|
|
9688
|
-
|
|
9689
|
-
```typescript
|
|
9690
|
-
await client.api.thera.timeoff.timeoffApi.updatePtoForContractor("string", "string", "string", {
|
|
9691
|
-
description: "string",
|
|
9692
|
-
dates: {
|
|
9693
|
-
"2023-01-15": {
|
|
9694
|
-
timeOffLength: "FULL_DAY",
|
|
9695
|
-
},
|
|
9696
|
-
},
|
|
9697
|
-
attachmentFileId: "string",
|
|
9698
|
-
contractId: "string",
|
|
9699
|
-
});
|
|
9700
|
-
```
|
|
9701
|
-
|
|
9702
|
-
</dd>
|
|
9703
|
-
</dl>
|
|
9704
|
-
</dd>
|
|
9705
|
-
</dl>
|
|
9706
|
-
|
|
9707
|
-
#### ⚙️ Parameters
|
|
9708
|
-
|
|
9709
|
-
<dl>
|
|
9710
|
-
<dd>
|
|
9711
|
-
|
|
9712
|
-
<dl>
|
|
9713
|
-
<dd>
|
|
9714
|
-
|
|
9715
|
-
**companyId:** `string`
|
|
9716
|
-
|
|
9717
|
-
</dd>
|
|
9718
|
-
</dl>
|
|
9719
|
-
|
|
9720
|
-
<dl>
|
|
9721
|
-
<dd>
|
|
9722
|
-
|
|
9723
|
-
**userId:** `string`
|
|
9724
|
-
|
|
9725
|
-
</dd>
|
|
9726
|
-
</dl>
|
|
9727
|
-
|
|
9728
|
-
<dl>
|
|
9729
|
-
<dd>
|
|
9730
|
-
|
|
9731
|
-
**timeOffId:** `string`
|
|
9732
|
-
|
|
9733
|
-
</dd>
|
|
9734
|
-
</dl>
|
|
9735
|
-
|
|
9736
|
-
<dl>
|
|
9737
|
-
<dd>
|
|
9738
|
-
|
|
9739
|
-
**request:** `TheraApi.UpdatePtoRequest`
|
|
9740
|
-
|
|
9741
|
-
</dd>
|
|
9742
|
-
</dl>
|
|
9743
|
-
|
|
9744
|
-
<dl>
|
|
9745
|
-
<dd>
|
|
9746
|
-
|
|
9747
|
-
**requestOptions:** `TimeoffApi.RequestOptions`
|
|
9748
|
-
|
|
9749
|
-
</dd>
|
|
9750
|
-
</dl>
|
|
9751
|
-
</dd>
|
|
9752
|
-
</dl>
|
|
9753
|
-
|
|
9754
|
-
</dd>
|
|
9755
|
-
</dl>
|
|
9756
|
-
</details>
|
|
9757
|
-
|
|
9758
|
-
## Time Tracking Management
|
|
9759
|
-
|
|
9760
|
-
<details><summary><code>client.api.thera.timetracking.timetrackingApi.<a href="/src/api/resources/api/resources/thera/resources/timetracking/resources/timetrackingApi/client/Client.ts">createTimeEntry</a>(companyId, userId, { ...params }) -> TheraApi.TimeTrackingEntry</code></summary>
|
|
9761
|
-
<dl>
|
|
9762
|
-
<dd>
|
|
9763
|
-
|
|
9764
|
-
#### 📝 Description
|
|
9765
|
-
|
|
9766
|
-
<dl>
|
|
9767
|
-
<dd>
|
|
9768
|
-
|
|
9769
|
-
<dl>
|
|
9770
|
-
<dd>
|
|
9771
|
-
|
|
9772
|
-
Create a time tracking entry for a specific time period
|
|
9773
|
-
|
|
9774
|
-
</dd>
|
|
9775
|
-
</dl>
|
|
9776
|
-
</dd>
|
|
9777
|
-
</dl>
|
|
9778
|
-
|
|
9779
|
-
#### 🔌 Usage
|
|
9780
|
-
|
|
9781
|
-
<dl>
|
|
9782
|
-
<dd>
|
|
9783
|
-
|
|
9784
|
-
<dl>
|
|
9785
|
-
<dd>
|
|
9786
|
-
|
|
9787
|
-
```typescript
|
|
9788
|
-
await client.api.thera.timetracking.timetrackingApi.createTimeEntry("string", "string", {
|
|
9789
|
-
description: "string",
|
|
9790
|
-
startTime: 1000000,
|
|
9791
|
-
endTime: 1000000,
|
|
9792
|
-
contractId: "string",
|
|
9793
|
-
isBillable: true,
|
|
9794
|
-
rate: 1000000,
|
|
9795
|
-
});
|
|
9796
|
-
```
|
|
9797
|
-
|
|
9798
|
-
</dd>
|
|
9799
|
-
</dl>
|
|
9800
|
-
</dd>
|
|
9801
|
-
</dl>
|
|
9802
|
-
|
|
9803
|
-
#### ⚙️ Parameters
|
|
9804
|
-
|
|
9805
|
-
<dl>
|
|
9806
|
-
<dd>
|
|
9807
|
-
|
|
9808
|
-
<dl>
|
|
9809
|
-
<dd>
|
|
9810
|
-
|
|
9811
|
-
**companyId:** `string`
|
|
9812
|
-
|
|
9813
|
-
</dd>
|
|
9814
|
-
</dl>
|
|
9815
|
-
|
|
9816
|
-
<dl>
|
|
9817
|
-
<dd>
|
|
9818
|
-
|
|
9819
|
-
**userId:** `string`
|
|
9820
|
-
|
|
9821
|
-
</dd>
|
|
9822
|
-
</dl>
|
|
9823
|
-
|
|
9824
|
-
<dl>
|
|
9825
|
-
<dd>
|
|
9826
|
-
|
|
9827
|
-
**request:** `TheraApi.CreateTimeEntryRequest`
|
|
9828
|
-
|
|
9829
|
-
</dd>
|
|
9830
|
-
</dl>
|
|
9831
|
-
|
|
9832
|
-
<dl>
|
|
9833
|
-
<dd>
|
|
9834
|
-
|
|
9835
|
-
**requestOptions:** `TimetrackingApi.RequestOptions`
|
|
9836
|
-
|
|
9837
|
-
</dd>
|
|
9838
|
-
</dl>
|
|
9839
|
-
</dd>
|
|
9840
|
-
</dl>
|
|
9841
|
-
|
|
9842
|
-
</dd>
|
|
9843
|
-
</dl>
|
|
9844
|
-
</details>
|
|
9845
|
-
|
|
9846
|
-
<details><summary><code>client.api.thera.timetracking.timetrackingApi.<a href="/src/api/resources/api/resources/thera/resources/timetracking/resources/timetrackingApi/client/Client.ts">startTimeTracking</a>(companyId, userId, { ...params }) -> TheraApi.TimeTrackingEntry</code></summary>
|
|
9847
|
-
<dl>
|
|
9848
|
-
<dd>
|
|
9849
|
-
|
|
9850
|
-
#### 📝 Description
|
|
9851
|
-
|
|
9852
|
-
<dl>
|
|
9853
|
-
<dd>
|
|
9854
|
-
|
|
9855
|
-
<dl>
|
|
9856
|
-
<dd>
|
|
9857
|
-
|
|
9858
|
-
Start tracking time for a user
|
|
9859
|
-
|
|
9860
|
-
</dd>
|
|
9861
|
-
</dl>
|
|
9862
|
-
</dd>
|
|
9863
|
-
</dl>
|
|
9864
|
-
|
|
9865
|
-
#### 🔌 Usage
|
|
9866
|
-
|
|
9867
|
-
<dl>
|
|
9868
|
-
<dd>
|
|
9869
|
-
|
|
9870
|
-
<dl>
|
|
9871
|
-
<dd>
|
|
9872
|
-
|
|
9873
|
-
```typescript
|
|
9874
|
-
await client.api.thera.timetracking.timetrackingApi.startTimeTracking("string", "string", {
|
|
9875
|
-
description: "string",
|
|
9876
|
-
contractId: "string",
|
|
9877
|
-
userId: "string",
|
|
9878
|
-
isBillable: true,
|
|
9879
|
-
rate: 1000000,
|
|
9880
|
-
});
|
|
9881
|
-
```
|
|
9882
|
-
|
|
9883
|
-
</dd>
|
|
9884
|
-
</dl>
|
|
9885
|
-
</dd>
|
|
9886
|
-
</dl>
|
|
9887
|
-
|
|
9888
|
-
#### ⚙️ Parameters
|
|
9889
|
-
|
|
9890
|
-
<dl>
|
|
9891
|
-
<dd>
|
|
9892
|
-
|
|
9893
|
-
<dl>
|
|
9894
|
-
<dd>
|
|
9895
|
-
|
|
9896
|
-
**companyId:** `string`
|
|
9897
|
-
|
|
9898
|
-
</dd>
|
|
9899
|
-
</dl>
|
|
9900
|
-
|
|
9901
|
-
<dl>
|
|
9902
|
-
<dd>
|
|
9903
|
-
|
|
9904
|
-
**userId:** `string`
|
|
9905
|
-
|
|
9906
|
-
</dd>
|
|
9907
|
-
</dl>
|
|
9908
|
-
|
|
9909
|
-
<dl>
|
|
9910
|
-
<dd>
|
|
9911
|
-
|
|
9912
|
-
**request:** `TheraApi.StartTimeTrackingRequest`
|
|
9913
|
-
|
|
9914
|
-
</dd>
|
|
9915
|
-
</dl>
|
|
9916
|
-
|
|
9917
|
-
<dl>
|
|
9918
|
-
<dd>
|
|
9919
|
-
|
|
9920
|
-
**requestOptions:** `TimetrackingApi.RequestOptions`
|
|
9921
|
-
|
|
9922
|
-
</dd>
|
|
9923
|
-
</dl>
|
|
9924
|
-
</dd>
|
|
9925
|
-
</dl>
|
|
9926
|
-
|
|
9927
|
-
</dd>
|
|
9928
|
-
</dl>
|
|
9929
|
-
</details>
|
|
9930
|
-
|
|
9931
|
-
<details><summary><code>client.api.thera.timetracking.timetrackingApi.<a href="/src/api/resources/api/resources/thera/resources/timetracking/resources/timetrackingApi/client/Client.ts">stopTimeTracking</a>(companyId, userId, { ...params }) -> TheraApi.TimeTrackingEntry</code></summary>
|
|
9932
|
-
<dl>
|
|
9933
|
-
<dd>
|
|
9934
|
-
|
|
9935
|
-
#### 📝 Description
|
|
9936
|
-
|
|
9937
|
-
<dl>
|
|
9938
|
-
<dd>
|
|
9939
|
-
|
|
9940
|
-
<dl>
|
|
9941
|
-
<dd>
|
|
9942
|
-
|
|
9943
|
-
Stop tracking time for a user
|
|
9944
|
-
|
|
9945
|
-
</dd>
|
|
9946
|
-
</dl>
|
|
9947
|
-
</dd>
|
|
9948
|
-
</dl>
|
|
9949
|
-
|
|
9950
|
-
#### 🔌 Usage
|
|
9951
|
-
|
|
9952
|
-
<dl>
|
|
9953
|
-
<dd>
|
|
9954
|
-
|
|
9955
|
-
<dl>
|
|
9956
|
-
<dd>
|
|
9957
|
-
|
|
9958
|
-
```typescript
|
|
9959
|
-
await client.api.thera.timetracking.timetrackingApi.stopTimeTracking("string", "string", {
|
|
9960
|
-
entryId: "string",
|
|
9961
|
-
userId: "string",
|
|
9962
|
-
endTime: 1000000,
|
|
9963
|
-
});
|
|
9964
|
-
```
|
|
9965
|
-
|
|
9966
|
-
</dd>
|
|
9967
|
-
</dl>
|
|
9968
|
-
</dd>
|
|
9969
|
-
</dl>
|
|
9970
|
-
|
|
9971
|
-
#### ⚙️ Parameters
|
|
9972
|
-
|
|
9973
|
-
<dl>
|
|
9974
|
-
<dd>
|
|
9975
|
-
|
|
9976
|
-
<dl>
|
|
9977
|
-
<dd>
|
|
9978
|
-
|
|
9979
|
-
**companyId:** `string`
|
|
9980
|
-
|
|
9981
|
-
</dd>
|
|
9982
|
-
</dl>
|
|
9983
|
-
|
|
9984
|
-
<dl>
|
|
9985
|
-
<dd>
|
|
9986
|
-
|
|
9987
|
-
**userId:** `string`
|
|
9988
|
-
|
|
9989
|
-
</dd>
|
|
9990
|
-
</dl>
|
|
9991
|
-
|
|
9992
|
-
<dl>
|
|
9993
|
-
<dd>
|
|
9994
|
-
|
|
9995
|
-
**request:** `TheraApi.StopTimeTrackingRequest`
|
|
9996
|
-
|
|
9997
|
-
</dd>
|
|
9998
|
-
</dl>
|
|
9999
|
-
|
|
10000
|
-
<dl>
|
|
10001
|
-
<dd>
|
|
10002
|
-
|
|
10003
|
-
**requestOptions:** `TimetrackingApi.RequestOptions`
|
|
10004
|
-
|
|
10005
|
-
</dd>
|
|
10006
|
-
</dl>
|
|
10007
|
-
</dd>
|
|
10008
|
-
</dl>
|
|
10009
|
-
|
|
10010
|
-
</dd>
|
|
10011
|
-
</dl>
|
|
10012
|
-
</details>
|
|
10013
|
-
|
|
10014
|
-
<details><summary><code>client.api.thera.timetracking.timetrackingApi.<a href="/src/api/resources/api/resources/thera/resources/timetracking/resources/timetrackingApi/client/Client.ts">updateTimeTracking</a>(companyId, userId, entryId, { ...params }) -> TheraApi.TimeTrackingEntry</code></summary>
|
|
10015
|
-
<dl>
|
|
10016
|
-
<dd>
|
|
10017
|
-
|
|
10018
|
-
#### 📝 Description
|
|
10019
|
-
|
|
10020
|
-
<dl>
|
|
10021
|
-
<dd>
|
|
10022
|
-
|
|
10023
|
-
<dl>
|
|
10024
|
-
<dd>
|
|
10025
|
-
|
|
10026
|
-
Update a time tracking entry
|
|
10027
|
-
|
|
10028
|
-
</dd>
|
|
10029
|
-
</dl>
|
|
10030
|
-
</dd>
|
|
10031
|
-
</dl>
|
|
10032
|
-
|
|
10033
|
-
#### 🔌 Usage
|
|
10034
|
-
|
|
10035
|
-
<dl>
|
|
10036
|
-
<dd>
|
|
10037
|
-
|
|
10038
|
-
<dl>
|
|
10039
|
-
<dd>
|
|
10040
|
-
|
|
10041
|
-
```typescript
|
|
10042
|
-
await client.api.thera.timetracking.timetrackingApi.updateTimeTracking("string", "string", "string", {
|
|
10043
|
-
description: "string",
|
|
10044
|
-
startTime: 1000000,
|
|
10045
|
-
endTime: 1000000,
|
|
10046
|
-
isBillable: true,
|
|
10047
|
-
rate: 1000000,
|
|
10048
|
-
});
|
|
10049
|
-
```
|
|
10050
|
-
|
|
10051
|
-
</dd>
|
|
10052
|
-
</dl>
|
|
10053
|
-
</dd>
|
|
10054
|
-
</dl>
|
|
10055
|
-
|
|
10056
|
-
#### ⚙️ Parameters
|
|
10057
|
-
|
|
10058
|
-
<dl>
|
|
10059
|
-
<dd>
|
|
10060
|
-
|
|
10061
|
-
<dl>
|
|
10062
|
-
<dd>
|
|
10063
|
-
|
|
10064
|
-
**companyId:** `string`
|
|
10065
|
-
|
|
10066
|
-
</dd>
|
|
10067
|
-
</dl>
|
|
10068
|
-
|
|
10069
|
-
<dl>
|
|
10070
|
-
<dd>
|
|
10071
|
-
|
|
10072
|
-
**userId:** `string`
|
|
10073
|
-
|
|
10074
|
-
</dd>
|
|
10075
|
-
</dl>
|
|
10076
|
-
|
|
10077
|
-
<dl>
|
|
10078
|
-
<dd>
|
|
10079
|
-
|
|
10080
|
-
**entryId:** `string`
|
|
10081
|
-
|
|
10082
|
-
</dd>
|
|
10083
|
-
</dl>
|
|
10084
|
-
|
|
10085
|
-
<dl>
|
|
10086
|
-
<dd>
|
|
10087
|
-
|
|
10088
|
-
**request:** `TheraApi.UpdateTimeTrackingRequest`
|
|
10089
|
-
|
|
10090
|
-
</dd>
|
|
10091
|
-
</dl>
|
|
10092
|
-
|
|
10093
|
-
<dl>
|
|
10094
|
-
<dd>
|
|
10095
|
-
|
|
10096
|
-
**requestOptions:** `TimetrackingApi.RequestOptions`
|
|
10097
|
-
|
|
10098
|
-
</dd>
|
|
10099
|
-
</dl>
|
|
10100
|
-
</dd>
|
|
10101
|
-
</dl>
|
|
10102
|
-
|
|
10103
|
-
</dd>
|
|
10104
|
-
</dl>
|
|
10105
|
-
</details>
|
|
10106
|
-
|
|
10107
|
-
<details><summary><code>client.api.thera.timetracking.timetrackingApi.<a href="/src/api/resources/api/resources/thera/resources/timetracking/resources/timetrackingApi/client/Client.ts">deleteTimeTracking</a>(companyId, userId, entryId) -> void</code></summary>
|
|
10108
|
-
<dl>
|
|
10109
|
-
<dd>
|
|
10110
|
-
|
|
10111
|
-
#### 📝 Description
|
|
10112
|
-
|
|
10113
|
-
<dl>
|
|
10114
|
-
<dd>
|
|
10115
|
-
|
|
10116
|
-
<dl>
|
|
10117
|
-
<dd>
|
|
10118
|
-
|
|
10119
|
-
Delete a time tracking entry
|
|
10120
|
-
|
|
10121
|
-
</dd>
|
|
10122
|
-
</dl>
|
|
10123
|
-
</dd>
|
|
10124
|
-
</dl>
|
|
10125
|
-
|
|
10126
|
-
#### 🔌 Usage
|
|
10127
|
-
|
|
10128
|
-
<dl>
|
|
10129
|
-
<dd>
|
|
10130
|
-
|
|
10131
|
-
<dl>
|
|
10132
|
-
<dd>
|
|
10133
|
-
|
|
10134
|
-
```typescript
|
|
10135
|
-
await client.api.thera.timetracking.timetrackingApi.deleteTimeTracking("string", "string", "string");
|
|
10136
|
-
```
|
|
10137
|
-
|
|
10138
|
-
</dd>
|
|
10139
|
-
</dl>
|
|
10140
|
-
</dd>
|
|
10141
|
-
</dl>
|
|
10142
|
-
|
|
10143
|
-
#### ⚙️ Parameters
|
|
10144
|
-
|
|
10145
|
-
<dl>
|
|
10146
|
-
<dd>
|
|
10147
|
-
|
|
10148
|
-
<dl>
|
|
10149
|
-
<dd>
|
|
10150
|
-
|
|
10151
|
-
**companyId:** `string`
|
|
10152
|
-
|
|
10153
|
-
</dd>
|
|
10154
|
-
</dl>
|
|
10155
|
-
|
|
10156
|
-
<dl>
|
|
10157
|
-
<dd>
|
|
10158
|
-
|
|
10159
|
-
**userId:** `string`
|
|
10160
|
-
|
|
10161
|
-
</dd>
|
|
10162
|
-
</dl>
|
|
10163
|
-
|
|
10164
|
-
<dl>
|
|
10165
|
-
<dd>
|
|
10166
|
-
|
|
10167
|
-
**entryId:** `string`
|
|
10168
|
-
|
|
10169
|
-
</dd>
|
|
10170
|
-
</dl>
|
|
10171
|
-
|
|
10172
|
-
<dl>
|
|
10173
|
-
<dd>
|
|
10174
|
-
|
|
10175
|
-
**requestOptions:** `TimetrackingApi.RequestOptions`
|
|
10176
|
-
|
|
10177
|
-
</dd>
|
|
10178
|
-
</dl>
|
|
10179
|
-
</dd>
|
|
10180
|
-
</dl>
|
|
10181
|
-
|
|
10182
|
-
</dd>
|
|
10183
|
-
</dl>
|
|
10184
|
-
</details>
|
|
10185
|
-
|
|
10186
|
-
<details><summary><code>client.api.thera.timetracking.timetrackingApi.<a href="/src/api/resources/api/resources/thera/resources/timetracking/resources/timetrackingApi/client/Client.ts">getAllTimeTracking</a>(companyId, userId, { ...params }) -> TheraApi.TimeTrackingHistory</code></summary>
|
|
10187
|
-
<dl>
|
|
10188
|
-
<dd>
|
|
10189
|
-
|
|
10190
|
-
#### 📝 Description
|
|
10191
|
-
|
|
10192
|
-
<dl>
|
|
10193
|
-
<dd>
|
|
10194
|
-
|
|
10195
|
-
<dl>
|
|
10196
|
-
<dd>
|
|
10197
|
-
|
|
10198
|
-
Get all time tracking entries for a user within a date range
|
|
10199
|
-
|
|
10200
|
-
</dd>
|
|
10201
|
-
</dl>
|
|
10202
|
-
</dd>
|
|
10203
|
-
</dl>
|
|
10204
|
-
|
|
10205
|
-
#### 🔌 Usage
|
|
10206
|
-
|
|
10207
|
-
<dl>
|
|
10208
|
-
<dd>
|
|
10209
|
-
|
|
10210
|
-
<dl>
|
|
10211
|
-
<dd>
|
|
10212
|
-
|
|
10213
|
-
```typescript
|
|
10214
|
-
await client.api.thera.timetracking.timetrackingApi.getAllTimeTracking("string", "string", {
|
|
10215
|
-
startDate: "string",
|
|
10216
|
-
endDate: "string",
|
|
10217
|
-
timezone: "string",
|
|
10218
|
-
});
|
|
10219
|
-
```
|
|
10220
|
-
|
|
10221
|
-
</dd>
|
|
10222
|
-
</dl>
|
|
10223
|
-
</dd>
|
|
10224
|
-
</dl>
|
|
10225
|
-
|
|
10226
|
-
#### ⚙️ Parameters
|
|
10227
|
-
|
|
10228
|
-
<dl>
|
|
10229
|
-
<dd>
|
|
10230
|
-
|
|
10231
|
-
<dl>
|
|
10232
|
-
<dd>
|
|
10233
|
-
|
|
10234
|
-
**companyId:** `string`
|
|
10235
|
-
|
|
10236
|
-
</dd>
|
|
10237
|
-
</dl>
|
|
10238
|
-
|
|
10239
|
-
<dl>
|
|
10240
|
-
<dd>
|
|
10241
|
-
|
|
10242
|
-
**userId:** `string`
|
|
10243
|
-
|
|
10244
|
-
</dd>
|
|
10245
|
-
</dl>
|
|
10246
|
-
|
|
10247
|
-
<dl>
|
|
10248
|
-
<dd>
|
|
10249
|
-
|
|
10250
|
-
**request:** `TheraApi.api.thera.timetracking.GetAllTimeTrackingRequest`
|
|
10251
|
-
|
|
10252
|
-
</dd>
|
|
10253
|
-
</dl>
|
|
10254
|
-
|
|
10255
|
-
<dl>
|
|
10256
|
-
<dd>
|
|
10257
|
-
|
|
10258
|
-
**requestOptions:** `TimetrackingApi.RequestOptions`
|
|
10259
|
-
|
|
10260
|
-
</dd>
|
|
10261
|
-
</dl>
|
|
10262
|
-
</dd>
|
|
10263
|
-
</dl>
|
|
10264
|
-
|
|
10265
|
-
</dd>
|
|
10266
|
-
</dl>
|
|
10267
|
-
</details>
|
|
10268
|
-
|
|
10269
|
-
<details><summary><code>client.api.thera.timetracking.timetrackingApi.<a href="/src/api/resources/api/resources/thera/resources/timetracking/resources/timetrackingApi/client/Client.ts">getTimeTrackingByInvoice</a>(companyId, invoiceId) -> TheraApi.TimeTrackingHistory</code></summary>
|
|
10270
|
-
<dl>
|
|
10271
|
-
<dd>
|
|
10272
|
-
|
|
10273
|
-
#### 📝 Description
|
|
10274
|
-
|
|
10275
|
-
<dl>
|
|
10276
|
-
<dd>
|
|
10277
|
-
|
|
10278
|
-
<dl>
|
|
10279
|
-
<dd>
|
|
10280
|
-
|
|
10281
|
-
Get all time tracking entries associated with an invoice
|
|
10282
|
-
|
|
10283
|
-
</dd>
|
|
10284
|
-
</dl>
|
|
10285
|
-
</dd>
|
|
10286
|
-
</dl>
|
|
10287
|
-
|
|
10288
|
-
#### 🔌 Usage
|
|
10289
|
-
|
|
10290
|
-
<dl>
|
|
10291
|
-
<dd>
|
|
10292
|
-
|
|
10293
|
-
<dl>
|
|
10294
|
-
<dd>
|
|
10295
|
-
|
|
10296
|
-
```typescript
|
|
10297
|
-
await client.api.thera.timetracking.timetrackingApi.getTimeTrackingByInvoice("string", "string");
|
|
10298
|
-
```
|
|
10299
|
-
|
|
10300
|
-
</dd>
|
|
10301
|
-
</dl>
|
|
10302
|
-
</dd>
|
|
10303
|
-
</dl>
|
|
10304
|
-
|
|
10305
|
-
#### ⚙️ Parameters
|
|
10306
|
-
|
|
10307
|
-
<dl>
|
|
10308
|
-
<dd>
|
|
10309
|
-
|
|
10310
|
-
<dl>
|
|
10311
|
-
<dd>
|
|
10312
|
-
|
|
10313
|
-
**companyId:** `string`
|
|
10314
|
-
|
|
10315
|
-
</dd>
|
|
10316
|
-
</dl>
|
|
10317
|
-
|
|
10318
|
-
<dl>
|
|
10319
|
-
<dd>
|
|
10320
|
-
|
|
10321
|
-
**invoiceId:** `string`
|
|
10322
|
-
|
|
10323
|
-
</dd>
|
|
10324
|
-
</dl>
|
|
10325
|
-
|
|
10326
|
-
<dl>
|
|
10327
|
-
<dd>
|
|
10328
|
-
|
|
10329
|
-
**requestOptions:** `TimetrackingApi.RequestOptions`
|
|
10330
|
-
|
|
10331
|
-
</dd>
|
|
10332
|
-
</dl>
|
|
10333
|
-
</dd>
|
|
10334
|
-
</dl>
|
|
10335
|
-
|
|
10336
|
-
</dd>
|
|
10337
|
-
</dl>
|
|
10338
|
-
</details>
|
|
10339
|
-
|
|
10340
|
-
<details><summary><code>client.api.thera.timetracking.timetrackingApi.<a href="/src/api/resources/api/resources/thera/resources/timetracking/resources/timetrackingApi/client/Client.ts">bulkUpdateTimeEntries</a>(companyId, userId, { ...params }) -> TheraApi.TimeTrackingEntry[]</code></summary>
|
|
10341
|
-
<dl>
|
|
10342
|
-
<dd>
|
|
10343
|
-
|
|
10344
|
-
#### 📝 Description
|
|
10345
|
-
|
|
10346
|
-
<dl>
|
|
10347
|
-
<dd>
|
|
10348
|
-
|
|
10349
|
-
<dl>
|
|
10350
|
-
<dd>
|
|
10351
|
-
|
|
10352
|
-
Update multiple time entries with invoice association
|
|
10353
|
-
|
|
10354
|
-
</dd>
|
|
10355
|
-
</dl>
|
|
10356
|
-
</dd>
|
|
10357
|
-
</dl>
|
|
10358
|
-
|
|
10359
|
-
#### 🔌 Usage
|
|
10360
|
-
|
|
10361
|
-
<dl>
|
|
10362
|
-
<dd>
|
|
10363
|
-
|
|
10364
|
-
<dl>
|
|
10365
|
-
<dd>
|
|
10366
|
-
|
|
10367
|
-
```typescript
|
|
10368
|
-
await client.api.thera.timetracking.timetrackingApi.bulkUpdateTimeEntries("string", "string", {
|
|
10369
|
-
entryIds: ["string"],
|
|
10370
|
-
invoiceId: "string",
|
|
10371
|
-
});
|
|
10372
|
-
```
|
|
10373
|
-
|
|
10374
|
-
</dd>
|
|
10375
|
-
</dl>
|
|
10376
|
-
</dd>
|
|
10377
|
-
</dl>
|
|
10378
|
-
|
|
10379
|
-
#### ⚙️ Parameters
|
|
10380
|
-
|
|
10381
|
-
<dl>
|
|
10382
|
-
<dd>
|
|
10383
|
-
|
|
10384
|
-
<dl>
|
|
10385
|
-
<dd>
|
|
10386
|
-
|
|
10387
|
-
**companyId:** `string`
|
|
10388
|
-
|
|
10389
|
-
</dd>
|
|
10390
|
-
</dl>
|
|
10391
|
-
|
|
10392
|
-
<dl>
|
|
10393
|
-
<dd>
|
|
10394
|
-
|
|
10395
|
-
**userId:** `string`
|
|
10396
|
-
|
|
10397
|
-
</dd>
|
|
10398
|
-
</dl>
|
|
10399
|
-
|
|
10400
|
-
<dl>
|
|
10401
|
-
<dd>
|
|
10402
|
-
|
|
10403
|
-
**request:** `TheraApi.BulkTimeEntryUpdateRequest`
|
|
10404
|
-
|
|
10405
|
-
</dd>
|
|
10406
|
-
</dl>
|
|
10407
|
-
|
|
10408
|
-
<dl>
|
|
10409
|
-
<dd>
|
|
10410
|
-
|
|
10411
|
-
**requestOptions:** `TimetrackingApi.RequestOptions`
|
|
10412
|
-
|
|
10413
|
-
</dd>
|
|
10414
|
-
</dl>
|
|
10415
|
-
</dd>
|
|
10416
|
-
</dl>
|
|
10417
|
-
|
|
10418
|
-
</dd>
|
|
10419
|
-
</dl>
|
|
10420
|
-
</details>
|
|
10421
|
-
|
|
10422
|
-
<details><summary><code>client.api.thera.timetracking.timetrackingApi.<a href="/src/api/resources/api/resources/thera/resources/timetracking/resources/timetrackingApi/client/Client.ts">getTimeTrackingHistory</a>(companyId, userId, { ...params }) -> TheraApi.TimeTrackingHistory</code></summary>
|
|
10423
|
-
<dl>
|
|
10424
|
-
<dd>
|
|
10425
|
-
|
|
10426
|
-
#### 📝 Description
|
|
10427
|
-
|
|
10428
|
-
<dl>
|
|
10429
|
-
<dd>
|
|
10430
|
-
|
|
10431
|
-
<dl>
|
|
10432
|
-
<dd>
|
|
10433
|
-
|
|
10434
|
-
Get complete time tracking history for a user with year/month/week breakdowns
|
|
10435
|
-
|
|
10436
|
-
</dd>
|
|
10437
|
-
</dl>
|
|
10438
|
-
</dd>
|
|
10439
|
-
</dl>
|
|
10440
|
-
|
|
10441
|
-
#### 🔌 Usage
|
|
10442
|
-
|
|
10443
|
-
<dl>
|
|
10444
|
-
<dd>
|
|
10445
|
-
|
|
10446
|
-
<dl>
|
|
10447
|
-
<dd>
|
|
10448
|
-
|
|
10449
|
-
```typescript
|
|
10450
|
-
await client.api.thera.timetracking.timetrackingApi.getTimeTrackingHistory("string", "string", {
|
|
10451
|
-
fromYear: "string",
|
|
10452
|
-
});
|
|
10453
|
-
```
|
|
10454
|
-
|
|
10455
|
-
</dd>
|
|
10456
|
-
</dl>
|
|
10457
|
-
</dd>
|
|
10458
|
-
</dl>
|
|
10459
|
-
|
|
10460
|
-
#### ⚙️ Parameters
|
|
10461
|
-
|
|
10462
|
-
<dl>
|
|
10463
|
-
<dd>
|
|
10464
|
-
|
|
10465
|
-
<dl>
|
|
10466
|
-
<dd>
|
|
10467
|
-
|
|
10468
|
-
**companyId:** `string`
|
|
10469
|
-
|
|
10470
|
-
</dd>
|
|
10471
|
-
</dl>
|
|
10472
|
-
|
|
10473
|
-
<dl>
|
|
10474
|
-
<dd>
|
|
10475
|
-
|
|
10476
|
-
**userId:** `string`
|
|
10477
|
-
|
|
10478
|
-
</dd>
|
|
10479
|
-
</dl>
|
|
10480
|
-
|
|
10481
|
-
<dl>
|
|
10482
|
-
<dd>
|
|
10483
|
-
|
|
10484
|
-
**request:** `TheraApi.api.thera.timetracking.GetTimeTrackingHistoryRequest`
|
|
10485
|
-
|
|
10486
|
-
</dd>
|
|
10487
|
-
</dl>
|
|
10488
|
-
|
|
10489
|
-
<dl>
|
|
10490
|
-
<dd>
|
|
10491
|
-
|
|
10492
|
-
**requestOptions:** `TimetrackingApi.RequestOptions`
|
|
10493
|
-
|
|
10494
|
-
</dd>
|
|
10495
|
-
</dl>
|
|
10496
|
-
</dd>
|
|
10497
|
-
</dl>
|
|
10498
|
-
|
|
10499
|
-
</dd>
|
|
10500
|
-
</dl>
|
|
10501
|
-
</details>
|
|
10502
|
-
|
|
10503
|
-
## Treasury Prime
|
|
10504
|
-
|
|
10505
|
-
<details><summary><code>client.api.thera.tp.tpApi.<a href="/src/api/resources/api/resources/thera/resources/tp/resources/tpApi/client/Client.ts">addCompanyBankingDetails</a>(companyId, { ...params }) -> TheraApi.AddCompanyBankingDetailsResponse</code></summary>
|
|
10506
|
-
<dl>
|
|
10507
|
-
<dd>
|
|
10508
|
-
|
|
10509
|
-
#### 📝 Description
|
|
10510
|
-
|
|
10511
|
-
<dl>
|
|
10512
|
-
<dd>
|
|
10513
|
-
|
|
10514
|
-
<dl>
|
|
10515
|
-
<dd>
|
|
10516
|
-
|
|
10517
|
-
Final step of company onboarding, if the company is using Thera banking.
|
|
10518
|
-
|
|
10519
|
-
</dd>
|
|
10520
|
-
</dl>
|
|
10521
|
-
</dd>
|
|
10522
|
-
</dl>
|
|
10523
|
-
|
|
10524
|
-
#### 🔌 Usage
|
|
10525
|
-
|
|
10526
|
-
<dl>
|
|
10527
|
-
<dd>
|
|
10528
|
-
|
|
10529
|
-
<dl>
|
|
10530
|
-
<dd>
|
|
10531
|
-
|
|
10532
|
-
```typescript
|
|
10533
|
-
await client.api.thera.tp.tpApi.addCompanyBankingDetails("string", {
|
|
10534
|
-
details: {
|
|
10535
|
-
establishedOn: "2023-01-15",
|
|
10536
|
-
incorporationState: "string",
|
|
10537
|
-
legalStructure: "ccorp",
|
|
10538
|
-
naics: "string",
|
|
10539
|
-
callerUserBeneficiaryInformation: {
|
|
10540
|
-
dateOfBirth: "2023-01-15",
|
|
10541
|
-
emailAddress: "string",
|
|
10542
|
-
firstName: "string",
|
|
10543
|
-
lastName: "string",
|
|
10544
|
-
middleName: {
|
|
10545
|
-
key: "value",
|
|
10546
|
-
},
|
|
10547
|
-
phoneNumber: "string",
|
|
10548
|
-
mailingAddress: {
|
|
10549
|
-
key: "value",
|
|
10550
|
-
},
|
|
10551
|
-
physicalAddress: {
|
|
10552
|
-
city: "string",
|
|
10553
|
-
country: "string",
|
|
10554
|
-
line1: "string",
|
|
10555
|
-
line2: "string",
|
|
10556
|
-
postalCode: "string",
|
|
10557
|
-
state: "string",
|
|
10558
|
-
},
|
|
10559
|
-
tin: "string",
|
|
10560
|
-
ownershipPercentage: 1,
|
|
10561
|
-
title: "string",
|
|
10562
|
-
makeOrgAdmin: {
|
|
10563
|
-
key: "value",
|
|
10564
|
-
},
|
|
10565
|
-
isControlPerson: true,
|
|
10566
|
-
},
|
|
10567
|
-
beneficiaries: [
|
|
10568
|
-
{
|
|
10569
|
-
key: "value",
|
|
10570
|
-
},
|
|
10571
|
-
],
|
|
10572
|
-
},
|
|
10573
|
-
skipTpApplication: true,
|
|
10574
|
-
setupDepositFbo: true,
|
|
10575
|
-
});
|
|
10576
|
-
```
|
|
10577
|
-
|
|
10578
|
-
</dd>
|
|
10579
|
-
</dl>
|
|
10580
|
-
</dd>
|
|
10581
|
-
</dl>
|
|
10582
|
-
|
|
10583
|
-
#### ⚙️ Parameters
|
|
10584
|
-
|
|
10585
|
-
<dl>
|
|
10586
|
-
<dd>
|
|
10587
|
-
|
|
10588
|
-
<dl>
|
|
10589
|
-
<dd>
|
|
10590
|
-
|
|
10591
|
-
**companyId:** `string`
|
|
10592
|
-
|
|
10593
|
-
</dd>
|
|
10594
|
-
</dl>
|
|
10595
|
-
|
|
10596
|
-
<dl>
|
|
10597
|
-
<dd>
|
|
10598
|
-
|
|
10599
|
-
**request:** `TheraApi.api.thera.tp.AddCompanyBankingDetailsRequest`
|
|
10600
|
-
|
|
10601
|
-
</dd>
|
|
10602
|
-
</dl>
|
|
10603
|
-
|
|
10604
|
-
<dl>
|
|
10605
|
-
<dd>
|
|
10606
|
-
|
|
10607
|
-
**requestOptions:** `TpApi.RequestOptions`
|
|
10608
|
-
|
|
10609
|
-
</dd>
|
|
10610
|
-
</dl>
|
|
10611
|
-
</dd>
|
|
10612
|
-
</dl>
|
|
10613
|
-
|
|
10614
|
-
</dd>
|
|
10615
|
-
</dl>
|
|
10616
|
-
</details>
|
|
10617
|
-
|
|
10618
|
-
<details><summary><code>client.api.thera.tp.tpApi.<a href="/src/api/resources/api/resources/thera/resources/tp/resources/tpApi/client/Client.ts">getIndustryCodesTp</a>() -> TheraApi.GetIndustryCodesResponse</code></summary>
|
|
10619
|
-
<dl>
|
|
10620
|
-
<dd>
|
|
10621
|
-
|
|
10622
|
-
#### 📝 Description
|
|
10623
|
-
|
|
10624
|
-
<dl>
|
|
10625
|
-
<dd>
|
|
10626
|
-
|
|
10627
|
-
<dl>
|
|
10628
|
-
<dd>
|
|
10629
|
-
|
|
10630
|
-
Get Industry codes to be usd in the `addCompanyBankingDetails` endpoint.
|
|
10631
|
-
|
|
10632
|
-
</dd>
|
|
10633
|
-
</dl>
|
|
10634
|
-
</dd>
|
|
10635
|
-
</dl>
|
|
10636
|
-
|
|
10637
|
-
#### 🔌 Usage
|
|
10638
|
-
|
|
10639
|
-
<dl>
|
|
10640
|
-
<dd>
|
|
10641
|
-
|
|
10642
|
-
<dl>
|
|
10643
|
-
<dd>
|
|
10644
|
-
|
|
10645
|
-
```typescript
|
|
10646
|
-
await client.api.thera.tp.tpApi.getIndustryCodesTp();
|
|
10647
|
-
```
|
|
10648
|
-
|
|
10649
|
-
</dd>
|
|
10650
|
-
</dl>
|
|
10651
|
-
</dd>
|
|
10652
|
-
</dl>
|
|
10653
|
-
|
|
10654
|
-
#### ⚙️ Parameters
|
|
10655
|
-
|
|
10656
|
-
<dl>
|
|
10657
|
-
<dd>
|
|
10658
|
-
|
|
10659
|
-
<dl>
|
|
10660
|
-
<dd>
|
|
10661
|
-
|
|
10662
|
-
**requestOptions:** `TpApi.RequestOptions`
|
|
10663
|
-
|
|
10664
|
-
</dd>
|
|
10665
|
-
</dl>
|
|
10666
|
-
</dd>
|
|
10667
|
-
</dl>
|
|
10668
|
-
|
|
10669
|
-
</dd>
|
|
10670
|
-
</dl>
|
|
10671
|
-
</details>
|
|
10672
|
-
|
|
10673
|
-
<details><summary><code>client.api.thera.tp.tpApi.<a href="/src/api/resources/api/resources/thera/resources/tp/resources/tpApi/client/Client.ts">processTreasuryPrimePayment</a>(companyId, { ...params }) -> unknown</code></summary>
|
|
10674
|
-
<dl>
|
|
10675
|
-
<dd>
|
|
10676
|
-
|
|
10677
|
-
#### 📝 Description
|
|
10678
|
-
|
|
10679
|
-
<dl>
|
|
10680
|
-
<dd>
|
|
10681
|
-
|
|
10682
|
-
<dl>
|
|
10683
|
-
<dd>
|
|
10684
|
-
|
|
10685
|
-
Process funds from company account to fbo account
|
|
10686
|
-
|
|
10687
|
-
</dd>
|
|
10688
|
-
</dl>
|
|
10689
|
-
</dd>
|
|
10690
|
-
</dl>
|
|
10691
|
-
|
|
10692
|
-
#### 🔌 Usage
|
|
10693
|
-
|
|
10694
|
-
<dl>
|
|
10695
|
-
<dd>
|
|
10696
|
-
|
|
10697
|
-
<dl>
|
|
10698
|
-
<dd>
|
|
10699
|
-
|
|
10700
|
-
```typescript
|
|
10701
|
-
await client.api.thera.tp.tpApi.processTreasuryPrimePayment("string", {
|
|
10702
|
-
accountId: "string",
|
|
10703
|
-
amount: "string",
|
|
10704
|
-
direction: "string",
|
|
10705
|
-
paymentMethodId: "string",
|
|
10706
|
-
secCode: "string",
|
|
10707
|
-
service: "string",
|
|
10708
|
-
revenueAmount: "string",
|
|
10709
|
-
cashDeposit: true,
|
|
10710
|
-
});
|
|
10711
|
-
```
|
|
10712
|
-
|
|
10713
|
-
</dd>
|
|
10714
|
-
</dl>
|
|
10715
|
-
</dd>
|
|
10716
|
-
</dl>
|
|
10717
|
-
|
|
10718
|
-
#### ⚙️ Parameters
|
|
10719
|
-
|
|
10720
|
-
<dl>
|
|
10721
|
-
<dd>
|
|
10722
|
-
|
|
10723
|
-
<dl>
|
|
10724
|
-
<dd>
|
|
10725
|
-
|
|
10726
|
-
**companyId:** `string`
|
|
10727
|
-
|
|
10728
|
-
</dd>
|
|
10729
|
-
</dl>
|
|
10730
|
-
|
|
10731
|
-
<dl>
|
|
10732
|
-
<dd>
|
|
10733
|
-
|
|
10734
|
-
**request:** `TheraApi.ProcessFundsTransfer`
|
|
10735
|
-
|
|
10736
|
-
</dd>
|
|
10737
|
-
</dl>
|
|
10738
|
-
|
|
10739
|
-
<dl>
|
|
10740
|
-
<dd>
|
|
10741
|
-
|
|
10742
|
-
**requestOptions:** `TpApi.RequestOptions`
|
|
10743
|
-
|
|
10744
|
-
</dd>
|
|
10745
|
-
</dl>
|
|
10746
|
-
</dd>
|
|
10747
|
-
</dl>
|
|
10748
|
-
|
|
10749
|
-
</dd>
|
|
10750
|
-
</dl>
|
|
10751
|
-
</details>
|
|
10752
|
-
|
|
10753
|
-
<details><summary><code>client.api.thera.tp.tpApi.<a href="/src/api/resources/api/resources/thera/resources/tp/resources/tpApi/client/Client.ts">createCounterPartyForBanking</a>(companyId, { ...params }) -> unknown</code></summary>
|
|
10754
|
-
<dl>
|
|
10755
|
-
<dd>
|
|
10756
|
-
|
|
10757
|
-
#### 📝 Description
|
|
10758
|
-
|
|
10759
|
-
<dl>
|
|
10760
|
-
<dd>
|
|
10761
|
-
|
|
10762
|
-
<dl>
|
|
10763
|
-
<dd>
|
|
10764
|
-
|
|
10765
|
-
Create TP counter party required for processing payments, each payment method needs to have a counterparty before initiating payments
|
|
10766
|
-
|
|
10767
|
-
</dd>
|
|
10768
|
-
</dl>
|
|
10769
|
-
</dd>
|
|
10770
|
-
</dl>
|
|
10771
|
-
|
|
10772
|
-
#### 🔌 Usage
|
|
10773
|
-
|
|
10774
|
-
<dl>
|
|
10775
|
-
<dd>
|
|
10776
|
-
|
|
10777
|
-
<dl>
|
|
10778
|
-
<dd>
|
|
10779
|
-
|
|
10780
|
-
```typescript
|
|
10781
|
-
await client.api.thera.tp.tpApi.createCounterPartyForBanking("string", {
|
|
10782
|
-
paymentMethodId: "string",
|
|
10783
|
-
});
|
|
10784
|
-
```
|
|
10785
|
-
|
|
10786
|
-
</dd>
|
|
10787
|
-
</dl>
|
|
10788
|
-
</dd>
|
|
10789
|
-
</dl>
|
|
10790
|
-
|
|
10791
|
-
#### ⚙️ Parameters
|
|
10792
|
-
|
|
10793
|
-
<dl>
|
|
10794
|
-
<dd>
|
|
10795
|
-
|
|
10796
|
-
<dl>
|
|
10797
|
-
<dd>
|
|
10798
|
-
|
|
10799
|
-
**companyId:** `string`
|
|
10800
|
-
|
|
10801
|
-
</dd>
|
|
10802
|
-
</dl>
|
|
10803
|
-
|
|
10804
|
-
<dl>
|
|
10805
|
-
<dd>
|
|
10806
|
-
|
|
10807
|
-
**request:** `TheraApi.CreateCounterPartyForBankingRequest`
|
|
10808
|
-
|
|
10809
|
-
</dd>
|
|
10810
|
-
</dl>
|
|
10811
|
-
|
|
10812
|
-
<dl>
|
|
10813
|
-
<dd>
|
|
10814
|
-
|
|
10815
|
-
**requestOptions:** `TpApi.RequestOptions`
|
|
10816
|
-
|
|
10817
|
-
</dd>
|
|
10818
|
-
</dl>
|
|
10819
|
-
</dd>
|
|
10820
|
-
</dl>
|
|
10821
|
-
|
|
10822
|
-
</dd>
|
|
10823
|
-
</dl>
|
|
10824
|
-
</details>
|
|
10825
|
-
|
|
10826
|
-
<details><summary><code>client.api.thera.tp.tpApi.<a href="/src/api/resources/api/resources/thera/resources/tp/resources/tpApi/client/Client.ts">getTpAccountsForCompany</a>(companyId) -> unknown</code></summary>
|
|
10827
|
-
<dl>
|
|
10828
|
-
<dd>
|
|
10829
|
-
|
|
10830
|
-
#### 📝 Description
|
|
10831
|
-
|
|
10832
|
-
<dl>
|
|
10833
|
-
<dd>
|
|
10834
|
-
|
|
10835
|
-
<dl>
|
|
10836
|
-
<dd>
|
|
10837
|
-
|
|
10838
|
-
Get all tp accounts to display the account info by fe
|
|
10839
|
-
|
|
10840
|
-
</dd>
|
|
10841
|
-
</dl>
|
|
10842
|
-
</dd>
|
|
10843
|
-
</dl>
|
|
10844
|
-
|
|
10845
|
-
#### 🔌 Usage
|
|
10846
|
-
|
|
10847
|
-
<dl>
|
|
10848
|
-
<dd>
|
|
10849
|
-
|
|
10850
|
-
<dl>
|
|
10851
|
-
<dd>
|
|
10852
|
-
|
|
10853
|
-
```typescript
|
|
10854
|
-
await client.api.thera.tp.tpApi.getTpAccountsForCompany("string");
|
|
10855
|
-
```
|
|
10856
|
-
|
|
10857
|
-
</dd>
|
|
10858
|
-
</dl>
|
|
10859
|
-
</dd>
|
|
10860
|
-
</dl>
|
|
10861
|
-
|
|
10862
|
-
#### ⚙️ Parameters
|
|
10863
|
-
|
|
10864
|
-
<dl>
|
|
10865
|
-
<dd>
|
|
10866
|
-
|
|
10867
|
-
<dl>
|
|
10868
|
-
<dd>
|
|
10869
|
-
|
|
10870
|
-
**companyId:** `string`
|
|
10871
|
-
|
|
10872
|
-
</dd>
|
|
10873
|
-
</dl>
|
|
10874
|
-
|
|
10875
|
-
<dl>
|
|
10876
|
-
<dd>
|
|
10877
|
-
|
|
10878
|
-
**requestOptions:** `TpApi.RequestOptions`
|
|
10879
|
-
|
|
10880
|
-
</dd>
|
|
10881
|
-
</dl>
|
|
10882
|
-
</dd>
|
|
10883
|
-
</dl>
|
|
10884
|
-
|
|
10885
|
-
</dd>
|
|
10886
|
-
</dl>
|
|
10887
|
-
</details>
|
|
10888
|
-
|
|
10889
|
-
<details><summary><code>client.api.thera.tp.tpApi.<a href="/src/api/resources/api/resources/thera/resources/tp/resources/tpApi/client/Client.ts">getTpAccount</a>(companyId, accountId, { ...params }) -> unknown</code></summary>
|
|
10890
|
-
<dl>
|
|
10891
|
-
<dd>
|
|
10892
|
-
|
|
10893
|
-
#### 📝 Description
|
|
10894
|
-
|
|
10895
|
-
<dl>
|
|
10896
|
-
<dd>
|
|
10897
|
-
|
|
10898
|
-
<dl>
|
|
10899
|
-
<dd>
|
|
10900
|
-
|
|
10901
|
-
Get a tp accounts to display the detailed account info
|
|
10902
|
-
|
|
10903
|
-
</dd>
|
|
10904
|
-
</dl>
|
|
10905
|
-
</dd>
|
|
10906
|
-
</dl>
|
|
10907
|
-
|
|
10908
|
-
#### 🔌 Usage
|
|
10909
|
-
|
|
10910
|
-
<dl>
|
|
10911
|
-
<dd>
|
|
10912
|
-
|
|
10913
|
-
<dl>
|
|
10914
|
-
<dd>
|
|
10915
|
-
|
|
10916
|
-
```typescript
|
|
10917
|
-
await client.api.thera.tp.tpApi.getTpAccount("string", "string", {
|
|
10918
|
-
fboType: "PAYROLL",
|
|
10919
|
-
});
|
|
10920
|
-
```
|
|
10921
|
-
|
|
10922
|
-
</dd>
|
|
10923
|
-
</dl>
|
|
10924
|
-
</dd>
|
|
10925
|
-
</dl>
|
|
10926
|
-
|
|
10927
|
-
#### ⚙️ Parameters
|
|
10928
|
-
|
|
10929
|
-
<dl>
|
|
10930
|
-
<dd>
|
|
10931
|
-
|
|
10932
|
-
<dl>
|
|
10933
|
-
<dd>
|
|
10934
|
-
|
|
10935
|
-
**companyId:** `string`
|
|
10936
|
-
|
|
10937
|
-
</dd>
|
|
10938
|
-
</dl>
|
|
10939
|
-
|
|
10940
|
-
<dl>
|
|
10941
|
-
<dd>
|
|
10942
|
-
|
|
10943
|
-
**accountId:** `string`
|
|
10944
|
-
|
|
10945
|
-
</dd>
|
|
10946
|
-
</dl>
|
|
10947
|
-
|
|
10948
|
-
<dl>
|
|
10949
|
-
<dd>
|
|
10950
|
-
|
|
10951
|
-
**request:** `TheraApi.api.thera.tp.TpAccountRequest`
|
|
10952
|
-
|
|
10953
|
-
</dd>
|
|
10954
|
-
</dl>
|
|
10955
|
-
|
|
10956
|
-
<dl>
|
|
10957
|
-
<dd>
|
|
10958
|
-
|
|
10959
|
-
**requestOptions:** `TpApi.RequestOptions`
|
|
10960
|
-
|
|
10961
|
-
</dd>
|
|
10962
|
-
</dl>
|
|
10963
|
-
</dd>
|
|
10964
|
-
</dl>
|
|
10965
|
-
|
|
10966
|
-
</dd>
|
|
10967
|
-
</dl>
|
|
10968
|
-
</details>
|
|
10969
|
-
|
|
10970
|
-
<details><summary><code>client.api.thera.tp.tpApi.<a href="/src/api/resources/api/resources/thera/resources/tp/resources/tpApi/client/Client.ts">transferFundsToOmnibusAccount</a>(companyId, { ...params }) -> unknown</code></summary>
|
|
10971
|
-
<dl>
|
|
10972
|
-
<dd>
|
|
10973
|
-
|
|
10974
|
-
#### 📝 Description
|
|
10975
|
-
|
|
10976
|
-
<dl>
|
|
10977
|
-
<dd>
|
|
10978
|
-
|
|
10979
|
-
<dl>
|
|
10980
|
-
<dd>
|
|
10981
|
-
|
|
10982
|
-
Transfer funds from FBO to omnibus account
|
|
10983
|
-
|
|
10984
|
-
</dd>
|
|
10985
|
-
</dl>
|
|
10986
|
-
</dd>
|
|
10987
|
-
</dl>
|
|
10988
|
-
|
|
10989
|
-
#### 🔌 Usage
|
|
10990
|
-
|
|
10991
|
-
<dl>
|
|
10992
|
-
<dd>
|
|
10993
|
-
|
|
10994
|
-
<dl>
|
|
10995
|
-
<dd>
|
|
10996
|
-
|
|
10997
|
-
```typescript
|
|
10998
|
-
await client.api.thera.tp.tpApi.transferFundsToOmnibusAccount("string", {
|
|
10999
|
-
amount: "string",
|
|
11000
|
-
sourceAccountId: "string",
|
|
11001
|
-
});
|
|
11002
|
-
```
|
|
11003
|
-
|
|
11004
|
-
</dd>
|
|
11005
|
-
</dl>
|
|
11006
|
-
</dd>
|
|
11007
|
-
</dl>
|
|
11008
|
-
|
|
11009
|
-
#### ⚙️ Parameters
|
|
11010
|
-
|
|
11011
|
-
<dl>
|
|
11012
|
-
<dd>
|
|
11013
|
-
|
|
11014
|
-
<dl>
|
|
11015
|
-
<dd>
|
|
11016
|
-
|
|
11017
|
-
**companyId:** `string`
|
|
11018
|
-
|
|
11019
|
-
</dd>
|
|
11020
|
-
</dl>
|
|
11021
|
-
|
|
11022
|
-
<dl>
|
|
11023
|
-
<dd>
|
|
11024
|
-
|
|
11025
|
-
**request:** `TheraApi.TransferFundsToOmnibusAccount`
|
|
11026
|
-
|
|
11027
|
-
</dd>
|
|
11028
|
-
</dl>
|
|
11029
|
-
|
|
11030
|
-
<dl>
|
|
11031
|
-
<dd>
|
|
11032
|
-
|
|
11033
|
-
**requestOptions:** `TpApi.RequestOptions`
|
|
11034
|
-
|
|
11035
|
-
</dd>
|
|
11036
|
-
</dl>
|
|
11037
|
-
</dd>
|
|
11038
|
-
</dl>
|
|
11039
|
-
|
|
11040
|
-
</dd>
|
|
11041
|
-
</dl>
|
|
11042
|
-
</details>
|
|
11043
|
-
|
|
11044
|
-
<details><summary><code>client.api.thera.tp.tpApi.<a href="/src/api/resources/api/resources/thera/resources/tp/resources/tpApi/client/Client.ts">transactionHistory</a>(companyId, accountId) -> TheraApi.TpTransactionHistory[]</code></summary>
|
|
11045
|
-
<dl>
|
|
11046
|
-
<dd>
|
|
11047
|
-
|
|
11048
|
-
#### 📝 Description
|
|
11049
|
-
|
|
11050
|
-
<dl>
|
|
11051
|
-
<dd>
|
|
11052
|
-
|
|
11053
|
-
<dl>
|
|
11054
|
-
<dd>
|
|
11055
|
-
|
|
11056
|
-
Get all account Transactions
|
|
11057
|
-
|
|
11058
|
-
</dd>
|
|
11059
|
-
</dl>
|
|
11060
|
-
</dd>
|
|
11061
|
-
</dl>
|
|
11062
|
-
|
|
11063
|
-
#### 🔌 Usage
|
|
11064
|
-
|
|
11065
|
-
<dl>
|
|
11066
|
-
<dd>
|
|
11067
|
-
|
|
11068
|
-
<dl>
|
|
11069
|
-
<dd>
|
|
11070
|
-
|
|
11071
|
-
```typescript
|
|
11072
|
-
await client.api.thera.tp.tpApi.transactionHistory("string", "string");
|
|
11073
|
-
```
|
|
11074
|
-
|
|
11075
|
-
</dd>
|
|
11076
|
-
</dl>
|
|
11077
|
-
</dd>
|
|
11078
|
-
</dl>
|
|
11079
|
-
|
|
11080
|
-
#### ⚙️ Parameters
|
|
11081
|
-
|
|
11082
|
-
<dl>
|
|
11083
|
-
<dd>
|
|
11084
|
-
|
|
11085
|
-
<dl>
|
|
11086
|
-
<dd>
|
|
11087
|
-
|
|
11088
|
-
**companyId:** `string`
|
|
11089
|
-
|
|
11090
|
-
</dd>
|
|
11091
|
-
</dl>
|
|
11092
|
-
|
|
11093
|
-
<dl>
|
|
11094
|
-
<dd>
|
|
11095
|
-
|
|
11096
|
-
**accountId:** `string`
|
|
11097
|
-
|
|
11098
|
-
</dd>
|
|
11099
|
-
</dl>
|
|
11100
|
-
|
|
11101
|
-
<dl>
|
|
11102
|
-
<dd>
|
|
11103
|
-
|
|
11104
|
-
**requestOptions:** `TpApi.RequestOptions`
|
|
11105
|
-
|
|
11106
|
-
</dd>
|
|
11107
|
-
</dl>
|
|
11108
|
-
</dd>
|
|
11109
|
-
</dl>
|
|
11110
|
-
|
|
11111
|
-
</dd>
|
|
11112
|
-
</dl>
|
|
11113
|
-
</details>
|
|
11114
|
-
|
|
11115
|
-
<details><summary><code>client.api.thera.tp.tpApi.<a href="/src/api/resources/api/resources/thera/resources/tp/resources/tpApi/client/Client.ts">deatiledTpTransaction</a>(companyId, transactionId) -> TheraApi.TpTransactionHistory</code></summary>
|
|
11116
|
-
<dl>
|
|
11117
|
-
<dd>
|
|
11118
|
-
|
|
11119
|
-
#### 📝 Description
|
|
11120
|
-
|
|
11121
|
-
<dl>
|
|
11122
|
-
<dd>
|
|
11123
|
-
|
|
11124
|
-
<dl>
|
|
11125
|
-
<dd>
|
|
11126
|
-
|
|
11127
|
-
Get a detailed account transaction
|
|
11128
|
-
|
|
11129
|
-
</dd>
|
|
11130
|
-
</dl>
|
|
11131
|
-
</dd>
|
|
11132
|
-
</dl>
|
|
11133
|
-
|
|
11134
|
-
#### 🔌 Usage
|
|
11135
|
-
|
|
11136
|
-
<dl>
|
|
11137
|
-
<dd>
|
|
11138
|
-
|
|
11139
|
-
<dl>
|
|
11140
|
-
<dd>
|
|
11141
|
-
|
|
11142
|
-
```typescript
|
|
11143
|
-
await client.api.thera.tp.tpApi.deatiledTpTransaction("string", "string");
|
|
11144
|
-
```
|
|
11145
|
-
|
|
11146
|
-
</dd>
|
|
11147
|
-
</dl>
|
|
11148
|
-
</dd>
|
|
11149
|
-
</dl>
|
|
11150
|
-
|
|
11151
|
-
#### ⚙️ Parameters
|
|
11152
|
-
|
|
11153
|
-
<dl>
|
|
11154
|
-
<dd>
|
|
11155
|
-
|
|
11156
|
-
<dl>
|
|
11157
|
-
<dd>
|
|
11158
|
-
|
|
11159
|
-
**companyId:** `string`
|
|
11160
|
-
|
|
11161
|
-
</dd>
|
|
11162
|
-
</dl>
|
|
11163
|
-
|
|
11164
|
-
<dl>
|
|
11165
|
-
<dd>
|
|
11166
|
-
|
|
11167
|
-
**transactionId:** `string`
|
|
11168
|
-
|
|
11169
|
-
</dd>
|
|
11170
|
-
</dl>
|
|
11171
|
-
|
|
11172
|
-
<dl>
|
|
11173
|
-
<dd>
|
|
11174
|
-
|
|
11175
|
-
**requestOptions:** `TpApi.RequestOptions`
|
|
11176
|
-
|
|
11177
|
-
</dd>
|
|
11178
|
-
</dl>
|
|
11179
|
-
</dd>
|
|
11180
|
-
</dl>
|
|
11181
|
-
|
|
11182
|
-
</dd>
|
|
11183
|
-
</dl>
|
|
11184
|
-
</details>
|
|
11185
|
-
|
|
11186
|
-
<details><summary><code>client.api.thera.tp.tpApi.<a href="/src/api/resources/api/resources/thera/resources/tp/resources/tpApi/client/Client.ts">externalTransferFund</a>({ ...params }) -> unknown</code></summary>
|
|
11187
|
-
<dl>
|
|
11188
|
-
<dd>
|
|
11189
|
-
|
|
11190
|
-
#### 📝 Description
|
|
11191
|
-
|
|
11192
|
-
<dl>
|
|
11193
|
-
<dd>
|
|
11194
|
-
|
|
11195
|
-
<dl>
|
|
11196
|
-
<dd>
|
|
11197
|
-
|
|
11198
|
-
Use for sending funds to wise/dlocal from omnibus Account
|
|
11199
|
-
|
|
11200
|
-
</dd>
|
|
11201
|
-
</dl>
|
|
11202
|
-
</dd>
|
|
11203
|
-
</dl>
|
|
11204
|
-
|
|
11205
|
-
#### 🔌 Usage
|
|
11206
|
-
|
|
11207
|
-
<dl>
|
|
11208
|
-
<dd>
|
|
11209
|
-
|
|
11210
|
-
<dl>
|
|
11211
|
-
<dd>
|
|
11212
|
-
|
|
11213
|
-
```typescript
|
|
11214
|
-
await client.api.thera.tp.tpApi.externalTransferFund({
|
|
11215
|
-
password: "string",
|
|
11216
|
-
body: {
|
|
11217
|
-
amount: "string",
|
|
11218
|
-
routingNumber: "string",
|
|
11219
|
-
accountNumber: "string",
|
|
11220
|
-
externalFundTransferCode: "string",
|
|
11221
|
-
consumer: "string",
|
|
11222
|
-
},
|
|
11223
|
-
});
|
|
11224
|
-
```
|
|
11225
|
-
|
|
11226
|
-
</dd>
|
|
11227
|
-
</dl>
|
|
11228
|
-
</dd>
|
|
11229
|
-
</dl>
|
|
11230
|
-
|
|
11231
|
-
#### ⚙️ Parameters
|
|
11232
|
-
|
|
11233
|
-
<dl>
|
|
11234
|
-
<dd>
|
|
11235
|
-
|
|
11236
|
-
<dl>
|
|
11237
|
-
<dd>
|
|
11238
|
-
|
|
11239
|
-
**request:** `TheraApi.api.thera.tp.ExternalTransferFundRequest`
|
|
11240
|
-
|
|
11241
|
-
</dd>
|
|
11242
|
-
</dl>
|
|
11243
|
-
|
|
11244
|
-
<dl>
|
|
11245
|
-
<dd>
|
|
11246
|
-
|
|
11247
|
-
**requestOptions:** `TpApi.RequestOptions`
|
|
11248
|
-
|
|
11249
|
-
</dd>
|
|
11250
|
-
</dl>
|
|
11251
|
-
</dd>
|
|
11252
|
-
</dl>
|
|
11253
|
-
|
|
11254
|
-
</dd>
|
|
11255
|
-
</dl>
|
|
11256
|
-
</details>
|
|
11257
|
-
|
|
11258
|
-
<details><summary><code>client.api.thera.tp.tpApi.<a href="/src/api/resources/api/resources/thera/resources/tp/resources/tpApi/client/Client.ts">withdrawalTheraCash</a>(companyId, { ...params }) -> unknown</code></summary>
|
|
11259
|
-
<dl>
|
|
11260
|
-
<dd>
|
|
11261
|
-
|
|
11262
|
-
#### 📝 Description
|
|
11263
|
-
|
|
11264
|
-
<dl>
|
|
11265
|
-
<dd>
|
|
11266
|
-
|
|
11267
|
-
<dl>
|
|
11268
|
-
<dd>
|
|
11269
|
-
|
|
11270
|
-
Withdrawal funds from thera cash to user's personal account via ach or wire
|
|
11271
|
-
|
|
11272
|
-
</dd>
|
|
11273
|
-
</dl>
|
|
11274
|
-
</dd>
|
|
11275
|
-
</dl>
|
|
11276
|
-
|
|
11277
|
-
#### 🔌 Usage
|
|
11278
|
-
|
|
11279
|
-
<dl>
|
|
11280
|
-
<dd>
|
|
11281
|
-
|
|
11282
|
-
<dl>
|
|
11283
|
-
<dd>
|
|
11284
|
-
|
|
11285
|
-
```typescript
|
|
11286
|
-
await client.api.thera.tp.tpApi.withdrawalTheraCash("string", {
|
|
11287
|
-
nameOnAccount: "string",
|
|
11288
|
-
amount: "string",
|
|
11289
|
-
ach: {
|
|
11290
|
-
accountNumber: "string",
|
|
11291
|
-
accountType: "string",
|
|
11292
|
-
routingNumber: "string",
|
|
11293
|
-
},
|
|
11294
|
-
wire: {
|
|
11295
|
-
accountNumber: "string",
|
|
11296
|
-
routingNumber: "string",
|
|
11297
|
-
addressOnAccount: {
|
|
11298
|
-
streetLine1: "string",
|
|
11299
|
-
streetLine2: "string",
|
|
11300
|
-
city: "string",
|
|
11301
|
-
state: "string",
|
|
11302
|
-
postalCode: "string",
|
|
11303
|
-
country: "string",
|
|
11304
|
-
},
|
|
11305
|
-
bankName: "string",
|
|
11306
|
-
bankAddress: {
|
|
11307
|
-
streetLine1: "string",
|
|
11308
|
-
streetLine2: "string",
|
|
11309
|
-
city: "string",
|
|
11310
|
-
state: "string",
|
|
11311
|
-
postalCode: "string",
|
|
11312
|
-
country: "string",
|
|
11313
|
-
},
|
|
11314
|
-
},
|
|
11315
|
-
});
|
|
11316
|
-
```
|
|
11317
|
-
|
|
11318
|
-
</dd>
|
|
11319
|
-
</dl>
|
|
11320
|
-
</dd>
|
|
11321
|
-
</dl>
|
|
11322
|
-
|
|
11323
|
-
#### ⚙️ Parameters
|
|
11324
|
-
|
|
11325
|
-
<dl>
|
|
11326
|
-
<dd>
|
|
11327
|
-
|
|
11328
|
-
<dl>
|
|
11329
|
-
<dd>
|
|
11330
|
-
|
|
11331
|
-
**companyId:** `string`
|
|
11332
|
-
|
|
11333
|
-
</dd>
|
|
11334
|
-
</dl>
|
|
11335
|
-
|
|
11336
|
-
<dl>
|
|
11337
|
-
<dd>
|
|
11338
|
-
|
|
11339
|
-
**request:** `TheraApi.WithdrawalTheraCash`
|
|
11340
|
-
|
|
11341
|
-
</dd>
|
|
11342
|
-
</dl>
|
|
11343
|
-
|
|
11344
|
-
<dl>
|
|
11345
|
-
<dd>
|
|
11346
|
-
|
|
11347
|
-
**requestOptions:** `TpApi.RequestOptions`
|
|
11348
|
-
|
|
11349
|
-
</dd>
|
|
11350
|
-
</dl>
|
|
11351
|
-
</dd>
|
|
11352
|
-
</dl>
|
|
11353
|
-
|
|
11354
|
-
</dd>
|
|
11355
|
-
</dl>
|
|
11356
|
-
</details>
|
|
11357
|
-
|
|
11358
|
-
## User API
|
|
11359
|
-
|
|
11360
|
-
<details><summary><code>client.api.thera.user.userApi.<a href="/src/api/resources/api/resources/thera/resources/user/resources/userApi/client/Client.ts">setUserComplianceSetting</a>(userId, companyId, { ...params }) -> void</code></summary>
|
|
11361
|
-
<dl>
|
|
11362
|
-
<dd>
|
|
11363
|
-
|
|
11364
|
-
#### 📝 Description
|
|
11365
|
-
|
|
11366
|
-
<dl>
|
|
11367
|
-
<dd>
|
|
11368
|
-
|
|
11369
|
-
<dl>
|
|
11370
|
-
<dd>
|
|
11371
|
-
|
|
11372
|
-
Set User Compliance Setting (KYC and Compliance docs)
|
|
11373
|
-
|
|
11374
|
-
</dd>
|
|
11375
|
-
</dl>
|
|
11376
|
-
</dd>
|
|
11377
|
-
</dl>
|
|
11378
|
-
|
|
11379
|
-
#### 🔌 Usage
|
|
11380
|
-
|
|
11381
|
-
<dl>
|
|
11382
|
-
<dd>
|
|
11383
|
-
|
|
11384
|
-
<dl>
|
|
11385
|
-
<dd>
|
|
11386
|
-
|
|
11387
|
-
```typescript
|
|
11388
|
-
await client.api.thera.user.userApi.setUserComplianceSetting("string", "string", {
|
|
11389
|
-
teamId: "string",
|
|
11390
|
-
kycEnabled: true,
|
|
11391
|
-
complianceDocsEnabled: true,
|
|
11392
|
-
});
|
|
11393
|
-
```
|
|
11394
|
-
|
|
11395
|
-
</dd>
|
|
11396
|
-
</dl>
|
|
11397
|
-
</dd>
|
|
11398
|
-
</dl>
|
|
11399
|
-
|
|
11400
|
-
#### ⚙️ Parameters
|
|
11401
|
-
|
|
11402
|
-
<dl>
|
|
11403
|
-
<dd>
|
|
11404
|
-
|
|
11405
|
-
<dl>
|
|
11406
|
-
<dd>
|
|
11407
|
-
|
|
11408
|
-
**userId:** `string`
|
|
11409
|
-
|
|
11410
|
-
</dd>
|
|
11411
|
-
</dl>
|
|
11412
|
-
|
|
11413
|
-
<dl>
|
|
11414
|
-
<dd>
|
|
11415
|
-
|
|
11416
|
-
**companyId:** `string`
|
|
11417
|
-
|
|
11418
|
-
</dd>
|
|
11419
|
-
</dl>
|
|
11420
|
-
|
|
11421
|
-
<dl>
|
|
11422
|
-
<dd>
|
|
11423
|
-
|
|
11424
|
-
**request:** `TheraApi.SetUserComplianceSettingsRequest`
|
|
11425
|
-
|
|
11426
|
-
</dd>
|
|
11427
|
-
</dl>
|
|
11428
|
-
|
|
11429
|
-
<dl>
|
|
11430
|
-
<dd>
|
|
11431
|
-
|
|
11432
|
-
**requestOptions:** `UserApi.RequestOptions`
|
|
11433
|
-
|
|
11434
|
-
</dd>
|
|
11435
|
-
</dl>
|
|
11436
|
-
</dd>
|
|
11437
|
-
</dl>
|
|
11438
|
-
|
|
11439
|
-
</dd>
|
|
11440
|
-
</dl>
|
|
11441
|
-
</details>
|
|
11442
|
-
|
|
11443
|
-
<details><summary><code>client.api.thera.user.userApi.<a href="/src/api/resources/api/resources/thera/resources/user/resources/userApi/client/Client.ts">getComplianceUserSetting</a>(companyId, { ...params }) -> TheraApi.GetUserComplianceSettingsResponse</code></summary>
|
|
11444
|
-
<dl>
|
|
11445
|
-
<dd>
|
|
11446
|
-
|
|
11447
|
-
#### 📝 Description
|
|
11448
|
-
|
|
11449
|
-
<dl>
|
|
11450
|
-
<dd>
|
|
11451
|
-
|
|
11452
|
-
<dl>
|
|
11453
|
-
<dd>
|
|
11454
|
-
|
|
11455
|
-
Get Compliance User Setting (KYC and Compliance docs). How it works: 1. If ANY of the created contract has KYC or Compliance setting enabled, then the respective setting for that user will be considered as enabled. 2. If ALL of the contracts has KYC or Compliant Setting disabled, then the respective setting for that user is disabled In the future, this API will accept team ID.
|
|
11456
|
-
|
|
11457
|
-
</dd>
|
|
11458
|
-
</dl>
|
|
11459
|
-
</dd>
|
|
11460
|
-
</dl>
|
|
11461
|
-
|
|
11462
|
-
#### 🔌 Usage
|
|
11463
|
-
|
|
11464
|
-
<dl>
|
|
11465
|
-
<dd>
|
|
11466
|
-
|
|
11467
|
-
<dl>
|
|
11468
|
-
<dd>
|
|
11469
|
-
|
|
11470
|
-
```typescript
|
|
11471
|
-
await client.api.thera.user.userApi.getComplianceUserSetting("string", {
|
|
11472
|
-
userId: "string",
|
|
11473
|
-
email: "string",
|
|
11474
|
-
});
|
|
11475
|
-
```
|
|
11476
|
-
|
|
11477
|
-
</dd>
|
|
11478
|
-
</dl>
|
|
11479
|
-
</dd>
|
|
11480
|
-
</dl>
|
|
11481
|
-
|
|
11482
|
-
#### ⚙️ Parameters
|
|
11483
|
-
|
|
11484
|
-
<dl>
|
|
11485
|
-
<dd>
|
|
11486
|
-
|
|
11487
|
-
<dl>
|
|
11488
|
-
<dd>
|
|
11489
|
-
|
|
11490
|
-
**companyId:** `string`
|
|
11491
|
-
|
|
11492
|
-
</dd>
|
|
11493
|
-
</dl>
|
|
11494
|
-
|
|
11495
|
-
<dl>
|
|
11496
|
-
<dd>
|
|
11497
|
-
|
|
11498
|
-
**request:** `TheraApi.api.thera.user.GetUserComplianceSettingsRequest`
|
|
11499
|
-
|
|
11500
|
-
</dd>
|
|
11501
|
-
</dl>
|
|
11502
|
-
|
|
11503
|
-
<dl>
|
|
11504
|
-
<dd>
|
|
11505
|
-
|
|
11506
|
-
**requestOptions:** `UserApi.RequestOptions`
|
|
11507
|
-
|
|
11508
|
-
</dd>
|
|
11509
|
-
</dl>
|
|
11510
|
-
</dd>
|
|
11511
|
-
</dl>
|
|
11512
|
-
|
|
11513
|
-
</dd>
|
|
11514
|
-
</dl>
|
|
11515
|
-
</details>
|
|
11516
|
-
|
|
11517
|
-
<details><summary><code>client.api.thera.user.userApi.<a href="/src/api/resources/api/resources/thera/resources/user/resources/userApi/client/Client.ts">getUser</a>({ ...params }) -> TheraApi.User</code></summary>
|
|
11518
|
-
<dl>
|
|
11519
|
-
<dd>
|
|
11520
|
-
|
|
11521
|
-
#### 📝 Description
|
|
11522
|
-
|
|
11523
|
-
<dl>
|
|
11524
|
-
<dd>
|
|
11525
|
-
|
|
11526
|
-
<dl>
|
|
11527
|
-
<dd>
|
|
11528
|
-
|
|
11529
|
-
Get User API
|
|
11530
|
-
|
|
11531
|
-
</dd>
|
|
11532
|
-
</dl>
|
|
11533
|
-
</dd>
|
|
11534
|
-
</dl>
|
|
11535
|
-
|
|
11536
|
-
#### 🔌 Usage
|
|
11537
|
-
|
|
11538
|
-
<dl>
|
|
11539
|
-
<dd>
|
|
11540
|
-
|
|
11541
|
-
<dl>
|
|
11542
|
-
<dd>
|
|
11543
|
-
|
|
11544
|
-
```typescript
|
|
11545
|
-
await client.api.thera.user.userApi.getUser({
|
|
11546
|
-
userId: "string",
|
|
11547
|
-
});
|
|
11548
|
-
```
|
|
11549
|
-
|
|
11550
|
-
</dd>
|
|
11551
|
-
</dl>
|
|
11552
|
-
</dd>
|
|
11553
|
-
</dl>
|
|
11554
|
-
|
|
11555
|
-
#### ⚙️ Parameters
|
|
11556
|
-
|
|
11557
|
-
<dl>
|
|
11558
|
-
<dd>
|
|
11559
|
-
|
|
11560
|
-
<dl>
|
|
11561
|
-
<dd>
|
|
11562
|
-
|
|
11563
|
-
**request:** `TheraApi.api.thera.user.GetUserRequest`
|
|
11564
|
-
|
|
11565
|
-
</dd>
|
|
11566
|
-
</dl>
|
|
11567
|
-
|
|
11568
|
-
<dl>
|
|
11569
|
-
<dd>
|
|
11570
|
-
|
|
11571
|
-
**requestOptions:** `UserApi.RequestOptions`
|
|
11572
|
-
|
|
11573
|
-
</dd>
|
|
11574
|
-
</dl>
|
|
11575
|
-
</dd>
|
|
11576
|
-
</dl>
|
|
11577
|
-
|
|
11578
|
-
</dd>
|
|
11579
|
-
</dl>
|
|
11580
|
-
</details>
|