yellowgrid-api-ts 3.2.120-dev.0 → 3.2.122-dev.0

package/dist/api.d.ts

@@ -880,6 +880,7 @@ export declare const AuditLogEntityTypeEnum: {
     readonly ApiLog: "api_log";
     readonly PopsBatches: "pops_batches";
     readonly PopsCourierPrices: "pops_courier_prices";
+    readonly PopsCrmNotes: "pops_crm_notes";
     readonly PopsCreditAccounts: "pops_credit_accounts";
     readonly PopsCreditNotes: "pops_credit_notes";
     readonly PopsCreditNotesItems: "pops_credit_notes_items";
@@ -1580,6 +1581,39 @@ export interface CreditNoteModel {
      */
     'items'?: Array<CreditNoteItemModel>;
 }
+/**
+ * CRM Activity
+ */
+export interface CrmActivityDto {
+    /**
+     * Activity Type
+     */
+    'type'?: string;
+    /**
+     * Date Time
+     */
+    'timeStamp'?: string | null;
+    /**
+     * Activity Title
+     */
+    'title'?: string;
+    /**
+     * Activity Description
+     */
+    'description'?: string;
+    /**
+     * Activity URL
+     */
+    'url'?: string | null;
+    /**
+     * Activity User Name
+     */
+    'user'?: string | null;
+    /**
+     * Activity Contact Name
+     */
+    'contact'?: string | null;
+}
 /**
  * CRM Contact
  */
@@ -1613,6 +1647,96 @@ export interface CrmContactDTO {
      */
     'url'?: string;
 }
+/**
+ * CrmNotesEntity
+ */
+export interface CrmNoteEntity {
+    /**
+     * id
+     */
+    'id'?: number;
+    /**
+     * customerId
+     */
+    'customerId'?: string;
+    /**
+     * userId
+     */
+    'userId'?: number;
+    /**
+     * type
+     */
+    'type'?: string;
+    /**
+     * note
+     */
+    'note'?: string;
+    /**
+     * timestamp
+     */
+    'timestamp'?: string;
+    /**
+     * journalTime
+     */
+    'journalTime'?: string;
+    /**
+     * duration
+     */
+    'duration'?: string;
+    /**
+     * callType
+     */
+    'callType'?: string;
+    /**
+     * callId
+     */
+    'callId'?: number;
+}
+/**
+ * CrmNotesEntity
+ */
+export interface CrmNoteModel {
+    /**
+     * id
+     */
+    'id'?: number;
+    /**
+     * customerId
+     */
+    'customerId'?: string;
+    /**
+     * userId
+     */
+    'userId'?: number;
+    /**
+     * type
+     */
+    'type'?: string;
+    /**
+     * note
+     */
+    'note'?: string;
+    /**
+     * timestamp
+     */
+    'timestamp'?: string;
+    /**
+     * journalTime
+     */
+    'journalTime'?: string;
+    /**
+     * duration
+     */
+    'duration'?: string;
+    /**
+     * callType
+     */
+    'callType'?: string;
+    /**
+     * callId
+     */
+    'callId'?: number;
+}
 /**
  * SIP Trunk Customer
  */
@@ -4098,12 +4222,6 @@ export interface PortalLoginModel {
      */
     'redirect_uri'?: string;
 }
-export interface PostAddAdminNoteRequest {
-    /**
-     * Note
-     */
-    'note'?: string;
-}
 export interface PostAddOrderNoteRequest {
     /**
      * Order Note
@@ -4113,6 +4231,12 @@ export interface PostAddOrderNoteRequest {
 export interface PostAddWebhook200Response {
     'url'?: string;
 }
+export interface PostCreateCrmNoteRequest {
+    /**
+     * Note
+     */
+    'note'?: string;
+}
 export interface PostGetClientCredentialsRequest {
     /**
      * OAuth 2.0 scopes
@@ -8817,46 +8941,123 @@ export type PatchSetPrizePromoStateEnum = typeof PatchSetPrizePromoStateEnum[key
  * CRMApi - axios parameter creator
  */
 export declare const CRMApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Get Customer CRM Activities
+     * @param {number} id Account ID
+     * @param {GetGetCrmActivitiesTypeEnum} type Activity Type
+     * @param {number} userId Activity Created By
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetCrmActivities: (id: number, type: GetGetCrmActivitiesTypeEnum, userId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Search for contacts by phone number
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     getSearchByPhone: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Create CRM Note
+     * @param {number} id Account ID
+     * @param {PostCreateCrmNoteRequest} [postCreateCrmNoteRequest] CRM Note Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postCreateCrmNote: (id: number, postCreateCrmNoteRequest?: PostCreateCrmNoteRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * CRMApi - functional programming interface
  */
 export declare const CRMApiFp: (configuration?: Configuration) => {
+    /**
+     * Get Customer CRM Activities
+     * @param {number} id Account ID
+     * @param {GetGetCrmActivitiesTypeEnum} type Activity Type
+     * @param {number} userId Activity Created By
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetCrmActivities(id: number, type: GetGetCrmActivitiesTypeEnum, userId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CrmActivityDto>>>;
     /**
      * Search for contacts by phone number
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     getSearchByPhone(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CrmContactDTO>>;
+    /**
+     * Create CRM Note
+     * @param {number} id Account ID
+     * @param {PostCreateCrmNoteRequest} [postCreateCrmNoteRequest] CRM Note Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postCreateCrmNote(id: number, postCreateCrmNoteRequest?: PostCreateCrmNoteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CrmActivityDto>>;
 };
 /**
  * CRMApi - factory interface
  */
 export declare const CRMApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Get Customer CRM Activities
+     * @param {number} id Account ID
+     * @param {GetGetCrmActivitiesTypeEnum} type Activity Type
+     * @param {number} userId Activity Created By
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetCrmActivities(id: number, type: GetGetCrmActivitiesTypeEnum, userId: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<CrmActivityDto>>;
     /**
      * Search for contacts by phone number
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     getSearchByPhone(options?: RawAxiosRequestConfig): AxiosPromise<CrmContactDTO>;
+    /**
+     * Create CRM Note
+     * @param {number} id Account ID
+     * @param {PostCreateCrmNoteRequest} [postCreateCrmNoteRequest] CRM Note Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postCreateCrmNote(id: number, postCreateCrmNoteRequest?: PostCreateCrmNoteRequest, options?: RawAxiosRequestConfig): AxiosPromise<CrmActivityDto>;
 };
 /**
  * CRMApi - object-oriented interface
  */
 export declare class CRMApi extends BaseAPI {
+    /**
+     * Get Customer CRM Activities
+     * @param {number} id Account ID
+     * @param {GetGetCrmActivitiesTypeEnum} type Activity Type
+     * @param {number} userId Activity Created By
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetCrmActivities(id: number, type: GetGetCrmActivitiesTypeEnum, userId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CrmActivityDto[], any, {}>>;
     /**
      * Search for contacts by phone number
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     getSearchByPhone(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CrmContactDTO, any, {}>>;
+    /**
+     * Create CRM Note
+     * @param {number} id Account ID
+     * @param {PostCreateCrmNoteRequest} [postCreateCrmNoteRequest] CRM Note Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postCreateCrmNote(id: number, postCreateCrmNoteRequest?: PostCreateCrmNoteRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CrmActivityDto, any, {}>>;
 }
+export declare const GetGetCrmActivitiesTypeEnum: {
+    readonly Alert: "alert";
+    readonly Call: "call";
+    readonly Note: "note";
+    readonly Order: "order";
+    readonly Quote: "quote";
+    readonly TcxOrder: "tcx_order";
+};
+export type GetGetCrmActivitiesTypeEnum = typeof GetGetCrmActivitiesTypeEnum[keyof typeof GetGetCrmActivitiesTypeEnum];
 /**
  * Class3CXApi - axios parameter creator
  */
@@ -11400,11 +11601,11 @@ export declare const NumberPortingApiAxiosParamCreator: (configuration?: Configu
     /**
      *
      * @param {number} id Number Port ID
-     * @param {PostAddAdminNoteRequest} postAddAdminNoteRequest
+     * @param {PostCreateCrmNoteRequest} postCreateCrmNoteRequest
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    postAddAdminNote: (id: number, postAddAdminNoteRequest: PostAddAdminNoteRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    postAddAdminNote: (id: number, postCreateCrmNoteRequest: PostCreateCrmNoteRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @param {string | null} [companyName] Company Name
@@ -11530,11 +11731,11 @@ export declare const NumberPortingApiFp: (configuration?: Configuration) => {
     /**
      *
      * @param {number} id Number Port ID
-     * @param {PostAddAdminNoteRequest} postAddAdminNoteRequest
+     * @param {PostCreateCrmNoteRequest} postCreateCrmNoteRequest
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    postAddAdminNote(id: number, postAddAdminNoteRequest: PostAddAdminNoteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminNumberPortDTO>>;
+    postAddAdminNote(id: number, postCreateCrmNoteRequest: PostCreateCrmNoteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminNumberPortDTO>>;
     /**
      *
      * @param {string | null} [companyName] Company Name
@@ -11660,11 +11861,11 @@ export declare const NumberPortingApiFactory: (configuration?: Configuration, ba
     /**
      *
      * @param {number} id Number Port ID
-     * @param {PostAddAdminNoteRequest} postAddAdminNoteRequest
+     * @param {PostCreateCrmNoteRequest} postCreateCrmNoteRequest
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    postAddAdminNote(id: number, postAddAdminNoteRequest: PostAddAdminNoteRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminNumberPortDTO>;
+    postAddAdminNote(id: number, postCreateCrmNoteRequest: PostCreateCrmNoteRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminNumberPortDTO>;
     /**
      *
      * @param {string | null} [companyName] Company Name
@@ -11790,11 +11991,11 @@ export declare class NumberPortingApi extends BaseAPI {
     /**
      *
      * @param {number} id Number Port ID
-     * @param {PostAddAdminNoteRequest} postAddAdminNoteRequest
+     * @param {PostCreateCrmNoteRequest} postCreateCrmNoteRequest
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    postAddAdminNote(id: number, postAddAdminNoteRequest: PostAddAdminNoteRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminNumberPortDTO, any, {}>>;
+    postAddAdminNote(id: number, postCreateCrmNoteRequest: PostCreateCrmNoteRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminNumberPortDTO, any, {}>>;
     /**
      *
      * @param {string | null} [companyName] Company Name