yellowgrid-api-ts 3.2.246-dev.0 → 3.2.248-dev.0

package/dist/api.d.ts

@@ -1457,6 +1457,7 @@ export declare const AuditLogEntityTypeEnum: {
     readonly Pops3cxSipTrunks: "pops_3cx_sip_trunks";
     readonly Pops3cxUsers: "pops_3cx_users";
     readonly PopsUsers: "pops_users";
+    readonly PopsVideoRequests: "pops_video_requests";
     readonly Webhook: "webhook";
     readonly PopsXeroLog: "pops_xero_log";
     readonly Oauth2Clients: "oauth2_clients";
@@ -1855,6 +1856,135 @@ export interface BatchEntity {
      */
     'mac'?: string;
 }
+/**
+ * Branded Video Summary
+ * @export
+ * @interface BrandedVideoSummaryDTO
+ */
+export interface BrandedVideoSummaryDTO {
+    /**
+     * ID
+     * @type {number}
+     * @memberof BrandedVideoSummaryDTO
+     */
+    'id'?: number;
+    /**
+     * Company
+     * @type {string}
+     * @memberof BrandedVideoSummaryDTO
+     */
+    'company'?: string;
+    /**
+     * Type
+     * @type {string}
+     * @memberof BrandedVideoSummaryDTO
+     */
+    'type'?: BrandedVideoSummaryDTOTypeEnum;
+    /**
+     * Video
+     * @type {string}
+     * @memberof BrandedVideoSummaryDTO
+     */
+    'video'?: string;
+    /**
+     * Email
+     * @type {string}
+     * @memberof BrandedVideoSummaryDTO
+     */
+    'email'?: string;
+    /**
+     * Website
+     * @type {string}
+     * @memberof BrandedVideoSummaryDTO
+     */
+    'website'?: string;
+    /**
+     * Telephone
+     * @type {string}
+     * @memberof BrandedVideoSummaryDTO
+     */
+    'telephone'?: string;
+    /**
+     * Invoice Number
+     * @type {string}
+     * @memberof BrandedVideoSummaryDTO
+     */
+    'invoiceNumber'?: string | null;
+    /**
+     * Date Time
+     * @type {string}
+     * @memberof BrandedVideoSummaryDTO
+     */
+    'requestDate'?: string;
+    /**
+     * Date Time
+     * @type {string}
+     * @memberof BrandedVideoSummaryDTO
+     */
+    'dueDate'?: string;
+    /**
+     * OneDrive ID
+     * @type {string}
+     * @memberof BrandedVideoSummaryDTO
+     */
+    'oneDriveId'?: string | null;
+    /**
+     * Status
+     * @type {string}
+     * @memberof BrandedVideoSummaryDTO
+     */
+    'status'?: BrandedVideoSummaryDTOStatusEnum;
+    /**
+     * Notes
+     * @type {string}
+     * @memberof BrandedVideoSummaryDTO
+     */
+    'notes'?: string;
+}
+export declare const BrandedVideoSummaryDTOTypeEnum: {
+    readonly Paid: "paid";
+    readonly Reward: "reward";
+    readonly Sample: "sample";
+};
+export type BrandedVideoSummaryDTOTypeEnum = typeof BrandedVideoSummaryDTOTypeEnum[keyof typeof BrandedVideoSummaryDTOTypeEnum];
+export declare const BrandedVideoSummaryDTOStatusEnum: {
+    readonly Pending: "pending";
+    readonly Complete: "complete";
+    readonly Incomplete: "incomplete";
+    readonly Unpaid: "unpaid";
+};
+export type BrandedVideoSummaryDTOStatusEnum = typeof BrandedVideoSummaryDTOStatusEnum[keyof typeof BrandedVideoSummaryDTOStatusEnum];
+/**
+ * Promotions
+ * @export
+ * @interface BrandedVideosSummariesModel
+ */
+export interface BrandedVideosSummariesModel {
+    /**
+     * Results
+     * @type {Array<BrandedVideoSummaryDTO>}
+     * @memberof BrandedVideosSummariesModel
+     */
+    'results'?: Array<BrandedVideoSummaryDTO>;
+    /**
+     * Page
+     * @type {number}
+     * @memberof BrandedVideosSummariesModel
+     */
+    'page'?: number;
+    /**
+     * Per Page
+     * @type {number}
+     * @memberof BrandedVideosSummariesModel
+     */
+    'perPage'?: number;
+    /**
+     * Total Results
+     * @type {number}
+     * @memberof BrandedVideosSummariesModel
+     */
+    'totalResults'?: number;
+}
 /**
  *
  * @export
@@ -9933,13 +10063,13 @@ export interface PromoCodesEntity {
      * @type {string}
      * @memberof PromoCodesEntity
      */
-    'start'?: string;
+    'startDate'?: string;
     /**
      * Date Time
      * @type {string}
      * @memberof PromoCodesEntity
      */
-    'expiry'?: string;
+    'endDate'?: string;
     /**
      * customerLimit
      * @type {number}
@@ -9954,10 +10084,10 @@ export interface PromoCodesEntity {
     'globalLimit'?: number;
     /**
      * orderRestrictions
-     * @type {string}
+     * @type {Array<string>}
      * @memberof PromoCodesEntity
      */
-    'orderRestrictions'?: string;
+    'orderRestrictions'?: Array<string>;
     /**
      * includeDistribution
      * @type {boolean}
@@ -10122,13 +10252,13 @@ export interface PromoModel {
      * @type {string}
      * @memberof PromoModel
      */
-    'start'?: string;
+    'startDate'?: string;
     /**
      * Date Time
      * @type {string}
      * @memberof PromoModel
      */
-    'expiry'?: string;
+    'endDate'?: string;
     /**
      * customerLimit
      * @type {number}
@@ -10143,10 +10273,10 @@ export interface PromoModel {
     'globalLimit'?: number;
     /**
      * orderRestrictions
-     * @type {string}
+     * @type {Array<string>}
      * @memberof PromoModel
      */
-    'orderRestrictions'?: string;
+    'orderRestrictions'?: Array<string>;
     /**
      * includeDistribution
      * @type {boolean}
@@ -10215,6 +10345,12 @@ export interface PromoSummariesModel {
  * @interface PromoSummaryDTO
  */
 export interface PromoSummaryDTO {
+    /**
+     * ID
+     * @type {number}
+     * @memberof PromoSummaryDTO
+     */
+    'id'?: number | null;
     /**
      * Description
      * @type {string}
@@ -16461,6 +16597,31 @@ export interface TechSupportCompanySummaryDTO {
      */
     'monthlyReportEmailAddress'?: string;
 }
+/**
+ * Thumbnail
+ * @export
+ * @interface ThumbnailDTO
+ */
+export interface ThumbnailDTO {
+    /**
+     * ID
+     * @type {string}
+     * @memberof ThumbnailDTO
+     */
+    'id'?: string;
+    /**
+     * Name
+     * @type {string}
+     * @memberof ThumbnailDTO
+     */
+    'name'?: string;
+    /**
+     * URL
+     * @type {string}
+     * @memberof ThumbnailDTO
+     */
+    'url'?: string;
+}
 /**
  * Ticket Summary Model
  * @export
@@ -16898,6 +17059,109 @@ export interface UserEntity {
      */
     'secondaryHex'?: number | null;
 }
