yellowgrid-api-ts 3.2.120-dev.0 → 3.2.122-dev.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.
Files changed (12) hide show
  1. package/.openapi-generator/FILES +4 -1
  2. package/README.md +6 -1
  3. package/api.ts +307 -20
  4. package/dist/api.d.ts +215 -14
  5. package/dist/api.js +207 -18
  6. package/docs/CRMApi.md +120 -0
  7. package/docs/CrmActivityDto.md +33 -0
  8. package/docs/CrmNoteEntity.md +39 -0
  9. package/docs/CrmNoteModel.md +39 -0
  10. package/docs/NumberPortingApi.md +5 -5
  11. package/docs/PostCreateCrmNoteRequest.md +20 -0
  12. package/package.json +1 -1
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.Class3CXInstallationWizardApiFp = exports.Class3CXInstallationWizardApiAxiosParamCreator = exports.Class3CXApi = exports.Class3CXApiFactory = exports.Class3CXApiFp = exports.Class3CXApiAxiosParamCreator = exports.CRMApi = exports.CRMApiFactory = exports.CRMApiFp = exports.CRMApiAxiosParamCreator = exports.PatchSetPrizePromoStateEnum = exports.PatchSetPortalAccessStateEnum = 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.SmsAccountRequestDTOTypeEnum = exports.SmsAccountRequestDTOProviderEnum = exports.SipTrunkChangeResponseModelTypeEnum = exports.ShippingServiceModelCourierEnum = exports.ShippingServiceDTOCourierEnum = exports.ShippingRequestDTOPrinterEnum = exports.ShippingRequestDTOCourierEnum = exports.ShipmentRequestDTOCourierEnum = exports.ShipmentDTOCourierEnum = exports.ServiceStatusDTOStatusEnum = exports.ServiceHealthDTOGlobalStatusEnum = exports.OrderTotalModelCurrencyEnum = exports.OrderRequestModelSchoolTypeEnum = exports.OrderRequestModelLicenceTypeEnum = exports.MultiTenantChangeResponseModelTypeEnum = exports.ItemDiscountEntityTypeEnum = exports.HostingRegionDTOCodeEnum = exports.HostingChangeResponseModelTypeEnum = exports.EventDTOStatusEnum = exports.DivertResponseModelStatusEnum = exports.AuditLogEntityTypeEnum = exports.AuditLogEntityActionEnum = exports.AdminUserModelRoleEnum = void 0;
88
- exports.GetGetPriceListTypeEnum = exports.PricingApi = exports.PricingApiFactory = exports.PricingApiFp = exports.PricingApiAxiosParamCreator = exports.PostPrintShippingLabelPrinterEnum = 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.NumberPortingApi = exports.NumberPortingApiFactory = exports.NumberPortingApiFp = exports.NumberPortingApiAxiosParamCreator = exports.MyPBXToolsApi = exports.MyPBXToolsApiFactory = exports.MyPBXToolsApiFp = exports.MyPBXToolsApiAxiosParamCreator = exports.GetGetTenantsStatusEnum = exports.Class3CXMultiTenantApi = exports.Class3CXMultiTenantApiFactory = exports.Class3CXMultiTenantApiFp = exports.Class3CXMultiTenantApiAxiosParamCreator = exports.GetGetPriceSchoolTypeEnum = exports.GetGetPriceLicenceTypeEnum = exports.Class3CXIntegrationsApi = exports.Class3CXIntegrationsApiFactory = exports.Class3CXIntegrationsApiFp = exports.Class3CXIntegrationsApiAxiosParamCreator = exports.PostResizeInstanceSizeEnum = exports.PostFailoverInstanceTypeEnum = exports.GetGetInstallationsInstallTypeEnum = exports.GetGetInstallationsHostingEnum = exports.GetGetInstallationsStatusEnum = exports.Class3CXInstallationsApi = exports.Class3CXInstallationsApiFactory = exports.Class3CXInstallationsApiFp = exports.Class3CXInstallationsApiAxiosParamCreator = exports.Class3CXInstallationWizardApi = exports.Class3CXInstallationWizardApiFactory = 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 = exports.StockManagementApiAxiosParamCreator = exports.ShippingApi = exports.ShippingApiFactory = exports.ShippingApiFp = exports.ShippingApiAxiosParamCreator = exports.ServicesApi = exports.ServicesApiFactory = exports.ServicesApiFp = exports.ServicesApiAxiosParamCreator = 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 = void 0;
87
+ exports.Class3CXInstallationWizardApiAxiosParamCreator = exports.Class3CXApi = exports.Class3CXApiFactory = exports.Class3CXApiFp = exports.Class3CXApiAxiosParamCreator = exports.GetGetCrmActivitiesTypeEnum = exports.CRMApi = exports.CRMApiFactory = exports.CRMApiFp = exports.CRMApiAxiosParamCreator = exports.PatchSetPrizePromoStateEnum = exports.PatchSetPortalAccessStateEnum = 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.SmsAccountRequestDTOTypeEnum = exports.SmsAccountRequestDTOProviderEnum = exports.SipTrunkChangeResponseModelTypeEnum = exports.ShippingServiceModelCourierEnum = exports.ShippingServiceDTOCourierEnum = exports.ShippingRequestDTOPrinterEnum = exports.ShippingRequestDTOCourierEnum = exports.ShipmentRequestDTOCourierEnum = exports.ShipmentDTOCourierEnum = exports.ServiceStatusDTOStatusEnum = exports.ServiceHealthDTOGlobalStatusEnum = exports.OrderTotalModelCurrencyEnum = exports.OrderRequestModelSchoolTypeEnum = exports.OrderRequestModelLicenceTypeEnum = exports.MultiTenantChangeResponseModelTypeEnum = exports.ItemDiscountEntityTypeEnum = exports.HostingRegionDTOCodeEnum = exports.HostingChangeResponseModelTypeEnum = exports.EventDTOStatusEnum = exports.DivertResponseModelStatusEnum = exports.AuditLogEntityTypeEnum = exports.AuditLogEntityActionEnum = exports.AdminUserModelRoleEnum = void 0;
88
+ exports.PricingApi = exports.PricingApiFactory = exports.PricingApiFp = exports.PricingApiAxiosParamCreator = exports.PostPrintShippingLabelPrinterEnum = 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.NumberPortingApi = exports.NumberPortingApiFactory = exports.NumberPortingApiFp = exports.NumberPortingApiAxiosParamCreator = exports.MyPBXToolsApi = exports.MyPBXToolsApiFactory = exports.MyPBXToolsApiFp = exports.MyPBXToolsApiAxiosParamCreator = exports.GetGetTenantsStatusEnum = exports.Class3CXMultiTenantApi = exports.Class3CXMultiTenantApiFactory = exports.Class3CXMultiTenantApiFp = exports.Class3CXMultiTenantApiAxiosParamCreator = exports.GetGetPriceSchoolTypeEnum = exports.GetGetPriceLicenceTypeEnum = exports.Class3CXIntegrationsApi = exports.Class3CXIntegrationsApiFactory = exports.Class3CXIntegrationsApiFp = exports.Class3CXIntegrationsApiAxiosParamCreator = exports.PostResizeInstanceSizeEnum = exports.PostFailoverInstanceTypeEnum = exports.GetGetInstallationsInstallTypeEnum = exports.GetGetInstallationsHostingEnum = exports.GetGetInstallationsStatusEnum = exports.Class3CXInstallationsApi = exports.Class3CXInstallationsApiFactory = exports.Class3CXInstallationsApiFp = exports.Class3CXInstallationsApiAxiosParamCreator = exports.Class3CXInstallationWizardApi = exports.Class3CXInstallationWizardApiFactory = exports.Class3CXInstallationWizardApiFp = 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 = exports.StockManagementApiAxiosParamCreator = exports.ShippingApi = exports.ShippingApiFactory = exports.ShippingApiFp = exports.ShippingApiAxiosParamCreator = exports.ServicesApi = exports.ServicesApiFactory = exports.ServicesApiFp = exports.ServicesApiAxiosParamCreator = 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 = void 0;
90
90
  var axios_1 = require("axios");
