yellowgrid-api-ts 3.2.276 → 3.2.277

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/api.ts CHANGED
@@ -1022,6 +1022,7 @@ export const AuditLogEntityTypeEnum = {
1022
1022
  Pops3cxSipTrunks: 'pops_3cx_sip_trunks',
1023
1023
  Pops3cxUsers: 'pops_3cx_users',
1024
1024
  PopsUsers: 'pops_users',
1025
+ PopsVideoRequests: 'pops_video_requests',
1025
1026
  Webhook: 'webhook',
1026
1027
  PopsXeroLog: 'pops_xero_log',
1027
1028
  Oauth2Clients: 'oauth2_clients',
@@ -1266,6 +1267,105 @@ export interface BatchEntity {
1266
1267
  */
1267
1268
  'mac'?: string;
1268
1269
  }
1270
+ /**
1271
+ * Branded Video Summary
1272
+ */
1273
+ export interface BrandedVideoSummaryDTO {
1274
+ /**
1275
+ * ID
1276
+ */
1277
+ 'id'?: number;
1278
+ /**
1279
+ * Customer ID
1280
+ */
1281
+ 'customerId'?: number;
1282
+ /**
1283
+ * Company
1284
+ */
1285
+ 'company'?: string;
1286
+ /**
1287
+ * Type
1288
+ */
1289
+ 'type'?: BrandedVideoSummaryDTOTypeEnum;
1290
+ /**
1291
+ * Video
1292
+ */
1293
+ 'video'?: string;
1294
+ /**
1295
+ * Email
1296
+ */
1297
+ 'email'?: string;
1298
+ /**
1299
+ * Website
1300
+ */
1301
+ 'website'?: string;
1302
+ /**
1303
+ * Telephone
1304
+ */
1305
+ 'telephone'?: string;
1306
+ /**
1307
+ * Invoice Number
1308
+ */
1309
+ 'invoiceNumber'?: string | null;
1310
+ /**
1311
+ * Request Date
1312
+ */
1313
+ 'requestDate'?: string | null;
1314
+ /**
1315
+ * Due Date
1316
+ */
1317
+ 'dueDate'?: string | null;
1318
+ /**
1319
+ * OneDrive ID
1320
+ */
1321
+ 'oneDriveId'?: string | null;
1322
+ /**
1323
+ * Status
1324
+ */
1325
+ 'status'?: BrandedVideoSummaryDTOStatusEnum;
1326
+ /**
1327
+ * Notes
1328
+ */
1329
+ 'notes'?: string;
1330
+ }
1331
+
1332
+ export const BrandedVideoSummaryDTOTypeEnum = {
1333
+ Paid: 'paid',
1334
+ Reward: 'reward',
1335
+ Sample: 'sample',
1336
+ } as const;
1337
+
1338
+ export type BrandedVideoSummaryDTOTypeEnum = typeof BrandedVideoSummaryDTOTypeEnum[keyof typeof BrandedVideoSummaryDTOTypeEnum];
1339
+ export const BrandedVideoSummaryDTOStatusEnum = {
1340
+ Pending: 'pending',
1341
+ Complete: 'complete',
1342
+ Incomplete: 'incomplete',
1343
+ Unpaid: 'unpaid',
1344
+ } as const;
1345
+
1346
+ export type BrandedVideoSummaryDTOStatusEnum = typeof BrandedVideoSummaryDTOStatusEnum[keyof typeof BrandedVideoSummaryDTOStatusEnum];
1347
+
1348
+ /**
1349
+ * Promotions
1350
+ */
1351
+ export interface BrandedVideosSummariesModel {
1352
+ /**
1353
+ * Results
1354
+ */
1355
+ 'results'?: Array<BrandedVideoSummaryDTO>;
1356
+ /**
1357
+ * Page
1358
+ */
1359
+ 'page'?: number;
1360
+ /**
1361
+ * Per Page
1362
+ */
1363
+ 'perPage'?: number;
1364
+ /**
1365
+ * Total Results
1366
+ */
1367
+ 'totalResults'?: number;
1368
+ }
1269
1369
  export interface Bundle {
1270
1370
  'createdDate'?: string;
1271
1371
  'id'?: number;
@@ -9712,6 +9812,23 @@ export interface TechSupportCompanySummaryDTO {
9712
9812
  */
9713
9813
  'monthlyReportEmailAddress'?: string;
9714
9814
  }
9815
+ /**
9816
+ * Thumbnail
9817
+ */
9818
+ export interface ThumbnailDTO {
9819
+ /**
9820
+ * ID
9821
+ */
9822
+ 'id'?: string;
9823
+ /**
9824
+ * Name
9825
+ */
9826
+ 'name'?: string;
9827
+ /**
9828
+ * URL
9829
+ */
9830
+ 'url'?: string;
9831
+ }
9715
9832
  /**
9716
9833
  * Ticket Summary Model
9717
9834
  */
@@ -9932,6 +10049,75 @@ export interface UserEntity {
9932
10049
  */
9933
10050
  'secondaryHex'?: number | null;
9934
10051
  }
10052
+ /**
10053
+ * VideoRequestsEntity
10054
+ */
10055
+ export interface VideoRequestEntity {
10056
+ /**
10057
+ * id
10058
+ */
10059
+ 'id'?: number;
10060
+ /**
10061
+ * userId
10062
+ */
10063
+ 'userId'?: number;
10064
+ /**
10065
+ * type
10066
+ */
10067
+ 'type'?: string;
10068
+ /**
10069
+ * status
10070
+ */
10071
+ 'status'?: string;
10072
+ /**
10073
+ * video
10074
+ */
10075
+ 'video'?: string;
10076
+ /**
10077
+ * company
10078
+ */
10079
+ 'company'?: string;
10080
+ /**
10081
+ * email
10082
+ */
10083
+ 'email'?: string;
10084
+ /**
10085
+ * website
10086
+ */
10087
+ 'website'?: string;
10088
+ /**
10089
+ * telephone
10090
+ */
10091
+ 'telephone'?: string;
10092
+ /**
10093
+ * notes
10094
+ */
10095
+ 'notes'?: string;
10096
+ /**
10097
+ * requestDate
10098
+ */
10099
+ 'requestDate'?: string;
10100
+ /**
10101
+ * dueDate
10102
+ */
10103
+ 'dueDate'?: string;
10104
+ /**
10105
+ * invId
10106
+ */
10107
+ 'invId'?: string | null;
10108
+ /**
10109
+ * invNo
10110
+ */
10111
+ 'invNo'?: string | null;
10112
+ /**
10113
+ * onedriveId
10114
+ */
10115
+ 'onedriveId'?: string | null;
10116
+ /**
10117
+ * thumbnailId
10118
+ */
10119
+ 'thumbnailId'?: string;
10120
+ }
9935
10121
  /**
9936
10122
  * XeroLogEntity
9937
10123
  */
@@ -17914,6 +18100,604 @@ export const GetGetServicesPlanDetailsTypeEnum = {
17914
18100
  export type GetGetServicesPlanDetailsTypeEnum = typeof GetGetServicesPlanDetailsTypeEnum[keyof typeof GetGetServicesPlanDetailsTypeEnum];
17915
18101
 
17916
18102
 
18103
+ /**
18104
+ * BrandedVideosApi - axios parameter creator
18105
+ */
18106
+ export const BrandedVideosApiAxiosParamCreator = function (configuration?: Configuration) {
18107
+ return {
18108
+ /**
18109
+ * Send Branded Video Email
18110
+ * @param {number} id Video ID
18111
+ * @param {number} [customerId] Customer ID
18112
+ * @param {*} [options] Override http request option.
18113
+ * @throws {RequiredError}
18114
+ */
18115
+ deleteDeleteVideoRequest: async (id: number, customerId?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
18116
+ // verify required parameter 'id' is not null or undefined
18117
+ assertParamExists('deleteDeleteVideoRequest', 'id', id)
18118
+ const localVarPath = `/marketing/videos/{id}`
18119
+ .replace('{id}', encodeURIComponent(String(id)));
18120
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
18121
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
18122
+ let baseOptions;
18123
+ if (configuration) {
18124
+ baseOptions = configuration.baseOptions;
18125
+ }
18126
+
18127
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
18128
+ const localVarHeaderParameter = {} as any;
18129
+ const localVarQueryParameter = {} as any;
18130
+
18131
+ if (customerId !== undefined) {
18132
+ localVarQueryParameter['customerId'] = customerId;
18133
+ }
18134
+
18135
+
18136
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
18137
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
18138
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
18139
+
18140
+ return {
18141
+ url: toPathString(localVarUrlObj),
18142
+ options: localVarRequestOptions,
18143
+ };
18144
+ },
18145
+ /**
18146
+ * Get Customer Logo
18147
+ * @param {number} [customerId] Customer ID
18148
+ * @param {*} [options] Override http request option.
18149
+ * @throws {RequiredError}
18150
+ */
18151
+ getDownloadLogo: async (customerId?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
18152
+ const localVarPath = `/marketing/videos/logo`;
18153
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
18154
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
18155
+ let baseOptions;
18156
+ if (configuration) {
18157
+ baseOptions = configuration.baseOptions;
18158
+ }
18159
+
18160
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
18161
+ const localVarHeaderParameter = {} as any;
18162
+ const localVarQueryParameter = {} as any;
18163
+
18164
+ if (customerId !== undefined) {
18165
+ localVarQueryParameter['customerId'] = customerId;
18166
+ }
18167
+
18168
+ localVarHeaderParameter['Accept'] = 'application/json';
18169
+
18170
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
18171
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
18172
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
18173
+
18174
+ return {
18175
+ url: toPathString(localVarUrlObj),
18176
+ options: localVarRequestOptions,
18177
+ };
18178
+ },
18179
+ /**
18180
+ * Get Branded Videos
18181
+ * @param {number} [pageSize] Number Of Results
18182
+ * @param {number} [page] Page Number
18183
+ * @param {string} [search] Search
18184
+ * @param {GetGetBrandedVideosTypeEnum} [type] Type
18185
+ * @param {boolean} [outstanding] Outstanding
18186
+ * @param {boolean} [overdue] Overdue
18187
+ * @param {number} [customerId] Customer ID
18188
+ * @param {*} [options] Override http request option.
18189
+ * @throws {RequiredError}
18190
+ */
18191
+ getGetBrandedVideos: async (pageSize?: number, page?: number, search?: string, type?: GetGetBrandedVideosTypeEnum, outstanding?: boolean, overdue?: boolean, customerId?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
18192
+ const localVarPath = `/marketing/videos`;
18193
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
18194
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
18195
+ let baseOptions;
18196
+ if (configuration) {
18197
+ baseOptions = configuration.baseOptions;
18198
+ }
18199
+
18200
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
18201
+ const localVarHeaderParameter = {} as any;
18202
+ const localVarQueryParameter = {} as any;
18203
+
18204
+ if (pageSize !== undefined) {
18205
+ localVarQueryParameter['pageSize'] = pageSize;
18206
+ }
18207
+
18208
+ if (page !== undefined) {
18209
+ localVarQueryParameter['page'] = page;
18210
+ }
18211
+
18212
+ if (search !== undefined) {
18213
+ localVarQueryParameter['search'] = search;
18214
+ }
18215
+
18216
+ if (type !== undefined) {
18217
+ localVarQueryParameter['type'] = type;
18218
+ }
18219
+
18220
+ if (outstanding !== undefined) {
18221
+ localVarQueryParameter['outstanding'] = outstanding;
18222
+ }
18223
+
18224
+ if (overdue !== undefined) {
18225
+ localVarQueryParameter['overdue'] = overdue;
18226
+ }
18227
+
18228
+ if (customerId !== undefined) {
18229
+ localVarQueryParameter['customerId'] = customerId;
18230
+ }
18231
+
18232
+ localVarHeaderParameter['Accept'] = 'application/json';
18233
+
18234
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
18235
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
18236
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
18237
+
18238
+ return {
18239
+ url: toPathString(localVarUrlObj),
18240
+ options: localVarRequestOptions,
18241
+ };
18242
+ },
18243
+ /**
18244
+ * Get Thumbnails
18245
+ * @param {*} [options] Override http request option.
18246
+ * @throws {RequiredError}
18247
+ */
18248
+ getGetThumbnails: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
18249
+ const localVarPath = `/marketing/videos/thumbnails`;
18250
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
18251
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
18252
+ let baseOptions;
18253
+ if (configuration) {
18254
+ baseOptions = configuration.baseOptions;
18255
+ }
18256
+
18257
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
18258
+ const localVarHeaderParameter = {} as any;
18259
+ const localVarQueryParameter = {} as any;
18260
+
18261
+ localVarHeaderParameter['Accept'] = 'application/json';
18262
+
18263
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
18264
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
18265
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
18266
+
18267
+ return {
18268
+ url: toPathString(localVarUrlObj),
18269
+ options: localVarRequestOptions,
18270
+ };
18271
+ },
18272
+ /**
18273
+ * Upload logo
18274
+ * @param {File} logo Logo
18275
+ * @param {number} [customerId] Customer ID
18276
+ * @param {*} [options] Override http request option.
18277
+ * @throws {RequiredError}
18278
+ */
18279
+ postDownloadLogo: async (logo: File, customerId?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
18280
+ // verify required parameter 'logo' is not null or undefined
18281
+ assertParamExists('postDownloadLogo', 'logo', logo)
18282
+ const localVarPath = `/marketing/videos/logo`;
18283
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
18284
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
18285
+ let baseOptions;
18286
+ if (configuration) {
18287
+ baseOptions = configuration.baseOptions;
18288
+ }
18289
+
18290
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
18291
+ const localVarHeaderParameter = {} as any;
18292
+ const localVarQueryParameter = {} as any;
18293
+ const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)();
18294
+
18295
+ if (customerId !== undefined) {
18296
+ localVarQueryParameter['customerId'] = customerId;
18297
+ }
18298
+
18299
+
18300
+ if (logo !== undefined) {
18301
+ localVarFormParams.append('logo', logo as any);
18302
+ }
18303
+ localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
18304
+
18305
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
18306
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
18307
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
18308
+ localVarRequestOptions.data = localVarFormParams;
18309
+
18310
+ return {
18311
+ url: toPathString(localVarUrlObj),
18312
+ options: localVarRequestOptions,
18313
+ };
18314
+ },
18315
+ /**
18316
+ * Send Branded Video Email
18317
+ * @param {string} email Email
18318
+ * @param {number} id Video ID
18319
+ * @param {number} [customerId] Customer ID
18320
+ * @param {*} [options] Override http request option.
18321
+ * @throws {RequiredError}
18322
+ */
18323
+ postSendBrandedVideoEmail: async (email: string, id: number, customerId?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
18324
+ // verify required parameter 'email' is not null or undefined
18325
+ assertParamExists('postSendBrandedVideoEmail', 'email', email)
18326
+ // verify required parameter 'id' is not null or undefined
18327
+ assertParamExists('postSendBrandedVideoEmail', 'id', id)
18328
+ const localVarPath = `/marketing/videos/{id}/send`
18329
+ .replace('{id}', encodeURIComponent(String(id)));
18330
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
18331
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
18332
+ let baseOptions;
18333
+ if (configuration) {
18334
+ baseOptions = configuration.baseOptions;
18335
+ }
18336
+
18337
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
18338
+ const localVarHeaderParameter = {} as any;
18339
+ const localVarQueryParameter = {} as any;
18340
+
18341
+ if (customerId !== undefined) {
18342
+ localVarQueryParameter['customerId'] = customerId;
18343
+ }
18344
+
18345
+ if (email !== undefined) {
18346
+ localVarQueryParameter['email'] = email;
18347
+ }
18348
+
18349
+
18350
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
18351
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
18352
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
18353
+
18354
+ return {
18355
+ url: toPathString(localVarUrlObj),
18356
+ options: localVarRequestOptions,
18357
+ };
18358
+ },
18359
+ /**
18360
+ * Upload Video
18361
+ * @param {string} thumbnailId Thumbnail ID
18362
+ * @param {number} id Video ID
18363
+ * @param {File} video Video
18364
+ * @param {number} [customerId] Customer ID
18365
+ * @param {*} [options] Override http request option.
18366
+ * @throws {RequiredError}
18367
+ */
18368
+ postUploadVideo: async (thumbnailId: string, id: number, video: File, customerId?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
18369
+ // verify required parameter 'thumbnailId' is not null or undefined
18370
+ assertParamExists('postUploadVideo', 'thumbnailId', thumbnailId)
18371
+ // verify required parameter 'id' is not null or undefined
18372
+ assertParamExists('postUploadVideo', 'id', id)
18373
+ // verify required parameter 'video' is not null or undefined
18374
+ assertParamExists('postUploadVideo', 'video', video)
18375
+ const localVarPath = `/marketing/videos/{id}/upload`
18376
+ .replace('{id}', encodeURIComponent(String(id)));
18377
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
18378
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
18379
+ let baseOptions;
18380
+ if (configuration) {
18381
+ baseOptions = configuration.baseOptions;
18382
+ }
18383
+
18384
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
18385
+ const localVarHeaderParameter = {} as any;
18386
+ const localVarQueryParameter = {} as any;
18387
+ const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)();
18388
+
18389
+ if (customerId !== undefined) {
18390
+ localVarQueryParameter['customerId'] = customerId;
18391
+ }
18392
+
18393
+ if (thumbnailId !== undefined) {
18394
+ localVarQueryParameter['thumbnailId'] = thumbnailId;
18395
+ }
18396
+
18397
+
18398
+ if (video !== undefined) {
18399
+ localVarFormParams.append('video', video as any);
18400
+ }
18401
+ localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
18402
+ localVarHeaderParameter['Accept'] = 'application/json';
18403
+
18404
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
18405
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
18406
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
18407
+ localVarRequestOptions.data = localVarFormParams;
18408
+
18409
+ return {
18410
+ url: toPathString(localVarUrlObj),
18411
+ options: localVarRequestOptions,
18412
+ };
18413
+ },
18414
+ }
18415
+ };
18416
+
18417
+ /**
18418
+ * BrandedVideosApi - functional programming interface
18419
+ */
18420
+ export const BrandedVideosApiFp = function(configuration?: Configuration) {
18421
+ const localVarAxiosParamCreator = BrandedVideosApiAxiosParamCreator(configuration)
18422
+ return {
18423
+ /**
18424
+ * Send Branded Video Email
18425
+ * @param {number} id Video ID
18426
+ * @param {number} [customerId] Customer ID
18427
+ * @param {*} [options] Override http request option.
18428
+ * @throws {RequiredError}
18429
+ */
18430
+ async deleteDeleteVideoRequest(id: number, customerId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
18431
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteDeleteVideoRequest(id, customerId, options);
18432
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
18433
+ const localVarOperationServerBasePath = operationServerMap['BrandedVideosApi.deleteDeleteVideoRequest']?.[localVarOperationServerIndex]?.url;
18434
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
18435
+ },
18436
+ /**
18437
+ * Get Customer Logo
18438
+ * @param {number} [customerId] Customer ID
18439
+ * @param {*} [options] Override http request option.
18440
+ * @throws {RequiredError}
18441
+ */
18442
+ async getDownloadLogo(customerId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>> {
18443
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getDownloadLogo(customerId, options);
18444
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
18445
+ const localVarOperationServerBasePath = operationServerMap['BrandedVideosApi.getDownloadLogo']?.[localVarOperationServerIndex]?.url;
18446
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
18447
+ },
18448
+ /**
18449
+ * Get Branded Videos
18450
+ * @param {number} [pageSize] Number Of Results
18451
+ * @param {number} [page] Page Number
18452
+ * @param {string} [search] Search
18453
+ * @param {GetGetBrandedVideosTypeEnum} [type] Type
18454
+ * @param {boolean} [outstanding] Outstanding
18455
+ * @param {boolean} [overdue] Overdue
18456
+ * @param {number} [customerId] Customer ID
18457
+ * @param {*} [options] Override http request option.
18458
+ * @throws {RequiredError}
18459
+ */
18460
+ async getGetBrandedVideos(pageSize?: number, page?: number, search?: string, type?: GetGetBrandedVideosTypeEnum, outstanding?: boolean, overdue?: boolean, customerId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BrandedVideosSummariesModel>> {
18461
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getGetBrandedVideos(pageSize, page, search, type, outstanding, overdue, customerId, options);
18462
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
18463
+ const localVarOperationServerBasePath = operationServerMap['BrandedVideosApi.getGetBrandedVideos']?.[localVarOperationServerIndex]?.url;
18464
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
18465
+ },
18466
+ /**
18467
+ * Get Thumbnails
18468
+ * @param {*} [options] Override http request option.
18469
+ * @throws {RequiredError}
18470
+ */
18471
+ async getGetThumbnails(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ThumbnailDTO>>> {
18472
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getGetThumbnails(options);
18473
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
18474
+ const localVarOperationServerBasePath = operationServerMap['BrandedVideosApi.getGetThumbnails']?.[localVarOperationServerIndex]?.url;
18475
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
18476
+ },
18477
+ /**
18478
+ * Upload logo
18479
+ * @param {File} logo Logo
18480
+ * @param {number} [customerId] Customer ID
18481
+ * @param {*} [options] Override http request option.
18482
+ * @throws {RequiredError}
18483
+ */
18484
+ async postDownloadLogo(logo: File, customerId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
18485
+ const localVarAxiosArgs = await localVarAxiosParamCreator.postDownloadLogo(logo, customerId, options);
18486
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
18487
+ const localVarOperationServerBasePath = operationServerMap['BrandedVideosApi.postDownloadLogo']?.[localVarOperationServerIndex]?.url;
18488
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
18489
+ },
18490
+ /**
18491
+ * Send Branded Video Email
18492
+ * @param {string} email Email
18493
+ * @param {number} id Video ID
18494
+ * @param {number} [customerId] Customer ID
18495
+ * @param {*} [options] Override http request option.
18496
+ * @throws {RequiredError}
18497
+ */
18498
+ async postSendBrandedVideoEmail(email: string, id: number, customerId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
18499
+ const localVarAxiosArgs = await localVarAxiosParamCreator.postSendBrandedVideoEmail(email, id, customerId, options);
18500
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
18501
+ const localVarOperationServerBasePath = operationServerMap['BrandedVideosApi.postSendBrandedVideoEmail']?.[localVarOperationServerIndex]?.url;
18502
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
18503
+ },
18504
+ /**
18505
+ * Upload Video
18506
+ * @param {string} thumbnailId Thumbnail ID
18507
+ * @param {number} id Video ID
18508
+ * @param {File} video Video
18509
+ * @param {number} [customerId] Customer ID
18510
+ * @param {*} [options] Override http request option.
18511
+ * @throws {RequiredError}
18512
+ */
18513
+ async postUploadVideo(thumbnailId: string, id: number, video: File, customerId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BrandedVideoSummaryDTO>> {
18514
+ const localVarAxiosArgs = await localVarAxiosParamCreator.postUploadVideo(thumbnailId, id, video, customerId, options);
18515
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
18516
+ const localVarOperationServerBasePath = operationServerMap['BrandedVideosApi.postUploadVideo']?.[localVarOperationServerIndex]?.url;
18517
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
18518
+ },
18519
+ }
18520
+ };
18521
+
18522
+ /**
18523
+ * BrandedVideosApi - factory interface
18524
+ */
18525
+ export const BrandedVideosApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
18526
+ const localVarFp = BrandedVideosApiFp(configuration)
18527
+ return {
18528
+ /**
18529
+ * Send Branded Video Email
18530
+ * @param {number} id Video ID
18531
+ * @param {number} [customerId] Customer ID
18532
+ * @param {*} [options] Override http request option.
18533
+ * @throws {RequiredError}
18534
+ */
18535
+ deleteDeleteVideoRequest(id: number, customerId?: number, options?: RawAxiosRequestConfig): AxiosPromise<void> {
18536
+ return localVarFp.deleteDeleteVideoRequest(id, customerId, options).then((request) => request(axios, basePath));
18537
+ },
18538
+ /**
18539
+ * Get Customer Logo
18540
+ * @param {number} [customerId] Customer ID
18541
+ * @param {*} [options] Override http request option.
18542
+ * @throws {RequiredError}
18543
+ */
18544
+ getDownloadLogo(customerId?: number, options?: RawAxiosRequestConfig): AxiosPromise<string> {
18545
+ return localVarFp.getDownloadLogo(customerId, options).then((request) => request(axios, basePath));
18546
+ },
18547
+ /**
18548
+ * Get Branded Videos
18549
+ * @param {number} [pageSize] Number Of Results
18550
+ * @param {number} [page] Page Number
18551
+ * @param {string} [search] Search
18552
+ * @param {GetGetBrandedVideosTypeEnum} [type] Type
18553
+ * @param {boolean} [outstanding] Outstanding
18554
+ * @param {boolean} [overdue] Overdue
18555
+ * @param {number} [customerId] Customer ID
18556
+ * @param {*} [options] Override http request option.
18557
+ * @throws {RequiredError}
18558
+ */
18559
+ getGetBrandedVideos(pageSize?: number, page?: number, search?: string, type?: GetGetBrandedVideosTypeEnum, outstanding?: boolean, overdue?: boolean, customerId?: number, options?: RawAxiosRequestConfig): AxiosPromise<BrandedVideosSummariesModel> {
18560
+ return localVarFp.getGetBrandedVideos(pageSize, page, search, type, outstanding, overdue, customerId, options).then((request) => request(axios, basePath));
18561
+ },
18562
+ /**
18563
+ * Get Thumbnails
18564
+ * @param {*} [options] Override http request option.
18565
+ * @throws {RequiredError}
18566
+ */
18567
+ getGetThumbnails(options?: RawAxiosRequestConfig): AxiosPromise<Array<ThumbnailDTO>> {
18568
+ return localVarFp.getGetThumbnails(options).then((request) => request(axios, basePath));
18569
+ },
18570
+ /**
18571
+ * Upload logo
18572
+ * @param {File} logo Logo
18573
+ * @param {number} [customerId] Customer ID
18574
+ * @param {*} [options] Override http request option.
18575
+ * @throws {RequiredError}
18576
+ */
18577
+ postDownloadLogo(logo: File, customerId?: number, options?: RawAxiosRequestConfig): AxiosPromise<void> {
18578
+ return localVarFp.postDownloadLogo(logo, customerId, options).then((request) => request(axios, basePath));
18579
+ },
18580
+ /**
18581
+ * Send Branded Video Email
18582
+ * @param {string} email Email
18583
+ * @param {number} id Video ID
18584
+ * @param {number} [customerId] Customer ID
18585
+ * @param {*} [options] Override http request option.
18586
+ * @throws {RequiredError}
18587
+ */
18588
+ postSendBrandedVideoEmail(email: string, id: number, customerId?: number, options?: RawAxiosRequestConfig): AxiosPromise<void> {
18589
+ return localVarFp.postSendBrandedVideoEmail(email, id, customerId, options).then((request) => request(axios, basePath));
18590
+ },
18591
+ /**
18592
+ * Upload Video
18593
+ * @param {string} thumbnailId Thumbnail ID
18594
+ * @param {number} id Video ID
18595
+ * @param {File} video Video
18596
+ * @param {number} [customerId] Customer ID
18597
+ * @param {*} [options] Override http request option.
18598
+ * @throws {RequiredError}
18599
+ */
18600
+ postUploadVideo(thumbnailId: string, id: number, video: File, customerId?: number, options?: RawAxiosRequestConfig): AxiosPromise<BrandedVideoSummaryDTO> {
18601
+ return localVarFp.postUploadVideo(thumbnailId, id, video, customerId, options).then((request) => request(axios, basePath));
18602
+ },
18603
+ };
18604
+ };
18605
+
18606
+ /**
18607
+ * BrandedVideosApi - object-oriented interface
18608
+ */
18609
+ export class BrandedVideosApi extends BaseAPI {
18610
+ /**
18611
+ * Send Branded Video Email
18612
+ * @param {number} id Video ID
18613
+ * @param {number} [customerId] Customer ID
18614
+ * @param {*} [options] Override http request option.
18615
+ * @throws {RequiredError}
18616
+ */
18617
+ public deleteDeleteVideoRequest(id: number, customerId?: number, options?: RawAxiosRequestConfig) {
18618
+ return BrandedVideosApiFp(this.configuration).deleteDeleteVideoRequest(id, customerId, options).then((request) => request(this.axios, this.basePath));
18619
+ }
18620
+
18621
+ /**
18622
+ * Get Customer Logo
18623
+ * @param {number} [customerId] Customer ID
18624
+ * @param {*} [options] Override http request option.
18625
+ * @throws {RequiredError}
18626
+ */
18627
+ public getDownloadLogo(customerId?: number, options?: RawAxiosRequestConfig) {
18628
+ return BrandedVideosApiFp(this.configuration).getDownloadLogo(customerId, options).then((request) => request(this.axios, this.basePath));
18629
+ }
18630
+
18631
+ /**
18632
+ * Get Branded Videos
18633
+ * @param {number} [pageSize] Number Of Results
18634
+ * @param {number} [page] Page Number
18635
+ * @param {string} [search] Search
18636
+ * @param {GetGetBrandedVideosTypeEnum} [type] Type
18637
+ * @param {boolean} [outstanding] Outstanding
18638
+ * @param {boolean} [overdue] Overdue
18639
+ * @param {number} [customerId] Customer ID
18640
+ * @param {*} [options] Override http request option.
18641
+ * @throws {RequiredError}
18642
+ */
18643
+ public getGetBrandedVideos(pageSize?: number, page?: number, search?: string, type?: GetGetBrandedVideosTypeEnum, outstanding?: boolean, overdue?: boolean, customerId?: number, options?: RawAxiosRequestConfig) {
18644
+ return BrandedVideosApiFp(this.configuration).getGetBrandedVideos(pageSize, page, search, type, outstanding, overdue, customerId, options).then((request) => request(this.axios, this.basePath));
18645
+ }
18646
+
18647
+ /**
18648
+ * Get Thumbnails
18649
+ * @param {*} [options] Override http request option.
18650
+ * @throws {RequiredError}
18651
+ */
18652
+ public getGetThumbnails(options?: RawAxiosRequestConfig) {
18653
+ return BrandedVideosApiFp(this.configuration).getGetThumbnails(options).then((request) => request(this.axios, this.basePath));
18654
+ }
18655
+
18656
+ /**
18657
+ * Upload logo
18658
+ * @param {File} logo Logo
18659
+ * @param {number} [customerId] Customer ID
18660
+ * @param {*} [options] Override http request option.
18661
+ * @throws {RequiredError}
18662
+ */
18663
+ public postDownloadLogo(logo: File, customerId?: number, options?: RawAxiosRequestConfig) {
18664
+ return BrandedVideosApiFp(this.configuration).postDownloadLogo(logo, customerId, options).then((request) => request(this.axios, this.basePath));
18665
+ }
18666
+
18667
+ /**
18668
+ * Send Branded Video Email
18669
+ * @param {string} email Email
18670
+ * @param {number} id Video ID
18671
+ * @param {number} [customerId] Customer ID
18672
+ * @param {*} [options] Override http request option.
18673
+ * @throws {RequiredError}
18674
+ */
18675
+ public postSendBrandedVideoEmail(email: string, id: number, customerId?: number, options?: RawAxiosRequestConfig) {
18676
+ return BrandedVideosApiFp(this.configuration).postSendBrandedVideoEmail(email, id, customerId, options).then((request) => request(this.axios, this.basePath));
18677
+ }
18678
+
18679
+ /**
18680
+ * Upload Video
18681
+ * @param {string} thumbnailId Thumbnail ID
18682
+ * @param {number} id Video ID
18683
+ * @param {File} video Video
18684
+ * @param {number} [customerId] Customer ID
18685
+ * @param {*} [options] Override http request option.
18686
+ * @throws {RequiredError}
18687
+ */
18688
+ public postUploadVideo(thumbnailId: string, id: number, video: File, customerId?: number, options?: RawAxiosRequestConfig) {
18689
+ return BrandedVideosApiFp(this.configuration).postUploadVideo(thumbnailId, id, video, customerId, options).then((request) => request(this.axios, this.basePath));
18690
+ }
18691
+ }
18692
+
18693
+ export const GetGetBrandedVideosTypeEnum = {
18694
+ Paid: 'paid',
18695
+ Reward: 'reward',
18696
+ Sample: 'sample',
18697
+ } as const;
18698
+ export type GetGetBrandedVideosTypeEnum = typeof GetGetBrandedVideosTypeEnum[keyof typeof GetGetBrandedVideosTypeEnum];
18699
+
18700
+
17917
18701
  /**
17918
18702
  * CRMApi - axios parameter creator
17919
18703
  */
@@ -25625,6 +26409,8 @@ export const PostAccessTokenScopeEnum = {
25625
26409
  TcxWizard: 'tcx_wizard',
25626
26410
  AccountsRead: 'accounts.read',
25627
26411
  AccountsWrite: 'accounts.write',
26412
+ BrandedVideosread: 'branded_videosread',
26413
+ BrandedVideoswrite: 'branded_videoswrite',
25628
26414
  NumberPortingRead: 'number_porting.read',
25629
26415
  NumberPortingWrite: 'number_porting.write',
25630
26416
  PricingRead: 'pricing.read',
@@ -25661,6 +26447,8 @@ export const PostAuthoriseScopeEnum = {
25661
26447
  TcxWizard: 'tcx_wizard',
25662
26448
  AccountsRead: 'accounts.read',
25663
26449
  AccountsWrite: 'accounts.write',
26450
+ BrandedVideosread: 'branded_videosread',
26451
+ BrandedVideoswrite: 'branded_videoswrite',
25664
26452
  NumberPortingRead: 'number_porting.read',
25665
26453
  NumberPortingWrite: 'number_porting.write',
25666
26454
  PricingRead: 'pricing.read',