@teemill/platform 0.31.0 → 0.33.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.
- package/README.md +16 -2
- package/api.ts +1407 -273
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +698 -1
- package/dist/api.js +683 -2
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +698 -1
- package/dist/esm/api.js +674 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/CreatePixelRequest.md +24 -0
- package/docs/CreatePixelRequestFilters.md +24 -0
- package/docs/DashboardApi.md +127 -0
- package/docs/DashboardItem.md +30 -0
- package/docs/GetDashboardResponse.md +20 -0
- package/docs/Pixel.md +26 -0
- package/docs/PixelsApi.md +341 -0
- package/docs/PixelsResponse.md +22 -0
- package/docs/SaveDashboardRequest.md +20 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Platform API
|
|
3
3
|
* Manage Your podOS platform
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.
|
|
5
|
+
* The version of the OpenAPI document: 0.33.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -418,6 +418,56 @@ export interface CreateOrderContactInformation {
|
|
|
418
418
|
*/
|
|
419
419
|
'phone'?: string | null;
|
|
420
420
|
}
|
|
421
|
+
/**
|
|
422
|
+
*
|
|
423
|
+
* @export
|
|
424
|
+
* @interface CreatePixelRequest
|
|
425
|
+
*/
|
|
426
|
+
export interface CreatePixelRequest {
|
|
427
|
+
/**
|
|
428
|
+
*
|
|
429
|
+
* @type {string}
|
|
430
|
+
* @memberof CreatePixelRequest
|
|
431
|
+
*/
|
|
432
|
+
'name': string;
|
|
433
|
+
/**
|
|
434
|
+
*
|
|
435
|
+
* @type {Array<string>}
|
|
436
|
+
* @memberof CreatePixelRequest
|
|
437
|
+
*/
|
|
438
|
+
'sourceProjects': Array<string>;
|
|
439
|
+
/**
|
|
440
|
+
*
|
|
441
|
+
* @type {CreatePixelRequestFilters}
|
|
442
|
+
* @memberof CreatePixelRequest
|
|
443
|
+
*/
|
|
444
|
+
'filters': CreatePixelRequestFilters;
|
|
445
|
+
}
|
|
446
|
+
/**
|
|
447
|
+
*
|
|
448
|
+
* @export
|
|
449
|
+
* @interface CreatePixelRequestFilters
|
|
450
|
+
*/
|
|
451
|
+
export interface CreatePixelRequestFilters {
|
|
452
|
+
/**
|
|
453
|
+
*
|
|
454
|
+
* @type {Array<string>}
|
|
455
|
+
* @memberof CreatePixelRequestFilters
|
|
456
|
+
*/
|
|
457
|
+
'projects': Array<string> | null;
|
|
458
|
+
/**
|
|
459
|
+
*
|
|
460
|
+
* @type {Array<string>}
|
|
461
|
+
* @memberof CreatePixelRequestFilters
|
|
462
|
+
*/
|
|
463
|
+
'demographics': Array<string> | null;
|
|
464
|
+
/**
|
|
465
|
+
*
|
|
466
|
+
* @type {Array<string>}
|
|
467
|
+
* @memberof CreatePixelRequestFilters
|
|
468
|
+
*/
|
|
469
|
+
'tags': Array<string> | null;
|
|
470
|
+
}
|
|
421
471
|
/**
|
|
422
472
|
* @type CreateReview201Response
|
|
423
473
|
* @export
|
|
@@ -605,6 +655,51 @@ export declare const CustomsInformationPreRegistrationTypeEnum: {
|
|
|
605
655
|
readonly Ioss: "IOSS";
|
|
606
656
|
};
|
|
607
657
|
export type CustomsInformationPreRegistrationTypeEnum = typeof CustomsInformationPreRegistrationTypeEnum[keyof typeof CustomsInformationPreRegistrationTypeEnum];
|
|
658
|
+
/**
|
|
659
|
+
*
|
|
660
|
+
* @export
|
|
661
|
+
* @interface DashboardItem
|
|
662
|
+
*/
|
|
663
|
+
export interface DashboardItem {
|
|
664
|
+
/**
|
|
665
|
+
*
|
|
666
|
+
* @type {string}
|
|
667
|
+
* @memberof DashboardItem
|
|
668
|
+
*/
|
|
669
|
+
'id': string;
|
|
670
|
+
/**
|
|
671
|
+
*
|
|
672
|
+
* @type {string}
|
|
673
|
+
* @memberof DashboardItem
|
|
674
|
+
*/
|
|
675
|
+
'type': string;
|
|
676
|
+
/**
|
|
677
|
+
*
|
|
678
|
+
* @type {{ [key: string]: any; }}
|
|
679
|
+
* @memberof DashboardItem
|
|
680
|
+
*/
|
|
681
|
+
'properties': {
|
|
682
|
+
[key: string]: any;
|
|
683
|
+
} | null;
|
|
684
|
+
/**
|
|
685
|
+
*
|
|
686
|
+
* @type {boolean}
|
|
687
|
+
* @memberof DashboardItem
|
|
688
|
+
*/
|
|
689
|
+
'published': boolean;
|
|
690
|
+
/**
|
|
691
|
+
*
|
|
692
|
+
* @type {number}
|
|
693
|
+
* @memberof DashboardItem
|
|
694
|
+
*/
|
|
695
|
+
'sortOrder': number;
|
|
696
|
+
/**
|
|
697
|
+
*
|
|
698
|
+
* @type {Array<DashboardItem>}
|
|
699
|
+
* @memberof DashboardItem
|
|
700
|
+
*/
|
|
701
|
+
'items'?: Array<DashboardItem> | null;
|
|
702
|
+
}
|
|
608
703
|
/**
|
|
609
704
|
*
|
|
610
705
|
* @export
|
|
@@ -932,6 +1027,19 @@ export interface FulfillmentItem {
|
|
|
932
1027
|
*/
|
|
933
1028
|
'quantity'?: number;
|
|
934
1029
|
}
|
|
1030
|
+
/**
|
|
1031
|
+
*
|
|
1032
|
+
* @export
|
|
1033
|
+
* @interface GetDashboardResponse
|
|
1034
|
+
*/
|
|
1035
|
+
export interface GetDashboardResponse {
|
|
1036
|
+
/**
|
|
1037
|
+
*
|
|
1038
|
+
* @type {Array<DashboardItem>}
|
|
1039
|
+
* @memberof GetDashboardResponse
|
|
1040
|
+
*/
|
|
1041
|
+
'items'?: Array<DashboardItem>;
|
|
1042
|
+
}
|
|
935
1043
|
/**
|
|
936
1044
|
* Image description
|
|
937
1045
|
* @export
|
|
@@ -1535,6 +1643,56 @@ export declare const PaymentAttemptStatusEnum: {
|
|
|
1535
1643
|
readonly Cancelled: "cancelled";
|
|
1536
1644
|
};
|
|
1537
1645
|
export type PaymentAttemptStatusEnum = typeof PaymentAttemptStatusEnum[keyof typeof PaymentAttemptStatusEnum];
|
|
1646
|
+
/**
|
|
1647
|
+
*
|
|
1648
|
+
* @export
|
|
1649
|
+
* @interface Pixel
|
|
1650
|
+
*/
|
|
1651
|
+
export interface Pixel {
|
|
1652
|
+
/**
|
|
1653
|
+
* Unique object identifier
|
|
1654
|
+
* @type {string}
|
|
1655
|
+
* @memberof Pixel
|
|
1656
|
+
*/
|
|
1657
|
+
'id': string;
|
|
1658
|
+
/**
|
|
1659
|
+
*
|
|
1660
|
+
* @type {string}
|
|
1661
|
+
* @memberof Pixel
|
|
1662
|
+
*/
|
|
1663
|
+
'name': string;
|
|
1664
|
+
/**
|
|
1665
|
+
*
|
|
1666
|
+
* @type {Array<string>}
|
|
1667
|
+
* @memberof Pixel
|
|
1668
|
+
*/
|
|
1669
|
+
'sourceProjects': Array<string>;
|
|
1670
|
+
/**
|
|
1671
|
+
*
|
|
1672
|
+
* @type {CreatePixelRequestFilters}
|
|
1673
|
+
* @memberof Pixel
|
|
1674
|
+
*/
|
|
1675
|
+
'filters': CreatePixelRequestFilters;
|
|
1676
|
+
}
|
|
1677
|
+
/**
|
|
1678
|
+
*
|
|
1679
|
+
* @export
|
|
1680
|
+
* @interface PixelsResponse
|
|
1681
|
+
*/
|
|
1682
|
+
export interface PixelsResponse {
|
|
1683
|
+
/**
|
|
1684
|
+
*
|
|
1685
|
+
* @type {Array<Pixel>}
|
|
1686
|
+
* @memberof PixelsResponse
|
|
1687
|
+
*/
|
|
1688
|
+
'pixels': Array<Pixel>;
|
|
1689
|
+
/**
|
|
1690
|
+
*
|
|
1691
|
+
* @type {number}
|
|
1692
|
+
* @memberof PixelsResponse
|
|
1693
|
+
*/
|
|
1694
|
+
'nextPageToken'?: number | null;
|
|
1695
|
+
}
|
|
1538
1696
|
/**
|
|
1539
1697
|
*
|
|
1540
1698
|
* @export
|
|
@@ -1867,6 +2025,19 @@ export interface ReviewsResponse {
|
|
|
1867
2025
|
*/
|
|
1868
2026
|
'nextPageToken'?: number | null;
|
|
1869
2027
|
}
|
|
2028
|
+
/**
|
|
2029
|
+
*
|
|
2030
|
+
* @export
|
|
2031
|
+
* @interface SaveDashboardRequest
|
|
2032
|
+
*/
|
|
2033
|
+
export interface SaveDashboardRequest {
|
|
2034
|
+
/**
|
|
2035
|
+
*
|
|
2036
|
+
* @type {Array<DashboardItem>}
|
|
2037
|
+
* @memberof SaveDashboardRequest
|
|
2038
|
+
*/
|
|
2039
|
+
'items'?: Array<DashboardItem>;
|
|
2040
|
+
}
|
|
1870
2041
|
/**
|
|
1871
2042
|
*
|
|
1872
2043
|
* @export
|
|
@@ -2669,6 +2840,148 @@ export declare const ListCustomersGenderEnum: {
|
|
|
2669
2840
|
readonly Female: "female";
|
|
2670
2841
|
};
|
|
2671
2842
|
export type ListCustomersGenderEnum = typeof ListCustomersGenderEnum[keyof typeof ListCustomersGenderEnum];
|
|
2843
|
+
/**
|
|
2844
|
+
* DashboardApi - axios parameter creator
|
|
2845
|
+
* @export
|
|
2846
|
+
*/
|
|
2847
|
+
export declare const DashboardApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2848
|
+
/**
|
|
2849
|
+
*
|
|
2850
|
+
* @summary Get the platform\'s dashboard
|
|
2851
|
+
* @param {string} project Project unique identifier
|
|
2852
|
+
* @param {string} platformId The platform identifier
|
|
2853
|
+
* @param {*} [options] Override http request option.
|
|
2854
|
+
* @throws {RequiredError}
|
|
2855
|
+
*/
|
|
2856
|
+
getDashboard: (project: string, platformId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2857
|
+
/**
|
|
2858
|
+
*
|
|
2859
|
+
* @summary Save the platform\'s dashboard
|
|
2860
|
+
* @param {string} project Project unique identifier
|
|
2861
|
+
* @param {string} platformId The platform identifier
|
|
2862
|
+
* @param {SaveDashboardRequest} saveDashboardRequest Save dashboard
|
|
2863
|
+
* @param {*} [options] Override http request option.
|
|
2864
|
+
* @throws {RequiredError}
|
|
2865
|
+
*/
|
|
2866
|
+
saveDashboard: (project: string, platformId: string, saveDashboardRequest: SaveDashboardRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2867
|
+
};
|
|
2868
|
+
/**
|
|
2869
|
+
* DashboardApi - functional programming interface
|
|
2870
|
+
* @export
|
|
2871
|
+
*/
|
|
2872
|
+
export declare const DashboardApiFp: (configuration?: Configuration) => {
|
|
2873
|
+
/**
|
|
2874
|
+
*
|
|
2875
|
+
* @summary Get the platform\'s dashboard
|
|
2876
|
+
* @param {string} project Project unique identifier
|
|
2877
|
+
* @param {string} platformId The platform identifier
|
|
2878
|
+
* @param {*} [options] Override http request option.
|
|
2879
|
+
* @throws {RequiredError}
|
|
2880
|
+
*/
|
|
2881
|
+
getDashboard(project: string, platformId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDashboardResponse>>;
|
|
2882
|
+
/**
|
|
2883
|
+
*
|
|
2884
|
+
* @summary Save the platform\'s dashboard
|
|
2885
|
+
* @param {string} project Project unique identifier
|
|
2886
|
+
* @param {string} platformId The platform identifier
|
|
2887
|
+
* @param {SaveDashboardRequest} saveDashboardRequest Save dashboard
|
|
2888
|
+
* @param {*} [options] Override http request option.
|
|
2889
|
+
* @throws {RequiredError}
|
|
2890
|
+
*/
|
|
2891
|
+
saveDashboard(project: string, platformId: string, saveDashboardRequest: SaveDashboardRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDashboardResponse>>;
|
|
2892
|
+
};
|
|
2893
|
+
/**
|
|
2894
|
+
* DashboardApi - factory interface
|
|
2895
|
+
* @export
|
|
2896
|
+
*/
|
|
2897
|
+
export declare const DashboardApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2898
|
+
/**
|
|
2899
|
+
*
|
|
2900
|
+
* @summary Get the platform\'s dashboard
|
|
2901
|
+
* @param {DashboardApiGetDashboardRequest} requestParameters Request parameters.
|
|
2902
|
+
* @param {*} [options] Override http request option.
|
|
2903
|
+
* @throws {RequiredError}
|
|
2904
|
+
*/
|
|
2905
|
+
getDashboard(requestParameters: DashboardApiGetDashboardRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetDashboardResponse>;
|
|
2906
|
+
/**
|
|
2907
|
+
*
|
|
2908
|
+
* @summary Save the platform\'s dashboard
|
|
2909
|
+
* @param {DashboardApiSaveDashboardRequest} requestParameters Request parameters.
|
|
2910
|
+
* @param {*} [options] Override http request option.
|
|
2911
|
+
* @throws {RequiredError}
|
|
2912
|
+
*/
|
|
2913
|
+
saveDashboard(requestParameters: DashboardApiSaveDashboardRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetDashboardResponse>;
|
|
2914
|
+
};
|
|
2915
|
+
/**
|
|
2916
|
+
* Request parameters for getDashboard operation in DashboardApi.
|
|
2917
|
+
* @export
|
|
2918
|
+
* @interface DashboardApiGetDashboardRequest
|
|
2919
|
+
*/
|
|
2920
|
+
export interface DashboardApiGetDashboardRequest {
|
|
2921
|
+
/**
|
|
2922
|
+
* Project unique identifier
|
|
2923
|
+
* @type {string}
|
|
2924
|
+
* @memberof DashboardApiGetDashboard
|
|
2925
|
+
*/
|
|
2926
|
+
readonly project: string;
|
|
2927
|
+
/**
|
|
2928
|
+
* The platform identifier
|
|
2929
|
+
* @type {string}
|
|
2930
|
+
* @memberof DashboardApiGetDashboard
|
|
2931
|
+
*/
|
|
2932
|
+
readonly platformId: string;
|
|
2933
|
+
}
|
|
2934
|
+
/**
|
|
2935
|
+
* Request parameters for saveDashboard operation in DashboardApi.
|
|
2936
|
+
* @export
|
|
2937
|
+
* @interface DashboardApiSaveDashboardRequest
|
|
2938
|
+
*/
|
|
2939
|
+
export interface DashboardApiSaveDashboardRequest {
|
|
2940
|
+
/**
|
|
2941
|
+
* Project unique identifier
|
|
2942
|
+
* @type {string}
|
|
2943
|
+
* @memberof DashboardApiSaveDashboard
|
|
2944
|
+
*/
|
|
2945
|
+
readonly project: string;
|
|
2946
|
+
/**
|
|
2947
|
+
* The platform identifier
|
|
2948
|
+
* @type {string}
|
|
2949
|
+
* @memberof DashboardApiSaveDashboard
|
|
2950
|
+
*/
|
|
2951
|
+
readonly platformId: string;
|
|
2952
|
+
/**
|
|
2953
|
+
* Save dashboard
|
|
2954
|
+
* @type {SaveDashboardRequest}
|
|
2955
|
+
* @memberof DashboardApiSaveDashboard
|
|
2956
|
+
*/
|
|
2957
|
+
readonly saveDashboardRequest: SaveDashboardRequest;
|
|
2958
|
+
}
|
|
2959
|
+
/**
|
|
2960
|
+
* DashboardApi - object-oriented interface
|
|
2961
|
+
* @export
|
|
2962
|
+
* @class DashboardApi
|
|
2963
|
+
* @extends {BaseAPI}
|
|
2964
|
+
*/
|
|
2965
|
+
export declare class DashboardApi extends BaseAPI {
|
|
2966
|
+
/**
|
|
2967
|
+
*
|
|
2968
|
+
* @summary Get the platform\'s dashboard
|
|
2969
|
+
* @param {DashboardApiGetDashboardRequest} requestParameters Request parameters.
|
|
2970
|
+
* @param {*} [options] Override http request option.
|
|
2971
|
+
* @throws {RequiredError}
|
|
2972
|
+
* @memberof DashboardApi
|
|
2973
|
+
*/
|
|
2974
|
+
getDashboard(requestParameters: DashboardApiGetDashboardRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetDashboardResponse, any>>;
|
|
2975
|
+
/**
|
|
2976
|
+
*
|
|
2977
|
+
* @summary Save the platform\'s dashboard
|
|
2978
|
+
* @param {DashboardApiSaveDashboardRequest} requestParameters Request parameters.
|
|
2979
|
+
* @param {*} [options] Override http request option.
|
|
2980
|
+
* @throws {RequiredError}
|
|
2981
|
+
* @memberof DashboardApi
|
|
2982
|
+
*/
|
|
2983
|
+
saveDashboard(requestParameters: DashboardApiSaveDashboardRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetDashboardResponse, any>>;
|
|
2984
|
+
}
|
|
2672
2985
|
/**
|
|
2673
2986
|
* EnquiriesApi - axios parameter creator
|
|
2674
2987
|
* @export
|
|
@@ -4154,6 +4467,390 @@ export declare class PaymentApi extends BaseAPI {
|
|
|
4154
4467
|
*/
|
|
4155
4468
|
getStripePaymentAccount(requestParameters: PaymentApiGetStripePaymentAccountRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentAccount, any>>;
|
|
4156
4469
|
}
|
|
4470
|
+
/**
|
|
4471
|
+
* PixelsApi - axios parameter creator
|
|
4472
|
+
* @export
|
|
4473
|
+
*/
|
|
4474
|
+
export declare const PixelsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
4475
|
+
/**
|
|
4476
|
+
*
|
|
4477
|
+
* @summary Create a pixel
|
|
4478
|
+
* @param {string} project Project unique identifier
|
|
4479
|
+
* @param {string} platformId The platform identifier
|
|
4480
|
+
* @param {number} [pageToken] Page reference token
|
|
4481
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
4482
|
+
* @param {string} [search] Search term to filter results
|
|
4483
|
+
* @param {CreatePixelRequest} [createPixelRequest]
|
|
4484
|
+
* @param {*} [options] Override http request option.
|
|
4485
|
+
* @throws {RequiredError}
|
|
4486
|
+
*/
|
|
4487
|
+
createPixel: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, createPixelRequest?: CreatePixelRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4488
|
+
/**
|
|
4489
|
+
* Delete a pixel
|
|
4490
|
+
* @summary Delete a pixel
|
|
4491
|
+
* @param {string} project Project unique identifier
|
|
4492
|
+
* @param {string} platformId The platform identifier
|
|
4493
|
+
* @param {string} pixelId The pixel identifier
|
|
4494
|
+
* @param {*} [options] Override http request option.
|
|
4495
|
+
* @throws {RequiredError}
|
|
4496
|
+
*/
|
|
4497
|
+
deletePixel: (project: string, platformId: string, pixelId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4498
|
+
/**
|
|
4499
|
+
* Get a pixel for a platform by a given pixel ID.
|
|
4500
|
+
* @summary Get pixel
|
|
4501
|
+
* @param {string} project Project unique identifier
|
|
4502
|
+
* @param {string} platformId The platform identifier
|
|
4503
|
+
* @param {string} pixelId The pixel identifier
|
|
4504
|
+
* @param {*} [options] Override http request option.
|
|
4505
|
+
* @throws {RequiredError}
|
|
4506
|
+
*/
|
|
4507
|
+
getPixel: (project: string, platformId: string, pixelId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4508
|
+
/**
|
|
4509
|
+
* List pixels for a platform
|
|
4510
|
+
* @summary List pixels
|
|
4511
|
+
* @param {string} project Project unique identifier
|
|
4512
|
+
* @param {string} platformId The platform identifier
|
|
4513
|
+
* @param {number} [pageToken] Page reference token
|
|
4514
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
4515
|
+
* @param {string} [search] Search term to filter results
|
|
4516
|
+
* @param {*} [options] Override http request option.
|
|
4517
|
+
* @throws {RequiredError}
|
|
4518
|
+
*/
|
|
4519
|
+
listPixels: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4520
|
+
/**
|
|
4521
|
+
* Update a pixel
|
|
4522
|
+
* @summary Update a pixel
|
|
4523
|
+
* @param {string} project Project unique identifier
|
|
4524
|
+
* @param {string} platformId The platform identifier
|
|
4525
|
+
* @param {string} pixelId The pixel identifier
|
|
4526
|
+
* @param {CreatePixelRequest} [createPixelRequest]
|
|
4527
|
+
* @param {*} [options] Override http request option.
|
|
4528
|
+
* @throws {RequiredError}
|
|
4529
|
+
*/
|
|
4530
|
+
updatePixel: (project: string, platformId: string, pixelId: string, createPixelRequest?: CreatePixelRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
4531
|
+
};
|
|
4532
|
+
/**
|
|
4533
|
+
* PixelsApi - functional programming interface
|
|
4534
|
+
* @export
|
|
4535
|
+
*/
|
|
4536
|
+
export declare const PixelsApiFp: (configuration?: Configuration) => {
|
|
4537
|
+
/**
|
|
4538
|
+
*
|
|
4539
|
+
* @summary Create a pixel
|
|
4540
|
+
* @param {string} project Project unique identifier
|
|
4541
|
+
* @param {string} platformId The platform identifier
|
|
4542
|
+
* @param {number} [pageToken] Page reference token
|
|
4543
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
4544
|
+
* @param {string} [search] Search term to filter results
|
|
4545
|
+
* @param {CreatePixelRequest} [createPixelRequest]
|
|
4546
|
+
* @param {*} [options] Override http request option.
|
|
4547
|
+
* @throws {RequiredError}
|
|
4548
|
+
*/
|
|
4549
|
+
createPixel(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, createPixelRequest?: CreatePixelRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Pixel>>;
|
|
4550
|
+
/**
|
|
4551
|
+
* Delete a pixel
|
|
4552
|
+
* @summary Delete a pixel
|
|
4553
|
+
* @param {string} project Project unique identifier
|
|
4554
|
+
* @param {string} platformId The platform identifier
|
|
4555
|
+
* @param {string} pixelId The pixel identifier
|
|
4556
|
+
* @param {*} [options] Override http request option.
|
|
4557
|
+
* @throws {RequiredError}
|
|
4558
|
+
*/
|
|
4559
|
+
deletePixel(project: string, platformId: string, pixelId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
4560
|
+
/**
|
|
4561
|
+
* Get a pixel for a platform by a given pixel ID.
|
|
4562
|
+
* @summary Get pixel
|
|
4563
|
+
* @param {string} project Project unique identifier
|
|
4564
|
+
* @param {string} platformId The platform identifier
|
|
4565
|
+
* @param {string} pixelId The pixel identifier
|
|
4566
|
+
* @param {*} [options] Override http request option.
|
|
4567
|
+
* @throws {RequiredError}
|
|
4568
|
+
*/
|
|
4569
|
+
getPixel(project: string, platformId: string, pixelId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Pixel>>;
|
|
4570
|
+
/**
|
|
4571
|
+
* List pixels for a platform
|
|
4572
|
+
* @summary List pixels
|
|
4573
|
+
* @param {string} project Project unique identifier
|
|
4574
|
+
* @param {string} platformId The platform identifier
|
|
4575
|
+
* @param {number} [pageToken] Page reference token
|
|
4576
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
4577
|
+
* @param {string} [search] Search term to filter results
|
|
4578
|
+
* @param {*} [options] Override http request option.
|
|
4579
|
+
* @throws {RequiredError}
|
|
4580
|
+
*/
|
|
4581
|
+
listPixels(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PixelsResponse>>;
|
|
4582
|
+
/**
|
|
4583
|
+
* Update a pixel
|
|
4584
|
+
* @summary Update a pixel
|
|
4585
|
+
* @param {string} project Project unique identifier
|
|
4586
|
+
* @param {string} platformId The platform identifier
|
|
4587
|
+
* @param {string} pixelId The pixel identifier
|
|
4588
|
+
* @param {CreatePixelRequest} [createPixelRequest]
|
|
4589
|
+
* @param {*} [options] Override http request option.
|
|
4590
|
+
* @throws {RequiredError}
|
|
4591
|
+
*/
|
|
4592
|
+
updatePixel(project: string, platformId: string, pixelId: string, createPixelRequest?: CreatePixelRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Pixel>>;
|
|
4593
|
+
};
|
|
4594
|
+
/**
|
|
4595
|
+
* PixelsApi - factory interface
|
|
4596
|
+
* @export
|
|
4597
|
+
*/
|
|
4598
|
+
export declare const PixelsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
4599
|
+
/**
|
|
4600
|
+
*
|
|
4601
|
+
* @summary Create a pixel
|
|
4602
|
+
* @param {PixelsApiCreatePixelRequest} requestParameters Request parameters.
|
|
4603
|
+
* @param {*} [options] Override http request option.
|
|
4604
|
+
* @throws {RequiredError}
|
|
4605
|
+
*/
|
|
4606
|
+
createPixel(requestParameters: PixelsApiCreatePixelRequest, options?: RawAxiosRequestConfig): AxiosPromise<Pixel>;
|
|
4607
|
+
/**
|
|
4608
|
+
* Delete a pixel
|
|
4609
|
+
* @summary Delete a pixel
|
|
4610
|
+
* @param {PixelsApiDeletePixelRequest} requestParameters Request parameters.
|
|
4611
|
+
* @param {*} [options] Override http request option.
|
|
4612
|
+
* @throws {RequiredError}
|
|
4613
|
+
*/
|
|
4614
|
+
deletePixel(requestParameters: PixelsApiDeletePixelRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
4615
|
+
/**
|
|
4616
|
+
* Get a pixel for a platform by a given pixel ID.
|
|
4617
|
+
* @summary Get pixel
|
|
4618
|
+
* @param {PixelsApiGetPixelRequest} requestParameters Request parameters.
|
|
4619
|
+
* @param {*} [options] Override http request option.
|
|
4620
|
+
* @throws {RequiredError}
|
|
4621
|
+
*/
|
|
4622
|
+
getPixel(requestParameters: PixelsApiGetPixelRequest, options?: RawAxiosRequestConfig): AxiosPromise<Pixel>;
|
|
4623
|
+
/**
|
|
4624
|
+
* List pixels for a platform
|
|
4625
|
+
* @summary List pixels
|
|
4626
|
+
* @param {PixelsApiListPixelsRequest} requestParameters Request parameters.
|
|
4627
|
+
* @param {*} [options] Override http request option.
|
|
4628
|
+
* @throws {RequiredError}
|
|
4629
|
+
*/
|
|
4630
|
+
listPixels(requestParameters: PixelsApiListPixelsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PixelsResponse>;
|
|
4631
|
+
/**
|
|
4632
|
+
* Update a pixel
|
|
4633
|
+
* @summary Update a pixel
|
|
4634
|
+
* @param {PixelsApiUpdatePixelRequest} requestParameters Request parameters.
|
|
4635
|
+
* @param {*} [options] Override http request option.
|
|
4636
|
+
* @throws {RequiredError}
|
|
4637
|
+
*/
|
|
4638
|
+
updatePixel(requestParameters: PixelsApiUpdatePixelRequest, options?: RawAxiosRequestConfig): AxiosPromise<Pixel>;
|
|
4639
|
+
};
|
|
4640
|
+
/**
|
|
4641
|
+
* Request parameters for createPixel operation in PixelsApi.
|
|
4642
|
+
* @export
|
|
4643
|
+
* @interface PixelsApiCreatePixelRequest
|
|
4644
|
+
*/
|
|
4645
|
+
export interface PixelsApiCreatePixelRequest {
|
|
4646
|
+
/**
|
|
4647
|
+
* Project unique identifier
|
|
4648
|
+
* @type {string}
|
|
4649
|
+
* @memberof PixelsApiCreatePixel
|
|
4650
|
+
*/
|
|
4651
|
+
readonly project: string;
|
|
4652
|
+
/**
|
|
4653
|
+
* The platform identifier
|
|
4654
|
+
* @type {string}
|
|
4655
|
+
* @memberof PixelsApiCreatePixel
|
|
4656
|
+
*/
|
|
4657
|
+
readonly platformId: string;
|
|
4658
|
+
/**
|
|
4659
|
+
* Page reference token
|
|
4660
|
+
* @type {number}
|
|
4661
|
+
* @memberof PixelsApiCreatePixel
|
|
4662
|
+
*/
|
|
4663
|
+
readonly pageToken?: number;
|
|
4664
|
+
/**
|
|
4665
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
4666
|
+
* @type {number}
|
|
4667
|
+
* @memberof PixelsApiCreatePixel
|
|
4668
|
+
*/
|
|
4669
|
+
readonly pageSize?: number;
|
|
4670
|
+
/**
|
|
4671
|
+
* Search term to filter results
|
|
4672
|
+
* @type {string}
|
|
4673
|
+
* @memberof PixelsApiCreatePixel
|
|
4674
|
+
*/
|
|
4675
|
+
readonly search?: string;
|
|
4676
|
+
/**
|
|
4677
|
+
*
|
|
4678
|
+
* @type {CreatePixelRequest}
|
|
4679
|
+
* @memberof PixelsApiCreatePixel
|
|
4680
|
+
*/
|
|
4681
|
+
readonly createPixelRequest?: CreatePixelRequest;
|
|
4682
|
+
}
|
|
4683
|
+
/**
|
|
4684
|
+
* Request parameters for deletePixel operation in PixelsApi.
|
|
4685
|
+
* @export
|
|
4686
|
+
* @interface PixelsApiDeletePixelRequest
|
|
4687
|
+
*/
|
|
4688
|
+
export interface PixelsApiDeletePixelRequest {
|
|
4689
|
+
/**
|
|
4690
|
+
* Project unique identifier
|
|
4691
|
+
* @type {string}
|
|
4692
|
+
* @memberof PixelsApiDeletePixel
|
|
4693
|
+
*/
|
|
4694
|
+
readonly project: string;
|
|
4695
|
+
/**
|
|
4696
|
+
* The platform identifier
|
|
4697
|
+
* @type {string}
|
|
4698
|
+
* @memberof PixelsApiDeletePixel
|
|
4699
|
+
*/
|
|
4700
|
+
readonly platformId: string;
|
|
4701
|
+
/**
|
|
4702
|
+
* The pixel identifier
|
|
4703
|
+
* @type {string}
|
|
4704
|
+
* @memberof PixelsApiDeletePixel
|
|
4705
|
+
*/
|
|
4706
|
+
readonly pixelId: string;
|
|
4707
|
+
}
|
|
4708
|
+
/**
|
|
4709
|
+
* Request parameters for getPixel operation in PixelsApi.
|
|
4710
|
+
* @export
|
|
4711
|
+
* @interface PixelsApiGetPixelRequest
|
|
4712
|
+
*/
|
|
4713
|
+
export interface PixelsApiGetPixelRequest {
|
|
4714
|
+
/**
|
|
4715
|
+
* Project unique identifier
|
|
4716
|
+
* @type {string}
|
|
4717
|
+
* @memberof PixelsApiGetPixel
|
|
4718
|
+
*/
|
|
4719
|
+
readonly project: string;
|
|
4720
|
+
/**
|
|
4721
|
+
* The platform identifier
|
|
4722
|
+
* @type {string}
|
|
4723
|
+
* @memberof PixelsApiGetPixel
|
|
4724
|
+
*/
|
|
4725
|
+
readonly platformId: string;
|
|
4726
|
+
/**
|
|
4727
|
+
* The pixel identifier
|
|
4728
|
+
* @type {string}
|
|
4729
|
+
* @memberof PixelsApiGetPixel
|
|
4730
|
+
*/
|
|
4731
|
+
readonly pixelId: string;
|
|
4732
|
+
}
|
|
4733
|
+
/**
|
|
4734
|
+
* Request parameters for listPixels operation in PixelsApi.
|
|
4735
|
+
* @export
|
|
4736
|
+
* @interface PixelsApiListPixelsRequest
|
|
4737
|
+
*/
|
|
4738
|
+
export interface PixelsApiListPixelsRequest {
|
|
4739
|
+
/**
|
|
4740
|
+
* Project unique identifier
|
|
4741
|
+
* @type {string}
|
|
4742
|
+
* @memberof PixelsApiListPixels
|
|
4743
|
+
*/
|
|
4744
|
+
readonly project: string;
|
|
4745
|
+
/**
|
|
4746
|
+
* The platform identifier
|
|
4747
|
+
* @type {string}
|
|
4748
|
+
* @memberof PixelsApiListPixels
|
|
4749
|
+
*/
|
|
4750
|
+
readonly platformId: string;
|
|
4751
|
+
/**
|
|
4752
|
+
* Page reference token
|
|
4753
|
+
* @type {number}
|
|
4754
|
+
* @memberof PixelsApiListPixels
|
|
4755
|
+
*/
|
|
4756
|
+
readonly pageToken?: number;
|
|
4757
|
+
/**
|
|
4758
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
4759
|
+
* @type {number}
|
|
4760
|
+
* @memberof PixelsApiListPixels
|
|
4761
|
+
*/
|
|
4762
|
+
readonly pageSize?: number;
|
|
4763
|
+
/**
|
|
4764
|
+
* Search term to filter results
|
|
4765
|
+
* @type {string}
|
|
4766
|
+
* @memberof PixelsApiListPixels
|
|
4767
|
+
*/
|
|
4768
|
+
readonly search?: string;
|
|
4769
|
+
}
|
|
4770
|
+
/**
|
|
4771
|
+
* Request parameters for updatePixel operation in PixelsApi.
|
|
4772
|
+
* @export
|
|
4773
|
+
* @interface PixelsApiUpdatePixelRequest
|
|
4774
|
+
*/
|
|
4775
|
+
export interface PixelsApiUpdatePixelRequest {
|
|
4776
|
+
/**
|
|
4777
|
+
* Project unique identifier
|
|
4778
|
+
* @type {string}
|
|
4779
|
+
* @memberof PixelsApiUpdatePixel
|
|
4780
|
+
*/
|
|
4781
|
+
readonly project: string;
|
|
4782
|
+
/**
|
|
4783
|
+
* The platform identifier
|
|
4784
|
+
* @type {string}
|
|
4785
|
+
* @memberof PixelsApiUpdatePixel
|
|
4786
|
+
*/
|
|
4787
|
+
readonly platformId: string;
|
|
4788
|
+
/**
|
|
4789
|
+
* The pixel identifier
|
|
4790
|
+
* @type {string}
|
|
4791
|
+
* @memberof PixelsApiUpdatePixel
|
|
4792
|
+
*/
|
|
4793
|
+
readonly pixelId: string;
|
|
4794
|
+
/**
|
|
4795
|
+
*
|
|
4796
|
+
* @type {CreatePixelRequest}
|
|
4797
|
+
* @memberof PixelsApiUpdatePixel
|
|
4798
|
+
*/
|
|
4799
|
+
readonly createPixelRequest?: CreatePixelRequest;
|
|
4800
|
+
}
|
|
4801
|
+
/**
|
|
4802
|
+
* PixelsApi - object-oriented interface
|
|
4803
|
+
* @export
|
|
4804
|
+
* @class PixelsApi
|
|
4805
|
+
* @extends {BaseAPI}
|
|
4806
|
+
*/
|
|
4807
|
+
export declare class PixelsApi extends BaseAPI {
|
|
4808
|
+
/**
|
|
4809
|
+
*
|
|
4810
|
+
* @summary Create a pixel
|
|
4811
|
+
* @param {PixelsApiCreatePixelRequest} requestParameters Request parameters.
|
|
4812
|
+
* @param {*} [options] Override http request option.
|
|
4813
|
+
* @throws {RequiredError}
|
|
4814
|
+
* @memberof PixelsApi
|
|
4815
|
+
*/
|
|
4816
|
+
createPixel(requestParameters: PixelsApiCreatePixelRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Pixel, any>>;
|
|
4817
|
+
/**
|
|
4818
|
+
* Delete a pixel
|
|
4819
|
+
* @summary Delete a pixel
|
|
4820
|
+
* @param {PixelsApiDeletePixelRequest} requestParameters Request parameters.
|
|
4821
|
+
* @param {*} [options] Override http request option.
|
|
4822
|
+
* @throws {RequiredError}
|
|
4823
|
+
* @memberof PixelsApi
|
|
4824
|
+
*/
|
|
4825
|
+
deletePixel(requestParameters: PixelsApiDeletePixelRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
4826
|
+
/**
|
|
4827
|
+
* Get a pixel for a platform by a given pixel ID.
|
|
4828
|
+
* @summary Get pixel
|
|
4829
|
+
* @param {PixelsApiGetPixelRequest} requestParameters Request parameters.
|
|
4830
|
+
* @param {*} [options] Override http request option.
|
|
4831
|
+
* @throws {RequiredError}
|
|
4832
|
+
* @memberof PixelsApi
|
|
4833
|
+
*/
|
|
4834
|
+
getPixel(requestParameters: PixelsApiGetPixelRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Pixel, any>>;
|
|
4835
|
+
/**
|
|
4836
|
+
* List pixels for a platform
|
|
4837
|
+
* @summary List pixels
|
|
4838
|
+
* @param {PixelsApiListPixelsRequest} requestParameters Request parameters.
|
|
4839
|
+
* @param {*} [options] Override http request option.
|
|
4840
|
+
* @throws {RequiredError}
|
|
4841
|
+
* @memberof PixelsApi
|
|
4842
|
+
*/
|
|
4843
|
+
listPixels(requestParameters: PixelsApiListPixelsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PixelsResponse, any>>;
|
|
4844
|
+
/**
|
|
4845
|
+
* Update a pixel
|
|
4846
|
+
* @summary Update a pixel
|
|
4847
|
+
* @param {PixelsApiUpdatePixelRequest} requestParameters Request parameters.
|
|
4848
|
+
* @param {*} [options] Override http request option.
|
|
4849
|
+
* @throws {RequiredError}
|
|
4850
|
+
* @memberof PixelsApi
|
|
4851
|
+
*/
|
|
4852
|
+
updatePixel(requestParameters: PixelsApiUpdatePixelRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Pixel, any>>;
|
|
4853
|
+
}
|
|
4157
4854
|
/**
|
|
4158
4855
|
* PlatformApi - axios parameter creator
|
|
4159
4856
|
* @export
|