91
91
  // Some imports not used depending on template conditions
92
92
  // @ts-ignore
@@ -113,6 +113,7 @@ exports.AuditLogEntityTypeEnum = {
113
113
  ApiLog: 'api_log',
114
114
  PopsBatches: 'pops_batches',
115
115
  PopsCourierPrices: 'pops_courier_prices',
116
+ PopsCrmNotes: 'pops_crm_notes',
116
117
  PopsCreditAccounts: 'pops_credit_accounts',
117
118
  PopsCreditNotes: 'pops_credit_notes',
118
119
  PopsCreditNotesItems: 'pops_credit_notes_items',
@@ -2857,6 +2858,55 @@ exports.PatchSetPrizePromoStateEnum = {
2857
2858
  var CRMApiAxiosParamCreator = function (configuration) {
2858
2859
  var _this = this;
2859
2860
  return {
2861
+ /**
2862
+ * Get Customer CRM Activities
2863
+ * @param {number} id Account ID
2864
+ * @param {GetGetCrmActivitiesTypeEnum} type Activity Type
2865
+ * @param {number} userId Activity Created By
2866
+ * @param {*} [options] Override http request option.
2867
+ * @throws {RequiredError}
2868
+ */
2869
+ getGetCrmActivities: function (id_1, type_1, userId_1) {
2870
+ var args_1 = [];
2871
+ for (var _i = 3; _i < arguments.length; _i++) {
2872
+ args_1[_i - 3] = arguments[_i];
2873
+ }
2874
+ return __awaiter(_this, __spreadArray([id_1, type_1, userId_1], args_1, true), void 0, function (id, type, userId, options) {
2875
+ var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
2876
+ if (options === void 0) { options = {}; }
2877
+ return __generator(this, function (_a) {
2878
+ // verify required parameter 'id' is not null or undefined
2879
+ (0, common_1.assertParamExists)('getGetCrmActivities', 'id', id);
2880
+ // verify required parameter 'type' is not null or undefined
2881
+ (0, common_1.assertParamExists)('getGetCrmActivities', 'type', type);
2882
+ // verify required parameter 'userId' is not null or undefined
2883
+ (0, common_1.assertParamExists)('getGetCrmActivities', 'userId', userId);
2884
+ localVarPath = "/admin/crm/{id}/activities"
2885
+ .replace("{".concat("id", "}"), encodeURIComponent(String(id)));
2886
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
2887
+ if (configuration) {
2888
+ baseOptions = configuration.baseOptions;
2889
+ }
2890
+ localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
2891
+ localVarHeaderParameter = {};
2892
+ localVarQueryParameter = {};
2893
+ if (type !== undefined) {
2894
+ localVarQueryParameter['type'] = type;
2895
+ }
2896
+ if (userId !== undefined) {
2897
+ localVarQueryParameter['userId'] = userId;
2898
+ }
2899
+ localVarHeaderParameter['Accept'] = 'application/json';
2900
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
2901
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2902
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
2903
+ return [2 /*return*/, {
2904
+ url: (0, common_1.toPathString)(localVarUrlObj),
2905
+ options: localVarRequestOptions,
2906
+ }];
2907
+ });
2908
+ });
2909
+ },
2860
2910
  /**
2861
2911
  * Search for contacts by phone number
2862
2912
  * @param {*} [options] Override http request option.
@@ -2890,6 +2940,46 @@ var CRMApiAxiosParamCreator = function (configuration) {
2890
2940
  });
2891
2941
  });
2892
2942
  },
2943
+ /**
2944
+ * Create CRM Note
2945
+ * @param {number} id Account ID
2946
+ * @param {PostCreateCrmNoteRequest} [postCreateCrmNoteRequest] CRM Note Request
2947
+ * @param {*} [options] Override http request option.
2948
+ * @throws {RequiredError}
2949
+ */
2950
+ postCreateCrmNote: function (id_1, postCreateCrmNoteRequest_1) {
2951
+ var args_1 = [];
2952
+ for (var _i = 2; _i < arguments.length; _i++) {
2953
+ args_1[_i - 2] = arguments[_i];
2954
+ }
2955
+ return __awaiter(_this, __spreadArray([id_1, postCreateCrmNoteRequest_1], args_1, true), void 0, function (id, postCreateCrmNoteRequest, options) {
2956
+ var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
2957
+ if (options === void 0) { options = {}; }
2958
+ return __generator(this, function (_a) {
2959
+ // verify required parameter 'id' is not null or undefined
2960
+ (0, common_1.assertParamExists)('postCreateCrmNote', 'id', id);
2961
+ localVarPath = "/admin/crm/{id}/activities/note"
2962
+ .replace("{".concat("id", "}"), encodeURIComponent(String(id)));
2963
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
2964
+ if (configuration) {
2965
+ baseOptions = configuration.baseOptions;
2966
+ }
2967
+ localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
2968
+ localVarHeaderParameter = {};
2969
+ localVarQueryParameter = {};
2970
+ localVarHeaderParameter['Content-Type'] = 'application/json';
2971
+ localVarHeaderParameter['Accept'] = 'application/json';
2972
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
2973
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2974
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
2975
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(postCreateCrmNoteRequest, localVarRequestOptions, configuration);
2976
+ return [2 /*return*/, {
2977
+ url: (0, common_1.toPathString)(localVarUrlObj),
2978
+ options: localVarRequestOptions,
2979
+ }];
2980
+ });
2981
+ });
2982
+ },
2893
2983
  };
2894
2984
  };
2895
2985
  exports.CRMApiAxiosParamCreator = CRMApiAxiosParamCreator;
@@ -2899,6 +2989,30 @@ exports.CRMApiAxiosParamCreator = CRMApiAxiosParamCreator;
2899
2989
  var CRMApiFp = function (configuration) {
2900
2990
  var localVarAxiosParamCreator = (0, exports.CRMApiAxiosParamCreator)(configuration);
2901
2991
  return {
2992
+ /**
2993
+ * Get Customer CRM Activities
2994
+ * @param {number} id Account ID
2995
+ * @param {GetGetCrmActivitiesTypeEnum} type Activity Type
2996
+ * @param {number} userId Activity Created By
2997
+ * @param {*} [options] Override http request option.
2998
+ * @throws {RequiredError}
2999
+ */
3000
+ getGetCrmActivities: function (id, type, userId, options) {
3001
+ return __awaiter(this, void 0, void 0, function () {
3002
+ var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
3003
+ var _a, _b, _c;
3004
+ return __generator(this, function (_d) {
3005
+ switch (_d.label) {
3006
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.getGetCrmActivities(id, type, userId, options)];
3007
+ case 1:
3008
+ localVarAxiosArgs = _d.sent();
3009
+ localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
3010
+ localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['CRMApi.getGetCrmActivities']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
3011
+ return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
3012
+ }
3013
+ });
3014
+ });
3015
+ },
2902
3016
  /**
2903
3017
  * Search for contacts by phone number
2904
3018
  * @param {*} [options] Override http request option.
@@ -2920,6 +3034,29 @@ var CRMApiFp = function (configuration) {
2920
3034
  });
2921
3035
  });
2922
3036
  },
3037
+ /**
3038
+ * Create CRM Note
3039
+ * @param {number} id Account ID
3040
+ * @param {PostCreateCrmNoteRequest} [postCreateCrmNoteRequest] CRM Note Request
3041
+ * @param {*} [options] Override http request option.
3042
+ * @throws {RequiredError}
3043
+ */
3044
+ postCreateCrmNote: function (id, postCreateCrmNoteRequest, options) {
3045
+ return __awaiter(this, void 0, void 0, function () {
3046
+ var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
3047
+ var _a, _b, _c;
3048
+ return __generator(this, function (_d) {
3049
+ switch (_d.label) {
3050
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.postCreateCrmNote(id, postCreateCrmNoteRequest, options)];
3051
+ case 1:
3052
+ localVarAxiosArgs = _d.sent();
3053
+ localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
3054
+ localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['CRMApi.postCreateCrmNote']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
3055
+ return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
3056
+ }
3057
+ });
3058
+ });
3059
+ },
2923
3060
  };
2924
3061
  };
