yellowgrid-api-ts 3.1.5 → 3.1.6
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 +2 -0
- package/README.md +2 -0
- package/api.ts +140 -0
- package/dist/api.d.ts +94 -0
- package/dist/api.js +118 -3
- package/docs/CRMApi.md +55 -0
- package/docs/CrmContactDTO.md +31 -0
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -23,6 +23,7 @@ docs/AttachmentModel.md
|
|
|
23
23
|
docs/AttributeSetEnum.md
|
|
24
24
|
docs/AuthCodeResponseModel.md
|
|
25
25
|
docs/BatchEntity.md
|
|
26
|
+
docs/CRMApi.md
|
|
26
27
|
docs/CallBarringModel.md
|
|
27
28
|
docs/Class3CXApi.md
|
|
28
29
|
docs/Class3CXInstallationWizardApi.md
|
|
@@ -35,6 +36,7 @@ docs/CompanyContractModel.md
|
|
|
35
36
|
docs/ContactInfoModel.md
|
|
36
37
|
docs/ConversationModel.md
|
|
37
38
|
docs/CreditAccountEntity.md
|
|
39
|
+
docs/CrmContactDTO.md
|
|
38
40
|
docs/CustomerInformationModel.md
|
|
39
41
|
docs/CustomerPriceListEnum.md
|
|
40
42
|
docs/CustomerSummaryReportDTO.md
|
package/README.md
CHANGED
|
@@ -68,6 +68,7 @@ Class | Method | HTTP request | Description
|
|
|
68
68
|
*AccountsApi* | [**postSendPasswordReset**](docs/AccountsApi.md#postsendpasswordreset) | **POST** /accounts/contacts/password/reset | Send password reset email
|
|
69
69
|
*AccountsApi* | [**postSubmitResellerApplication**](docs/AccountsApi.md#postsubmitresellerapplication) | **POST** /accounts/reseller | Submit reseller application
|
|
70
70
|
*AccountsApi* | [**putUpdateAccountContact**](docs/AccountsApi.md#putupdateaccountcontact) | **PUT** /accounts/me/contacts/{email} | Update Account Contact
|
|
71
|
+
*CRMApi* | [**getSearchByPhone**](docs/CRMApi.md#getsearchbyphone) | **GET** /crm/contact/search |
|
|
71
72
|
*Class3CXApi* | [**getGetLicenceDetails**](docs/Class3CXApi.md#getgetlicencedetails) | **GET** /tcx/licences/details | Get 3CX Licence Details
|
|
72
73
|
*Class3CXApi* | [**getGetPasswordHash**](docs/Class3CXApi.md#getgetpasswordhash) | **GET** /tcx/pwd2hash | Convert a password to a hashed 3CX password
|
|
73
74
|
*Class3CXApi* | [**postGetBulkLicenceDetails**](docs/Class3CXApi.md#postgetbulklicencedetails) | **POST** /tcx/licences/bulk/details | Get bulk 3CX Licence Details
|
|
@@ -234,6 +235,7 @@ Class | Method | HTTP request | Description
|
|
|
234
235
|
- [ContactInfoModel](docs/ContactInfoModel.md)
|
|
235
236
|
- [ConversationModel](docs/ConversationModel.md)
|
|
236
237
|
- [CreditAccountEntity](docs/CreditAccountEntity.md)
|
|
238
|
+
- [CrmContactDTO](docs/CrmContactDTO.md)
|
|
237
239
|
- [CustomerInformationModel](docs/CustomerInformationModel.md)
|
|
238
240
|
- [CustomerPriceListEnum](docs/CustomerPriceListEnum.md)
|
|
239
241
|
- [CustomerSummaryReportDTO](docs/CustomerSummaryReportDTO.md)
|
package/api.ts
CHANGED
|
@@ -1258,6 +1258,49 @@ export interface CreditAccountEntity {
|
|
|
1258
1258
|
*/
|
|
1259
1259
|
'prizePromo'?: boolean;
|
|
1260
1260
|
}
|
|
1261
|
+
/**
|
|
1262
|
+
* CRM Contact
|
|
1263
|
+
* @export
|
|
1264
|
+
* @interface CrmContactDTO
|
|
1265
|
+
*/
|
|
1266
|
+
export interface CrmContactDTO {
|
|
1267
|
+
/**
|
|
1268
|
+
* Contact ID
|
|
1269
|
+
* @type {string}
|
|
1270
|
+
* @memberof CrmContactDTO
|
|
1271
|
+
*/
|
|
1272
|
+
'id'?: string;
|
|
1273
|
+
/**
|
|
1274
|
+
* Contact Name
|
|
1275
|
+
* @type {string}
|
|
1276
|
+
* @memberof CrmContactDTO
|
|
1277
|
+
*/
|
|
1278
|
+
'name'?: string;
|
|
1279
|
+
/**
|
|
1280
|
+
* Phone Number
|
|
1281
|
+
* @type {string}
|
|
1282
|
+
* @memberof CrmContactDTO
|
|
1283
|
+
*/
|
|
1284
|
+
'phone'?: string;
|
|
1285
|
+
/**
|
|
1286
|
+
* Company Name
|
|
1287
|
+
* @type {string}
|
|
1288
|
+
* @memberof CrmContactDTO
|
|
1289
|
+
*/
|
|
1290
|
+
'company'?: string;
|
|
1291
|
+
/**
|
|
1292
|
+
* Email Address
|
|
1293
|
+
* @type {string}
|
|
1294
|
+
* @memberof CrmContactDTO
|
|
1295
|
+
*/
|
|
1296
|
+
'email'?: string;
|
|
1297
|
+
/**
|
|
1298
|
+
* URL
|
|
1299
|
+
* @type {string}
|
|
1300
|
+
* @memberof CrmContactDTO
|
|
1301
|
+
*/
|
|
1302
|
+
'url'?: string;
|
|
1303
|
+
}
|
|
1261
1304
|
/**
|
|
1262
1305
|
* SIP Trunk Customer
|
|
1263
1306
|
* @export
|
|
@@ -9769,6 +9812,103 @@ export class AccountsApi extends BaseAPI {
|
|
|
9769
9812
|
|
|
9770
9813
|
|
|
9771
9814
|
|
|
9815
|
+
/**
|
|
9816
|
+
* CRMApi - axios parameter creator
|
|
9817
|
+
* @export
|
|
9818
|
+
*/
|
|
9819
|
+
export const CRMApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
9820
|
+
return {
|
|
9821
|
+
/**
|
|
9822
|
+
* Search for contacts by phone number
|
|
9823
|
+
* @param {*} [options] Override http request option.
|
|
9824
|
+
* @throws {RequiredError}
|
|
9825
|
+
*/
|
|
9826
|
+
getSearchByPhone: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
9827
|
+
const localVarPath = `/crm/contact/search`;
|
|
9828
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
9829
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
9830
|
+
let baseOptions;
|
|
9831
|
+
if (configuration) {
|
|
9832
|
+
baseOptions = configuration.baseOptions;
|
|
9833
|
+
}
|
|
9834
|
+
|
|
9835
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
9836
|
+
const localVarHeaderParameter = {} as any;
|
|
9837
|
+
const localVarQueryParameter = {} as any;
|
|
9838
|
+
|
|
9839
|
+
|
|
9840
|
+
|
|
9841
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
9842
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
9843
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
9844
|
+
|
|
9845
|
+
return {
|
|
9846
|
+
url: toPathString(localVarUrlObj),
|
|
9847
|
+
options: localVarRequestOptions,
|
|
9848
|
+
};
|
|
9849
|
+
},
|
|
9850
|
+
}
|
|
9851
|
+
};
|
|
9852
|
+
|
|
9853
|
+
/**
|
|
9854
|
+
* CRMApi - functional programming interface
|
|
9855
|
+
* @export
|
|
9856
|
+
*/
|
|
9857
|
+
export const CRMApiFp = function(configuration?: Configuration) {
|
|
9858
|
+
const localVarAxiosParamCreator = CRMApiAxiosParamCreator(configuration)
|
|
9859
|
+
return {
|
|
9860
|
+
/**
|
|
9861
|
+
* Search for contacts by phone number
|
|
9862
|
+
* @param {*} [options] Override http request option.
|
|
9863
|
+
* @throws {RequiredError}
|
|
9864
|
+
*/
|
|
9865
|
+
async getSearchByPhone(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CrmContactDTO>> {
|
|
9866
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getSearchByPhone(options);
|
|
9867
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
9868
|
+
const localVarOperationServerBasePath = operationServerMap['CRMApi.getSearchByPhone']?.[localVarOperationServerIndex]?.url;
|
|
9869
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
9870
|
+
},
|
|
9871
|
+
}
|
|
9872
|
+
};
|
|
9873
|
+
|
|
9874
|
+
/**
|
|
9875
|
+
* CRMApi - factory interface
|
|
9876
|
+
* @export
|
|
9877
|
+
*/
|
|
9878
|
+
export const CRMApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
9879
|
+
const localVarFp = CRMApiFp(configuration)
|
|
9880
|
+
return {
|
|
9881
|
+
/**
|
|
9882
|
+
* Search for contacts by phone number
|
|
9883
|
+
* @param {*} [options] Override http request option.
|
|
9884
|
+
* @throws {RequiredError}
|
|
9885
|
+
*/
|
|
9886
|
+
getSearchByPhone(options?: RawAxiosRequestConfig): AxiosPromise<CrmContactDTO> {
|
|
9887
|
+
return localVarFp.getSearchByPhone(options).then((request) => request(axios, basePath));
|
|
9888
|
+
},
|
|
9889
|
+
};
|
|
9890
|
+
};
|
|
9891
|
+
|
|
9892
|
+
/**
|
|
9893
|
+
* CRMApi - object-oriented interface
|
|
9894
|
+
* @export
|
|
9895
|
+
* @class CRMApi
|
|
9896
|
+
* @extends {BaseAPI}
|
|
9897
|
+
*/
|
|
9898
|
+
export class CRMApi extends BaseAPI {
|
|
9899
|
+
/**
|
|
9900
|
+
* Search for contacts by phone number
|
|
9901
|
+
* @param {*} [options] Override http request option.
|
|
9902
|
+
* @throws {RequiredError}
|
|
9903
|
+
* @memberof CRMApi
|
|
9904
|
+
*/
|
|
9905
|
+
public getSearchByPhone(options?: RawAxiosRequestConfig) {
|
|
9906
|
+
return CRMApiFp(this.configuration).getSearchByPhone(options).then((request) => request(this.axios, this.basePath));
|
|
9907
|
+
}
|
|
9908
|
+
}
|
|
9909
|
+
|
|
9910
|
+
|
|
9911
|
+
|
|
9772
9912
|
/**
|
|
9773
9913
|
* Class3CXApi - axios parameter creator
|
|
9774
9914
|
* @export
|
package/dist/api.d.ts
CHANGED
|
@@ -1248,6 +1248,49 @@ export interface CreditAccountEntity {
|
|
|
1248
1248
|
*/
|
|
1249
1249
|
'prizePromo'?: boolean;
|
|
1250
1250
|
}
|
|
1251
|
+
/**
|
|
1252
|
+
* CRM Contact
|
|
1253
|
+
* @export
|
|
1254
|
+
* @interface CrmContactDTO
|
|
1255
|
+
*/
|
|
1256
|
+
export interface CrmContactDTO {
|
|
1257
|
+
/**
|
|
1258
|
+
* Contact ID
|
|
1259
|
+
* @type {string}
|
|
1260
|
+
* @memberof CrmContactDTO
|
|
1261
|
+
*/
|
|
1262
|
+
'id'?: string;
|
|
1263
|
+
/**
|
|
1264
|
+
* Contact Name
|
|
1265
|
+
* @type {string}
|
|
1266
|
+
* @memberof CrmContactDTO
|
|
1267
|
+
*/
|
|
1268
|
+
'name'?: string;
|
|
1269
|
+
/**
|
|
1270
|
+
* Phone Number
|
|
1271
|
+
* @type {string}
|
|
1272
|
+
* @memberof CrmContactDTO
|
|
1273
|
+
*/
|
|
1274
|
+
'phone'?: string;
|
|
1275
|
+
/**
|
|
1276
|
+
* Company Name
|
|
1277
|
+
* @type {string}
|
|
1278
|
+
* @memberof CrmContactDTO
|
|
1279
|
+
*/
|
|
1280
|
+
'company'?: string;
|
|
1281
|
+
/**
|
|
1282
|
+
* Email Address
|
|
1283
|
+
* @type {string}
|
|
1284
|
+
* @memberof CrmContactDTO
|
|
1285
|
+
*/
|
|
1286
|
+
'email'?: string;
|
|
1287
|
+
/**
|
|
1288
|
+
* URL
|
|
1289
|
+
* @type {string}
|
|
1290
|
+
* @memberof CrmContactDTO
|
|
1291
|
+
*/
|
|
1292
|
+
'url'?: string;
|
|
1293
|
+
}
|
|
1251
1294
|
/**
|
|
1252
1295
|
* SIP Trunk Customer
|
|
1253
1296
|
* @export
|
|
@@ -9053,6 +9096,57 @@ export declare class AccountsApi extends BaseAPI {
|
|
|
9053
9096
|
*/
|
|
9054
9097
|
putUpdateAccountContact(email: string, accountContactRequestModel?: AccountContactRequestModel, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
9055
9098
|
}
|
|
9099
|
+
/**
|
|
9100
|
+
* CRMApi - axios parameter creator
|
|
9101
|
+
* @export
|
|
9102
|
+
*/
|
|
9103
|
+
export declare const CRMApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
9104
|
+
/**
|
|
9105
|
+
* Search for contacts by phone number
|
|
9106
|
+
* @param {*} [options] Override http request option.
|
|
9107
|
+
* @throws {RequiredError}
|
|
9108
|
+
*/
|
|
9109
|
+
getSearchByPhone: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
9110
|
+
};
|
|
9111
|
+
/**
|
|
9112
|
+
* CRMApi - functional programming interface
|
|
9113
|
+
* @export
|
|
9114
|
+
*/
|
|
9115
|
+
export declare const CRMApiFp: (configuration?: Configuration) => {
|
|
9116
|
+
/**
|
|
9117
|
+
* Search for contacts by phone number
|
|
9118
|
+
* @param {*} [options] Override http request option.
|
|
9119
|
+
* @throws {RequiredError}
|
|
9120
|
+
*/
|
|
9121
|
+
getSearchByPhone(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CrmContactDTO>>;
|
|
9122
|
+
};
|
|
9123
|
+
/**
|
|
9124
|
+
* CRMApi - factory interface
|
|
9125
|
+
* @export
|
|
9126
|
+
*/
|
|
9127
|
+
export declare const CRMApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
9128
|
+
/**
|
|
9129
|
+
* Search for contacts by phone number
|
|
9130
|
+
* @param {*} [options] Override http request option.
|
|
9131
|
+
* @throws {RequiredError}
|
|
9132
|
+
*/
|
|
9133
|
+
getSearchByPhone(options?: RawAxiosRequestConfig): AxiosPromise<CrmContactDTO>;
|
|
9134
|
+
};
|
|
9135
|
+
/**
|
|
9136
|
+
* CRMApi - object-oriented interface
|
|
9137
|
+
* @export
|
|
9138
|
+
* @class CRMApi
|
|
9139
|
+
* @extends {BaseAPI}
|
|
9140
|
+
*/
|
|
9141
|
+
export declare class CRMApi extends BaseAPI {
|
|
9142
|
+
/**
|
|
9143
|
+
* Search for contacts by phone number
|
|
9144
|
+
* @param {*} [options] Override http request option.
|
|
9145
|
+
* @throws {RequiredError}
|
|
9146
|
+
* @memberof CRMApi
|
|
9147
|
+
*/
|
|
9148
|
+
getSearchByPhone(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CrmContactDTO, any, {}>>;
|
|
9149
|
+
}
|
|
9056
9150
|
/**
|
|
9057
9151
|
* Class3CXApi - axios parameter creator
|
|
9058
9152
|
* @export
|
package/dist/api.js
CHANGED
|
@@ -84,9 +84,9 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
|
|
|
84
84
|
return to.concat(ar || Array.prototype.slice.call(from));
|
|
85
85
|
};
|
|
86
86
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
87
|
-
exports.
|
|
88
|
-
exports.
|
|
89
|
-
exports.PostAddWebhookWebhookUriEnum = exports.WebhooksApi = exports.WebhooksApiFactory = exports.WebhooksApiFp = exports.WebhooksApiAxiosParamCreator = exports.TicketsApi = exports.TicketsApiFactory = exports.TicketsApiFp = exports.TicketsApiAxiosParamCreator = exports.SystemApi = exports.SystemApiFactory = exports.SystemApiFp = void 0;
|
|
87
|
+
exports.Class3CXMultiTenantApiAxiosParamCreator = exports.GetGetPriceSchoolTypeEnum = exports.GetGetPriceLicenceTypeEnum = exports.Class3CXIntegrationsApi = exports.Class3CXIntegrationsApiFactory = exports.Class3CXIntegrationsApiFp = exports.Class3CXIntegrationsApiAxiosParamCreator = exports.PostResizeInstanceSizeEnum = exports.PostFailoverInstanceTypeEnum = exports.GetGetInstallationsHostingEnum = exports.GetGetInstallationsStatusEnum = exports.Class3CXInstallationsApi = exports.Class3CXInstallationsApiFactory = exports.Class3CXInstallationsApiFp = exports.Class3CXInstallationsApiAxiosParamCreator = exports.Class3CXInstallationWizardApi = exports.Class3CXInstallationWizardApiFactory = exports.Class3CXInstallationWizardApiFp = exports.Class3CXInstallationWizardApiAxiosParamCreator = exports.Class3CXApi = exports.Class3CXApiFactory = exports.Class3CXApiFp = exports.Class3CXApiAxiosParamCreator = exports.CRMApi = exports.CRMApiFactory = exports.CRMApiFp = exports.CRMApiAxiosParamCreator = exports.AccountsApi = exports.AccountsApiFactory = exports.AccountsApiFp = exports.AccountsApiAxiosParamCreator = exports.UpgradeRequestModelSchoolTypeEnum = exports.UpgradeRequestModelLicenceTypeEnum = exports.TcxWizardModelInstallationStatusEnum = exports.TcxWizardModelInstallTypeEnum = exports.TcxSetupEntityRegionEnum = exports.TcxSetupEntityInstallTypeEnum = exports.TcxMultiTenantModelPackageEnum = exports.StockOrderModelPaidEnum = exports.StockOrderModelDeliveryMethodEnum = exports.SmsResponseModelEventTypeEnum = exports.SmsPhoneNumberModelStatusEnum = exports.SipTrunkChangeResponseModelTypeEnum = exports.OrderTotalModelCurrencyEnum = exports.OrderRequestModelSchoolTypeEnum = exports.OrderRequestModelLicenceTypeEnum = exports.MultiTenantChangeResponseModelTypeEnum = exports.HostingRegionDTOCodeEnum = exports.HostingChangeResponseModelTypeEnum = exports.DivertResponseModelStatusEnum = void 0;
|
|
88
|
+
exports.StockManagementApiAxiosParamCreator = exports.SMSApi = exports.SMSApiFactory = exports.SMSApiFp = exports.SMSApiAxiosParamCreator = exports.SIPTrunksApi = exports.SIPTrunksApiFactory = exports.SIPTrunksApiFp = exports.SIPTrunksApiAxiosParamCreator = exports.ProvisioningApi = exports.ProvisioningApiFactory = exports.ProvisioningApiFp = exports.ProvisioningApiAxiosParamCreator = exports.GetGetLegacyStockListFormatEnum = exports.ProductsApi = exports.ProductsApiFactory = exports.ProductsApiFp = exports.ProductsApiAxiosParamCreator = exports.PostSendPriceListCategoryEnum = exports.PostSendPriceListFormatEnum = exports.PostSendPriceListTypeEnum = exports.GetGetPriceListCategoryEnum = exports.GetGetPriceListFormatEnum = exports.GetGetPriceListTypeEnum = exports.PricingApi = exports.PricingApiFactory = exports.PricingApiFp = exports.PricingApiAxiosParamCreator = exports.GetGetOrdersFilterEnum = exports.GetGetOrdersStatusEnum = exports.OrdersApi = exports.OrdersApiFactory = exports.OrdersApiFp = exports.OrdersApiAxiosParamCreator = exports.PostAuthoriseScopeEnum = exports.PostAccessTokenTokenExchangeTypeEnum = exports.PostAccessTokenScopeEnum = exports.PostAccessTokenGrantTypeEnum = exports.OAuth20Api = exports.OAuth20ApiFactory = exports.OAuth20ApiFp = exports.OAuth20ApiAxiosParamCreator = exports.MyPBXToolsApi = exports.MyPBXToolsApiFactory = exports.MyPBXToolsApiFp = exports.MyPBXToolsApiAxiosParamCreator = exports.GetGetTenantsStatusEnum = exports.Class3CXMultiTenantApi = exports.Class3CXMultiTenantApiFactory = exports.Class3CXMultiTenantApiFp = void 0;
|
|
89
|
+
exports.PostAddWebhookWebhookUriEnum = exports.WebhooksApi = exports.WebhooksApiFactory = exports.WebhooksApiFp = exports.WebhooksApiAxiosParamCreator = exports.TicketsApi = exports.TicketsApiFactory = exports.TicketsApiFp = exports.TicketsApiAxiosParamCreator = exports.SystemApi = exports.SystemApiFactory = exports.SystemApiFp = exports.SystemApiAxiosParamCreator = exports.StockManagementApi = exports.StockManagementApiFactory = exports.StockManagementApiFp = void 0;
|
|
90
90
|
var axios_1 = require("axios");
|
|
91
91
|
// Some imports not used depending on template conditions
|
|
92
92
|
// @ts-ignore
|
|
@@ -1724,6 +1724,121 @@ var AccountsApi = /** @class */ (function (_super) {
|
|
|
1724
1724
|
return AccountsApi;
|
|
1725
1725
|
}(base_1.BaseAPI));
|
|
1726
1726
|
exports.AccountsApi = AccountsApi;
|
|
1727
|
+
/**
|
|
1728
|
+
* CRMApi - axios parameter creator
|
|
1729
|
+
* @export
|
|
1730
|
+
*/
|
|
1731
|
+
var CRMApiAxiosParamCreator = function (configuration) {
|
|
1732
|
+
var _this = this;
|
|
1733
|
+
return {
|
|
1734
|
+
/**
|
|
1735
|
+
* Search for contacts by phone number
|
|
1736
|
+
* @param {*} [options] Override http request option.
|
|
1737
|
+
* @throws {RequiredError}
|
|
1738
|
+
*/
|
|
1739
|
+
getSearchByPhone: function () {
|
|
1740
|
+
var args_1 = [];
|
|
1741
|
+
for (var _i = 0; _i < arguments.length; _i++) {
|
|
1742
|
+
args_1[_i] = arguments[_i];
|
|
1743
|
+
}
|
|
1744
|
+
return __awaiter(_this, __spreadArray([], args_1, true), void 0, function (options) {
|
|
1745
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
1746
|
+
if (options === void 0) { options = {}; }
|
|
1747
|
+
return __generator(this, function (_a) {
|
|
1748
|
+
localVarPath = "/crm/contact/search";
|
|
1749
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1750
|
+
if (configuration) {
|
|
1751
|
+
baseOptions = configuration.baseOptions;
|
|
1752
|
+
}
|
|
1753
|
+
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
|
|
1754
|
+
localVarHeaderParameter = {};
|
|
1755
|
+
localVarQueryParameter = {};
|
|
1756
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1757
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1758
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1759
|
+
return [2 /*return*/, {
|
|
1760
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1761
|
+
options: localVarRequestOptions,
|
|
1762
|
+
}];
|
|
1763
|
+
});
|
|
1764
|
+
});
|
|
1765
|
+
},
|
|
1766
|
+
};
|
|
1767
|
+
};
|
|
1768
|
+
exports.CRMApiAxiosParamCreator = CRMApiAxiosParamCreator;
|
|
1769
|
+
/**
|
|
1770
|
+
* CRMApi - functional programming interface
|
|
1771
|
+
* @export
|
|
1772
|
+
*/
|
|
1773
|
+
var CRMApiFp = function (configuration) {
|
|
1774
|
+
var localVarAxiosParamCreator = (0, exports.CRMApiAxiosParamCreator)(configuration);
|
|
1775
|
+
return {
|
|
1776
|
+
/**
|
|
1777
|
+
* Search for contacts by phone number
|
|
1778
|
+
* @param {*} [options] Override http request option.
|
|
1779
|
+
* @throws {RequiredError}
|
|
1780
|
+
*/
|
|
1781
|
+
getSearchByPhone: function (options) {
|
|
1782
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
1783
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
1784
|
+
var _a, _b, _c;
|
|
1785
|
+
return __generator(this, function (_d) {
|
|
1786
|
+
switch (_d.label) {
|
|
1787
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getSearchByPhone(options)];
|
|
1788
|
+
case 1:
|
|
1789
|
+
localVarAxiosArgs = _d.sent();
|
|
1790
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1791
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['CRMApi.getSearchByPhone']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1792
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
1793
|
+
}
|
|
1794
|
+
});
|
|
1795
|
+
});
|
|
1796
|
+
},
|
|
1797
|
+
};
|
|
1798
|
+
};
|
|
1799
|
+
exports.CRMApiFp = CRMApiFp;
|
|
1800
|
+
/**
|
|
1801
|
+
* CRMApi - factory interface
|
|
1802
|
+
* @export
|
|
1803
|
+
*/
|
|
1804
|
+
var CRMApiFactory = function (configuration, basePath, axios) {
|
|
1805
|
+
var localVarFp = (0, exports.CRMApiFp)(configuration);
|
|
1806
|
+
return {
|
|
1807
|
+
/**
|
|
1808
|
+
* Search for contacts by phone number
|
|
1809
|
+
* @param {*} [options] Override http request option.
|
|
1810
|
+
* @throws {RequiredError}
|
|
1811
|
+
*/
|
|
1812
|
+
getSearchByPhone: function (options) {
|
|
1813
|
+
return localVarFp.getSearchByPhone(options).then(function (request) { return request(axios, basePath); });
|
|
1814
|
+
},
|
|
1815
|
+
};
|
|
1816
|
+
};
|
|
1817
|
+
exports.CRMApiFactory = CRMApiFactory;
|
|
1818
|
+
/**
|
|
1819
|
+
* CRMApi - object-oriented interface
|
|
1820
|
+
* @export
|
|
1821
|
+
* @class CRMApi
|
|
1822
|
+
* @extends {BaseAPI}
|
|
1823
|
+
*/
|
|
1824
|
+
var CRMApi = /** @class */ (function (_super) {
|
|
1825
|
+
__extends(CRMApi, _super);
|
|
1826
|
+
function CRMApi() {
|
|
1827
|
+
return _super !== null && _super.apply(this, arguments) || this;
|
|
1828
|
+
}
|
|
1829
|
+
/**
|
|
1830
|
+
* Search for contacts by phone number
|
|
1831
|
+
* @param {*} [options] Override http request option.
|
|
1832
|
+
* @throws {RequiredError}
|
|
1833
|
+
* @memberof CRMApi
|
|
1834
|
+
*/
|
|
1835
|
+
CRMApi.prototype.getSearchByPhone = function (options) {
|
|
1836
|
+
var _this = this;
|
|
1837
|
+
return (0, exports.CRMApiFp)(this.configuration).getSearchByPhone(options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
1838
|
+
};
|
|
1839
|
+
return CRMApi;
|
|
1840
|
+
}(base_1.BaseAPI));
|
|
1841
|
+
exports.CRMApi = CRMApi;
|
|
1727
1842
|
/**
|
|
1728
1843
|
* Class3CXApi - axios parameter creator
|
|
1729
1844
|
* @export
|
package/docs/CRMApi.md
ADDED
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
# CRMApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://api.yellowgrid.local*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**getSearchByPhone**](#getsearchbyphone) | **GET** /crm/contact/search | |
|
|
8
|
+
|
|
9
|
+
# **getSearchByPhone**
|
|
10
|
+
> CrmContactDTO getSearchByPhone()
|
|
11
|
+
|
|
12
|
+
Search for contacts by phone number
|
|
13
|
+
|
|
14
|
+
### Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import {
|
|
18
|
+
CRMApi,
|
|
19
|
+
Configuration
|
|
20
|
+
} from 'yellowgrid-api-ts';
|
|
21
|
+
|
|
22
|
+
const configuration = new Configuration();
|
|
23
|
+
const apiInstance = new CRMApi(configuration);
|
|
24
|
+
|
|
25
|
+
const { status, data } = await apiInstance.getSearchByPhone();
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
### Parameters
|
|
29
|
+
This endpoint does not have any parameters.
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
### Return type
|
|
33
|
+
|
|
34
|
+
**CrmContactDTO**
|
|
35
|
+
|
|
36
|
+
### Authorization
|
|
37
|
+
|
|
38
|
+
No authorization required
|
|
39
|
+
|
|
40
|
+
### HTTP request headers
|
|
41
|
+
|
|
42
|
+
- **Content-Type**: Not defined
|
|
43
|
+
- **Accept**: application/json
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
### HTTP response details
|
|
47
|
+
| Status code | Description | Response headers |
|
|
48
|
+
|-------------|-------------|------------------|
|
|
49
|
+
|**200** | CRM Contact | - |
|
|
50
|
+
|**400** | Bad Request | - |
|
|
51
|
+
|**401** | Unauthorised | - |
|
|
52
|
+
|**403** | Access Denied | - |
|
|
53
|
+
|
|
54
|
+
[[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)
|
|
55
|
+
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# CrmContactDTO
|
|
2
|
+
|
|
3
|
+
CRM Contact
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | Contact ID | [optional] [default to undefined]
|
|
10
|
+
**name** | **string** | Contact Name | [optional] [default to undefined]
|
|
11
|
+
**phone** | **string** | Phone Number | [optional] [default to undefined]
|
|
12
|
+
**company** | **string** | Company Name | [optional] [default to undefined]
|
|
13
|
+
**email** | **string** | Email Address | [optional] [default to undefined]
|
|
14
|
+
**url** | **string** | URL | [optional] [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { CrmContactDTO } from 'yellowgrid-api-ts';
|
|
20
|
+
|
|
21
|
+
const instance: CrmContactDTO = {
|
|
22
|
+
id,
|
|
23
|
+
name,
|
|
24
|
+
phone,
|
|
25
|
+
company,
|
|
26
|
+
email,
|
|
27
|
+
url,
|
|
28
|
+
};
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|