@defoai/ads-client 1.4.0 → 1.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (129) hide show
  1. package/dist/index.cjs +2914 -0
  2. package/dist/index.cjs.map +1 -0
  3. package/dist/index.d.cts +2226 -0
  4. package/dist/index.d.ts +2061 -12
  5. package/dist/index.js +2892 -198
  6. package/dist/index.js.map +1 -0
  7. package/package.json +10 -7
  8. package/dist/generated/apis/AdAssetsApi.d.ts +0 -140
  9. package/dist/generated/apis/AdAssetsApi.js +0 -173
  10. package/dist/generated/apis/AdGroupsApi.d.ts +0 -165
  11. package/dist/generated/apis/AdGroupsApi.js +0 -205
  12. package/dist/generated/apis/AdsApi.d.ts +0 -160
  13. package/dist/generated/apis/AdsApi.js +0 -200
  14. package/dist/generated/apis/AssetsApi.d.ts +0 -162
  15. package/dist/generated/apis/AssetsApi.js +0 -203
  16. package/dist/generated/apis/CampaignAssetsApi.d.ts +0 -136
  17. package/dist/generated/apis/CampaignAssetsApi.js +0 -167
  18. package/dist/generated/apis/CampaignsApi.d.ts +0 -169
  19. package/dist/generated/apis/CampaignsApi.js +0 -206
  20. package/dist/generated/apis/KeywordsApi.d.ts +0 -160
  21. package/dist/generated/apis/KeywordsApi.js +0 -200
  22. package/dist/generated/apis/MediaApi.d.ts +0 -50
  23. package/dist/generated/apis/MediaApi.js +0 -51
  24. package/dist/generated/apis/MetaApi.d.ts +0 -86
  25. package/dist/generated/apis/MetaApi.js +0 -104
  26. package/dist/generated/apis/ReportsApi.d.ts +0 -50
  27. package/dist/generated/apis/ReportsApi.js +0 -51
  28. package/dist/generated/apis/SitesApi.d.ts +0 -163
  29. package/dist/generated/apis/SitesApi.js +0 -202
  30. package/dist/generated/apis/SyncApi.d.ts +0 -199
  31. package/dist/generated/apis/SyncApi.js +0 -241
  32. package/dist/generated/apis/index.d.ts +0 -12
  33. package/dist/generated/apis/index.js +0 -14
  34. package/dist/generated/index.d.ts +0 -3
  35. package/dist/generated/index.js +0 -5
  36. package/dist/generated/models/AdAssetCreate.d.ts +0 -83
  37. package/dist/generated/models/AdAssetCreate.js +0 -76
  38. package/dist/generated/models/AdCreate.d.ts +0 -147
  39. package/dist/generated/models/AdCreate.js +0 -97
  40. package/dist/generated/models/AdGroupAudience.d.ts +0 -44
  41. package/dist/generated/models/AdGroupAudience.js +0 -49
  42. package/dist/generated/models/AdGroupCreate.d.ts +0 -104
  43. package/dist/generated/models/AdGroupCreate.js +0 -74
  44. package/dist/generated/models/AdGroupUpdate.d.ts +0 -104
  45. package/dist/generated/models/AdGroupUpdate.js +0 -70
  46. package/dist/generated/models/AdUpdate.d.ts +0 -147
  47. package/dist/generated/models/AdUpdate.js +0 -85
  48. package/dist/generated/models/AssetCreate.d.ts +0 -117
  49. package/dist/generated/models/AssetCreate.js +0 -80
  50. package/dist/generated/models/AssetUpdate.d.ts +0 -79
  51. package/dist/generated/models/AssetUpdate.js +0 -61
  52. package/dist/generated/models/BiddingStrategy.d.ts +0 -70
  53. package/dist/generated/models/BiddingStrategy.js +0 -62
  54. package/dist/generated/models/CampaignAdScheduleField.d.ts +0 -12
  55. package/dist/generated/models/CampaignAdScheduleField.js +0 -4
  56. package/dist/generated/models/CampaignAssetCreate.d.ts +0 -57
  57. package/dist/generated/models/CampaignAssetCreate.js +0 -63
  58. package/dist/generated/models/CampaignCreate.d.ts +0 -161
  59. package/dist/generated/models/CampaignCreate.js +0 -102
  60. package/dist/generated/models/CampaignTargeting.d.ts +0 -50
  61. package/dist/generated/models/CampaignTargeting.js +0 -47
  62. package/dist/generated/models/CampaignUpdate.d.ts +0 -161
  63. package/dist/generated/models/CampaignUpdate.js +0 -98
  64. package/dist/generated/models/CampaignsListCursorParameter.d.ts +0 -26
  65. package/dist/generated/models/CampaignsListCursorParameter.js +0 -31
  66. package/dist/generated/models/ErrorEnvelope.d.ts +0 -33
  67. package/dist/generated/models/ErrorEnvelope.js +0 -44
  68. package/dist/generated/models/ErrorEnvelopeError.d.ts +0 -44
  69. package/dist/generated/models/ErrorEnvelopeError.js +0 -49
  70. package/dist/generated/models/KeywordCreate.d.ts +0 -86
  71. package/dist/generated/models/KeywordCreate.js +0 -73
  72. package/dist/generated/models/KeywordUpdate.d.ts +0 -86
  73. package/dist/generated/models/KeywordUpdate.js +0 -69
  74. package/dist/generated/models/Location.d.ts +0 -61
  75. package/dist/generated/models/Location.js +0 -61
  76. package/dist/generated/models/NegativeKeywordEntry.d.ts +0 -47
  77. package/dist/generated/models/NegativeKeywordEntry.js +0 -55
  78. package/dist/generated/models/ScheduleWindow.d.ts +0 -95
  79. package/dist/generated/models/ScheduleWindow.js +0 -87
  80. package/dist/generated/models/SiteCreate.d.ts +0 -99
  81. package/dist/generated/models/SiteCreate.js +0 -78
  82. package/dist/generated/models/SiteCreateSeoKeywords.d.ts +0 -11
  83. package/dist/generated/models/SiteCreateSeoKeywords.js +0 -12
  84. package/dist/generated/models/SiteCreateTargetGroups.d.ts +0 -11
  85. package/dist/generated/models/SiteCreateTargetGroups.js +0 -12
  86. package/dist/generated/models/SiteLinkEntry.d.ts +0 -50
  87. package/dist/generated/models/SiteLinkEntry.js +0 -47
  88. package/dist/generated/models/SiteUpdate.d.ts +0 -99
  89. package/dist/generated/models/SiteUpdate.js +0 -74
  90. package/dist/generated/models/Sitelink.d.ts +0 -64
  91. package/dist/generated/models/Sitelink.js +0 -51
  92. package/dist/generated/models/StructuredSchedule.d.ts +0 -39
  93. package/dist/generated/models/StructuredSchedule.js +0 -46
  94. package/dist/generated/models/StructuredSnippet.d.ts +0 -38
  95. package/dist/generated/models/StructuredSnippet.js +0 -47
  96. package/dist/generated/models/SuccessEnvelope.d.ts +0 -39
  97. package/dist/generated/models/SuccessEnvelope.js +0 -46
  98. package/dist/generated/models/SuccessEnvelopeMeta.d.ts +0 -39
  99. package/dist/generated/models/SuccessEnvelopeMeta.js +0 -44
  100. package/dist/generated/models/SuccessEnvelopeMetaNextCursor.d.ts +0 -26
  101. package/dist/generated/models/SuccessEnvelopeMetaNextCursor.js +0 -31
  102. package/dist/generated/models/SyncCampaignDetail.d.ts +0 -88
  103. package/dist/generated/models/SyncCampaignDetail.js +0 -71
  104. package/dist/generated/models/SyncPlan.d.ts +0 -35
  105. package/dist/generated/models/SyncPlan.js +0 -43
  106. package/dist/generated/models/SyncPlanPlatformsValue.d.ts +0 -33
  107. package/dist/generated/models/SyncPlanPlatformsValue.js +0 -42
  108. package/dist/generated/models/SyncPlanPlatformsValueTotals.d.ts +0 -44
  109. package/dist/generated/models/SyncPlanPlatformsValueTotals.js +0 -45
  110. package/dist/generated/models/SyncProgress.d.ts +0 -57
  111. package/dist/generated/models/SyncProgress.js +0 -50
  112. package/dist/generated/models/SyncRecord.d.ts +0 -103
  113. package/dist/generated/models/SyncRecord.js +0 -73
  114. package/dist/generated/models/SyncRecordErrorsInner.d.ts +0 -38
  115. package/dist/generated/models/SyncRecordErrorsInner.js +0 -43
  116. package/dist/generated/models/SyncTotals.d.ts +0 -68
  117. package/dist/generated/models/SyncTotals.js +0 -53
  118. package/dist/generated/models/SyncTriggerRequest.d.ts +0 -39
  119. package/dist/generated/models/SyncTriggerRequest.js +0 -44
  120. package/dist/generated/models/SyncTriggerRequestOptions.d.ts +0 -56
  121. package/dist/generated/models/SyncTriggerRequestOptions.js +0 -49
  122. package/dist/generated/models/SyncTriggerResponse.d.ts +0 -59
  123. package/dist/generated/models/SyncTriggerResponse.js +0 -55
  124. package/dist/generated/models/SyncUnlinkRequest.d.ts +0 -44
  125. package/dist/generated/models/SyncUnlinkRequest.js +0 -47
  126. package/dist/generated/models/index.d.ts +0 -45
  127. package/dist/generated/models/index.js +0 -47
  128. package/dist/generated/runtime.d.ts +0 -182
  129. package/dist/generated/runtime.js +0 -318
