@pidginhost/sdk 0.2.0
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/.openapi-generator/FILES +223 -0
- package/.openapi-generator/VERSION +1 -0
- package/.openapi-generator-ignore +23 -0
- package/README.md +727 -0
- package/api.ts +33802 -0
- package/base.ts +62 -0
- package/common.ts +128 -0
- package/configuration.ts +121 -0
- package/dist/api.d.ts +15244 -0
- package/dist/api.js +30223 -0
- package/dist/base.d.ts +42 -0
- package/dist/base.js +46 -0
- package/dist/common.d.ts +35 -0
- package/dist/common.js +140 -0
- package/dist/configuration.d.ts +98 -0
- package/dist/configuration.js +44 -0
- package/dist/esm/api.d.ts +15244 -0
- package/dist/esm/api.js +30179 -0
- package/dist/esm/base.d.ts +42 -0
- package/dist/esm/base.js +41 -0
- package/dist/esm/common.d.ts +35 -0
- package/dist/esm/common.js +127 -0
- package/dist/esm/configuration.d.ts +98 -0
- package/dist/esm/configuration.js +40 -0
- package/dist/esm/index.d.ts +14 -0
- package/dist/esm/index.js +16 -0
- package/dist/esm/pidginhost.d.ts +8 -0
- package/dist/esm/pidginhost.js +13 -0
- package/dist/index.d.ts +14 -0
- package/dist/index.js +34 -0
- package/dist/pidginhost.d.ts +8 -0
- package/dist/pidginhost.js +17 -0
- package/docs/APITokenCreate.md +28 -0
- package/docs/APITokenList.md +32 -0
- package/docs/AccountApi.md +1999 -0
- package/docs/ActivateFreeDNS.md +24 -0
- package/docs/ActivateFreeDNSResponse.md +24 -0
- package/docs/ActivityLogEntry.md +22 -0
- package/docs/ActivityLogResponse.md +20 -0
- package/docs/AddServerResponse.md +20 -0
- package/docs/Address.md +34 -0
- package/docs/AttachIPv4.md +20 -0
- package/docs/AttachIPv6.md +20 -0
- package/docs/AttachVolume.md +20 -0
- package/docs/BillingApi.md +1885 -0
- package/docs/CancelServiceResponse.md +22 -0
- package/docs/ChangeBillingCycle.md +20 -0
- package/docs/ChangeBillingCycleResponse.md +22 -0
- package/docs/ChangeCompany.md +20 -0
- package/docs/ChangeCompanyResponse.md +22 -0
- package/docs/ChangePassword.md +20 -0
- package/docs/CheckAvailability.md +20 -0
- package/docs/CloudApi.md +8433 -0
- package/docs/ClusterAdd.md +32 -0
- package/docs/ClusterAddResponse.md +20 -0
- package/docs/ClusterDetail.md +48 -0
- package/docs/ClusterPackage.md +24 -0
- package/docs/ClusterType.md +26 -0
- package/docs/ClusterTypeEnum.md +11 -0
- package/docs/Company.md +36 -0
- package/docs/ConnectVMRequest.md +20 -0
- package/docs/ConnectVMResponse.md +22 -0
- package/docs/ConnectedVM.md +24 -0
- package/docs/ConnectedVMsResponse.md +20 -0
- package/docs/ConsoleToken.md +22 -0
- package/docs/ContactTypeEnum.md +15 -0
- package/docs/ContactsUpdate.md +22 -0
- package/docs/ContactsUpdateResponse.md +20 -0
- package/docs/CountryEnum.md +515 -0
- package/docs/DNSRecord.md +53 -0
- package/docs/DNSRecordCreate.md +53 -0
- package/docs/DNSRecordCreateTypeEnum.md +21 -0
- package/docs/DNSRecordMutateResponse.md +22 -0
- package/docs/DeactivateFreeDNS.md +22 -0
- package/docs/DeactivateFreeDNSResponse.md +20 -0
- package/docs/DedicatedApi.md +551 -0
- package/docs/DedicatedRDNS.md +22 -0
- package/docs/DedicatedServer.md +39 -0
- package/docs/DeleteRecord.md +20 -0
- package/docs/DeleteRecordResponse.md +22 -0
- package/docs/Department.md +22 -0
- package/docs/Deposit.md +32 -0
- package/docs/DepositCreate.md +20 -0
- package/docs/DepositStatusEnum.md +15 -0
- package/docs/DestroyProtection.md +20 -0
- package/docs/DetachIPv4.md +20 -0
- package/docs/DetachIPv4Response.md +20 -0
- package/docs/DetachIPv6.md +20 -0
- package/docs/DetachIPv6Response.md +20 -0
- package/docs/DetachVolume.md +20 -0
- package/docs/DisconnectVMRequest.md +20 -0
- package/docs/DisconnectVMResponse.md +22 -0
- package/docs/Domain.md +42 -0
- package/docs/DomainApi.md +2047 -0
- package/docs/DomainCancelResponse.md +22 -0
- package/docs/DomainCreate.md +24 -0
- package/docs/DomainRegistrant.md +44 -0
- package/docs/EmailHistory.md +28 -0
- package/docs/FeatureUpgradeRequest.md +22 -0
- package/docs/FeatureUpgradeResponse.md +22 -0
- package/docs/FeaturesEnum.md +17 -0
- package/docs/FirewallRule.md +42 -0
- package/docs/FirewallRuleDirectionEnum.md +11 -0
- package/docs/FirewallRulesSet.md +28 -0
- package/docs/FirewallRulesSetStatusEnum.md +13 -0
- package/docs/FreeDNSDomain.md +24 -0
- package/docs/FreednsApi.md +655 -0
- package/docs/FundsBalanceResponse.md +26 -0
- package/docs/FundsLog.md +30 -0
- package/docs/FwPolicyOutEnum.md +13 -0
- package/docs/HTTPRoute.md +45 -0
- package/docs/HostingApi.md +327 -0
- package/docs/HostingChangePasswordResponse.md +20 -0
- package/docs/HostingService.md +39 -0
- package/docs/InvoiceDetail.md +50 -0
- package/docs/InvoiceList.md +40 -0
- package/docs/KubeUpgradeResponse.md +20 -0
- package/docs/KubeVersionEnum.md +13 -0
- package/docs/KubernetesApi.md +6209 -0
- package/docs/LBFirewallRule.md +44 -0
- package/docs/LBFirewallRuleActionEnum.md +13 -0
- package/docs/LBFirewallRuleDirectionEnum.md +11 -0
- package/docs/LowBalanceSettings.md +24 -0
- package/docs/NameserversUpdate.md +20 -0
- package/docs/NameserversUpdateResponse.md +20 -0
- package/docs/NodeMetricsResponse.md +32 -0
- package/docs/NodeRRDResponse.md +22 -0
- package/docs/NotificationSettingsResponse.md +26 -0
- package/docs/OSImage.md +28 -0
- package/docs/OperationEnum.md +27 -0
- package/docs/PaginatedAPITokenListList.md +26 -0
- package/docs/PaginatedClusterDetailList.md +26 -0
- package/docs/PaginatedClusterTypeList.md +26 -0
- package/docs/PaginatedCompanyList.md +26 -0
- package/docs/PaginatedDedicatedServerList.md +26 -0
- package/docs/PaginatedDepositList.md +26 -0
- package/docs/PaginatedDomainList.md +26 -0
- package/docs/PaginatedDomainRegistrantList.md +26 -0
- package/docs/PaginatedEmailHistoryList.md +26 -0
- package/docs/PaginatedFundsLogList.md +26 -0
- package/docs/PaginatedHostingServiceList.md +26 -0
- package/docs/PaginatedInvoiceListList.md +26 -0
- package/docs/PaginatedLBFirewallRuleList.md +26 -0
- package/docs/PaginatedOSImageList.md +26 -0
- package/docs/PaginatedPrivateNetworkList.md +26 -0
- package/docs/PaginatedPublicIPv4List.md +26 -0
- package/docs/PaginatedPublicIPv6List.md +26 -0
- package/docs/PaginatedResourcePoolList.md +26 -0
- package/docs/PaginatedResourcePoolNodeList.md +26 -0
- package/docs/PaginatedSSHKeyList.md +26 -0
- package/docs/PaginatedServerList.md +26 -0
- package/docs/PaginatedServerProductList.md +26 -0
- package/docs/PaginatedServiceListList.md +26 -0
- package/docs/PaginatedSnapshotList.md +26 -0
- package/docs/PaginatedStorageProductList.md +26 -0
- package/docs/PaginatedSubscriptionList.md +26 -0
- package/docs/PaginatedTLDList.md +26 -0
- package/docs/PaginatedTicketListList.md +26 -0
- package/docs/PatchedClusterDetail.md +48 -0
- package/docs/PatchedCompany.md +36 -0
- package/docs/PatchedDomain.md +42 -0
- package/docs/PatchedDomainRegistrant.md +44 -0
- package/docs/PatchedFirewallRule.md +42 -0
- package/docs/PatchedFirewallRulesSet.md +28 -0
- package/docs/PatchedHTTPRoute.md +45 -0
- package/docs/PatchedLBFirewallRule.md +44 -0
- package/docs/PatchedPrivateNetwork.md +30 -0
- package/docs/PatchedProfile.md +26 -0
- package/docs/PatchedResourcePool.md +28 -0
- package/docs/PatchedSSHKey.md +26 -0
- package/docs/PatchedTCPRoute.md +41 -0
- package/docs/PatchedUDPRoute.md +41 -0
- package/docs/PatchedVolume.md +32 -0
- package/docs/PayWithFundsResponse.md +22 -0
- package/docs/PowerAction.md +20 -0
- package/docs/PowerActionActionEnum.md +15 -0
- package/docs/PowerActionResponse.md +20 -0
- package/docs/PowerManagement.md +20 -0
- package/docs/PowerManagementRequest.md +20 -0
- package/docs/PowerManagementRequestActionEnum.md +15 -0
- package/docs/Priority3cdEnum.md +13 -0
- package/docs/PrivateNetwork.md +30 -0
- package/docs/PrivateNetworkAddHost.md +22 -0
- package/docs/PrivateNetworkRemoveHost.md +20 -0
- package/docs/Profile.md +26 -0
- package/docs/PublicIPv4.md +32 -0
- package/docs/PublicIPv6.md +32 -0
- package/docs/PublicInterface.md +30 -0
- package/docs/RDNSUpdateResponse.md +20 -0
- package/docs/Reinstall.md +20 -0
- package/docs/ReinstallResponse.md +20 -0
- package/docs/RemoveServerResponse.md +20 -0
- package/docs/RenewDomain.md +20 -0
- package/docs/ResourcePool.md +28 -0
- package/docs/ResourcePoolAdd.md +22 -0
- package/docs/ResourcePoolAddResponse.md +20 -0
- package/docs/ResourcePoolNode.md +24 -0
- package/docs/RetryProvision.md +20 -0
- package/docs/ReverseDNS.md +20 -0
- package/docs/SSHKey.md +26 -0
- package/docs/SchemaApi.md +117 -0
- package/docs/ScopeEnum.md +11 -0
- package/docs/Server.md +42 -0
- package/docs/ServerAdd.md +58 -0
- package/docs/ServerAddResponse.md +20 -0
- package/docs/ServerProduct.md +24 -0
- package/docs/ServerProductUpgrade.md +20 -0
- package/docs/ServerUpgradeResponse.md +20 -0
- package/docs/ServerUsageResponse.md +28 -0
- package/docs/Service.md +40 -0
- package/docs/ServiceList.md +36 -0
- package/docs/Snapshot.md +30 -0
- package/docs/SnapshotCreate.md +24 -0
- package/docs/SnapshotCreateQueued.md +20 -0
- package/docs/SnapshotDeleteQueued.md +20 -0
- package/docs/SnapshotRollbackQueued.md +20 -0
- package/docs/SourceEnum.md +11 -0
- package/docs/Status03cEnum.md +21 -0
- package/docs/Status63aEnum.md +23 -0
- package/docs/StatusA57Enum.md +31 -0
- package/docs/StatusEf2Enum.md +15 -0
- package/docs/StorageProduct.md +34 -0
- package/docs/Subscription.md +34 -0
- package/docs/SubscriptionStatusEnum.md +15 -0
- package/docs/SupportApi.md +841 -0
- package/docs/TCPRoute.md +41 -0
- package/docs/TLD.md +38 -0
- package/docs/TalosUpgradeResponse.md +20 -0
- package/docs/ThresholdTypeEnum.md +13 -0
- package/docs/TicketCloseResponse.md +22 -0
- package/docs/TicketCreate.md +30 -0
- package/docs/TicketCreatePriorityEnum.md +13 -0
- package/docs/TicketDetail.md +34 -0
- package/docs/TicketList.md +32 -0
- package/docs/TicketReopenResponse.md +22 -0
- package/docs/TicketReply.md +22 -0
- package/docs/TicketReplyResponse.md +20 -0
- package/docs/ToggleAutoPaymentResponse.md +22 -0
- package/docs/TransferRoDomain.md +22 -0
- package/docs/Type2faEnum.md +11 -0
- package/docs/UDPRoute.md +41 -0
- package/docs/Volume.md +32 -0
- package/git_push.sh +57 -0
- package/index.ts +19 -0
- package/package.json +33 -0
- package/pidginhost.ts +20 -0
- package/tsconfig.esm.json +7 -0
- package/tsconfig.json +18 -0
|
@@ -0,0 +1,1999 @@
|
|
|
1
|
+
# AccountApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://www.pidginhost.com*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**accountApiTokensCreate**](#accountapitokenscreate) | **POST** /api/account/api-tokens/ | |
|
|
8
|
+
|[**accountApiTokensCreate2**](#accountapitokenscreate2) | **POST** /api/v1/account/api-tokens/ | |
|
|
9
|
+
|[**accountApiTokensDestroy**](#accountapitokensdestroy) | **DELETE** /api/account/api-tokens/{id}/ | |
|
|
10
|
+
|[**accountApiTokensDestroy2**](#accountapitokensdestroy2) | **DELETE** /api/v1/account/api-tokens/{id}/ | |
|
|
11
|
+
|[**accountApiTokensList**](#accountapitokenslist) | **GET** /api/account/api-tokens/ | |
|
|
12
|
+
|[**accountApiTokensList2**](#accountapitokenslist2) | **GET** /api/v1/account/api-tokens/ | |
|
|
13
|
+
|[**accountCompaniesCreate**](#accountcompaniescreate) | **POST** /api/account/companies/ | |
|
|
14
|
+
|[**accountCompaniesCreate2**](#accountcompaniescreate2) | **POST** /api/v1/account/companies/ | |
|
|
15
|
+
|[**accountCompaniesDestroy**](#accountcompaniesdestroy) | **DELETE** /api/account/companies/{id}/ | |
|
|
16
|
+
|[**accountCompaniesDestroy2**](#accountcompaniesdestroy2) | **DELETE** /api/v1/account/companies/{id}/ | |
|
|
17
|
+
|[**accountCompaniesList**](#accountcompanieslist) | **GET** /api/account/companies/ | |
|
|
18
|
+
|[**accountCompaniesList2**](#accountcompanieslist2) | **GET** /api/v1/account/companies/ | |
|
|
19
|
+
|[**accountCompaniesPartialUpdate**](#accountcompaniespartialupdate) | **PATCH** /api/account/companies/{id}/ | |
|
|
20
|
+
|[**accountCompaniesPartialUpdate2**](#accountcompaniespartialupdate2) | **PATCH** /api/v1/account/companies/{id}/ | |
|
|
21
|
+
|[**accountCompaniesRetrieve**](#accountcompaniesretrieve) | **GET** /api/account/companies/{id}/ | |
|
|
22
|
+
|[**accountCompaniesRetrieve2**](#accountcompaniesretrieve2) | **GET** /api/v1/account/companies/{id}/ | |
|
|
23
|
+
|[**accountCompaniesUpdate**](#accountcompaniesupdate) | **PUT** /api/account/companies/{id}/ | |
|
|
24
|
+
|[**accountCompaniesUpdate2**](#accountcompaniesupdate2) | **PUT** /api/v1/account/companies/{id}/ | |
|
|
25
|
+
|[**accountEmailsList**](#accountemailslist) | **GET** /api/account/emails/ | |
|
|
26
|
+
|[**accountEmailsList2**](#accountemailslist2) | **GET** /api/v1/account/emails/ | |
|
|
27
|
+
|[**accountProfilePartialUpdate**](#accountprofilepartialupdate) | **PATCH** /api/account/profile | |
|
|
28
|
+
|[**accountProfilePartialUpdate2**](#accountprofilepartialupdate2) | **PATCH** /api/v1/account/profile | |
|
|
29
|
+
|[**accountProfileRetrieve**](#accountprofileretrieve) | **GET** /api/account/profile | |
|
|
30
|
+
|[**accountProfileRetrieve2**](#accountprofileretrieve2) | **GET** /api/v1/account/profile | |
|
|
31
|
+
|[**accountProfileUpdate**](#accountprofileupdate) | **PUT** /api/account/profile | |
|
|
32
|
+
|[**accountProfileUpdate2**](#accountprofileupdate2) | **PUT** /api/v1/account/profile | |
|
|
33
|
+
|[**accountSshKeysCreate**](#accountsshkeyscreate) | **POST** /api/account/ssh-keys/ | |
|
|
34
|
+
|[**accountSshKeysCreate2**](#accountsshkeyscreate2) | **POST** /api/v1/account/ssh-keys/ | |
|
|
35
|
+
|[**accountSshKeysDestroy**](#accountsshkeysdestroy) | **DELETE** /api/account/ssh-keys/{id}/ | |
|
|
36
|
+
|[**accountSshKeysDestroy2**](#accountsshkeysdestroy2) | **DELETE** /api/v1/account/ssh-keys/{id}/ | |
|
|
37
|
+
|[**accountSshKeysList**](#accountsshkeyslist) | **GET** /api/account/ssh-keys/ | |
|
|
38
|
+
|[**accountSshKeysList2**](#accountsshkeyslist2) | **GET** /api/v1/account/ssh-keys/ | |
|
|
39
|
+
|[**accountSshKeysPartialUpdate**](#accountsshkeyspartialupdate) | **PATCH** /api/account/ssh-keys/{id}/ | |
|
|
40
|
+
|[**accountSshKeysPartialUpdate2**](#accountsshkeyspartialupdate2) | **PATCH** /api/v1/account/ssh-keys/{id}/ | |
|
|
41
|
+
|[**accountSshKeysRetrieve**](#accountsshkeysretrieve) | **GET** /api/account/ssh-keys/{id}/ | |
|
|
42
|
+
|[**accountSshKeysRetrieve2**](#accountsshkeysretrieve2) | **GET** /api/v1/account/ssh-keys/{id}/ | |
|
|
43
|
+
|[**accountSshKeysUpdate**](#accountsshkeysupdate) | **PUT** /api/account/ssh-keys/{id}/ | |
|
|
44
|
+
|[**accountSshKeysUpdate2**](#accountsshkeysupdate2) | **PUT** /api/v1/account/ssh-keys/{id}/ | |
|
|
45
|
+
|
|
46
|
+
# **accountApiTokensCreate**
|
|
47
|
+
> APITokenCreate accountApiTokensCreate(aPITokenCreate)
|
|
48
|
+
|
|
49
|
+
Manage your API tokens
|
|
50
|
+
|
|
51
|
+
### Example
|
|
52
|
+
|
|
53
|
+
```typescript
|
|
54
|
+
import {
|
|
55
|
+
AccountApi,
|
|
56
|
+
Configuration,
|
|
57
|
+
APITokenCreate
|
|
58
|
+
} from '@pidginhost/sdk';
|
|
59
|
+
|
|
60
|
+
const configuration = new Configuration();
|
|
61
|
+
const apiInstance = new AccountApi(configuration);
|
|
62
|
+
|
|
63
|
+
let aPITokenCreate: APITokenCreate; //
|
|
64
|
+
|
|
65
|
+
const { status, data } = await apiInstance.accountApiTokensCreate(
|
|
66
|
+
aPITokenCreate
|
|
67
|
+
);
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
### Parameters
|
|
71
|
+
|
|
72
|
+
|Name | Type | Description | Notes|
|
|
73
|
+
|------------- | ------------- | ------------- | -------------|
|
|
74
|
+
| **aPITokenCreate** | **APITokenCreate**| | |
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
### Return type
|
|
78
|
+
|
|
79
|
+
**APITokenCreate**
|
|
80
|
+
|
|
81
|
+
### Authorization
|
|
82
|
+
|
|
83
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
84
|
+
|
|
85
|
+
### HTTP request headers
|
|
86
|
+
|
|
87
|
+
- **Content-Type**: application/json
|
|
88
|
+
- **Accept**: application/json
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
### HTTP response details
|
|
92
|
+
| Status code | Description | Response headers |
|
|
93
|
+
|-------------|-------------|------------------|
|
|
94
|
+
|**201** | | - |
|
|
95
|
+
|
|
96
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
97
|
+
|
|
98
|
+
# **accountApiTokensCreate2**
|
|
99
|
+
> APITokenCreate accountApiTokensCreate2(aPITokenCreate)
|
|
100
|
+
|
|
101
|
+
Manage your API tokens
|
|
102
|
+
|
|
103
|
+
### Example
|
|
104
|
+
|
|
105
|
+
```typescript
|
|
106
|
+
import {
|
|
107
|
+
AccountApi,
|
|
108
|
+
Configuration,
|
|
109
|
+
APITokenCreate
|
|
110
|
+
} from '@pidginhost/sdk';
|
|
111
|
+
|
|
112
|
+
const configuration = new Configuration();
|
|
113
|
+
const apiInstance = new AccountApi(configuration);
|
|
114
|
+
|
|
115
|
+
let aPITokenCreate: APITokenCreate; //
|
|
116
|
+
|
|
117
|
+
const { status, data } = await apiInstance.accountApiTokensCreate2(
|
|
118
|
+
aPITokenCreate
|
|
119
|
+
);
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
### Parameters
|
|
123
|
+
|
|
124
|
+
|Name | Type | Description | Notes|
|
|
125
|
+
|------------- | ------------- | ------------- | -------------|
|
|
126
|
+
| **aPITokenCreate** | **APITokenCreate**| | |
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
### Return type
|
|
130
|
+
|
|
131
|
+
**APITokenCreate**
|
|
132
|
+
|
|
133
|
+
### Authorization
|
|
134
|
+
|
|
135
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
136
|
+
|
|
137
|
+
### HTTP request headers
|
|
138
|
+
|
|
139
|
+
- **Content-Type**: application/json
|
|
140
|
+
- **Accept**: application/json
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
### HTTP response details
|
|
144
|
+
| Status code | Description | Response headers |
|
|
145
|
+
|-------------|-------------|------------------|
|
|
146
|
+
|**201** | | - |
|
|
147
|
+
|
|
148
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
149
|
+
|
|
150
|
+
# **accountApiTokensDestroy**
|
|
151
|
+
> accountApiTokensDestroy()
|
|
152
|
+
|
|
153
|
+
Manage your API tokens
|
|
154
|
+
|
|
155
|
+
### Example
|
|
156
|
+
|
|
157
|
+
```typescript
|
|
158
|
+
import {
|
|
159
|
+
AccountApi,
|
|
160
|
+
Configuration
|
|
161
|
+
} from '@pidginhost/sdk';
|
|
162
|
+
|
|
163
|
+
const configuration = new Configuration();
|
|
164
|
+
const apiInstance = new AccountApi(configuration);
|
|
165
|
+
|
|
166
|
+
let id: string; // (default to undefined)
|
|
167
|
+
|
|
168
|
+
const { status, data } = await apiInstance.accountApiTokensDestroy(
|
|
169
|
+
id
|
|
170
|
+
);
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
### Parameters
|
|
174
|
+
|
|
175
|
+
|Name | Type | Description | Notes|
|
|
176
|
+
|------------- | ------------- | ------------- | -------------|
|
|
177
|
+
| **id** | [**string**] | | defaults to undefined|
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
### Return type
|
|
181
|
+
|
|
182
|
+
void (empty response body)
|
|
183
|
+
|
|
184
|
+
### Authorization
|
|
185
|
+
|
|
186
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
187
|
+
|
|
188
|
+
### HTTP request headers
|
|
189
|
+
|
|
190
|
+
- **Content-Type**: Not defined
|
|
191
|
+
- **Accept**: Not defined
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
### HTTP response details
|
|
195
|
+
| Status code | Description | Response headers |
|
|
196
|
+
|-------------|-------------|------------------|
|
|
197
|
+
|**204** | No response body | - |
|
|
198
|
+
|
|
199
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
200
|
+
|
|
201
|
+
# **accountApiTokensDestroy2**
|
|
202
|
+
> accountApiTokensDestroy2()
|
|
203
|
+
|
|
204
|
+
Manage your API tokens
|
|
205
|
+
|
|
206
|
+
### Example
|
|
207
|
+
|
|
208
|
+
```typescript
|
|
209
|
+
import {
|
|
210
|
+
AccountApi,
|
|
211
|
+
Configuration
|
|
212
|
+
} from '@pidginhost/sdk';
|
|
213
|
+
|
|
214
|
+
const configuration = new Configuration();
|
|
215
|
+
const apiInstance = new AccountApi(configuration);
|
|
216
|
+
|
|
217
|
+
let id: string; // (default to undefined)
|
|
218
|
+
|
|
219
|
+
const { status, data } = await apiInstance.accountApiTokensDestroy2(
|
|
220
|
+
id
|
|
221
|
+
);
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
### Parameters
|
|
225
|
+
|
|
226
|
+
|Name | Type | Description | Notes|
|
|
227
|
+
|------------- | ------------- | ------------- | -------------|
|
|
228
|
+
| **id** | [**string**] | | defaults to undefined|
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
### Return type
|
|
232
|
+
|
|
233
|
+
void (empty response body)
|
|
234
|
+
|
|
235
|
+
### Authorization
|
|
236
|
+
|
|
237
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
238
|
+
|
|
239
|
+
### HTTP request headers
|
|
240
|
+
|
|
241
|
+
- **Content-Type**: Not defined
|
|
242
|
+
- **Accept**: Not defined
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
### HTTP response details
|
|
246
|
+
| Status code | Description | Response headers |
|
|
247
|
+
|-------------|-------------|------------------|
|
|
248
|
+
|**204** | No response body | - |
|
|
249
|
+
|
|
250
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
251
|
+
|
|
252
|
+
# **accountApiTokensList**
|
|
253
|
+
> PaginatedAPITokenListList accountApiTokensList()
|
|
254
|
+
|
|
255
|
+
Manage your API tokens
|
|
256
|
+
|
|
257
|
+
### Example
|
|
258
|
+
|
|
259
|
+
```typescript
|
|
260
|
+
import {
|
|
261
|
+
AccountApi,
|
|
262
|
+
Configuration
|
|
263
|
+
} from '@pidginhost/sdk';
|
|
264
|
+
|
|
265
|
+
const configuration = new Configuration();
|
|
266
|
+
const apiInstance = new AccountApi(configuration);
|
|
267
|
+
|
|
268
|
+
let page: number; //A page number within the paginated result set. (optional) (default to undefined)
|
|
269
|
+
|
|
270
|
+
const { status, data } = await apiInstance.accountApiTokensList(
|
|
271
|
+
page
|
|
272
|
+
);
|
|
273
|
+
```
|
|
274
|
+
|
|
275
|
+
### Parameters
|
|
276
|
+
|
|
277
|
+
|Name | Type | Description | Notes|
|
|
278
|
+
|------------- | ------------- | ------------- | -------------|
|
|
279
|
+
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
### Return type
|
|
283
|
+
|
|
284
|
+
**PaginatedAPITokenListList**
|
|
285
|
+
|
|
286
|
+
### Authorization
|
|
287
|
+
|
|
288
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
289
|
+
|
|
290
|
+
### HTTP request headers
|
|
291
|
+
|
|
292
|
+
- **Content-Type**: Not defined
|
|
293
|
+
- **Accept**: application/json
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
### HTTP response details
|
|
297
|
+
| Status code | Description | Response headers |
|
|
298
|
+
|-------------|-------------|------------------|
|
|
299
|
+
|**200** | | - |
|
|
300
|
+
|
|
301
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
302
|
+
|
|
303
|
+
# **accountApiTokensList2**
|
|
304
|
+
> PaginatedAPITokenListList accountApiTokensList2()
|
|
305
|
+
|
|
306
|
+
Manage your API tokens
|
|
307
|
+
|
|
308
|
+
### Example
|
|
309
|
+
|
|
310
|
+
```typescript
|
|
311
|
+
import {
|
|
312
|
+
AccountApi,
|
|
313
|
+
Configuration
|
|
314
|
+
} from '@pidginhost/sdk';
|
|
315
|
+
|
|
316
|
+
const configuration = new Configuration();
|
|
317
|
+
const apiInstance = new AccountApi(configuration);
|
|
318
|
+
|
|
319
|
+
let page: number; //A page number within the paginated result set. (optional) (default to undefined)
|
|
320
|
+
|
|
321
|
+
const { status, data } = await apiInstance.accountApiTokensList2(
|
|
322
|
+
page
|
|
323
|
+
);
|
|
324
|
+
```
|
|
325
|
+
|
|
326
|
+
### Parameters
|
|
327
|
+
|
|
328
|
+
|Name | Type | Description | Notes|
|
|
329
|
+
|------------- | ------------- | ------------- | -------------|
|
|
330
|
+
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
### Return type
|
|
334
|
+
|
|
335
|
+
**PaginatedAPITokenListList**
|
|
336
|
+
|
|
337
|
+
### Authorization
|
|
338
|
+
|
|
339
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
340
|
+
|
|
341
|
+
### HTTP request headers
|
|
342
|
+
|
|
343
|
+
- **Content-Type**: Not defined
|
|
344
|
+
- **Accept**: application/json
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
### HTTP response details
|
|
348
|
+
| Status code | Description | Response headers |
|
|
349
|
+
|-------------|-------------|------------------|
|
|
350
|
+
|**200** | | - |
|
|
351
|
+
|
|
352
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
353
|
+
|
|
354
|
+
# **accountCompaniesCreate**
|
|
355
|
+
> Company accountCompaniesCreate(company)
|
|
356
|
+
|
|
357
|
+
Manage your companies
|
|
358
|
+
|
|
359
|
+
### Example
|
|
360
|
+
|
|
361
|
+
```typescript
|
|
362
|
+
import {
|
|
363
|
+
AccountApi,
|
|
364
|
+
Configuration,
|
|
365
|
+
Company
|
|
366
|
+
} from '@pidginhost/sdk';
|
|
367
|
+
|
|
368
|
+
const configuration = new Configuration();
|
|
369
|
+
const apiInstance = new AccountApi(configuration);
|
|
370
|
+
|
|
371
|
+
let company: Company; //
|
|
372
|
+
|
|
373
|
+
const { status, data } = await apiInstance.accountCompaniesCreate(
|
|
374
|
+
company
|
|
375
|
+
);
|
|
376
|
+
```
|
|
377
|
+
|
|
378
|
+
### Parameters
|
|
379
|
+
|
|
380
|
+
|Name | Type | Description | Notes|
|
|
381
|
+
|------------- | ------------- | ------------- | -------------|
|
|
382
|
+
| **company** | **Company**| | |
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
### Return type
|
|
386
|
+
|
|
387
|
+
**Company**
|
|
388
|
+
|
|
389
|
+
### Authorization
|
|
390
|
+
|
|
391
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
392
|
+
|
|
393
|
+
### HTTP request headers
|
|
394
|
+
|
|
395
|
+
- **Content-Type**: application/json
|
|
396
|
+
- **Accept**: application/json
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
### HTTP response details
|
|
400
|
+
| Status code | Description | Response headers |
|
|
401
|
+
|-------------|-------------|------------------|
|
|
402
|
+
|**201** | | - |
|
|
403
|
+
|
|
404
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
405
|
+
|
|
406
|
+
# **accountCompaniesCreate2**
|
|
407
|
+
> Company accountCompaniesCreate2(company)
|
|
408
|
+
|
|
409
|
+
Manage your companies
|
|
410
|
+
|
|
411
|
+
### Example
|
|
412
|
+
|
|
413
|
+
```typescript
|
|
414
|
+
import {
|
|
415
|
+
AccountApi,
|
|
416
|
+
Configuration,
|
|
417
|
+
Company
|
|
418
|
+
} from '@pidginhost/sdk';
|
|
419
|
+
|
|
420
|
+
const configuration = new Configuration();
|
|
421
|
+
const apiInstance = new AccountApi(configuration);
|
|
422
|
+
|
|
423
|
+
let company: Company; //
|
|
424
|
+
|
|
425
|
+
const { status, data } = await apiInstance.accountCompaniesCreate2(
|
|
426
|
+
company
|
|
427
|
+
);
|
|
428
|
+
```
|
|
429
|
+
|
|
430
|
+
### Parameters
|
|
431
|
+
|
|
432
|
+
|Name | Type | Description | Notes|
|
|
433
|
+
|------------- | ------------- | ------------- | -------------|
|
|
434
|
+
| **company** | **Company**| | |
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
### Return type
|
|
438
|
+
|
|
439
|
+
**Company**
|
|
440
|
+
|
|
441
|
+
### Authorization
|
|
442
|
+
|
|
443
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
444
|
+
|
|
445
|
+
### HTTP request headers
|
|
446
|
+
|
|
447
|
+
- **Content-Type**: application/json
|
|
448
|
+
- **Accept**: application/json
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
### HTTP response details
|
|
452
|
+
| Status code | Description | Response headers |
|
|
453
|
+
|-------------|-------------|------------------|
|
|
454
|
+
|**201** | | - |
|
|
455
|
+
|
|
456
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
457
|
+
|
|
458
|
+
# **accountCompaniesDestroy**
|
|
459
|
+
> accountCompaniesDestroy()
|
|
460
|
+
|
|
461
|
+
Manage your companies
|
|
462
|
+
|
|
463
|
+
### Example
|
|
464
|
+
|
|
465
|
+
```typescript
|
|
466
|
+
import {
|
|
467
|
+
AccountApi,
|
|
468
|
+
Configuration
|
|
469
|
+
} from '@pidginhost/sdk';
|
|
470
|
+
|
|
471
|
+
const configuration = new Configuration();
|
|
472
|
+
const apiInstance = new AccountApi(configuration);
|
|
473
|
+
|
|
474
|
+
let id: number; //A unique integer value identifying this company. (default to undefined)
|
|
475
|
+
|
|
476
|
+
const { status, data } = await apiInstance.accountCompaniesDestroy(
|
|
477
|
+
id
|
|
478
|
+
);
|
|
479
|
+
```
|
|
480
|
+
|
|
481
|
+
### Parameters
|
|
482
|
+
|
|
483
|
+
|Name | Type | Description | Notes|
|
|
484
|
+
|------------- | ------------- | ------------- | -------------|
|
|
485
|
+
| **id** | [**number**] | A unique integer value identifying this company. | defaults to undefined|
|
|
486
|
+
|
|
487
|
+
|
|
488
|
+
### Return type
|
|
489
|
+
|
|
490
|
+
void (empty response body)
|
|
491
|
+
|
|
492
|
+
### Authorization
|
|
493
|
+
|
|
494
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
495
|
+
|
|
496
|
+
### HTTP request headers
|
|
497
|
+
|
|
498
|
+
- **Content-Type**: Not defined
|
|
499
|
+
- **Accept**: Not defined
|
|
500
|
+
|
|
501
|
+
|
|
502
|
+
### HTTP response details
|
|
503
|
+
| Status code | Description | Response headers |
|
|
504
|
+
|-------------|-------------|------------------|
|
|
505
|
+
|**204** | No response body | - |
|
|
506
|
+
|
|
507
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
508
|
+
|
|
509
|
+
# **accountCompaniesDestroy2**
|
|
510
|
+
> accountCompaniesDestroy2()
|
|
511
|
+
|
|
512
|
+
Manage your companies
|
|
513
|
+
|
|
514
|
+
### Example
|
|
515
|
+
|
|
516
|
+
```typescript
|
|
517
|
+
import {
|
|
518
|
+
AccountApi,
|
|
519
|
+
Configuration
|
|
520
|
+
} from '@pidginhost/sdk';
|
|
521
|
+
|
|
522
|
+
const configuration = new Configuration();
|
|
523
|
+
const apiInstance = new AccountApi(configuration);
|
|
524
|
+
|
|
525
|
+
let id: number; //A unique integer value identifying this company. (default to undefined)
|
|
526
|
+
|
|
527
|
+
const { status, data } = await apiInstance.accountCompaniesDestroy2(
|
|
528
|
+
id
|
|
529
|
+
);
|
|
530
|
+
```
|
|
531
|
+
|
|
532
|
+
### Parameters
|
|
533
|
+
|
|
534
|
+
|Name | Type | Description | Notes|
|
|
535
|
+
|------------- | ------------- | ------------- | -------------|
|
|
536
|
+
| **id** | [**number**] | A unique integer value identifying this company. | defaults to undefined|
|
|
537
|
+
|
|
538
|
+
|
|
539
|
+
### Return type
|
|
540
|
+
|
|
541
|
+
void (empty response body)
|
|
542
|
+
|
|
543
|
+
### Authorization
|
|
544
|
+
|
|
545
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
546
|
+
|
|
547
|
+
### HTTP request headers
|
|
548
|
+
|
|
549
|
+
- **Content-Type**: Not defined
|
|
550
|
+
- **Accept**: Not defined
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
### HTTP response details
|
|
554
|
+
| Status code | Description | Response headers |
|
|
555
|
+
|-------------|-------------|------------------|
|
|
556
|
+
|**204** | No response body | - |
|
|
557
|
+
|
|
558
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
559
|
+
|
|
560
|
+
# **accountCompaniesList**
|
|
561
|
+
> PaginatedCompanyList accountCompaniesList()
|
|
562
|
+
|
|
563
|
+
Manage your companies
|
|
564
|
+
|
|
565
|
+
### Example
|
|
566
|
+
|
|
567
|
+
```typescript
|
|
568
|
+
import {
|
|
569
|
+
AccountApi,
|
|
570
|
+
Configuration
|
|
571
|
+
} from '@pidginhost/sdk';
|
|
572
|
+
|
|
573
|
+
const configuration = new Configuration();
|
|
574
|
+
const apiInstance = new AccountApi(configuration);
|
|
575
|
+
|
|
576
|
+
let page: number; //A page number within the paginated result set. (optional) (default to undefined)
|
|
577
|
+
|
|
578
|
+
const { status, data } = await apiInstance.accountCompaniesList(
|
|
579
|
+
page
|
|
580
|
+
);
|
|
581
|
+
```
|
|
582
|
+
|
|
583
|
+
### Parameters
|
|
584
|
+
|
|
585
|
+
|Name | Type | Description | Notes|
|
|
586
|
+
|------------- | ------------- | ------------- | -------------|
|
|
587
|
+
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
588
|
+
|
|
589
|
+
|
|
590
|
+
### Return type
|
|
591
|
+
|
|
592
|
+
**PaginatedCompanyList**
|
|
593
|
+
|
|
594
|
+
### Authorization
|
|
595
|
+
|
|
596
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
597
|
+
|
|
598
|
+
### HTTP request headers
|
|
599
|
+
|
|
600
|
+
- **Content-Type**: Not defined
|
|
601
|
+
- **Accept**: application/json
|
|
602
|
+
|
|
603
|
+
|
|
604
|
+
### HTTP response details
|
|
605
|
+
| Status code | Description | Response headers |
|
|
606
|
+
|-------------|-------------|------------------|
|
|
607
|
+
|**200** | | - |
|
|
608
|
+
|
|
609
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
610
|
+
|
|
611
|
+
# **accountCompaniesList2**
|
|
612
|
+
> PaginatedCompanyList accountCompaniesList2()
|
|
613
|
+
|
|
614
|
+
Manage your companies
|
|
615
|
+
|
|
616
|
+
### Example
|
|
617
|
+
|
|
618
|
+
```typescript
|
|
619
|
+
import {
|
|
620
|
+
AccountApi,
|
|
621
|
+
Configuration
|
|
622
|
+
} from '@pidginhost/sdk';
|
|
623
|
+
|
|
624
|
+
const configuration = new Configuration();
|
|
625
|
+
const apiInstance = new AccountApi(configuration);
|
|
626
|
+
|
|
627
|
+
let page: number; //A page number within the paginated result set. (optional) (default to undefined)
|
|
628
|
+
|
|
629
|
+
const { status, data } = await apiInstance.accountCompaniesList2(
|
|
630
|
+
page
|
|
631
|
+
);
|
|
632
|
+
```
|
|
633
|
+
|
|
634
|
+
### Parameters
|
|
635
|
+
|
|
636
|
+
|Name | Type | Description | Notes|
|
|
637
|
+
|------------- | ------------- | ------------- | -------------|
|
|
638
|
+
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
639
|
+
|
|
640
|
+
|
|
641
|
+
### Return type
|
|
642
|
+
|
|
643
|
+
**PaginatedCompanyList**
|
|
644
|
+
|
|
645
|
+
### Authorization
|
|
646
|
+
|
|
647
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
648
|
+
|
|
649
|
+
### HTTP request headers
|
|
650
|
+
|
|
651
|
+
- **Content-Type**: Not defined
|
|
652
|
+
- **Accept**: application/json
|
|
653
|
+
|
|
654
|
+
|
|
655
|
+
### HTTP response details
|
|
656
|
+
| Status code | Description | Response headers |
|
|
657
|
+
|-------------|-------------|------------------|
|
|
658
|
+
|**200** | | - |
|
|
659
|
+
|
|
660
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
661
|
+
|
|
662
|
+
# **accountCompaniesPartialUpdate**
|
|
663
|
+
> Company accountCompaniesPartialUpdate()
|
|
664
|
+
|
|
665
|
+
Manage your companies
|
|
666
|
+
|
|
667
|
+
### Example
|
|
668
|
+
|
|
669
|
+
```typescript
|
|
670
|
+
import {
|
|
671
|
+
AccountApi,
|
|
672
|
+
Configuration,
|
|
673
|
+
PatchedCompany
|
|
674
|
+
} from '@pidginhost/sdk';
|
|
675
|
+
|
|
676
|
+
const configuration = new Configuration();
|
|
677
|
+
const apiInstance = new AccountApi(configuration);
|
|
678
|
+
|
|
679
|
+
let id: number; //A unique integer value identifying this company. (default to undefined)
|
|
680
|
+
let patchedCompany: PatchedCompany; // (optional)
|
|
681
|
+
|
|
682
|
+
const { status, data } = await apiInstance.accountCompaniesPartialUpdate(
|
|
683
|
+
id,
|
|
684
|
+
patchedCompany
|
|
685
|
+
);
|
|
686
|
+
```
|
|
687
|
+
|
|
688
|
+
### Parameters
|
|
689
|
+
|
|
690
|
+
|Name | Type | Description | Notes|
|
|
691
|
+
|------------- | ------------- | ------------- | -------------|
|
|
692
|
+
| **patchedCompany** | **PatchedCompany**| | |
|
|
693
|
+
| **id** | [**number**] | A unique integer value identifying this company. | defaults to undefined|
|
|
694
|
+
|
|
695
|
+
|
|
696
|
+
### Return type
|
|
697
|
+
|
|
698
|
+
**Company**
|
|
699
|
+
|
|
700
|
+
### Authorization
|
|
701
|
+
|
|
702
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
703
|
+
|
|
704
|
+
### HTTP request headers
|
|
705
|
+
|
|
706
|
+
- **Content-Type**: application/json
|
|
707
|
+
- **Accept**: application/json
|
|
708
|
+
|
|
709
|
+
|
|
710
|
+
### HTTP response details
|
|
711
|
+
| Status code | Description | Response headers |
|
|
712
|
+
|-------------|-------------|------------------|
|
|
713
|
+
|**200** | | - |
|
|
714
|
+
|
|
715
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
716
|
+
|
|
717
|
+
# **accountCompaniesPartialUpdate2**
|
|
718
|
+
> Company accountCompaniesPartialUpdate2()
|
|
719
|
+
|
|
720
|
+
Manage your companies
|
|
721
|
+
|
|
722
|
+
### Example
|
|
723
|
+
|
|
724
|
+
```typescript
|
|
725
|
+
import {
|
|
726
|
+
AccountApi,
|
|
727
|
+
Configuration,
|
|
728
|
+
PatchedCompany
|
|
729
|
+
} from '@pidginhost/sdk';
|
|
730
|
+
|
|
731
|
+
const configuration = new Configuration();
|
|
732
|
+
const apiInstance = new AccountApi(configuration);
|
|
733
|
+
|
|
734
|
+
let id: number; //A unique integer value identifying this company. (default to undefined)
|
|
735
|
+
let patchedCompany: PatchedCompany; // (optional)
|
|
736
|
+
|
|
737
|
+
const { status, data } = await apiInstance.accountCompaniesPartialUpdate2(
|
|
738
|
+
id,
|
|
739
|
+
patchedCompany
|
|
740
|
+
);
|
|
741
|
+
```
|
|
742
|
+
|
|
743
|
+
### Parameters
|
|
744
|
+
|
|
745
|
+
|Name | Type | Description | Notes|
|
|
746
|
+
|------------- | ------------- | ------------- | -------------|
|
|
747
|
+
| **patchedCompany** | **PatchedCompany**| | |
|
|
748
|
+
| **id** | [**number**] | A unique integer value identifying this company. | defaults to undefined|
|
|
749
|
+
|
|
750
|
+
|
|
751
|
+
### Return type
|
|
752
|
+
|
|
753
|
+
**Company**
|
|
754
|
+
|
|
755
|
+
### Authorization
|
|
756
|
+
|
|
757
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
758
|
+
|
|
759
|
+
### HTTP request headers
|
|
760
|
+
|
|
761
|
+
- **Content-Type**: application/json
|
|
762
|
+
- **Accept**: application/json
|
|
763
|
+
|
|
764
|
+
|
|
765
|
+
### HTTP response details
|
|
766
|
+
| Status code | Description | Response headers |
|
|
767
|
+
|-------------|-------------|------------------|
|
|
768
|
+
|**200** | | - |
|
|
769
|
+
|
|
770
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
771
|
+
|
|
772
|
+
# **accountCompaniesRetrieve**
|
|
773
|
+
> Company accountCompaniesRetrieve()
|
|
774
|
+
|
|
775
|
+
Manage your companies
|
|
776
|
+
|
|
777
|
+
### Example
|
|
778
|
+
|
|
779
|
+
```typescript
|
|
780
|
+
import {
|
|
781
|
+
AccountApi,
|
|
782
|
+
Configuration
|
|
783
|
+
} from '@pidginhost/sdk';
|
|
784
|
+
|
|
785
|
+
const configuration = new Configuration();
|
|
786
|
+
const apiInstance = new AccountApi(configuration);
|
|
787
|
+
|
|
788
|
+
let id: number; //A unique integer value identifying this company. (default to undefined)
|
|
789
|
+
|
|
790
|
+
const { status, data } = await apiInstance.accountCompaniesRetrieve(
|
|
791
|
+
id
|
|
792
|
+
);
|
|
793
|
+
```
|
|
794
|
+
|
|
795
|
+
### Parameters
|
|
796
|
+
|
|
797
|
+
|Name | Type | Description | Notes|
|
|
798
|
+
|------------- | ------------- | ------------- | -------------|
|
|
799
|
+
| **id** | [**number**] | A unique integer value identifying this company. | defaults to undefined|
|
|
800
|
+
|
|
801
|
+
|
|
802
|
+
### Return type
|
|
803
|
+
|
|
804
|
+
**Company**
|
|
805
|
+
|
|
806
|
+
### Authorization
|
|
807
|
+
|
|
808
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
809
|
+
|
|
810
|
+
### HTTP request headers
|
|
811
|
+
|
|
812
|
+
- **Content-Type**: Not defined
|
|
813
|
+
- **Accept**: application/json
|
|
814
|
+
|
|
815
|
+
|
|
816
|
+
### HTTP response details
|
|
817
|
+
| Status code | Description | Response headers |
|
|
818
|
+
|-------------|-------------|------------------|
|
|
819
|
+
|**200** | | - |
|
|
820
|
+
|
|
821
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
822
|
+
|
|
823
|
+
# **accountCompaniesRetrieve2**
|
|
824
|
+
> Company accountCompaniesRetrieve2()
|
|
825
|
+
|
|
826
|
+
Manage your companies
|
|
827
|
+
|
|
828
|
+
### Example
|
|
829
|
+
|
|
830
|
+
```typescript
|
|
831
|
+
import {
|
|
832
|
+
AccountApi,
|
|
833
|
+
Configuration
|
|
834
|
+
} from '@pidginhost/sdk';
|
|
835
|
+
|
|
836
|
+
const configuration = new Configuration();
|
|
837
|
+
const apiInstance = new AccountApi(configuration);
|
|
838
|
+
|
|
839
|
+
let id: number; //A unique integer value identifying this company. (default to undefined)
|
|
840
|
+
|
|
841
|
+
const { status, data } = await apiInstance.accountCompaniesRetrieve2(
|
|
842
|
+
id
|
|
843
|
+
);
|
|
844
|
+
```
|
|
845
|
+
|
|
846
|
+
### Parameters
|
|
847
|
+
|
|
848
|
+
|Name | Type | Description | Notes|
|
|
849
|
+
|------------- | ------------- | ------------- | -------------|
|
|
850
|
+
| **id** | [**number**] | A unique integer value identifying this company. | defaults to undefined|
|
|
851
|
+
|
|
852
|
+
|
|
853
|
+
### Return type
|
|
854
|
+
|
|
855
|
+
**Company**
|
|
856
|
+
|
|
857
|
+
### Authorization
|
|
858
|
+
|
|
859
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
860
|
+
|
|
861
|
+
### HTTP request headers
|
|
862
|
+
|
|
863
|
+
- **Content-Type**: Not defined
|
|
864
|
+
- **Accept**: application/json
|
|
865
|
+
|
|
866
|
+
|
|
867
|
+
### HTTP response details
|
|
868
|
+
| Status code | Description | Response headers |
|
|
869
|
+
|-------------|-------------|------------------|
|
|
870
|
+
|**200** | | - |
|
|
871
|
+
|
|
872
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
873
|
+
|
|
874
|
+
# **accountCompaniesUpdate**
|
|
875
|
+
> Company accountCompaniesUpdate(company)
|
|
876
|
+
|
|
877
|
+
Manage your companies
|
|
878
|
+
|
|
879
|
+
### Example
|
|
880
|
+
|
|
881
|
+
```typescript
|
|
882
|
+
import {
|
|
883
|
+
AccountApi,
|
|
884
|
+
Configuration,
|
|
885
|
+
Company
|
|
886
|
+
} from '@pidginhost/sdk';
|
|
887
|
+
|
|
888
|
+
const configuration = new Configuration();
|
|
889
|
+
const apiInstance = new AccountApi(configuration);
|
|
890
|
+
|
|
891
|
+
let id: number; //A unique integer value identifying this company. (default to undefined)
|
|
892
|
+
let company: Company; //
|
|
893
|
+
|
|
894
|
+
const { status, data } = await apiInstance.accountCompaniesUpdate(
|
|
895
|
+
id,
|
|
896
|
+
company
|
|
897
|
+
);
|
|
898
|
+
```
|
|
899
|
+
|
|
900
|
+
### Parameters
|
|
901
|
+
|
|
902
|
+
|Name | Type | Description | Notes|
|
|
903
|
+
|------------- | ------------- | ------------- | -------------|
|
|
904
|
+
| **company** | **Company**| | |
|
|
905
|
+
| **id** | [**number**] | A unique integer value identifying this company. | defaults to undefined|
|
|
906
|
+
|
|
907
|
+
|
|
908
|
+
### Return type
|
|
909
|
+
|
|
910
|
+
**Company**
|
|
911
|
+
|
|
912
|
+
### Authorization
|
|
913
|
+
|
|
914
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
915
|
+
|
|
916
|
+
### HTTP request headers
|
|
917
|
+
|
|
918
|
+
- **Content-Type**: application/json
|
|
919
|
+
- **Accept**: application/json
|
|
920
|
+
|
|
921
|
+
|
|
922
|
+
### HTTP response details
|
|
923
|
+
| Status code | Description | Response headers |
|
|
924
|
+
|-------------|-------------|------------------|
|
|
925
|
+
|**200** | | - |
|
|
926
|
+
|
|
927
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
928
|
+
|
|
929
|
+
# **accountCompaniesUpdate2**
|
|
930
|
+
> Company accountCompaniesUpdate2(company)
|
|
931
|
+
|
|
932
|
+
Manage your companies
|
|
933
|
+
|
|
934
|
+
### Example
|
|
935
|
+
|
|
936
|
+
```typescript
|
|
937
|
+
import {
|
|
938
|
+
AccountApi,
|
|
939
|
+
Configuration,
|
|
940
|
+
Company
|
|
941
|
+
} from '@pidginhost/sdk';
|
|
942
|
+
|
|
943
|
+
const configuration = new Configuration();
|
|
944
|
+
const apiInstance = new AccountApi(configuration);
|
|
945
|
+
|
|
946
|
+
let id: number; //A unique integer value identifying this company. (default to undefined)
|
|
947
|
+
let company: Company; //
|
|
948
|
+
|
|
949
|
+
const { status, data } = await apiInstance.accountCompaniesUpdate2(
|
|
950
|
+
id,
|
|
951
|
+
company
|
|
952
|
+
);
|
|
953
|
+
```
|
|
954
|
+
|
|
955
|
+
### Parameters
|
|
956
|
+
|
|
957
|
+
|Name | Type | Description | Notes|
|
|
958
|
+
|------------- | ------------- | ------------- | -------------|
|
|
959
|
+
| **company** | **Company**| | |
|
|
960
|
+
| **id** | [**number**] | A unique integer value identifying this company. | defaults to undefined|
|
|
961
|
+
|
|
962
|
+
|
|
963
|
+
### Return type
|
|
964
|
+
|
|
965
|
+
**Company**
|
|
966
|
+
|
|
967
|
+
### Authorization
|
|
968
|
+
|
|
969
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
970
|
+
|
|
971
|
+
### HTTP request headers
|
|
972
|
+
|
|
973
|
+
- **Content-Type**: application/json
|
|
974
|
+
- **Accept**: application/json
|
|
975
|
+
|
|
976
|
+
|
|
977
|
+
### HTTP response details
|
|
978
|
+
| Status code | Description | Response headers |
|
|
979
|
+
|-------------|-------------|------------------|
|
|
980
|
+
|**200** | | - |
|
|
981
|
+
|
|
982
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
983
|
+
|
|
984
|
+
# **accountEmailsList**
|
|
985
|
+
> PaginatedEmailHistoryList accountEmailsList()
|
|
986
|
+
|
|
987
|
+
List email history for the authenticated user.
|
|
988
|
+
|
|
989
|
+
### Example
|
|
990
|
+
|
|
991
|
+
```typescript
|
|
992
|
+
import {
|
|
993
|
+
AccountApi,
|
|
994
|
+
Configuration
|
|
995
|
+
} from '@pidginhost/sdk';
|
|
996
|
+
|
|
997
|
+
const configuration = new Configuration();
|
|
998
|
+
const apiInstance = new AccountApi(configuration);
|
|
999
|
+
|
|
1000
|
+
let page: number; //A page number within the paginated result set. (optional) (default to undefined)
|
|
1001
|
+
|
|
1002
|
+
const { status, data } = await apiInstance.accountEmailsList(
|
|
1003
|
+
page
|
|
1004
|
+
);
|
|
1005
|
+
```
|
|
1006
|
+
|
|
1007
|
+
### Parameters
|
|
1008
|
+
|
|
1009
|
+
|Name | Type | Description | Notes|
|
|
1010
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1011
|
+
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
1012
|
+
|
|
1013
|
+
|
|
1014
|
+
### Return type
|
|
1015
|
+
|
|
1016
|
+
**PaginatedEmailHistoryList**
|
|
1017
|
+
|
|
1018
|
+
### Authorization
|
|
1019
|
+
|
|
1020
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1021
|
+
|
|
1022
|
+
### HTTP request headers
|
|
1023
|
+
|
|
1024
|
+
- **Content-Type**: Not defined
|
|
1025
|
+
- **Accept**: application/json
|
|
1026
|
+
|
|
1027
|
+
|
|
1028
|
+
### HTTP response details
|
|
1029
|
+
| Status code | Description | Response headers |
|
|
1030
|
+
|-------------|-------------|------------------|
|
|
1031
|
+
|**200** | | - |
|
|
1032
|
+
|
|
1033
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1034
|
+
|
|
1035
|
+
# **accountEmailsList2**
|
|
1036
|
+
> PaginatedEmailHistoryList accountEmailsList2()
|
|
1037
|
+
|
|
1038
|
+
List email history for the authenticated user.
|
|
1039
|
+
|
|
1040
|
+
### Example
|
|
1041
|
+
|
|
1042
|
+
```typescript
|
|
1043
|
+
import {
|
|
1044
|
+
AccountApi,
|
|
1045
|
+
Configuration
|
|
1046
|
+
} from '@pidginhost/sdk';
|
|
1047
|
+
|
|
1048
|
+
const configuration = new Configuration();
|
|
1049
|
+
const apiInstance = new AccountApi(configuration);
|
|
1050
|
+
|
|
1051
|
+
let page: number; //A page number within the paginated result set. (optional) (default to undefined)
|
|
1052
|
+
|
|
1053
|
+
const { status, data } = await apiInstance.accountEmailsList2(
|
|
1054
|
+
page
|
|
1055
|
+
);
|
|
1056
|
+
```
|
|
1057
|
+
|
|
1058
|
+
### Parameters
|
|
1059
|
+
|
|
1060
|
+
|Name | Type | Description | Notes|
|
|
1061
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1062
|
+
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
1063
|
+
|
|
1064
|
+
|
|
1065
|
+
### Return type
|
|
1066
|
+
|
|
1067
|
+
**PaginatedEmailHistoryList**
|
|
1068
|
+
|
|
1069
|
+
### Authorization
|
|
1070
|
+
|
|
1071
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1072
|
+
|
|
1073
|
+
### HTTP request headers
|
|
1074
|
+
|
|
1075
|
+
- **Content-Type**: Not defined
|
|
1076
|
+
- **Accept**: application/json
|
|
1077
|
+
|
|
1078
|
+
|
|
1079
|
+
### HTTP response details
|
|
1080
|
+
| Status code | Description | Response headers |
|
|
1081
|
+
|-------------|-------------|------------------|
|
|
1082
|
+
|**200** | | - |
|
|
1083
|
+
|
|
1084
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1085
|
+
|
|
1086
|
+
# **accountProfilePartialUpdate**
|
|
1087
|
+
> Profile accountProfilePartialUpdate()
|
|
1088
|
+
|
|
1089
|
+
Manage your profile data
|
|
1090
|
+
|
|
1091
|
+
### Example
|
|
1092
|
+
|
|
1093
|
+
```typescript
|
|
1094
|
+
import {
|
|
1095
|
+
AccountApi,
|
|
1096
|
+
Configuration,
|
|
1097
|
+
PatchedProfile
|
|
1098
|
+
} from '@pidginhost/sdk';
|
|
1099
|
+
|
|
1100
|
+
const configuration = new Configuration();
|
|
1101
|
+
const apiInstance = new AccountApi(configuration);
|
|
1102
|
+
|
|
1103
|
+
let patchedProfile: PatchedProfile; // (optional)
|
|
1104
|
+
|
|
1105
|
+
const { status, data } = await apiInstance.accountProfilePartialUpdate(
|
|
1106
|
+
patchedProfile
|
|
1107
|
+
);
|
|
1108
|
+
```
|
|
1109
|
+
|
|
1110
|
+
### Parameters
|
|
1111
|
+
|
|
1112
|
+
|Name | Type | Description | Notes|
|
|
1113
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1114
|
+
| **patchedProfile** | **PatchedProfile**| | |
|
|
1115
|
+
|
|
1116
|
+
|
|
1117
|
+
### Return type
|
|
1118
|
+
|
|
1119
|
+
**Profile**
|
|
1120
|
+
|
|
1121
|
+
### Authorization
|
|
1122
|
+
|
|
1123
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1124
|
+
|
|
1125
|
+
### HTTP request headers
|
|
1126
|
+
|
|
1127
|
+
- **Content-Type**: application/json
|
|
1128
|
+
- **Accept**: application/json
|
|
1129
|
+
|
|
1130
|
+
|
|
1131
|
+
### HTTP response details
|
|
1132
|
+
| Status code | Description | Response headers |
|
|
1133
|
+
|-------------|-------------|------------------|
|
|
1134
|
+
|**200** | | - |
|
|
1135
|
+
|
|
1136
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1137
|
+
|
|
1138
|
+
# **accountProfilePartialUpdate2**
|
|
1139
|
+
> Profile accountProfilePartialUpdate2()
|
|
1140
|
+
|
|
1141
|
+
Manage your profile data
|
|
1142
|
+
|
|
1143
|
+
### Example
|
|
1144
|
+
|
|
1145
|
+
```typescript
|
|
1146
|
+
import {
|
|
1147
|
+
AccountApi,
|
|
1148
|
+
Configuration,
|
|
1149
|
+
PatchedProfile
|
|
1150
|
+
} from '@pidginhost/sdk';
|
|
1151
|
+
|
|
1152
|
+
const configuration = new Configuration();
|
|
1153
|
+
const apiInstance = new AccountApi(configuration);
|
|
1154
|
+
|
|
1155
|
+
let patchedProfile: PatchedProfile; // (optional)
|
|
1156
|
+
|
|
1157
|
+
const { status, data } = await apiInstance.accountProfilePartialUpdate2(
|
|
1158
|
+
patchedProfile
|
|
1159
|
+
);
|
|
1160
|
+
```
|
|
1161
|
+
|
|
1162
|
+
### Parameters
|
|
1163
|
+
|
|
1164
|
+
|Name | Type | Description | Notes|
|
|
1165
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1166
|
+
| **patchedProfile** | **PatchedProfile**| | |
|
|
1167
|
+
|
|
1168
|
+
|
|
1169
|
+
### Return type
|
|
1170
|
+
|
|
1171
|
+
**Profile**
|
|
1172
|
+
|
|
1173
|
+
### Authorization
|
|
1174
|
+
|
|
1175
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1176
|
+
|
|
1177
|
+
### HTTP request headers
|
|
1178
|
+
|
|
1179
|
+
- **Content-Type**: application/json
|
|
1180
|
+
- **Accept**: application/json
|
|
1181
|
+
|
|
1182
|
+
|
|
1183
|
+
### HTTP response details
|
|
1184
|
+
| Status code | Description | Response headers |
|
|
1185
|
+
|-------------|-------------|------------------|
|
|
1186
|
+
|**200** | | - |
|
|
1187
|
+
|
|
1188
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1189
|
+
|
|
1190
|
+
# **accountProfileRetrieve**
|
|
1191
|
+
> Profile accountProfileRetrieve()
|
|
1192
|
+
|
|
1193
|
+
Manage your profile data
|
|
1194
|
+
|
|
1195
|
+
### Example
|
|
1196
|
+
|
|
1197
|
+
```typescript
|
|
1198
|
+
import {
|
|
1199
|
+
AccountApi,
|
|
1200
|
+
Configuration
|
|
1201
|
+
} from '@pidginhost/sdk';
|
|
1202
|
+
|
|
1203
|
+
const configuration = new Configuration();
|
|
1204
|
+
const apiInstance = new AccountApi(configuration);
|
|
1205
|
+
|
|
1206
|
+
const { status, data } = await apiInstance.accountProfileRetrieve();
|
|
1207
|
+
```
|
|
1208
|
+
|
|
1209
|
+
### Parameters
|
|
1210
|
+
This endpoint does not have any parameters.
|
|
1211
|
+
|
|
1212
|
+
|
|
1213
|
+
### Return type
|
|
1214
|
+
|
|
1215
|
+
**Profile**
|
|
1216
|
+
|
|
1217
|
+
### Authorization
|
|
1218
|
+
|
|
1219
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1220
|
+
|
|
1221
|
+
### HTTP request headers
|
|
1222
|
+
|
|
1223
|
+
- **Content-Type**: Not defined
|
|
1224
|
+
- **Accept**: application/json
|
|
1225
|
+
|
|
1226
|
+
|
|
1227
|
+
### HTTP response details
|
|
1228
|
+
| Status code | Description | Response headers |
|
|
1229
|
+
|-------------|-------------|------------------|
|
|
1230
|
+
|**200** | | - |
|
|
1231
|
+
|
|
1232
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1233
|
+
|
|
1234
|
+
# **accountProfileRetrieve2**
|
|
1235
|
+
> Profile accountProfileRetrieve2()
|
|
1236
|
+
|
|
1237
|
+
Manage your profile data
|
|
1238
|
+
|
|
1239
|
+
### Example
|
|
1240
|
+
|
|
1241
|
+
```typescript
|
|
1242
|
+
import {
|
|
1243
|
+
AccountApi,
|
|
1244
|
+
Configuration
|
|
1245
|
+
} from '@pidginhost/sdk';
|
|
1246
|
+
|
|
1247
|
+
const configuration = new Configuration();
|
|
1248
|
+
const apiInstance = new AccountApi(configuration);
|
|
1249
|
+
|
|
1250
|
+
const { status, data } = await apiInstance.accountProfileRetrieve2();
|
|
1251
|
+
```
|
|
1252
|
+
|
|
1253
|
+
### Parameters
|
|
1254
|
+
This endpoint does not have any parameters.
|
|
1255
|
+
|
|
1256
|
+
|
|
1257
|
+
### Return type
|
|
1258
|
+
|
|
1259
|
+
**Profile**
|
|
1260
|
+
|
|
1261
|
+
### Authorization
|
|
1262
|
+
|
|
1263
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1264
|
+
|
|
1265
|
+
### HTTP request headers
|
|
1266
|
+
|
|
1267
|
+
- **Content-Type**: Not defined
|
|
1268
|
+
- **Accept**: application/json
|
|
1269
|
+
|
|
1270
|
+
|
|
1271
|
+
### HTTP response details
|
|
1272
|
+
| Status code | Description | Response headers |
|
|
1273
|
+
|-------------|-------------|------------------|
|
|
1274
|
+
|**200** | | - |
|
|
1275
|
+
|
|
1276
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1277
|
+
|
|
1278
|
+
# **accountProfileUpdate**
|
|
1279
|
+
> Profile accountProfileUpdate(profile)
|
|
1280
|
+
|
|
1281
|
+
Manage your profile data
|
|
1282
|
+
|
|
1283
|
+
### Example
|
|
1284
|
+
|
|
1285
|
+
```typescript
|
|
1286
|
+
import {
|
|
1287
|
+
AccountApi,
|
|
1288
|
+
Configuration,
|
|
1289
|
+
Profile
|
|
1290
|
+
} from '@pidginhost/sdk';
|
|
1291
|
+
|
|
1292
|
+
const configuration = new Configuration();
|
|
1293
|
+
const apiInstance = new AccountApi(configuration);
|
|
1294
|
+
|
|
1295
|
+
let profile: Profile; //
|
|
1296
|
+
|
|
1297
|
+
const { status, data } = await apiInstance.accountProfileUpdate(
|
|
1298
|
+
profile
|
|
1299
|
+
);
|
|
1300
|
+
```
|
|
1301
|
+
|
|
1302
|
+
### Parameters
|
|
1303
|
+
|
|
1304
|
+
|Name | Type | Description | Notes|
|
|
1305
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1306
|
+
| **profile** | **Profile**| | |
|
|
1307
|
+
|
|
1308
|
+
|
|
1309
|
+
### Return type
|
|
1310
|
+
|
|
1311
|
+
**Profile**
|
|
1312
|
+
|
|
1313
|
+
### Authorization
|
|
1314
|
+
|
|
1315
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1316
|
+
|
|
1317
|
+
### HTTP request headers
|
|
1318
|
+
|
|
1319
|
+
- **Content-Type**: application/json
|
|
1320
|
+
- **Accept**: application/json
|
|
1321
|
+
|
|
1322
|
+
|
|
1323
|
+
### HTTP response details
|
|
1324
|
+
| Status code | Description | Response headers |
|
|
1325
|
+
|-------------|-------------|------------------|
|
|
1326
|
+
|**200** | | - |
|
|
1327
|
+
|
|
1328
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1329
|
+
|
|
1330
|
+
# **accountProfileUpdate2**
|
|
1331
|
+
> Profile accountProfileUpdate2(profile)
|
|
1332
|
+
|
|
1333
|
+
Manage your profile data
|
|
1334
|
+
|
|
1335
|
+
### Example
|
|
1336
|
+
|
|
1337
|
+
```typescript
|
|
1338
|
+
import {
|
|
1339
|
+
AccountApi,
|
|
1340
|
+
Configuration,
|
|
1341
|
+
Profile
|
|
1342
|
+
} from '@pidginhost/sdk';
|
|
1343
|
+
|
|
1344
|
+
const configuration = new Configuration();
|
|
1345
|
+
const apiInstance = new AccountApi(configuration);
|
|
1346
|
+
|
|
1347
|
+
let profile: Profile; //
|
|
1348
|
+
|
|
1349
|
+
const { status, data } = await apiInstance.accountProfileUpdate2(
|
|
1350
|
+
profile
|
|
1351
|
+
);
|
|
1352
|
+
```
|
|
1353
|
+
|
|
1354
|
+
### Parameters
|
|
1355
|
+
|
|
1356
|
+
|Name | Type | Description | Notes|
|
|
1357
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1358
|
+
| **profile** | **Profile**| | |
|
|
1359
|
+
|
|
1360
|
+
|
|
1361
|
+
### Return type
|
|
1362
|
+
|
|
1363
|
+
**Profile**
|
|
1364
|
+
|
|
1365
|
+
### Authorization
|
|
1366
|
+
|
|
1367
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1368
|
+
|
|
1369
|
+
### HTTP request headers
|
|
1370
|
+
|
|
1371
|
+
- **Content-Type**: application/json
|
|
1372
|
+
- **Accept**: application/json
|
|
1373
|
+
|
|
1374
|
+
|
|
1375
|
+
### HTTP response details
|
|
1376
|
+
| Status code | Description | Response headers |
|
|
1377
|
+
|-------------|-------------|------------------|
|
|
1378
|
+
|**200** | | - |
|
|
1379
|
+
|
|
1380
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1381
|
+
|
|
1382
|
+
# **accountSshKeysCreate**
|
|
1383
|
+
> SSHKey accountSshKeysCreate()
|
|
1384
|
+
|
|
1385
|
+
|
|
1386
|
+
### Example
|
|
1387
|
+
|
|
1388
|
+
```typescript
|
|
1389
|
+
import {
|
|
1390
|
+
AccountApi,
|
|
1391
|
+
Configuration,
|
|
1392
|
+
SSHKey
|
|
1393
|
+
} from '@pidginhost/sdk';
|
|
1394
|
+
|
|
1395
|
+
const configuration = new Configuration();
|
|
1396
|
+
const apiInstance = new AccountApi(configuration);
|
|
1397
|
+
|
|
1398
|
+
let sSHKey: SSHKey; // (optional)
|
|
1399
|
+
|
|
1400
|
+
const { status, data } = await apiInstance.accountSshKeysCreate(
|
|
1401
|
+
sSHKey
|
|
1402
|
+
);
|
|
1403
|
+
```
|
|
1404
|
+
|
|
1405
|
+
### Parameters
|
|
1406
|
+
|
|
1407
|
+
|Name | Type | Description | Notes|
|
|
1408
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1409
|
+
| **sSHKey** | **SSHKey**| | |
|
|
1410
|
+
|
|
1411
|
+
|
|
1412
|
+
### Return type
|
|
1413
|
+
|
|
1414
|
+
**SSHKey**
|
|
1415
|
+
|
|
1416
|
+
### Authorization
|
|
1417
|
+
|
|
1418
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1419
|
+
|
|
1420
|
+
### HTTP request headers
|
|
1421
|
+
|
|
1422
|
+
- **Content-Type**: application/json
|
|
1423
|
+
- **Accept**: application/json
|
|
1424
|
+
|
|
1425
|
+
|
|
1426
|
+
### HTTP response details
|
|
1427
|
+
| Status code | Description | Response headers |
|
|
1428
|
+
|-------------|-------------|------------------|
|
|
1429
|
+
|**201** | | - |
|
|
1430
|
+
|
|
1431
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1432
|
+
|
|
1433
|
+
# **accountSshKeysCreate2**
|
|
1434
|
+
> SSHKey accountSshKeysCreate2()
|
|
1435
|
+
|
|
1436
|
+
|
|
1437
|
+
### Example
|
|
1438
|
+
|
|
1439
|
+
```typescript
|
|
1440
|
+
import {
|
|
1441
|
+
AccountApi,
|
|
1442
|
+
Configuration,
|
|
1443
|
+
SSHKey
|
|
1444
|
+
} from '@pidginhost/sdk';
|
|
1445
|
+
|
|
1446
|
+
const configuration = new Configuration();
|
|
1447
|
+
const apiInstance = new AccountApi(configuration);
|
|
1448
|
+
|
|
1449
|
+
let sSHKey: SSHKey; // (optional)
|
|
1450
|
+
|
|
1451
|
+
const { status, data } = await apiInstance.accountSshKeysCreate2(
|
|
1452
|
+
sSHKey
|
|
1453
|
+
);
|
|
1454
|
+
```
|
|
1455
|
+
|
|
1456
|
+
### Parameters
|
|
1457
|
+
|
|
1458
|
+
|Name | Type | Description | Notes|
|
|
1459
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1460
|
+
| **sSHKey** | **SSHKey**| | |
|
|
1461
|
+
|
|
1462
|
+
|
|
1463
|
+
### Return type
|
|
1464
|
+
|
|
1465
|
+
**SSHKey**
|
|
1466
|
+
|
|
1467
|
+
### Authorization
|
|
1468
|
+
|
|
1469
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1470
|
+
|
|
1471
|
+
### HTTP request headers
|
|
1472
|
+
|
|
1473
|
+
- **Content-Type**: application/json
|
|
1474
|
+
- **Accept**: application/json
|
|
1475
|
+
|
|
1476
|
+
|
|
1477
|
+
### HTTP response details
|
|
1478
|
+
| Status code | Description | Response headers |
|
|
1479
|
+
|-------------|-------------|------------------|
|
|
1480
|
+
|**201** | | - |
|
|
1481
|
+
|
|
1482
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1483
|
+
|
|
1484
|
+
# **accountSshKeysDestroy**
|
|
1485
|
+
> accountSshKeysDestroy()
|
|
1486
|
+
|
|
1487
|
+
|
|
1488
|
+
### Example
|
|
1489
|
+
|
|
1490
|
+
```typescript
|
|
1491
|
+
import {
|
|
1492
|
+
AccountApi,
|
|
1493
|
+
Configuration
|
|
1494
|
+
} from '@pidginhost/sdk';
|
|
1495
|
+
|
|
1496
|
+
const configuration = new Configuration();
|
|
1497
|
+
const apiInstance = new AccountApi(configuration);
|
|
1498
|
+
|
|
1499
|
+
let id: string; // (default to undefined)
|
|
1500
|
+
|
|
1501
|
+
const { status, data } = await apiInstance.accountSshKeysDestroy(
|
|
1502
|
+
id
|
|
1503
|
+
);
|
|
1504
|
+
```
|
|
1505
|
+
|
|
1506
|
+
### Parameters
|
|
1507
|
+
|
|
1508
|
+
|Name | Type | Description | Notes|
|
|
1509
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1510
|
+
| **id** | [**string**] | | defaults to undefined|
|
|
1511
|
+
|
|
1512
|
+
|
|
1513
|
+
### Return type
|
|
1514
|
+
|
|
1515
|
+
void (empty response body)
|
|
1516
|
+
|
|
1517
|
+
### Authorization
|
|
1518
|
+
|
|
1519
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1520
|
+
|
|
1521
|
+
### HTTP request headers
|
|
1522
|
+
|
|
1523
|
+
- **Content-Type**: Not defined
|
|
1524
|
+
- **Accept**: Not defined
|
|
1525
|
+
|
|
1526
|
+
|
|
1527
|
+
### HTTP response details
|
|
1528
|
+
| Status code | Description | Response headers |
|
|
1529
|
+
|-------------|-------------|------------------|
|
|
1530
|
+
|**204** | No response body | - |
|
|
1531
|
+
|
|
1532
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1533
|
+
|
|
1534
|
+
# **accountSshKeysDestroy2**
|
|
1535
|
+
> accountSshKeysDestroy2()
|
|
1536
|
+
|
|
1537
|
+
|
|
1538
|
+
### Example
|
|
1539
|
+
|
|
1540
|
+
```typescript
|
|
1541
|
+
import {
|
|
1542
|
+
AccountApi,
|
|
1543
|
+
Configuration
|
|
1544
|
+
} from '@pidginhost/sdk';
|
|
1545
|
+
|
|
1546
|
+
const configuration = new Configuration();
|
|
1547
|
+
const apiInstance = new AccountApi(configuration);
|
|
1548
|
+
|
|
1549
|
+
let id: string; // (default to undefined)
|
|
1550
|
+
|
|
1551
|
+
const { status, data } = await apiInstance.accountSshKeysDestroy2(
|
|
1552
|
+
id
|
|
1553
|
+
);
|
|
1554
|
+
```
|
|
1555
|
+
|
|
1556
|
+
### Parameters
|
|
1557
|
+
|
|
1558
|
+
|Name | Type | Description | Notes|
|
|
1559
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1560
|
+
| **id** | [**string**] | | defaults to undefined|
|
|
1561
|
+
|
|
1562
|
+
|
|
1563
|
+
### Return type
|
|
1564
|
+
|
|
1565
|
+
void (empty response body)
|
|
1566
|
+
|
|
1567
|
+
### Authorization
|
|
1568
|
+
|
|
1569
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1570
|
+
|
|
1571
|
+
### HTTP request headers
|
|
1572
|
+
|
|
1573
|
+
- **Content-Type**: Not defined
|
|
1574
|
+
- **Accept**: Not defined
|
|
1575
|
+
|
|
1576
|
+
|
|
1577
|
+
### HTTP response details
|
|
1578
|
+
| Status code | Description | Response headers |
|
|
1579
|
+
|-------------|-------------|------------------|
|
|
1580
|
+
|**204** | No response body | - |
|
|
1581
|
+
|
|
1582
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1583
|
+
|
|
1584
|
+
# **accountSshKeysList**
|
|
1585
|
+
> PaginatedSSHKeyList accountSshKeysList()
|
|
1586
|
+
|
|
1587
|
+
|
|
1588
|
+
### Example
|
|
1589
|
+
|
|
1590
|
+
```typescript
|
|
1591
|
+
import {
|
|
1592
|
+
AccountApi,
|
|
1593
|
+
Configuration
|
|
1594
|
+
} from '@pidginhost/sdk';
|
|
1595
|
+
|
|
1596
|
+
const configuration = new Configuration();
|
|
1597
|
+
const apiInstance = new AccountApi(configuration);
|
|
1598
|
+
|
|
1599
|
+
let page: number; //A page number within the paginated result set. (optional) (default to undefined)
|
|
1600
|
+
|
|
1601
|
+
const { status, data } = await apiInstance.accountSshKeysList(
|
|
1602
|
+
page
|
|
1603
|
+
);
|
|
1604
|
+
```
|
|
1605
|
+
|
|
1606
|
+
### Parameters
|
|
1607
|
+
|
|
1608
|
+
|Name | Type | Description | Notes|
|
|
1609
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1610
|
+
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
1611
|
+
|
|
1612
|
+
|
|
1613
|
+
### Return type
|
|
1614
|
+
|
|
1615
|
+
**PaginatedSSHKeyList**
|
|
1616
|
+
|
|
1617
|
+
### Authorization
|
|
1618
|
+
|
|
1619
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1620
|
+
|
|
1621
|
+
### HTTP request headers
|
|
1622
|
+
|
|
1623
|
+
- **Content-Type**: Not defined
|
|
1624
|
+
- **Accept**: application/json
|
|
1625
|
+
|
|
1626
|
+
|
|
1627
|
+
### HTTP response details
|
|
1628
|
+
| Status code | Description | Response headers |
|
|
1629
|
+
|-------------|-------------|------------------|
|
|
1630
|
+
|**200** | | - |
|
|
1631
|
+
|
|
1632
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1633
|
+
|
|
1634
|
+
# **accountSshKeysList2**
|
|
1635
|
+
> PaginatedSSHKeyList accountSshKeysList2()
|
|
1636
|
+
|
|
1637
|
+
|
|
1638
|
+
### Example
|
|
1639
|
+
|
|
1640
|
+
```typescript
|
|
1641
|
+
import {
|
|
1642
|
+
AccountApi,
|
|
1643
|
+
Configuration
|
|
1644
|
+
} from '@pidginhost/sdk';
|
|
1645
|
+
|
|
1646
|
+
const configuration = new Configuration();
|
|
1647
|
+
const apiInstance = new AccountApi(configuration);
|
|
1648
|
+
|
|
1649
|
+
let page: number; //A page number within the paginated result set. (optional) (default to undefined)
|
|
1650
|
+
|
|
1651
|
+
const { status, data } = await apiInstance.accountSshKeysList2(
|
|
1652
|
+
page
|
|
1653
|
+
);
|
|
1654
|
+
```
|
|
1655
|
+
|
|
1656
|
+
### Parameters
|
|
1657
|
+
|
|
1658
|
+
|Name | Type | Description | Notes|
|
|
1659
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1660
|
+
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
1661
|
+
|
|
1662
|
+
|
|
1663
|
+
### Return type
|
|
1664
|
+
|
|
1665
|
+
**PaginatedSSHKeyList**
|
|
1666
|
+
|
|
1667
|
+
### Authorization
|
|
1668
|
+
|
|
1669
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1670
|
+
|
|
1671
|
+
### HTTP request headers
|
|
1672
|
+
|
|
1673
|
+
- **Content-Type**: Not defined
|
|
1674
|
+
- **Accept**: application/json
|
|
1675
|
+
|
|
1676
|
+
|
|
1677
|
+
### HTTP response details
|
|
1678
|
+
| Status code | Description | Response headers |
|
|
1679
|
+
|-------------|-------------|------------------|
|
|
1680
|
+
|**200** | | - |
|
|
1681
|
+
|
|
1682
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1683
|
+
|
|
1684
|
+
# **accountSshKeysPartialUpdate**
|
|
1685
|
+
> SSHKey accountSshKeysPartialUpdate()
|
|
1686
|
+
|
|
1687
|
+
|
|
1688
|
+
### Example
|
|
1689
|
+
|
|
1690
|
+
```typescript
|
|
1691
|
+
import {
|
|
1692
|
+
AccountApi,
|
|
1693
|
+
Configuration,
|
|
1694
|
+
PatchedSSHKey
|
|
1695
|
+
} from '@pidginhost/sdk';
|
|
1696
|
+
|
|
1697
|
+
const configuration = new Configuration();
|
|
1698
|
+
const apiInstance = new AccountApi(configuration);
|
|
1699
|
+
|
|
1700
|
+
let id: string; // (default to undefined)
|
|
1701
|
+
let patchedSSHKey: PatchedSSHKey; // (optional)
|
|
1702
|
+
|
|
1703
|
+
const { status, data } = await apiInstance.accountSshKeysPartialUpdate(
|
|
1704
|
+
id,
|
|
1705
|
+
patchedSSHKey
|
|
1706
|
+
);
|
|
1707
|
+
```
|
|
1708
|
+
|
|
1709
|
+
### Parameters
|
|
1710
|
+
|
|
1711
|
+
|Name | Type | Description | Notes|
|
|
1712
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1713
|
+
| **patchedSSHKey** | **PatchedSSHKey**| | |
|
|
1714
|
+
| **id** | [**string**] | | defaults to undefined|
|
|
1715
|
+
|
|
1716
|
+
|
|
1717
|
+
### Return type
|
|
1718
|
+
|
|
1719
|
+
**SSHKey**
|
|
1720
|
+
|
|
1721
|
+
### Authorization
|
|
1722
|
+
|
|
1723
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1724
|
+
|
|
1725
|
+
### HTTP request headers
|
|
1726
|
+
|
|
1727
|
+
- **Content-Type**: application/json
|
|
1728
|
+
- **Accept**: application/json
|
|
1729
|
+
|
|
1730
|
+
|
|
1731
|
+
### HTTP response details
|
|
1732
|
+
| Status code | Description | Response headers |
|
|
1733
|
+
|-------------|-------------|------------------|
|
|
1734
|
+
|**200** | | - |
|
|
1735
|
+
|
|
1736
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1737
|
+
|
|
1738
|
+
# **accountSshKeysPartialUpdate2**
|
|
1739
|
+
> SSHKey accountSshKeysPartialUpdate2()
|
|
1740
|
+
|
|
1741
|
+
|
|
1742
|
+
### Example
|
|
1743
|
+
|
|
1744
|
+
```typescript
|
|
1745
|
+
import {
|
|
1746
|
+
AccountApi,
|
|
1747
|
+
Configuration,
|
|
1748
|
+
PatchedSSHKey
|
|
1749
|
+
} from '@pidginhost/sdk';
|
|
1750
|
+
|
|
1751
|
+
const configuration = new Configuration();
|
|
1752
|
+
const apiInstance = new AccountApi(configuration);
|
|
1753
|
+
|
|
1754
|
+
let id: string; // (default to undefined)
|
|
1755
|
+
let patchedSSHKey: PatchedSSHKey; // (optional)
|
|
1756
|
+
|
|
1757
|
+
const { status, data } = await apiInstance.accountSshKeysPartialUpdate2(
|
|
1758
|
+
id,
|
|
1759
|
+
patchedSSHKey
|
|
1760
|
+
);
|
|
1761
|
+
```
|
|
1762
|
+
|
|
1763
|
+
### Parameters
|
|
1764
|
+
|
|
1765
|
+
|Name | Type | Description | Notes|
|
|
1766
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1767
|
+
| **patchedSSHKey** | **PatchedSSHKey**| | |
|
|
1768
|
+
| **id** | [**string**] | | defaults to undefined|
|
|
1769
|
+
|
|
1770
|
+
|
|
1771
|
+
### Return type
|
|
1772
|
+
|
|
1773
|
+
**SSHKey**
|
|
1774
|
+
|
|
1775
|
+
### Authorization
|
|
1776
|
+
|
|
1777
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1778
|
+
|
|
1779
|
+
### HTTP request headers
|
|
1780
|
+
|
|
1781
|
+
- **Content-Type**: application/json
|
|
1782
|
+
- **Accept**: application/json
|
|
1783
|
+
|
|
1784
|
+
|
|
1785
|
+
### HTTP response details
|
|
1786
|
+
| Status code | Description | Response headers |
|
|
1787
|
+
|-------------|-------------|------------------|
|
|
1788
|
+
|**200** | | - |
|
|
1789
|
+
|
|
1790
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1791
|
+
|
|
1792
|
+
# **accountSshKeysRetrieve**
|
|
1793
|
+
> SSHKey accountSshKeysRetrieve()
|
|
1794
|
+
|
|
1795
|
+
|
|
1796
|
+
### Example
|
|
1797
|
+
|
|
1798
|
+
```typescript
|
|
1799
|
+
import {
|
|
1800
|
+
AccountApi,
|
|
1801
|
+
Configuration
|
|
1802
|
+
} from '@pidginhost/sdk';
|
|
1803
|
+
|
|
1804
|
+
const configuration = new Configuration();
|
|
1805
|
+
const apiInstance = new AccountApi(configuration);
|
|
1806
|
+
|
|
1807
|
+
let id: string; // (default to undefined)
|
|
1808
|
+
|
|
1809
|
+
const { status, data } = await apiInstance.accountSshKeysRetrieve(
|
|
1810
|
+
id
|
|
1811
|
+
);
|
|
1812
|
+
```
|
|
1813
|
+
|
|
1814
|
+
### Parameters
|
|
1815
|
+
|
|
1816
|
+
|Name | Type | Description | Notes|
|
|
1817
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1818
|
+
| **id** | [**string**] | | defaults to undefined|
|
|
1819
|
+
|
|
1820
|
+
|
|
1821
|
+
### Return type
|
|
1822
|
+
|
|
1823
|
+
**SSHKey**
|
|
1824
|
+
|
|
1825
|
+
### Authorization
|
|
1826
|
+
|
|
1827
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1828
|
+
|
|
1829
|
+
### HTTP request headers
|
|
1830
|
+
|
|
1831
|
+
- **Content-Type**: Not defined
|
|
1832
|
+
- **Accept**: application/json
|
|
1833
|
+
|
|
1834
|
+
|
|
1835
|
+
### HTTP response details
|
|
1836
|
+
| Status code | Description | Response headers |
|
|
1837
|
+
|-------------|-------------|------------------|
|
|
1838
|
+
|**200** | | - |
|
|
1839
|
+
|
|
1840
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1841
|
+
|
|
1842
|
+
# **accountSshKeysRetrieve2**
|
|
1843
|
+
> SSHKey accountSshKeysRetrieve2()
|
|
1844
|
+
|
|
1845
|
+
|
|
1846
|
+
### Example
|
|
1847
|
+
|
|
1848
|
+
```typescript
|
|
1849
|
+
import {
|
|
1850
|
+
AccountApi,
|
|
1851
|
+
Configuration
|
|
1852
|
+
} from '@pidginhost/sdk';
|
|
1853
|
+
|
|
1854
|
+
const configuration = new Configuration();
|
|
1855
|
+
const apiInstance = new AccountApi(configuration);
|
|
1856
|
+
|
|
1857
|
+
let id: string; // (default to undefined)
|
|
1858
|
+
|
|
1859
|
+
const { status, data } = await apiInstance.accountSshKeysRetrieve2(
|
|
1860
|
+
id
|
|
1861
|
+
);
|
|
1862
|
+
```
|
|
1863
|
+
|
|
1864
|
+
### Parameters
|
|
1865
|
+
|
|
1866
|
+
|Name | Type | Description | Notes|
|
|
1867
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1868
|
+
| **id** | [**string**] | | defaults to undefined|
|
|
1869
|
+
|
|
1870
|
+
|
|
1871
|
+
### Return type
|
|
1872
|
+
|
|
1873
|
+
**SSHKey**
|
|
1874
|
+
|
|
1875
|
+
### Authorization
|
|
1876
|
+
|
|
1877
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1878
|
+
|
|
1879
|
+
### HTTP request headers
|
|
1880
|
+
|
|
1881
|
+
- **Content-Type**: Not defined
|
|
1882
|
+
- **Accept**: application/json
|
|
1883
|
+
|
|
1884
|
+
|
|
1885
|
+
### HTTP response details
|
|
1886
|
+
| Status code | Description | Response headers |
|
|
1887
|
+
|-------------|-------------|------------------|
|
|
1888
|
+
|**200** | | - |
|
|
1889
|
+
|
|
1890
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1891
|
+
|
|
1892
|
+
# **accountSshKeysUpdate**
|
|
1893
|
+
> SSHKey accountSshKeysUpdate()
|
|
1894
|
+
|
|
1895
|
+
|
|
1896
|
+
### Example
|
|
1897
|
+
|
|
1898
|
+
```typescript
|
|
1899
|
+
import {
|
|
1900
|
+
AccountApi,
|
|
1901
|
+
Configuration,
|
|
1902
|
+
SSHKey
|
|
1903
|
+
} from '@pidginhost/sdk';
|
|
1904
|
+
|
|
1905
|
+
const configuration = new Configuration();
|
|
1906
|
+
const apiInstance = new AccountApi(configuration);
|
|
1907
|
+
|
|
1908
|
+
let id: string; // (default to undefined)
|
|
1909
|
+
let sSHKey: SSHKey; // (optional)
|
|
1910
|
+
|
|
1911
|
+
const { status, data } = await apiInstance.accountSshKeysUpdate(
|
|
1912
|
+
id,
|
|
1913
|
+
sSHKey
|
|
1914
|
+
);
|
|
1915
|
+
```
|
|
1916
|
+
|
|
1917
|
+
### Parameters
|
|
1918
|
+
|
|
1919
|
+
|Name | Type | Description | Notes|
|
|
1920
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1921
|
+
| **sSHKey** | **SSHKey**| | |
|
|
1922
|
+
| **id** | [**string**] | | defaults to undefined|
|
|
1923
|
+
|
|
1924
|
+
|
|
1925
|
+
### Return type
|
|
1926
|
+
|
|
1927
|
+
**SSHKey**
|
|
1928
|
+
|
|
1929
|
+
### Authorization
|
|
1930
|
+
|
|
1931
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1932
|
+
|
|
1933
|
+
### HTTP request headers
|
|
1934
|
+
|
|
1935
|
+
- **Content-Type**: application/json
|
|
1936
|
+
- **Accept**: application/json
|
|
1937
|
+
|
|
1938
|
+
|
|
1939
|
+
### HTTP response details
|
|
1940
|
+
| Status code | Description | Response headers |
|
|
1941
|
+
|-------------|-------------|------------------|
|
|
1942
|
+
|**200** | | - |
|
|
1943
|
+
|
|
1944
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1945
|
+
|
|
1946
|
+
# **accountSshKeysUpdate2**
|
|
1947
|
+
> SSHKey accountSshKeysUpdate2()
|
|
1948
|
+
|
|
1949
|
+
|
|
1950
|
+
### Example
|
|
1951
|
+
|
|
1952
|
+
```typescript
|
|
1953
|
+
import {
|
|
1954
|
+
AccountApi,
|
|
1955
|
+
Configuration,
|
|
1956
|
+
SSHKey
|
|
1957
|
+
} from '@pidginhost/sdk';
|
|
1958
|
+
|
|
1959
|
+
const configuration = new Configuration();
|
|
1960
|
+
const apiInstance = new AccountApi(configuration);
|
|
1961
|
+
|
|
1962
|
+
let id: string; // (default to undefined)
|
|
1963
|
+
let sSHKey: SSHKey; // (optional)
|
|
1964
|
+
|
|
1965
|
+
const { status, data } = await apiInstance.accountSshKeysUpdate2(
|
|
1966
|
+
id,
|
|
1967
|
+
sSHKey
|
|
1968
|
+
);
|
|
1969
|
+
```
|
|
1970
|
+
|
|
1971
|
+
### Parameters
|
|
1972
|
+
|
|
1973
|
+
|Name | Type | Description | Notes|
|
|
1974
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1975
|
+
| **sSHKey** | **SSHKey**| | |
|
|
1976
|
+
| **id** | [**string**] | | defaults to undefined|
|
|
1977
|
+
|
|
1978
|
+
|
|
1979
|
+
### Return type
|
|
1980
|
+
|
|
1981
|
+
**SSHKey**
|
|
1982
|
+
|
|
1983
|
+
### Authorization
|
|
1984
|
+
|
|
1985
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
1986
|
+
|
|
1987
|
+
### HTTP request headers
|
|
1988
|
+
|
|
1989
|
+
- **Content-Type**: application/json
|
|
1990
|
+
- **Accept**: application/json
|
|
1991
|
+
|
|
1992
|
+
|
|
1993
|
+
### HTTP response details
|
|
1994
|
+
| Status code | Description | Response headers |
|
|
1995
|
+
|-------------|-------------|------------------|
|
|
1996
|
+
|**200** | | - |
|
|
1997
|
+
|
|
1998
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1999
|
+
|