2925
3062
  exports.CRMApiFp = CRMApiFp;
@@ -2929,6 +3066,17 @@ exports.CRMApiFp = CRMApiFp;
2929
3066
  var CRMApiFactory = function (configuration, basePath, axios) {
2930
3067
  var localVarFp = (0, exports.CRMApiFp)(configuration);
2931
3068
  return {
3069
+ /**
3070
+ * Get Customer CRM Activities
3071
+ * @param {number} id Account ID
3072
+ * @param {GetGetCrmActivitiesTypeEnum} type Activity Type
3073
+ * @param {number} userId Activity Created By
3074
+ * @param {*} [options] Override http request option.
3075
+ * @throws {RequiredError}
3076
+ */
3077
+ getGetCrmActivities: function (id, type, userId, options) {
3078
+ return localVarFp.getGetCrmActivities(id, type, userId, options).then(function (request) { return request(axios, basePath); });
3079
+ },
2932
3080
  /**
2933
3081
  * Search for contacts by phone number
2934
3082
  * @param {*} [options] Override http request option.
@@ -2937,6 +3085,16 @@ var CRMApiFactory = function (configuration, basePath, axios) {
2937
3085
  getSearchByPhone: function (options) {
2938
3086
  return localVarFp.getSearchByPhone(options).then(function (request) { return request(axios, basePath); });
2939
3087
  },
3088
+ /**
3089
+ * Create CRM Note
3090
+ * @param {number} id Account ID
3091
+ * @param {PostCreateCrmNoteRequest} [postCreateCrmNoteRequest] CRM Note Request
3092
+ * @param {*} [options] Override http request option.
3093
+ * @throws {RequiredError}
3094
+ */
3095
+ postCreateCrmNote: function (id, postCreateCrmNoteRequest, options) {
3096
+ return localVarFp.postCreateCrmNote(id, postCreateCrmNoteRequest, options).then(function (request) { return request(axios, basePath); });
3097
+ },
2940
3098
  };
2941
3099
  };