+/**
+ * VideoRequestsEntity
+ * @export
+ * @interface VideoRequestEntity
+ */
+export interface VideoRequestEntity {
+    /**
+     * id
+     * @type {number}
+     * @memberof VideoRequestEntity
+     */
+    'id'?: number;
+    /**
+     * userId
+     * @type {number}
+     * @memberof VideoRequestEntity
+     */
+    'userId'?: number;
+    /**
+     * type
+     * @type {string}
+     * @memberof VideoRequestEntity
+     */
+    'type'?: string;
+    /**
+     * status
+     * @type {string}
+     * @memberof VideoRequestEntity
+     */
+    'status'?: string;
+    /**
+     * video
+     * @type {string}
+     * @memberof VideoRequestEntity
+     */
+    'video'?: string;
+    /**
+     * company
+     * @type {string}
+     * @memberof VideoRequestEntity
+     */
+    'company'?: string;
+    /**
+     * email
+     * @type {string}
+     * @memberof VideoRequestEntity
+     */
+    'email'?: string;
+    /**
+     * website
+     * @type {string}
+     * @memberof VideoRequestEntity
+     */
+    'website'?: string;
+    /**
+     * telephone
+     * @type {string}
+     * @memberof VideoRequestEntity
+     */
+    'telephone'?: string;
+    /**
+     * notes
+     * @type {string}
+     * @memberof VideoRequestEntity
+     */
+    'notes'?: string;
+    /**
+     * requestDate
+     * @type {string}
+     * @memberof VideoRequestEntity
+     */
+    'requestDate'?: string;
+    /**
+     * dueDate
+     * @type {string}
+     * @memberof VideoRequestEntity
+     */
+    'dueDate'?: string;
+    /**
+     * invId
+     * @type {string}
+     * @memberof VideoRequestEntity
+     */
+    'invId'?: string | null;
+    /**
+     * invNo
+     * @type {string}
+     * @memberof VideoRequestEntity
+     */
+    'invNo'?: string | null;
+    /**
+     * onedriveId
+     * @type {string}
+     * @memberof VideoRequestEntity
+     */
+    'onedriveId'?: string | null;
+    /**
+     * thumbnailId
+     * @type {string}
+     * @memberof VideoRequestEntity
+     */
+    'thumbnailId'?: string;
+}
 /**
  * XeroLogEntity
  * @export
@@ -20680,6 +20944,292 @@ export declare const GetGetServicesPlanDetailsTypeEnum: {
     readonly EdTechPro: "EdTechPro";
 };
 export type GetGetServicesPlanDetailsTypeEnum = typeof GetGetServicesPlanDetailsTypeEnum[keyof typeof GetGetServicesPlanDetailsTypeEnum];
+/**
+ * BrandedVideosApi - axios parameter creator
+ * @export
+ */
+export declare const BrandedVideosApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Send Branded Video Email
+     * @param {number} id Video ID
+     * @param {number} [customerId] Customer ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteDeleteVideoRequest: (id: number, customerId?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get Customer Logo
+     * @param {number} [customerId] Customer ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDownloadLogo: (customerId?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get Branded Videos
+     * @param {number} [pageSize] Number Of Results
+     * @param {number} [page] Page Number
+     * @param {string} [search] Search
+     * @param {GetGetBrandedVideosTypeEnum} [type] Type
+     * @param {boolean} [outstanding] Outstanding
+     * @param {boolean} [overdue] Overdue
+     * @param {number} [customerId] Customer ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetBrandedVideos: (pageSize?: number, page?: number, search?: string, type?: GetGetBrandedVideosTypeEnum, outstanding?: boolean, overdue?: boolean, customerId?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get Thumbnails
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetThumbnails: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Upload logo
+     * @param {File} logo Logo
+     * @param {number} [customerId] Customer ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postDownloadLogo: (logo: File, customerId?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Send Branded Video Email
+     * @param {string} email Email
+     * @param {number} id Video ID
+     * @param {number} [customerId] Customer ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postSendBrandedVideoEmail: (email: string, id: number, customerId?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Upload Video
+     * @param {string} thumbnailId Thumbnail ID
+     * @param {number} id Video ID
+     * @param {File} video Video
+     * @param {number} [customerId] Customer ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postUploadVideo: (thumbnailId: string, id: number, video: File, customerId?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * BrandedVideosApi - functional programming interface
+ * @export
+ */
+export declare const BrandedVideosApiFp: (configuration?: Configuration) => {
+    /**
+     * Send Branded Video Email
+     * @param {number} id Video ID
+     * @param {number} [customerId] Customer ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteDeleteVideoRequest(id: number, customerId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Get Customer Logo
+     * @param {number} [customerId] Customer ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDownloadLogo(customerId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
+    /**
+     * Get Branded Videos
+     * @param {number} [pageSize] Number Of Results
+     * @param {number} [page] Page Number
+     * @param {string} [search] Search
+     * @param {GetGetBrandedVideosTypeEnum} [type] Type
+     * @param {boolean} [outstanding] Outstanding
+     * @param {boolean} [overdue] Overdue
+     * @param {number} [customerId] Customer ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetBrandedVideos(pageSize?: number, page?: number, search?: string, type?: GetGetBrandedVideosTypeEnum, outstanding?: boolean, overdue?: boolean, customerId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BrandedVideosSummariesModel>>;
+    /**
+     * Get Thumbnails
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetThumbnails(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ThumbnailDTO>>>;
+    /**
+     * Upload logo
+     * @param {File} logo Logo
+     * @param {number} [customerId] Customer ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postDownloadLogo(logo: File, customerId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Send Branded Video Email
+     * @param {string} email Email
+     * @param {number} id Video ID
+     * @param {number} [customerId] Customer ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postSendBrandedVideoEmail(email: string, id: number, customerId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Upload Video
+     * @param {string} thumbnailId Thumbnail ID
+     * @param {number} id Video ID
+     * @param {File} video Video
+     * @param {number} [customerId] Customer ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postUploadVideo(thumbnailId: string, id: number, video: File, customerId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BrandedVideoSummaryDTO>>;
+};
+/**
+ * BrandedVideosApi - factory interface
+ * @export
+ */
+export declare const BrandedVideosApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Send Branded Video Email
+     * @param {number} id Video ID
+     * @param {number} [customerId] Customer ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteDeleteVideoRequest(id: number, customerId?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Get Customer Logo
+     * @param {number} [customerId] Customer ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDownloadLogo(customerId?: number, options?: RawAxiosRequestConfig): AxiosPromise<string>;
+    /**
+     * Get Branded Videos
+     * @param {number} [pageSize] Number Of Results
+     * @param {number} [page] Page Number
+     * @param {string} [search] Search
+     * @param {GetGetBrandedVideosTypeEnum} [type] Type
+     * @param {boolean} [outstanding] Outstanding
+     * @param {boolean} [overdue] Overdue
+     * @param {number} [customerId] Customer ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetBrandedVideos(pageSize?: number, page?: number, search?: string, type?: GetGetBrandedVideosTypeEnum, outstanding?: boolean, overdue?: boolean, customerId?: number, options?: RawAxiosRequestConfig): AxiosPromise<BrandedVideosSummariesModel>;
+    /**
+     * Get Thumbnails
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetThumbnails(options?: RawAxiosRequestConfig): AxiosPromise<Array<ThumbnailDTO>>;
+    /**
+     * Upload logo
+     * @param {File} logo Logo
+     * @param {number} [customerId] Customer ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postDownloadLogo(logo: File, customerId?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Send Branded Video Email
+     * @param {string} email Email
+     * @param {number} id Video ID
+     * @param {number} [customerId] Customer ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postSendBrandedVideoEmail(email: string, id: number, customerId?: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Upload Video
+     * @param {string} thumbnailId Thumbnail ID
+     * @param {number} id Video ID
+     * @param {File} video Video
+     * @param {number} [customerId] Customer ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postUploadVideo(thumbnailId: string, id: number, video: File, customerId?: number, options?: RawAxiosRequestConfig): AxiosPromise<BrandedVideoSummaryDTO>;
+};
+/**
+ * BrandedVideosApi - object-oriented interface
+ * @export
+ * @class BrandedVideosApi
+ * @extends {BaseAPI}
+ */
+export declare class BrandedVideosApi extends BaseAPI {
+    /**
+     * Send Branded Video Email
+     * @param {number} id Video ID
+     * @param {number} [customerId] Customer ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BrandedVideosApi
+     */
+    deleteDeleteVideoRequest(id: number, customerId?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * Get Customer Logo
+     * @param {number} [customerId] Customer ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BrandedVideosApi
+     */
+    getDownloadLogo(customerId?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
+    /**
+     * Get Branded Videos
+     * @param {number} [pageSize] Number Of Results
+     * @param {number} [page] Page Number
+     * @param {string} [search] Search
+     * @param {GetGetBrandedVideosTypeEnum} [type] Type
+     * @param {boolean} [outstanding] Outstanding
+     * @param {boolean} [overdue] Overdue
+     * @param {number} [customerId] Customer ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BrandedVideosApi
+     */
+    getGetBrandedVideos(pageSize?: number, page?: number, search?: string, type?: GetGetBrandedVideosTypeEnum, outstanding?: boolean, overdue?: boolean, customerId?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BrandedVideosSummariesModel, any, {}>>;
+    /**
+     * Get Thumbnails
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BrandedVideosApi
+     */
+    getGetThumbnails(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ThumbnailDTO[], any, {}>>;
+    /**
+     * Upload logo
+     * @param {File} logo Logo
+     * @param {number} [customerId] Customer ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BrandedVideosApi
+     */
+    postDownloadLogo(logo: File, customerId?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * Send Branded Video Email
+     * @param {string} email Email
+     * @param {number} id Video ID
+     * @param {number} [customerId] Customer ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BrandedVideosApi
+     */
+    postSendBrandedVideoEmail(email: string, id: number, customerId?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * Upload Video
+     * @param {string} thumbnailId Thumbnail ID
+     * @param {number} id Video ID
+     * @param {File} video Video
+     * @param {number} [customerId] Customer ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BrandedVideosApi
+     */
+    postUploadVideo(thumbnailId: string, id: number, video: File, customerId?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BrandedVideoSummaryDTO, any, {}>>;
+}
+/**
+ * @export
+ */
+export declare const GetGetBrandedVideosTypeEnum: {
+    readonly Paid: "paid";
+    readonly Reward: "reward";
+    readonly Sample: "sample";
+};
+export type GetGetBrandedVideosTypeEnum = typeof GetGetBrandedVideosTypeEnum[keyof typeof GetGetBrandedVideosTypeEnum];
 /**
  * CRMApi - axios parameter creator
  * @export
@@ -24534,6 +25084,8 @@ export declare const PostAccessTokenScopeEnum: {
     readonly TcxWizard: "tcx_wizard";
     readonly AccountsRead: "accounts.read";
     readonly AccountsWrite: "accounts.write";
+    readonly BrandedVideosread: "branded_videosread";
+    readonly BrandedVideoswrite: "branded_videoswrite";
     readonly NumberPortingRead: "number_porting.read";
     readonly NumberPortingWrite: "number_porting.write";
     readonly PricingRead: "pricing.read";
@@ -24576,6 +25128,8 @@ export declare const PostAuthoriseScopeEnum: {
     readonly TcxWizard: "tcx_wizard";
     readonly AccountsRead: "accounts.read";
     readonly AccountsWrite: "accounts.write";
+    readonly BrandedVideosread: "branded_videosread";
+    readonly BrandedVideoswrite: "branded_videoswrite";
     readonly NumberPortingRead: "number_porting.read";
     readonly NumberPortingWrite: "number_porting.write";
     readonly PricingRead: "pricing.read";