yellowgrid-api-ts 3.2.132 → 3.2.133
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 +21 -2
- package/README.md +45 -2
- package/api.ts +2184 -128
- package/dist/api.d.ts +1175 -28
- package/dist/api.js +2244 -219
- package/dist/models/HostingPriceListEnum.d.ts +28 -0
- package/dist/models/HostingPriceListEnum.js +30 -0
- package/docs/AccountAddressesDTO.md +25 -0
- package/docs/AccountFinanceDTO.md +37 -0
- package/docs/AccountsApi.md +1331 -53
- package/docs/AddressDTO.md +31 -0
- package/docs/AdminUserModel.md +2 -0
- package/docs/CRMApi.md +120 -0
- package/docs/{PostAddAdminNoteRequest.md → CreateCrmNoteBody.md} +3 -3
- package/docs/CreditAccountEntity.md +4 -0
- package/docs/CrmActivitiesResponseDTO.md +23 -0
- package/docs/CrmActivityDTO.md +33 -0
- package/docs/CrmDateActivitiesDTO.md +23 -0
- package/docs/CrmNoteEntity.md +39 -0
- package/docs/CrmNoteModel.md +39 -0
- package/docs/NumberPortAdminNoteBody.md +20 -0
- package/docs/NumberPortingApi.md +5 -5
- package/docs/PartnerDTO.md +39 -0
- package/docs/{PatchSetTcxWizardCnameRequest.md → PatchUpdateAccountCnameRequest.md} +3 -3
- package/docs/PatchUpdateAccountCompanyNumberRequest.md +20 -0
- package/docs/PatchUpdateAccountPhoneRequest.md +20 -0
- package/docs/PatchUpdateAccountVatNumberRequest.md +20 -0
- package/docs/PatchUpdateCreditLimitRequest.md +20 -0
- package/docs/PatchUpdatePriceListRequest.md +20 -0
- package/docs/PatchUpdateSipChannelCostRequest.md +20 -0
- package/docs/PatchUpdateTcxHostingPriceListRequest.md +20 -0
- package/docs/PatchUpdateTcxPartnerIdRequest.md +20 -0
- package/docs/PortalAccountModel.md +4 -2
- package/docs/PostSendWelcomeEmailRequest.md +20 -0
- package/docs/ProspectDTO.md +2 -0
- package/models/HostingPriceListEnum.ts +29 -0
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -7,14 +7,17 @@ base.ts
|
|
|
7
7
|
common.ts
|
|
8
8
|
configuration.ts
|
|
9
9
|
docs/AbstractOrderRequestDTO.md
|
|
10
|
+
docs/AccountAddressesDTO.md
|
|
10
11
|
docs/AccountContactEntity.md
|
|
11
12
|
docs/AccountContactModel.md
|
|
12
13
|
docs/AccountContactRequestModel.md
|
|
13
14
|
docs/AccountDetailedSummaryDTO.md
|
|
15
|
+
docs/AccountFinanceDTO.md
|
|
14
16
|
docs/AccountRequestModel.md
|
|
15
17
|
docs/AccountSummaryDTO.md
|
|
16
18
|
docs/AccountsApi.md
|
|
17
19
|
docs/AccountsResponseModel.md
|
|
20
|
+
docs/AddressDTO.md
|
|
18
21
|
docs/AddressModel.md
|
|
19
22
|
docs/AddressRequestModel.md
|
|
20
23
|
docs/AdminNumberPortDTO.md
|
|
@@ -46,6 +49,7 @@ docs/CompanyContractModel.md
|
|
|
46
49
|
docs/ContactInfoModel.md
|
|
47
50
|
docs/ConversationModel.md
|
|
48
51
|
docs/CourierPriceEntity.md
|
|
52
|
+
docs/CreateCrmNoteBody.md
|
|
49
53
|
docs/CreditAccountEntity.md
|
|
50
54
|
docs/CreditNoteDTO.md
|
|
51
55
|
docs/CreditNoteEntity.md
|
|
@@ -53,7 +57,12 @@ docs/CreditNoteItemDTO.md
|
|
|
53
57
|
docs/CreditNoteItemEntity.md
|
|
54
58
|
docs/CreditNoteItemModel.md
|
|
55
59
|
docs/CreditNoteModel.md
|
|
60
|
+
docs/CrmActivitiesResponseDTO.md
|
|
61
|
+
docs/CrmActivityDTO.md
|
|
56
62
|
docs/CrmContactDTO.md
|
|
63
|
+
docs/CrmDateActivitiesDTO.md
|
|
64
|
+
docs/CrmNoteEntity.md
|
|
65
|
+
docs/CrmNoteModel.md
|
|
57
66
|
docs/CustomerInformationModel.md
|
|
58
67
|
docs/CustomerItemRequestDTO.md
|
|
59
68
|
docs/CustomerOrderRequestDTO.md
|
|
@@ -103,6 +112,7 @@ docs/MonthlyUsageModel.md
|
|
|
103
112
|
docs/MultiTenantChangeResponseModel.md
|
|
104
113
|
docs/MyPBXToolsApi.md
|
|
105
114
|
docs/NavigationModel.md
|
|
115
|
+
docs/NumberPortAdminNoteBody.md
|
|
106
116
|
docs/NumberPortDTO.md
|
|
107
117
|
docs/NumberPortNoteDTO.md
|
|
108
118
|
docs/NumberPortRangeDTO.md
|
|
@@ -123,15 +133,24 @@ docs/OrderTotalModel.md
|
|
|
123
133
|
docs/OrderedItemEntity.md
|
|
124
134
|
docs/OrderedItemModel.md
|
|
125
135
|
docs/OrdersApi.md
|
|
126
|
-
docs/
|
|
136
|
+
docs/PartnerDTO.md
|
|
137
|
+
docs/PatchUpdateAccountCnameRequest.md
|
|
138
|
+
docs/PatchUpdateAccountCompanyNumberRequest.md
|
|
127
139
|
docs/PatchUpdateAccountContactPasswordRequest.md
|
|
140
|
+
docs/PatchUpdateAccountPhoneRequest.md
|
|
141
|
+
docs/PatchUpdateAccountVatNumberRequest.md
|
|
142
|
+
docs/PatchUpdateCreditLimitRequest.md
|
|
143
|
+
docs/PatchUpdatePriceListRequest.md
|
|
144
|
+
docs/PatchUpdateSipChannelCostRequest.md
|
|
145
|
+
docs/PatchUpdateTcxHostingPriceListRequest.md
|
|
146
|
+
docs/PatchUpdateTcxPartnerIdRequest.md
|
|
128
147
|
docs/PortalAccountModel.md
|
|
129
148
|
docs/PortalLoginModel.md
|
|
130
|
-
docs/PostAddAdminNoteRequest.md
|
|
131
149
|
docs/PostAddOrderNoteRequest.md
|
|
132
150
|
docs/PostAddWebhook200Response.md
|
|
133
151
|
docs/PostGetClientCredentialsRequest.md
|
|
134
152
|
docs/PostGetProductForCustomerRequest.md
|
|
153
|
+
docs/PostSendWelcomeEmailRequest.md
|
|
135
154
|
docs/PostSplitOrderRequest.md
|
|
136
155
|
docs/PriceListItemModel.md
|
|
137
156
|
docs/PricingApi.md
|
package/README.md
CHANGED
|
@@ -51,27 +51,51 @@ All URIs are relative to *https://bitbucket.org*
|
|
|
51
51
|
|
|
52
52
|
Class | Method | HTTP request | Description
|
|
53
53
|
------------ | ------------- | ------------- | -------------
|
|
54
|
+
*AccountsApi* | [**deleteAdminUpdateAccountContact**](docs/AccountsApi.md#deleteadminupdateaccountcontact) | **DELETE** /admin/accounts/{id}/contacts/{contact_id} |
|
|
55
|
+
*AccountsApi* | [**deleteArchiveAccount**](docs/AccountsApi.md#deletearchiveaccount) | **DELETE** /admin/accounts/{id}/archive |
|
|
54
56
|
*AccountsApi* | [**deleteDeleteClientCredentials**](docs/AccountsApi.md#deletedeleteclientcredentials) | **DELETE** /accounts/me/contacts/credentials/{id} | Delete client credentials
|
|
55
57
|
*AccountsApi* | [**deleteUpdateAccountContact**](docs/AccountsApi.md#deleteupdateaccountcontact) | **DELETE** /accounts/me/contacts/{email} | Delete Account Contact
|
|
58
|
+
*AccountsApi* | [**getAdminCreateAccountContact**](docs/AccountsApi.md#getadmincreateaccountcontact) | **GET** /admin/accounts/{id}/contacts |
|
|
56
59
|
*AccountsApi* | [**getGetAccount**](docs/AccountsApi.md#getgetaccount) | **GET** /accounts/me | Get Account
|
|
60
|
+
*AccountsApi* | [**getGetAccountAddresses**](docs/AccountsApi.md#getgetaccountaddresses) | **GET** /admin/accounts/{id}/addresses |
|
|
57
61
|
*AccountsApi* | [**getGetAccountContacts**](docs/AccountsApi.md#getgetaccountcontacts) | **GET** /accounts/me/contacts | Get Account Contacts
|
|
58
62
|
*AccountsApi* | [**getGetAccountDetailedSummary**](docs/AccountsApi.md#getgetaccountdetailedsummary) | **GET** /accounts/{id}/summary | Get Account Detailed Summary
|
|
59
63
|
*AccountsApi* | [**getGetAccounts**](docs/AccountsApi.md#getgetaccounts) | **GET** /accounts | Get Accounts
|
|
60
64
|
*AccountsApi* | [**getGetClientCredentials**](docs/AccountsApi.md#getgetclientcredentials) | **GET** /accounts/me/contacts/credentials | Get user\'s client credentials
|
|
61
65
|
*AccountsApi* | [**getGetCustomerKeys**](docs/AccountsApi.md#getgetcustomerkeys) | **GET** /accounts/me/tcx/keys | Get 3CX Keys
|
|
66
|
+
*AccountsApi* | [**getGetFinanceSettings**](docs/AccountsApi.md#getgetfinancesettings) | **GET** /admin/accounts/{id}/finance |
|
|
67
|
+
*AccountsApi* | [**getGetTcxPartnerDetails**](docs/AccountsApi.md#getgettcxpartnerdetails) | **GET** /admin/accounts/{id}/tcx/partner |
|
|
62
68
|
*AccountsApi* | [**getVerifyEmailAddress**](docs/AccountsApi.md#getverifyemailaddress) | **GET** /accounts/contacts/verify | Verify account email address
|
|
69
|
+
*AccountsApi* | [**patchSetPortalAccess**](docs/AccountsApi.md#patchsetportalaccess) | **PATCH** /admin/accounts/{id}/portal/access/{state} |
|
|
70
|
+
*AccountsApi* | [**patchSetPrizePromo**](docs/AccountsApi.md#patchsetprizepromo) | **PATCH** /admin/accounts/{id}/prizes/{state} |
|
|
63
71
|
*AccountsApi* | [**patchSetTcxWizardCname**](docs/AccountsApi.md#patchsettcxwizardcname) | **PATCH** /accounts/me/cname |
|
|
72
|
+
*AccountsApi* | [**patchUpdateAccountCname**](docs/AccountsApi.md#patchupdateaccountcname) | **PATCH** /admin/accounts/{id}/cname |
|
|
73
|
+
*AccountsApi* | [**patchUpdateAccountCompanyNumber**](docs/AccountsApi.md#patchupdateaccountcompanynumber) | **PATCH** /admin/accounts/{id}/companyNumber |
|
|
64
74
|
*AccountsApi* | [**patchUpdateAccountContactPassword**](docs/AccountsApi.md#patchupdateaccountcontactpassword) | **PATCH** /accounts/contacts/password | Update Account Password
|
|
75
|
+
*AccountsApi* | [**patchUpdateAccountPhone**](docs/AccountsApi.md#patchupdateaccountphone) | **PATCH** /admin/accounts/{id}/phone |
|
|
76
|
+
*AccountsApi* | [**patchUpdateAccountVatNumber**](docs/AccountsApi.md#patchupdateaccountvatnumber) | **PATCH** /admin/accounts/{id}/vatNumber |
|
|
77
|
+
*AccountsApi* | [**patchUpdateCreditLimit**](docs/AccountsApi.md#patchupdatecreditlimit) | **PATCH** /admin/accounts/{id}/creditLimit |
|
|
78
|
+
*AccountsApi* | [**patchUpdatePriceList**](docs/AccountsApi.md#patchupdatepricelist) | **PATCH** /admin/accounts/{id}/priceList |
|
|
79
|
+
*AccountsApi* | [**patchUpdateSipChannelCost**](docs/AccountsApi.md#patchupdatesipchannelcost) | **PATCH** /admin/accounts/{id}/channelCost |
|
|
80
|
+
*AccountsApi* | [**patchUpdateTcxHostingPriceList**](docs/AccountsApi.md#patchupdatetcxhostingpricelist) | **PATCH** /admin/accounts/{id}/tcx/hosting/priceList |
|
|
81
|
+
*AccountsApi* | [**patchUpdateTcxPartnerId**](docs/AccountsApi.md#patchupdatetcxpartnerid) | **PATCH** /admin/accounts{id}/tcx/partner/id |
|
|
82
|
+
*AccountsApi* | [**postAdminCreateAccountContact**](docs/AccountsApi.md#postadmincreateaccountcontact) | **POST** /admin/accounts/{id}/contacts |
|
|
65
83
|
*AccountsApi* | [**postGetAccountContacts**](docs/AccountsApi.md#postgetaccountcontacts) | **POST** /accounts/me/contacts | Add Account Contact
|
|
66
84
|
*AccountsApi* | [**postGetAccounts**](docs/AccountsApi.md#postgetaccounts) | **POST** /accounts | Create a new customer account
|
|
67
85
|
*AccountsApi* | [**postGetAdminAccount**](docs/AccountsApi.md#postgetadminaccount) | **POST** /admin/me | Get Admin Account
|
|
68
86
|
*AccountsApi* | [**postGetClientCredentials**](docs/AccountsApi.md#postgetclientcredentials) | **POST** /accounts/me/contacts/credentials | Create client credentials
|
|
69
87
|
*AccountsApi* | [**postSendEmailVerificationEmail**](docs/AccountsApi.md#postsendemailverificationemail) | **POST** /accounts/contacts/verify/{email} | Send email verification email
|
|
70
88
|
*AccountsApi* | [**postSendPasswordReset**](docs/AccountsApi.md#postsendpasswordreset) | **POST** /accounts/contacts/password/reset | Send password reset email
|
|
89
|
+
*AccountsApi* | [**postSendWelcomeEmail**](docs/AccountsApi.md#postsendwelcomeemail) | **POST** /admin/accounts/{id}/email/welcome |
|
|
71
90
|
*AccountsApi* | [**postSubmitResellerApplication**](docs/AccountsApi.md#postsubmitresellerapplication) | **POST** /accounts/reseller | Submit reseller application
|
|
91
|
+
*AccountsApi* | [**putAdminUpdateAccountContact**](docs/AccountsApi.md#putadminupdateaccountcontact) | **PUT** /admin/accounts/{id}/contacts/{contact_id} |
|
|
72
92
|
*AccountsApi* | [**putUpdateAccountContact**](docs/AccountsApi.md#putupdateaccountcontact) | **PUT** /accounts/me/contacts/{email} | Update Account Contact
|
|
93
|
+
*AccountsApi* | [**putUpdateBillingAddress**](docs/AccountsApi.md#putupdatebillingaddress) | **PUT** /admin/accounts/{id}/billing/address |
|
|
94
|
+
*AccountsApi* | [**putUpdateShippingAddress**](docs/AccountsApi.md#putupdateshippingaddress) | **PUT** /admin/accounts/{id}/shipping/address |
|
|
73
95
|
*BillingApi* | [**getGetAllCustomer**](docs/BillingApi.md#getgetallcustomer) | **GET** /billing/admin/customerList | Get Billing Customers
|
|
96
|
+
*CRMApi* | [**getGetCrmActivities**](docs/CRMApi.md#getgetcrmactivities) | **GET** /admin/crm/{id}/activities |
|
|
74
97
|
*CRMApi* | [**getSearchByPhone**](docs/CRMApi.md#getsearchbyphone) | **GET** /crm/contact/search |
|
|
98
|
+
*CRMApi* | [**postCreateCrmNote**](docs/CRMApi.md#postcreatecrmnote) | **POST** /admin/crm/{id}/activities/note |
|
|
75
99
|
*Class3CXApi* | [**getGetLicenceDetails**](docs/Class3CXApi.md#getgetlicencedetails) | **GET** /tcx/licences/details | Get 3CX Licence Details
|
|
76
100
|
*Class3CXApi* | [**postGetBulkLicenceDetails**](docs/Class3CXApi.md#postgetbulklicencedetails) | **POST** /tcx/licences/bulk/details | Get bulk 3CX Licence Details
|
|
77
101
|
*Class3CXInstallationWizardApi* | [**deleteAddExtensions**](docs/Class3CXInstallationWizardApi.md#deleteaddextensions) | **DELETE** /tcx/wizards/extensions | Delete 3CX Installation Wizard Extensions
|
|
@@ -286,13 +310,16 @@ Class | Method | HTTP request | Description
|
|
|
286
310
|
### Documentation For Models
|
|
287
311
|
|
|
288
312
|
- [AbstractOrderRequestDTO](docs/AbstractOrderRequestDTO.md)
|
|
313
|
+
- [AccountAddressesDTO](docs/AccountAddressesDTO.md)
|
|
289
314
|
- [AccountContactEntity](docs/AccountContactEntity.md)
|
|
290
315
|
- [AccountContactModel](docs/AccountContactModel.md)
|
|
291
316
|
- [AccountContactRequestModel](docs/AccountContactRequestModel.md)
|
|
292
317
|
- [AccountDetailedSummaryDTO](docs/AccountDetailedSummaryDTO.md)
|
|
318
|
+
- [AccountFinanceDTO](docs/AccountFinanceDTO.md)
|
|
293
319
|
- [AccountRequestModel](docs/AccountRequestModel.md)
|
|
294
320
|
- [AccountSummaryDTO](docs/AccountSummaryDTO.md)
|
|
295
321
|
- [AccountsResponseModel](docs/AccountsResponseModel.md)
|
|
322
|
+
- [AddressDTO](docs/AddressDTO.md)
|
|
296
323
|
- [AddressModel](docs/AddressModel.md)
|
|
297
324
|
- [AddressRequestModel](docs/AddressRequestModel.md)
|
|
298
325
|
- [AdminNumberPortDTO](docs/AdminNumberPortDTO.md)
|
|
@@ -317,6 +344,7 @@ Class | Method | HTTP request | Description
|
|
|
317
344
|
- [ContactInfoModel](docs/ContactInfoModel.md)
|
|
318
345
|
- [ConversationModel](docs/ConversationModel.md)
|
|
319
346
|
- [CourierPriceEntity](docs/CourierPriceEntity.md)
|
|
347
|
+
- [CreateCrmNoteBody](docs/CreateCrmNoteBody.md)
|
|
320
348
|
- [CreditAccountEntity](docs/CreditAccountEntity.md)
|
|
321
349
|
- [CreditNoteDTO](docs/CreditNoteDTO.md)
|
|
322
350
|
- [CreditNoteEntity](docs/CreditNoteEntity.md)
|
|
@@ -324,7 +352,12 @@ Class | Method | HTTP request | Description
|
|
|
324
352
|
- [CreditNoteItemEntity](docs/CreditNoteItemEntity.md)
|
|
325
353
|
- [CreditNoteItemModel](docs/CreditNoteItemModel.md)
|
|
326
354
|
- [CreditNoteModel](docs/CreditNoteModel.md)
|
|
355
|
+
- [CrmActivitiesResponseDTO](docs/CrmActivitiesResponseDTO.md)
|
|
356
|
+
- [CrmActivityDTO](docs/CrmActivityDTO.md)
|
|
327
357
|
- [CrmContactDTO](docs/CrmContactDTO.md)
|
|
358
|
+
- [CrmDateActivitiesDTO](docs/CrmDateActivitiesDTO.md)
|
|
359
|
+
- [CrmNoteEntity](docs/CrmNoteEntity.md)
|
|
360
|
+
- [CrmNoteModel](docs/CrmNoteModel.md)
|
|
328
361
|
- [CustomerInformationModel](docs/CustomerInformationModel.md)
|
|
329
362
|
- [CustomerItemRequestDTO](docs/CustomerItemRequestDTO.md)
|
|
330
363
|
- [CustomerOrderRequestDTO](docs/CustomerOrderRequestDTO.md)
|
|
@@ -373,6 +406,7 @@ Class | Method | HTTP request | Description
|
|
|
373
406
|
- [MonthlyUsageModel](docs/MonthlyUsageModel.md)
|
|
374
407
|
- [MultiTenantChangeResponseModel](docs/MultiTenantChangeResponseModel.md)
|
|
375
408
|
- [NavigationModel](docs/NavigationModel.md)
|
|
409
|
+
- [NumberPortAdminNoteBody](docs/NumberPortAdminNoteBody.md)
|
|
376
410
|
- [NumberPortDTO](docs/NumberPortDTO.md)
|
|
377
411
|
- [NumberPortNoteDTO](docs/NumberPortNoteDTO.md)
|
|
378
412
|
- [NumberPortRangeDTO](docs/NumberPortRangeDTO.md)
|
|
@@ -390,15 +424,24 @@ Class | Method | HTTP request | Description
|
|
|
390
424
|
- [OrderTotalModel](docs/OrderTotalModel.md)
|
|
391
425
|
- [OrderedItemEntity](docs/OrderedItemEntity.md)
|
|
392
426
|
- [OrderedItemModel](docs/OrderedItemModel.md)
|
|
393
|
-
- [
|
|
427
|
+
- [PartnerDTO](docs/PartnerDTO.md)
|
|
428
|
+
- [PatchUpdateAccountCnameRequest](docs/PatchUpdateAccountCnameRequest.md)
|
|
429
|
+
- [PatchUpdateAccountCompanyNumberRequest](docs/PatchUpdateAccountCompanyNumberRequest.md)
|
|
394
430
|
- [PatchUpdateAccountContactPasswordRequest](docs/PatchUpdateAccountContactPasswordRequest.md)
|
|
431
|
+
- [PatchUpdateAccountPhoneRequest](docs/PatchUpdateAccountPhoneRequest.md)
|
|
432
|
+
- [PatchUpdateAccountVatNumberRequest](docs/PatchUpdateAccountVatNumberRequest.md)
|
|
433
|
+
- [PatchUpdateCreditLimitRequest](docs/PatchUpdateCreditLimitRequest.md)
|
|
434
|
+
- [PatchUpdatePriceListRequest](docs/PatchUpdatePriceListRequest.md)
|
|
435
|
+
- [PatchUpdateSipChannelCostRequest](docs/PatchUpdateSipChannelCostRequest.md)
|
|
436
|
+
- [PatchUpdateTcxHostingPriceListRequest](docs/PatchUpdateTcxHostingPriceListRequest.md)
|
|
437
|
+
- [PatchUpdateTcxPartnerIdRequest](docs/PatchUpdateTcxPartnerIdRequest.md)
|
|
395
438
|
- [PortalAccountModel](docs/PortalAccountModel.md)
|
|
396
439
|
- [PortalLoginModel](docs/PortalLoginModel.md)
|
|
397
|
-
- [PostAddAdminNoteRequest](docs/PostAddAdminNoteRequest.md)
|
|
398
440
|
- [PostAddOrderNoteRequest](docs/PostAddOrderNoteRequest.md)
|
|
399
441
|
- [PostAddWebhook200Response](docs/PostAddWebhook200Response.md)
|
|
400
442
|
- [PostGetClientCredentialsRequest](docs/PostGetClientCredentialsRequest.md)
|
|
401
443
|
- [PostGetProductForCustomerRequest](docs/PostGetProductForCustomerRequest.md)
|
|
444
|
+
- [PostSendWelcomeEmailRequest](docs/PostSendWelcomeEmailRequest.md)
|
|
402
445
|
- [PostSplitOrderRequest](docs/PostSplitOrderRequest.md)
|
|
403
446
|
- [PriceListItemModel](docs/PriceListItemModel.md)
|
|
404
447
|
- [PrinterEntity](docs/PrinterEntity.md)
|