2942
3100
  exports.CRMApiFactory = CRMApiFactory;
@@ -2948,6 +3106,18 @@ var CRMApi = /** @class */ (function (_super) {
2948
3106
  function CRMApi() {
2949
3107
  return _super !== null && _super.apply(this, arguments) || this;
2950
3108
  }
3109
+ /**
3110
+ * Get Customer CRM Activities
3111
+ * @param {number} id Account ID
3112
+ * @param {GetGetCrmActivitiesTypeEnum} type Activity Type
3113
+ * @param {number} userId Activity Created By
3114
+ * @param {*} [options] Override http request option.
3115
+ * @throws {RequiredError}
3116
+ */
3117
+ CRMApi.prototype.getGetCrmActivities = function (id, type, userId, options) {
3118
+ var _this = this;
3119
+ return (0, exports.CRMApiFp)(this.configuration).getGetCrmActivities(id, type, userId, options).then(function (request) { return request(_this.axios, _this.basePath); });
3120
+ };
2951
3121
  /**
2952
3122
  * Search for contacts by phone number
2953
3123
  * @param {*} [options] Override http request option.
@@ -2957,9 +3127,28 @@ var CRMApi = /** @class */ (function (_super) {
2957
3127
  var _this = this;
2958
3128
  return (0, exports.CRMApiFp)(this.configuration).getSearchByPhone(options).then(function (request) { return request(_this.axios, _this.basePath); });
2959
3129
  };
3130
+ /**
3131
+ * Create CRM Note
3132
+ * @param {number} id Account ID
3133
+ * @param {PostCreateCrmNoteRequest} [postCreateCrmNoteRequest] CRM Note Request
3134
+ * @param {*} [options] Override http request option.
3135
+ * @throws {RequiredError}
3136
+ */
3137
+ CRMApi.prototype.postCreateCrmNote = function (id, postCreateCrmNoteRequest, options) {
3138
+ var _this = this;
3139
+ return (0, exports.CRMApiFp)(this.configuration).postCreateCrmNote(id, postCreateCrmNoteRequest, options).then(function (request) { return request(_this.axios, _this.basePath); });
3140
+ };
2960
3141
  return CRMApi;
2961
3142
  }(base_1.BaseAPI));
2962
3143
  exports.CRMApi = CRMApi;
3144
+ exports.GetGetCrmActivitiesTypeEnum = {
3145
+ Alert: 'alert',
3146
+ Call: 'call',
3147
+ Note: 'note',
3148
+ Order: 'order',
3149
+ Quote: 'quote',
3150
+ TcxOrder: 'tcx_order'
3151
+ };
2963
3152
  /**
2964
3153
  * Class3CXApi - axios parameter creator
2965
3154
  */
@@ -9381,23 +9570,23 @@ var NumberPortingApiAxiosParamCreator = function (configuration) {
9381
9570
  /**
9382
9571
  *
9383
9572
  * @param {number} id Number Port ID
9384
- * @param {PostAddAdminNoteRequest} postAddAdminNoteRequest
9573
+ * @param {PostCreateCrmNoteRequest} postCreateCrmNoteRequest
9385
9574
  * @param {*} [options] Override http request option.
9386
9575
  * @throws {RequiredError}
9387
9576
  */
9388
- postAddAdminNote: function (id_1, postAddAdminNoteRequest_1) {
9577
+ postAddAdminNote: function (id_1, postCreateCrmNoteRequest_1) {
9389
9578
  var args_1 = [];
9390
9579
  for (var _i = 2; _i < arguments.length; _i++) {
9391
9580
  args_1[_i - 2] = arguments[_i];
9392
9581
  }
9393
- return __awaiter(_this, __spreadArray([id_1, postAddAdminNoteRequest_1], args_1, true), void 0, function (id, postAddAdminNoteRequest, options) {
9582
+ return __awaiter(_this, __spreadArray([id_1, postCreateCrmNoteRequest_1], args_1, true), void 0, function (id, postCreateCrmNoteRequest, options) {
9394
9583
  var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
9395
9584
  if (options === void 0) { options = {}; }
9396
9585
  return __generator(this, function (_a) {
9397
9586
  // verify required parameter 'id' is not null or undefined
9398
9587
  (0, common_1.assertParamExists)('postAddAdminNote', 'id', id);
9399
- // verify required parameter 'postAddAdminNoteRequest' is not null or undefined
9400
- (0, common_1.assertParamExists)('postAddAdminNote', 'postAddAdminNoteRequest', postAddAdminNoteRequest);
9588
+ // verify required parameter 'postCreateCrmNoteRequest' is not null or undefined
9589
+ (0, common_1.assertParamExists)('postAddAdminNote', 'postCreateCrmNoteRequest', postCreateCrmNoteRequest);
9401
9590
  localVarPath = "/admin/sip/numbers/ports/{id}/notes"
9402
9591
  .replace("{".concat("id", "}"), encodeURIComponent(String(id)));
9403
9592
  localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -9412,7 +9601,7 @@ var NumberPortingApiAxiosParamCreator = function (configuration) {
9412
9601
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
9413
9602
  headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
9414
9603
  localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
9415
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(postAddAdminNoteRequest, localVarRequestOptions, configuration);
9604
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(postCreateCrmNoteRequest, localVarRequestOptions, configuration);
9416
9605
  return [2 /*return*/, {
9417
9606
  url: (0, common_1.toPathString)(localVarUrlObj),
9418
9607
  options: localVarRequestOptions,
@@ -9892,17 +10081,17 @@ var NumberPortingApiFp = function (configuration) {
9892
10081
  /**
9893
10082
  *
9894
10083
  * @param {number} id Number Port ID
9895
- * @param {PostAddAdminNoteRequest} postAddAdminNoteRequest
10084
+ * @param {PostCreateCrmNoteRequest} postCreateCrmNoteRequest
9896
10085
  * @param {*} [options] Override http request option.
9897
10086
  * @throws {RequiredError}
9898
10087
  */
9899
- postAddAdminNote: function (id, postAddAdminNoteRequest, options) {
10088
+ postAddAdminNote: function (id, postCreateCrmNoteRequest, options) {
9900
10089
  return __awaiter(this, void 0, void 0, function () {
9901
10090
  var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
9902
10091
  var _a, _b, _c;
9903
10092
  return __generator(this, function (_d) {
9904
10093
  switch (_d.label) {
9905
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.postAddAdminNote(id, postAddAdminNoteRequest, options)];
10094
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.postAddAdminNote(id, postCreateCrmNoteRequest, options)];
9906
10095
  case 1:
9907
10096
  localVarAxiosArgs = _d.sent();
9908
10097
  localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
@@ -10115,12 +10304,12 @@ var NumberPortingApiFactory = function (configuration, basePath, axios) {
10115
10304
  /**
10116
10305
  *
10117
10306
  * @param {number} id Number Port ID
10118
- * @param {PostAddAdminNoteRequest} postAddAdminNoteRequest
10307
+ * @param {PostCreateCrmNoteRequest} postCreateCrmNoteRequest
10119
10308
  * @param {*} [options] Override http request option.
10120
10309
  * @throws {RequiredError}
10121
10310
  */
10122
- postAddAdminNote: function (id, postAddAdminNoteRequest, options) {
10123
- return localVarFp.postAddAdminNote(id, postAddAdminNoteRequest, options).then(function (request) { return request(axios, basePath); });
10311
+ postAddAdminNote: function (id, postCreateCrmNoteRequest, options) {
10312
+ return localVarFp.postAddAdminNote(id, postCreateCrmNoteRequest, options).then(function (request) { return request(axios, basePath); });
10124
10313
  },
10125
10314
  /**
10126
10315
  *
@@ -10282,13 +10471,13 @@ var NumberPortingApi = /** @class */ (function (_super) {
10282
10471
  /**
10283
10472
  *
10284
10473
  * @param {number} id Number Port ID
10285
- * @param {PostAddAdminNoteRequest} postAddAdminNoteRequest
10474
+ * @param {PostCreateCrmNoteRequest} postCreateCrmNoteRequest
10286
10475
  * @param {*} [options] Override http request option.
10287
10476
  * @throws {RequiredError}
10288
10477
  */
10289
- NumberPortingApi.prototype.postAddAdminNote = function (id, postAddAdminNoteRequest, options) {
10478
+ NumberPortingApi.prototype.postAddAdminNote = function (id, postCreateCrmNoteRequest, options) {
10290
10479
  var _this = this;
10291
- return (0, exports.NumberPortingApiFp)(this.configuration).postAddAdminNote(id, postAddAdminNoteRequest, options).then(function (request) { return request(_this.axios, _this.basePath); });
10480
+ return (0, exports.NumberPortingApiFp)(this.configuration).postAddAdminNote(id, postCreateCrmNoteRequest, options).then(function (request) { return request(_this.axios, _this.basePath); });
10292
10481
  };
10293
10482
  /**
10294
10483
  *
package/docs/CRMApi.md CHANGED
@@ -4,7 +4,69 @@ All URIs are relative to *https://localhost*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
+ |[**getGetCrmActivities**](#getgetcrmactivities) | **GET** /admin/crm/{id}/activities | |
7
8
  |[**getSearchByPhone**](#getsearchbyphone) | **GET** /crm/contact/search | |
9
+ |[**postCreateCrmNote**](#postcreatecrmnote) | **POST** /admin/crm/{id}/activities/note | |
10
+
11
+ # **getGetCrmActivities**
12
+ > Array<CrmActivityDto> getGetCrmActivities()
13
+
14
+ Get Customer CRM Activities
15
+
16
+ ### Example
17
+
18
+ ```typescript
19
+ import {
20
+ CRMApi,
21
+ Configuration
22
+ } from 'yellowgrid-api-ts';
23
+
24
+ const configuration = new Configuration();
25
+ const apiInstance = new CRMApi(configuration);
26
+
27
+ let id: number; //Account ID (default to undefined)
28
+ let type: 'alert' | 'call' | 'note' | 'order' | 'quote' | 'tcx_order'; //Activity Type (default to undefined)
29
+ let userId: number; //Activity Created By (default to undefined)
30
+
31
+ const { status, data } = await apiInstance.getGetCrmActivities(
32
+ id,
33
+ type,
34
+ userId
35
+ );
36
+ ```
37
+
38
+ ### Parameters
39
+
40
+ |Name | Type | Description | Notes|
41
+ |------------- | ------------- | ------------- | -------------|
42
+ | **id** | [**number**] | Account ID | defaults to undefined|
43
+ | **type** | [**&#39;alert&#39; | &#39;call&#39; | &#39;note&#39; | &#39;order&#39; | &#39;quote&#39; | &#39;tcx_order&#39;**]**Array<&#39;alert&#39; &#124; &#39;call&#39; &#124; &#39;note&#39; &#124; &#39;order&#39; &#124; &#39;quote&#39; &#124; &#39;tcx_order&#39;>** | Activity Type | defaults to undefined|
44
+ | **userId** | [**number**] | Activity Created By | defaults to undefined|
45
+
46
+
47
+ ### Return type
48
+
49
+ **Array<CrmActivityDto>**
50
+
51
+ ### Authorization
52
+
53
+ No authorization required
54
+
55
+ ### HTTP request headers
56
+
57
+ - **Content-Type**: Not defined
58
+ - **Accept**: application/json
59
+
60
+
61
+ ### HTTP response details
62
+ | Status code | Description | Response headers |
63
+ |-------------|-------------|------------------|
64
+ |**200** | CRM Activities | - |
65
+ |**400** | Bad Request | - |
66
+ |**401** | Unauthorised | - |
67
+ |**403** | Access Denied | - |
68
+
69
+ [[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)
8
70
 
9
71
  # **getSearchByPhone**
10
72
  > CrmContactDTO getSearchByPhone()
@@ -53,3 +115,61 @@ No authorization required
53
115
 
54
116
  [[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
117
 
118
+ # **postCreateCrmNote**
119
+ > CrmActivityDto postCreateCrmNote()
120
+
121
+ Create CRM Note
122
+
123
+ ### Example
124
+
125
+ ```typescript
126
+ import {
127
+ CRMApi,
128
+ Configuration,
129
+ PostCreateCrmNoteRequest
130
+ } from 'yellowgrid-api-ts';
131
+
132
+ const configuration = new Configuration();
133
+ const apiInstance = new CRMApi(configuration);
134
+
135
+ let id: number; //Account ID (default to undefined)
136
+ let postCreateCrmNoteRequest: PostCreateCrmNoteRequest; //CRM Note Request (optional)
137
+
138
+ const { status, data } = await apiInstance.postCreateCrmNote(
139
+ id,
140
+ postCreateCrmNoteRequest
141
+ );
142
+ ```
143
+
144
+ ### Parameters
145
+
146
+ |Name | Type | Description | Notes|
147
+ |------------- | ------------- | ------------- | -------------|
148
+ | **postCreateCrmNoteRequest** | **PostCreateCrmNoteRequest**| CRM Note Request | |
149
+ | **id** | [**number**] | Account ID | defaults to undefined|
150
+
151
+
152
+ ### Return type
153
+
154
+ **CrmActivityDto**
155
+
156
+ ### Authorization
157
+
158
+ No authorization required
159
+
160
+ ### HTTP request headers
161
+
162
+ - **Content-Type**: application/json
163
+ - **Accept**: application/json
164
+
165
+
166
+ ### HTTP response details
167
+ | Status code | Description | Response headers |
168
+ |-------------|-------------|------------------|
169
+ |**200** | CRM Activity | - |
170
+ |**400** | Bad Request | - |
171
+ |**401** | Unauthorised | - |
172
+ |**403** | Access Denied | - |
173
+
174
+ [[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)
175
+
package/docs/CrmActivityDto.md ADDED
@@ -0,0 +1,33 @@
1
+ # CrmActivityDto
2
+
3
+ CRM Activity
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **type** | **string** | Activity Type | [optional] [default to undefined]
10
+ **timeStamp** | **string** | Date Time | [optional] [default to undefined]
11
+ **title** | **string** | Activity Title | [optional] [default to undefined]
12
+ **description** | **string** | Activity Description | [optional] [default to undefined]
13
+ **url** | **string** | Activity URL | [optional] [default to undefined]
14
+ **user** | **string** | Activity User Name | [optional] [default to undefined]
15
+ **contact** | **string** | Activity Contact Name | [optional] [default to undefined]
16
+
17
+ ## Example
18
+
19
+ ```typescript
20
+ import { CrmActivityDto } from 'yellowgrid-api-ts';
21
+
22
+ const instance: CrmActivityDto = {
23
+ type,
24
+ timeStamp,
25
+ title,
26
+ description,
27
+ url,
28
+ user,
29
+ contact,
30
+ };
31
+ ```
32
+
33
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
package/docs/CrmNoteEntity.md ADDED
@@ -0,0 +1,39 @@
1
+ # CrmNoteEntity
2
+
3
+ CrmNotesEntity
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **number** | id | [optional] [default to undefined]
10
+ **customerId** | **string** | customerId | [optional] [default to undefined]
11
+ **userId** | **number** | userId | [optional] [default to undefined]
12
+ **type** | **string** | type | [optional] [default to undefined]
13
+ **note** | **string** | note | [optional] [default to undefined]
14
+ **timestamp** | **string** | timestamp | [optional] [default to undefined]
15
+ **journalTime** | **string** | journalTime | [optional] [default to undefined]
16
+ **duration** | **string** | duration | [optional] [default to undefined]
17
+ **callType** | **string** | callType | [optional] [default to undefined]
18
+ **callId** | **number** | callId | [optional] [default to undefined]
19
+
20
+ ## Example
21
+
22
+ ```typescript
23
+ import { CrmNoteEntity } from 'yellowgrid-api-ts';
24
+
25
+ const instance: CrmNoteEntity = {
26
+ id,
27
+ customerId,
28
+ userId,
29
+ type,
30
+ note,
31
+ timestamp,
32
+ journalTime,
33
+ duration,
34
+ callType,
35
+ callId,
36
+ };
37
+ ```
38
+
39
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
package/docs/CrmNoteModel.md ADDED
@@ -0,0 +1,39 @@
1
+ # CrmNoteModel
2
+
3
+ CrmNotesEntity
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **number** | id | [optional] [default to undefined]
10
+ **customerId** | **string** | customerId | [optional] [default to undefined]
11
+ **userId** | **number** | userId | [optional] [default to undefined]
12
+ **type** | **string** | type | [optional] [default to undefined]
13
+ **note** | **string** | note | [optional] [default to undefined]
14
+ **timestamp** | **string** | timestamp | [optional] [default to undefined]
15
+ **journalTime** | **string** | journalTime | [optional] [default to undefined]
16
+ **duration** | **string** | duration | [optional] [default to undefined]
17
+ **callType** | **string** | callType | [optional] [default to undefined]
18
+ **callId** | **number** | callId | [optional] [default to undefined]
19
+
20
+ ## Example
21
+
22
+ ```typescript
23
+ import { CrmNoteModel } from 'yellowgrid-api-ts';
24
+
25
+ const instance: CrmNoteModel = {
26
+ id,
27
+ customerId,
28
+ userId,
29
+ type,
30
+ note,
31
+ timestamp,
32
+ journalTime,
33
+ duration,
34
+ callType,
35
+ callId,
36
+ };
37
+ ```
38
+
39
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
package/docs/NumberPortingApi.md CHANGED
@@ -401,7 +401,7 @@ No authorization required
401
401
  [[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)
402
402
 
403
403
  # **postAddAdminNote**
404
- > AdminNumberPortDTO postAddAdminNote(postAddAdminNoteRequest)
404
+ > AdminNumberPortDTO postAddAdminNote(postCreateCrmNoteRequest)
405
405
 
406
406
 
407
407
  ### Example
@@ -410,18 +410,18 @@ No authorization required
410
410
  import {
411
411
  NumberPortingApi,
412
412
  Configuration,
413
- PostAddAdminNoteRequest
413
+ PostCreateCrmNoteRequest
414
414
  } from 'yellowgrid-api-ts';
415
415
 
416
416
  const configuration = new Configuration();
417
417
  const apiInstance = new NumberPortingApi(configuration);
418
418
 
419
419
  let id: number; //Number Port ID (default to undefined)
420
- let postAddAdminNoteRequest: PostAddAdminNoteRequest; //
420
+ let postCreateCrmNoteRequest: PostCreateCrmNoteRequest; //
421
421
 
422
422
  const { status, data } = await apiInstance.postAddAdminNote(
423
423
  id,
424
- postAddAdminNoteRequest
424
+ postCreateCrmNoteRequest
425
425
  );
426
426
  ```
427
427
 
@@ -429,7 +429,7 @@ const { status, data } = await apiInstance.postAddAdminNote(
429
429
 
430
430
  |Name | Type | Description | Notes|
431
431
  |------------- | ------------- | ------------- | -------------|
432
- | **postAddAdminNoteRequest** | **PostAddAdminNoteRequest**| | |
432
+ | **postCreateCrmNoteRequest** | **PostCreateCrmNoteRequest**| | |
433
433
  | **id** | [**number**] | Number Port ID | defaults to undefined|
434
434
 
435
435