@@ -1,162 +0,0 @@
1
- /**
2
- * Defo Ads Public API
3
- * Stable public API for managing campaigns, ads, keywords, and sites.
4
- *
5
- * The version of the OpenAPI document: 1.4.0
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import * as runtime from '../runtime';
13
- import type { AssetCreate, AssetUpdate, CampaignsListCursorParameter, SuccessEnvelope } from '../models/index';
14
- export interface AssetsCreateRequest {
15
- assetCreate: AssetCreate;
16
- xSpaceId?: string;
17
- }
18
- export interface AssetsDeleteRequest {
19
- id: string;
20
- xSpaceId?: string;
21
- }
22
- export interface AssetsGetRequest {
23
- id: string;
24
- xSpaceId?: string;
25
- }
26
- export interface AssetsListRequest {
27
- limit?: number;
28
- cursor?: CampaignsListCursorParameter;
29
- type?: string;
30
- xSpaceId?: string;
31
- }
32
- export interface AssetsUpdateRequest {
33
- id: string;
34
- assetUpdate: AssetUpdate;
35
- xSpaceId?: string;
36
- }
37
- /**
38
- * AssetsApi - interface
39
- *
40
- * @export
41
- * @interface AssetsApiInterface
42
- */
43
- export interface AssetsApiInterface {
44
- /**
45
- *
46
- * @summary Create asset (URL-by-reference)
47
- * @param {AssetCreate} assetCreate
48
- * @param {string} [xSpaceId] Target Space ID (e.g. `spc_…`). Omit to use the caller\'s Personal Space. Invalid Space → 404 SPACE_NOT_FOUND; non-member → 403 NOT_A_MEMBER.
49
- * @param {*} [options] Override http request option.
50
- * @throws {RequiredError}
51
- * @memberof AssetsApiInterface
52
- */
53
- assetsCreateRaw(requestParameters: AssetsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
54
- /**
55
- * Create asset (URL-by-reference)
56
- */
57
- assetsCreate(requestParameters: AssetsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
58
- /**
59
- *
60
- * @summary Delete asset
61
- * @param {string} id
62
- * @param {string} [xSpaceId] Target Space ID (e.g. &#x60;spc_…&#x60;). Omit to use the caller\&#39;s Personal Space. Invalid Space → 404 SPACE_NOT_FOUND; non-member → 403 NOT_A_MEMBER.
63
- * @param {*} [options] Override http request option.
64
- * @throws {RequiredError}
65
- * @memberof AssetsApiInterface
66
- */
67
- assetsDeleteRaw(requestParameters: AssetsDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
68
- /**
69
- * Delete asset
70
- */
71
- assetsDelete(requestParameters: AssetsDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
72
- /**
73
- *
74
- * @summary Get asset
75
- * @param {string} id
76
- * @param {string} [xSpaceId] Target Space ID (e.g. &#x60;spc_…&#x60;). Omit to use the caller\&#39;s Personal Space. Invalid Space → 404 SPACE_NOT_FOUND; non-member → 403 NOT_A_MEMBER.
77
- * @param {*} [options] Override http request option.
78
- * @throws {RequiredError}
79
- * @memberof AssetsApiInterface
80
- */
81
- assetsGetRaw(requestParameters: AssetsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
82
- /**
83
- * Get asset
84
- */
85
- assetsGet(requestParameters: AssetsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
86
- /**
87
- *
88
- * @summary List assets
89
- * @param {number} [limit] Maximum items to return. Default 50, max 200.
90
- * @param {CampaignsListCursorParameter} [cursor] Opaque pagination cursor returned by the previous page in &#x60;meta.nextCursor&#x60;.
91
- * @param {string} [type] Filter by asset type (e.g. IMAGE, LOGO, VIDEO).
92
- * @param {string} [xSpaceId] Target Space ID (e.g. &#x60;spc_…&#x60;). Omit to use the caller\&#39;s Personal Space. Invalid Space → 404 SPACE_NOT_FOUND; non-member → 403 NOT_A_MEMBER.
93
- * @param {*} [options] Override http request option.
94
- * @throws {RequiredError}
95
- * @memberof AssetsApiInterface
96
- */
97
- assetsListRaw(requestParameters: AssetsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
98
- /**
99
- * List assets
100
- */
101
- assetsList(requestParameters: AssetsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
102
- /**
103
- *
104
- * @summary Update asset (partial: name, altText, tags, metadata, status, width, height)
105
- * @param {string} id
106
- * @param {AssetUpdate} assetUpdate
107
- * @param {string} [xSpaceId] Target Space ID (e.g. &#x60;spc_…&#x60;). Omit to use the caller\&#39;s Personal Space. Invalid Space → 404 SPACE_NOT_FOUND; non-member → 403 NOT_A_MEMBER.
108
- * @param {*} [options] Override http request option.
109
- * @throws {RequiredError}
110
- * @memberof AssetsApiInterface
111
- */
112
- assetsUpdateRaw(requestParameters: AssetsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
113
- /**
114
- * Update asset (partial: name, altText, tags, metadata, status, width, height)
115
- */
116
- assetsUpdate(requestParameters: AssetsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
117
- }
118
- /**
119
- *
120
- */
121
- export declare class AssetsApi extends runtime.BaseAPI implements AssetsApiInterface {
122
- /**
123
- * Create asset (URL-by-reference)
124
- */
125
- assetsCreateRaw(requestParameters: AssetsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
126
- /**
127
- * Create asset (URL-by-reference)
128
- */
129
- assetsCreate(requestParameters: AssetsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
130
- /**
131
- * Delete asset
132
- */
133
- assetsDeleteRaw(requestParameters: AssetsDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
134
- /**
135
- * Delete asset
136
- */
137
- assetsDelete(requestParameters: AssetsDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
138
- /**
139
- * Get asset
140
- */
141
- assetsGetRaw(requestParameters: AssetsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
142
- /**
143
- * Get asset
144
- */
145
- assetsGet(requestParameters: AssetsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
146
- /**
147
- * List assets
148
- */
149
- assetsListRaw(requestParameters: AssetsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
150
- /**
151
- * List assets
152
- */
153
- assetsList(requestParameters?: AssetsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
154
- /**
155
- * Update asset (partial: name, altText, tags, metadata, status, width, height)
156
- */
157
- assetsUpdateRaw(requestParameters: AssetsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
158
- /**
159
- * Update asset (partial: name, altText, tags, metadata, status, width, height)
160
- */
161
- assetsUpdate(requestParameters: AssetsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
162
- }
@@ -1,203 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * Defo Ads Public API
5
- * Stable public API for managing campaigns, ads, keywords, and sites.
6
- *
7
- * The version of the OpenAPI document: 1.4.0
8
- *
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- import * as runtime from '../runtime';
15
- import { AssetCreateToJSON, AssetUpdateToJSON, SuccessEnvelopeFromJSON, } from '../models/index';
16
- /**
17
- *
18
- */
19
- export class AssetsApi extends runtime.BaseAPI {
20
- /**
21
- * Create asset (URL-by-reference)
22
- */
23
- async assetsCreateRaw(requestParameters, initOverrides) {
24
- if (requestParameters['assetCreate'] == null) {
25
- throw new runtime.RequiredError('assetCreate', 'Required parameter "assetCreate" was null or undefined when calling assetsCreate().');
26
- }
27
- const queryParameters = {};
28
- const headerParameters = {};
29
- headerParameters['Content-Type'] = 'application/json';
30
- if (requestParameters['xSpaceId'] != null) {
31
- headerParameters['X-Space-Id'] = String(requestParameters['xSpaceId']);
32
- }
33
- if (this.configuration && this.configuration.accessToken) {
34
- const token = this.configuration.accessToken;
35
- const tokenString = await token("ApiToken", ["assets:write"]);
36
- if (tokenString) {
37
- headerParameters["Authorization"] = `Bearer ${tokenString}`;
38
- }
39
- }
40
- const response = await this.request({
41
- path: `/api/v1/assets`,
42
- method: 'POST',
43
- headers: headerParameters,
44
- query: queryParameters,
45
- body: AssetCreateToJSON(requestParameters['assetCreate']),
46
- }, initOverrides);
47
- return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
48
- }
49
- /**
50
- * Create asset (URL-by-reference)
51
- */
52
- async assetsCreate(requestParameters, initOverrides) {
53
- const response = await this.assetsCreateRaw(requestParameters, initOverrides);
54
- return await response.value();
55
- }
56
- /**
57
- * Delete asset
58
- */
59
- async assetsDeleteRaw(requestParameters, initOverrides) {
60
- if (requestParameters['id'] == null) {
61
- throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling assetsDelete().');
62
- }
63
- const queryParameters = {};
64
- const headerParameters = {};
65
- if (requestParameters['xSpaceId'] != null) {
66
- headerParameters['X-Space-Id'] = String(requestParameters['xSpaceId']);
67
- }
68
- if (this.configuration && this.configuration.accessToken) {
69
- const token = this.configuration.accessToken;
70
- const tokenString = await token("ApiToken", ["assets:write"]);
71
- if (tokenString) {
72
- headerParameters["Authorization"] = `Bearer ${tokenString}`;
73
- }
74
- }
75
- const response = await this.request({
76
- path: `/api/v1/assets/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
77
- method: 'DELETE',
78
- headers: headerParameters,
79
- query: queryParameters,
80
- }, initOverrides);
81
- return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
82
- }
83
- /**
84
- * Delete asset
85
- */
86
- async assetsDelete(requestParameters, initOverrides) {
87
- const response = await this.assetsDeleteRaw(requestParameters, initOverrides);
88
- return await response.value();
89
- }
90
- /**
91
- * Get asset
92
- */
93
- async assetsGetRaw(requestParameters, initOverrides) {
94
- if (requestParameters['id'] == null) {
95
- throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling assetsGet().');
96
- }
97
- const queryParameters = {};
98
- const headerParameters = {};
99
- if (requestParameters['xSpaceId'] != null) {
100
- headerParameters['X-Space-Id'] = String(requestParameters['xSpaceId']);
101
- }
102
- if (this.configuration && this.configuration.accessToken) {
103
- const token = this.configuration.accessToken;
104
- const tokenString = await token("ApiToken", ["assets:read"]);
105
- if (tokenString) {
106
- headerParameters["Authorization"] = `Bearer ${tokenString}`;
107
- }
108
- }
109
- const response = await this.request({
110
- path: `/api/v1/assets/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
111
- method: 'GET',
112
- headers: headerParameters,
113
- query: queryParameters,
114
- }, initOverrides);
115
- return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
116
- }
117
- /**
118
- * Get asset
119
- */
120
- async assetsGet(requestParameters, initOverrides) {
121
- const response = await this.assetsGetRaw(requestParameters, initOverrides);
122
- return await response.value();
123
- }
124
- /**
125
- * List assets
126
- */
127
- async assetsListRaw(requestParameters, initOverrides) {
128
- const queryParameters = {};
129
- if (requestParameters['limit'] != null) {
130
- queryParameters['limit'] = requestParameters['limit'];
131
- }
132
- if (requestParameters['cursor'] != null) {
133
- queryParameters['cursor'] = requestParameters['cursor'];
134
- }
135
- if (requestParameters['type'] != null) {
136
- queryParameters['type'] = requestParameters['type'];
137
- }
138
- const headerParameters = {};
139
- if (requestParameters['xSpaceId'] != null) {
140
- headerParameters['X-Space-Id'] = String(requestParameters['xSpaceId']);
141
- }
142
- if (this.configuration && this.configuration.accessToken) {
143
- const token = this.configuration.accessToken;
144
- const tokenString = await token("ApiToken", ["assets:read"]);
145
- if (tokenString) {
146
- headerParameters["Authorization"] = `Bearer ${tokenString}`;
147
- }
148
- }
149
- const response = await this.request({
150
- path: `/api/v1/assets`,
151
- method: 'GET',
152
- headers: headerParameters,
153
- query: queryParameters,
154
- }, initOverrides);
155
- return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
156
- }
157
- /**
158
- * List assets
159
- */
160
- async assetsList(requestParameters = {}, initOverrides) {
161
- const response = await this.assetsListRaw(requestParameters, initOverrides);
162
- return await response.value();
163
- }
164
- /**
165
- * Update asset (partial: name, altText, tags, metadata, status, width, height)
166
- */
167
- async assetsUpdateRaw(requestParameters, initOverrides) {
168
- if (requestParameters['id'] == null) {
169
- throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling assetsUpdate().');
170
- }
171
- if (requestParameters['assetUpdate'] == null) {
172
- throw new runtime.RequiredError('assetUpdate', 'Required parameter "assetUpdate" was null or undefined when calling assetsUpdate().');
173
- }
174
- const queryParameters = {};
175
- const headerParameters = {};
176
- headerParameters['Content-Type'] = 'application/json';
177
- if (requestParameters['xSpaceId'] != null) {
178
- headerParameters['X-Space-Id'] = String(requestParameters['xSpaceId']);
179
- }
180
- if (this.configuration && this.configuration.accessToken) {
181
- const token = this.configuration.accessToken;
182
- const tokenString = await token("ApiToken", ["assets:write"]);
183
- if (tokenString) {
184
- headerParameters["Authorization"] = `Bearer ${tokenString}`;
185
- }
186
- }
187
- const response = await this.request({
188
- path: `/api/v1/assets/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
189
- method: 'PUT',
190
- headers: headerParameters,
191
- query: queryParameters,
192
- body: AssetUpdateToJSON(requestParameters['assetUpdate']),
193
- }, initOverrides);
194
- return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
195
- }
196
- /**
197
- * Update asset (partial: name, altText, tags, metadata, status, width, height)
198
- */
199
- async assetsUpdate(requestParameters, initOverrides) {
200
- const response = await this.assetsUpdateRaw(requestParameters, initOverrides);
201
- return await response.value();
202
- }
203
- }
@@ -1,136 +0,0 @@
1
- /**
2
- * Defo Ads Public API
3
- * Stable public API for managing campaigns, ads, keywords, and sites.
4
- *
5
- * The version of the OpenAPI document: 1.4.0
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import * as runtime from '../runtime';
13
- import type { CampaignAssetCreate, CampaignsListCursorParameter, SuccessEnvelope } from '../models/index';
14
- export interface CampaignAssetsCreateRequest {
15
- campaignAssetCreate: CampaignAssetCreate;
16
- xSpaceId?: string;
17
- }
18
- export interface CampaignAssetsDeleteRequest {
19
- id: string;
20
- xSpaceId?: string;
21
- }
22
- export interface CampaignAssetsGetRequest {
23
- id: string;
24
- xSpaceId?: string;
25
- }
26
- export interface CampaignAssetsListRequest {
27
- limit?: number;
28
- cursor?: CampaignsListCursorParameter;
29
- campaignId?: string;
30
- assetId?: string;
31
- xSpaceId?: string;
32
- }
33
- /**
34
- * CampaignAssetsApi - interface
35
- *
36
- * @export
37
- * @interface CampaignAssetsApiInterface
38
- */
39
- export interface CampaignAssetsApiInterface {
40
- /**
41
- *
42
- * @summary Bind an asset to a campaign with a role
43
- * @param {CampaignAssetCreate} campaignAssetCreate
44
- * @param {string} [xSpaceId] Target Space ID (e.g. &#x60;spc_…&#x60;). Omit to use the caller\&#39;s Personal Space. Invalid Space → 404 SPACE_NOT_FOUND; non-member → 403 NOT_A_MEMBER.
45
- * @param {*} [options] Override http request option.
46
- * @throws {RequiredError}
47
- * @memberof CampaignAssetsApiInterface
48
- */
49
- campaignAssetsCreateRaw(requestParameters: CampaignAssetsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
50
- /**
51
- * Bind an asset to a campaign with a role
52
- */
53
- campaignAssetsCreate(requestParameters: CampaignAssetsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
54
- /**
55
- *
56
- * @summary Remove a campaign-asset binding
57
- * @param {string} id
58
- * @param {string} [xSpaceId] Target Space ID (e.g. &#x60;spc_…&#x60;). Omit to use the caller\&#39;s Personal Space. Invalid Space → 404 SPACE_NOT_FOUND; non-member → 403 NOT_A_MEMBER.
59
- * @param {*} [options] Override http request option.
60
- * @throws {RequiredError}
61
- * @memberof CampaignAssetsApiInterface
62
- */
63
- campaignAssetsDeleteRaw(requestParameters: CampaignAssetsDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
64
- /**
65
- * Remove a campaign-asset binding
66
- */
67
- campaignAssetsDelete(requestParameters: CampaignAssetsDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
68
- /**
69
- *
70
- * @summary Get campaign-asset binding
71
- * @param {string} id
72
- * @param {string} [xSpaceId] Target Space ID (e.g. &#x60;spc_…&#x60;). Omit to use the caller\&#39;s Personal Space. Invalid Space → 404 SPACE_NOT_FOUND; non-member → 403 NOT_A_MEMBER.
73
- * @param {*} [options] Override http request option.
74
- * @throws {RequiredError}
75
- * @memberof CampaignAssetsApiInterface
76
- */
77
- campaignAssetsGetRaw(requestParameters: CampaignAssetsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
78
- /**
79
- * Get campaign-asset binding
80
- */
81
- campaignAssetsGet(requestParameters: CampaignAssetsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
82
- /**
83
- *
84
- * @summary List campaign-asset bindings (filter by campaignId/assetId)
85
- * @param {number} [limit] Maximum items to return. Default 50, max 200.
86
- * @param {CampaignsListCursorParameter} [cursor] Opaque pagination cursor returned by the previous page in &#x60;meta.nextCursor&#x60;.
87
- * @param {string} [campaignId] Restrict to bindings for a specific campaign.
88
- * @param {string} [assetId] Restrict to bindings for a specific asset.
89
- * @param {string} [xSpaceId] Target Space ID (e.g. &#x60;spc_…&#x60;). Omit to use the caller\&#39;s Personal Space. Invalid Space → 404 SPACE_NOT_FOUND; non-member → 403 NOT_A_MEMBER.
90
- * @param {*} [options] Override http request option.
91
- * @throws {RequiredError}
92
- * @memberof CampaignAssetsApiInterface
93
- */
94
- campaignAssetsListRaw(requestParameters: CampaignAssetsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
95
- /**
96
- * List campaign-asset bindings (filter by campaignId/assetId)
97
- */
98
- campaignAssetsList(requestParameters: CampaignAssetsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
99
- }
100
- /**
101
- *
102
- */
103
- export declare class CampaignAssetsApi extends runtime.BaseAPI implements CampaignAssetsApiInterface {
104
- /**
105
- * Bind an asset to a campaign with a role
106
- */
107
- campaignAssetsCreateRaw(requestParameters: CampaignAssetsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
108
- /**
109
- * Bind an asset to a campaign with a role
110
- */
111
- campaignAssetsCreate(requestParameters: CampaignAssetsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
112
- /**
113
- * Remove a campaign-asset binding
114
- */
115
- campaignAssetsDeleteRaw(requestParameters: CampaignAssetsDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
116
- /**
117
- * Remove a campaign-asset binding
118
- */
119
- campaignAssetsDelete(requestParameters: CampaignAssetsDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
120
- /**
121
- * Get campaign-asset binding
122
- */
123
- campaignAssetsGetRaw(requestParameters: CampaignAssetsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
124
- /**
125
- * Get campaign-asset binding
126
- */
127
- campaignAssetsGet(requestParameters: CampaignAssetsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
128
- /**
129
- * List campaign-asset bindings (filter by campaignId/assetId)
130
- */
131
- campaignAssetsListRaw(requestParameters: CampaignAssetsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
132
- /**
133
- * List campaign-asset bindings (filter by campaignId/assetId)
134
- */
135
- campaignAssetsList(requestParameters?: CampaignAssetsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
136
- }
@@ -1,167 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
4
- * Defo Ads Public API
5
- * Stable public API for managing campaigns, ads, keywords, and sites.
6
- *
7
- * The version of the OpenAPI document: 1.4.0
8
- *
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
- import * as runtime from '../runtime';
15
- import { CampaignAssetCreateToJSON, SuccessEnvelopeFromJSON, } from '../models/index';
16
- /**
17
- *
18
- */
19
- export class CampaignAssetsApi extends runtime.BaseAPI {
20
- /**
21
- * Bind an asset to a campaign with a role
22
- */
23
- async campaignAssetsCreateRaw(requestParameters, initOverrides) {
24
- if (requestParameters['campaignAssetCreate'] == null) {
25
- throw new runtime.RequiredError('campaignAssetCreate', 'Required parameter "campaignAssetCreate" was null or undefined when calling campaignAssetsCreate().');
26
- }
27
- const queryParameters = {};
28
- const headerParameters = {};
29
- headerParameters['Content-Type'] = 'application/json';
30
- if (requestParameters['xSpaceId'] != null) {
31
- headerParameters['X-Space-Id'] = String(requestParameters['xSpaceId']);
32
- }
33
- if (this.configuration && this.configuration.accessToken) {
34
- const token = this.configuration.accessToken;
35
- const tokenString = await token("ApiToken", ["assets:write"]);
36
- if (tokenString) {
37
- headerParameters["Authorization"] = `Bearer ${tokenString}`;
38
- }
39
- }
40
- const response = await this.request({
41
- path: `/api/v1/campaign-assets`,
42
- method: 'POST',
43
- headers: headerParameters,
44
- query: queryParameters,
45
- body: CampaignAssetCreateToJSON(requestParameters['campaignAssetCreate']),
46
- }, initOverrides);
47
- return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
48
- }
49
- /**
50
- * Bind an asset to a campaign with a role
51
- */
52
- async campaignAssetsCreate(requestParameters, initOverrides) {
53
- const response = await this.campaignAssetsCreateRaw(requestParameters, initOverrides);
54
- return await response.value();
55
- }
56
- /**
57
- * Remove a campaign-asset binding
58
- */
59
- async campaignAssetsDeleteRaw(requestParameters, initOverrides) {
60
- if (requestParameters['id'] == null) {
61
- throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling campaignAssetsDelete().');
62
- }
63
- const queryParameters = {};
64
- const headerParameters = {};
65
- if (requestParameters['xSpaceId'] != null) {
66
- headerParameters['X-Space-Id'] = String(requestParameters['xSpaceId']);
67
- }
68
- if (this.configuration && this.configuration.accessToken) {
69
- const token = this.configuration.accessToken;
70
- const tokenString = await token("ApiToken", ["assets:write"]);
71
- if (tokenString) {
72
- headerParameters["Authorization"] = `Bearer ${tokenString}`;
73
- }
74
- }
75
- const response = await this.request({
76
- path: `/api/v1/campaign-assets/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
77
- method: 'DELETE',
78
- headers: headerParameters,
79
- query: queryParameters,
80
- }, initOverrides);
81
- return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
82
- }
83
- /**
84
- * Remove a campaign-asset binding
85
- */
86
- async campaignAssetsDelete(requestParameters, initOverrides) {
87
- const response = await this.campaignAssetsDeleteRaw(requestParameters, initOverrides);
88
- return await response.value();
89
- }
90
- /**
91
- * Get campaign-asset binding
92
- */
93
- async campaignAssetsGetRaw(requestParameters, initOverrides) {
94
- if (requestParameters['id'] == null) {
95
- throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling campaignAssetsGet().');
96
- }
97
- const queryParameters = {};
98
- const headerParameters = {};
99
- if (requestParameters['xSpaceId'] != null) {
100
- headerParameters['X-Space-Id'] = String(requestParameters['xSpaceId']);
101
- }
102
- if (this.configuration && this.configuration.accessToken) {
103
- const token = this.configuration.accessToken;
104
- const tokenString = await token("ApiToken", ["assets:read"]);
105
- if (tokenString) {
106
- headerParameters["Authorization"] = `Bearer ${tokenString}`;
107
- }
108
- }
109
- const response = await this.request({
110
- path: `/api/v1/campaign-assets/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
111
- method: 'GET',
112
- headers: headerParameters,
113
- query: queryParameters,
114
- }, initOverrides);
115
- return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
116
- }
117
- /**
118
- * Get campaign-asset binding
119
- */
120
- async campaignAssetsGet(requestParameters, initOverrides) {
121
- const response = await this.campaignAssetsGetRaw(requestParameters, initOverrides);
122
- return await response.value();
123
- }
124
- /**
125
- * List campaign-asset bindings (filter by campaignId/assetId)
126
- */
127
- async campaignAssetsListRaw(requestParameters, initOverrides) {
128
- const queryParameters = {};
129
- if (requestParameters['limit'] != null) {
130
- queryParameters['limit'] = requestParameters['limit'];
131
- }
132
- if (requestParameters['cursor'] != null) {
133
- queryParameters['cursor'] = requestParameters['cursor'];
134
- }
135
- if (requestParameters['campaignId'] != null) {
136
- queryParameters['campaignId'] = requestParameters['campaignId'];
137
- }
138
- if (requestParameters['assetId'] != null) {
139
- queryParameters['assetId'] = requestParameters['assetId'];
140
- }
141
- const headerParameters = {};
142
- if (requestParameters['xSpaceId'] != null) {
143
- headerParameters['X-Space-Id'] = String(requestParameters['xSpaceId']);
144
- }
145
- if (this.configuration && this.configuration.accessToken) {
146
- const token = this.configuration.accessToken;
147
- const tokenString = await token("ApiToken", ["assets:read"]);
148
- if (tokenString) {
149
- headerParameters["Authorization"] = `Bearer ${tokenString}`;
150
- }
151
- }
152
- const response = await this.request({
153
- path: `/api/v1/campaign-assets`,
154
- method: 'GET',
155
- headers: headerParameters,
156
- query: queryParameters,
157
- }, initOverrides);
158
- return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
159
- }
160
- /**
161
- * List campaign-asset bindings (filter by campaignId/assetId)
162
- */
163
- async campaignAssetsList(requestParameters = {}, initOverrides) {
164
- const response = await this.campaignAssetsListRaw(requestParameters, initOverrides);
165
- return await response.value();
166
- }
167
- }