@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
package/package.json CHANGED
@@ -1,32 +1,35 @@
1
1
  {
2
2
  "name": "@defoai/ads-client",
3
- "version": "1.4.0",
3
+ "version": "1.4.1",
4
4
  "description": "Official TypeScript SDK for the Defo Ads public API (/api/v1).",
5
5
  "license": "MIT",
6
6
  "type": "module",
7
- "main": "dist/index.js",
7
+ "main": "dist/index.cjs",
8
8
  "module": "dist/index.js",
9
9
  "types": "dist/index.d.ts",
10
10
  "files": [
11
11
  "dist",
12
- "src"
12
+ "src",
13
+ "README.md"
13
14
  ],
14
15
  "exports": {
15
16
  ".": {
16
17
  "types": "./dist/index.d.ts",
17
- "import": "./dist/index.js"
18
+ "import": "./dist/index.js",
19
+ "require": "./dist/index.cjs"
18
20
  }
19
21
  },
20
22
  "engines": {
21
23
  "node": ">=18"
22
24
  },
23
25
  "scripts": {
24
- "build": "tsc -p tsconfig.json",
26
+ "build": "tsup",
25
27
  "typecheck": "tsc -p tsconfig.json --noEmit",
26
28
  "test": "node --test --import tsx test/*.test.ts"
27
29
  },
28
30
  "devDependencies": {
29
31
  "tsx": "^4.22.4",
30
- "typescript": "^5.9.3"
32
+ "typescript": "^5.9.3",
33
+ "tsup": "^8.3.0"
31
34
  }
32
- }
35
+ }
@@ -1,140 +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 { AdAssetCreate, CampaignsListCursorParameter, SuccessEnvelope } from '../models/index';
14
- export interface AdAssetsCreateRequest {
15
- adAssetCreate: AdAssetCreate;
16
- xSpaceId?: string;
17
- }
18
- export interface AdAssetsDeleteRequest {
19
- id: string;
20
- xSpaceId?: string;
21
- }
22
- export interface AdAssetsGetRequest {
23
- id: string;
24
- xSpaceId?: string;
25
- }
26
- export interface AdAssetsListRequest {
27
- limit?: number;
28
- cursor?: CampaignsListCursorParameter;
29
- adId?: string;
30
- adGroupId?: string;
31
- campaignId?: string;
32
- role?: string;
33
- xSpaceId?: string;
34
- }
35
- /**
36
- * AdAssetsApi - interface
37
- *
38
- * @export
39
- * @interface AdAssetsApiInterface
40
- */
41
- export interface AdAssetsApiInterface {
42
- /**
43
- *
44
- * @summary Bind an asset to an ad or ad group with a role
45
- * @param {AdAssetCreate} adAssetCreate
46
- * @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.
47
- * @param {*} [options] Override http request option.
48
- * @throws {RequiredError}
49
- * @memberof AdAssetsApiInterface
50
- */
51
- adAssetsCreateRaw(requestParameters: AdAssetsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
52
- /**
53
- * Bind an asset to an ad or ad group with a role
54
- */
55
- adAssetsCreate(requestParameters: AdAssetsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
56
- /**
57
- *
58
- * @summary Remove an ad-asset binding
59
- * @param {string} id
60
- * @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.
61
- * @param {*} [options] Override http request option.
62
- * @throws {RequiredError}
63
- * @memberof AdAssetsApiInterface
64
- */
65
- adAssetsDeleteRaw(requestParameters: AdAssetsDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
66
- /**
67
- * Remove an ad-asset binding
68
- */
69
- adAssetsDelete(requestParameters: AdAssetsDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
70
- /**
71
- *
72
- * @summary Get ad-asset binding
73
- * @param {string} id
74
- * @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.
75
- * @param {*} [options] Override http request option.
76
- * @throws {RequiredError}
77
- * @memberof AdAssetsApiInterface
78
- */
79
- adAssetsGetRaw(requestParameters: AdAssetsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
80
- /**
81
- * Get ad-asset binding
82
- */
83
- adAssetsGet(requestParameters: AdAssetsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
84
- /**
85
- *
86
- * @summary List ad / ad-group asset bindings (filter by adId/adGroupId/campaignId)
87
- * @param {number} [limit] Maximum items to return. Default 50, max 200.
88
- * @param {CampaignsListCursorParameter} [cursor] Opaque pagination cursor returned by the previous page in &#x60;meta.nextCursor&#x60;.
89
- * @param {string} [adId] Restrict to bindings for a specific ad.
90
- * @param {string} [adGroupId] Restrict to bindings for a specific ad group.
91
- * @param {string} [campaignId] All ad/ad-group bindings across a campaign.
92
- * @param {string} [role] Filter by asset role.
93
- * @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.
94
- * @param {*} [options] Override http request option.
95
- * @throws {RequiredError}
96
- * @memberof AdAssetsApiInterface
97
- */
98
- adAssetsListRaw(requestParameters: AdAssetsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
99
- /**
100
- * List ad / ad-group asset bindings (filter by adId/adGroupId/campaignId)
101
- */
102
- adAssetsList(requestParameters: AdAssetsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
103
- }
104
- /**
105
- *
106
- */
107
- export declare class AdAssetsApi extends runtime.BaseAPI implements AdAssetsApiInterface {
108
- /**
109
- * Bind an asset to an ad or ad group with a role
110
- */
111
- adAssetsCreateRaw(requestParameters: AdAssetsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
112
- /**
113
- * Bind an asset to an ad or ad group with a role
114
- */
115
- adAssetsCreate(requestParameters: AdAssetsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
116
- /**
117
- * Remove an ad-asset binding
118
- */
119
- adAssetsDeleteRaw(requestParameters: AdAssetsDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
120
- /**
121
- * Remove an ad-asset binding
122
- */
123
- adAssetsDelete(requestParameters: AdAssetsDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
124
- /**
125
- * Get ad-asset binding
126
- */
127
- adAssetsGetRaw(requestParameters: AdAssetsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
128
- /**
129
- * Get ad-asset binding
130
- */
131
- adAssetsGet(requestParameters: AdAssetsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
132
- /**
133
- * List ad / ad-group asset bindings (filter by adId/adGroupId/campaignId)
134
- */
135
- adAssetsListRaw(requestParameters: AdAssetsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
136
- /**
137
- * List ad / ad-group asset bindings (filter by adId/adGroupId/campaignId)
138
- */
139
- adAssetsList(requestParameters?: AdAssetsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
140
- }
@@ -1,173 +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 { AdAssetCreateToJSON, SuccessEnvelopeFromJSON, } from '../models/index';
16
- /**
17
- *
18
- */
19
- export class AdAssetsApi extends runtime.BaseAPI {
20
- /**
21
- * Bind an asset to an ad or ad group with a role
22
- */
23
- async adAssetsCreateRaw(requestParameters, initOverrides) {
24
- if (requestParameters['adAssetCreate'] == null) {
25
- throw new runtime.RequiredError('adAssetCreate', 'Required parameter "adAssetCreate" was null or undefined when calling adAssetsCreate().');
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", ["ads:write"]);
36
- if (tokenString) {
37
- headerParameters["Authorization"] = `Bearer ${tokenString}`;
38
- }
39
- }
40
- const response = await this.request({
41
- path: `/api/v1/ad-assets`,
42
- method: 'POST',
43
- headers: headerParameters,
44
- query: queryParameters,
45
- body: AdAssetCreateToJSON(requestParameters['adAssetCreate']),
46
- }, initOverrides);
47
- return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
48
- }
49
- /**
50
- * Bind an asset to an ad or ad group with a role
51
- */
52
- async adAssetsCreate(requestParameters, initOverrides) {
53
- const response = await this.adAssetsCreateRaw(requestParameters, initOverrides);
54
- return await response.value();
55
- }
56
- /**
57
- * Remove an ad-asset binding
58
- */
59
- async adAssetsDeleteRaw(requestParameters, initOverrides) {
60
- if (requestParameters['id'] == null) {
61
- throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling adAssetsDelete().');
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", ["ads:write"]);
71
- if (tokenString) {
72
- headerParameters["Authorization"] = `Bearer ${tokenString}`;
73
- }
74
- }
75
- const response = await this.request({
76
- path: `/api/v1/ad-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 an ad-asset binding
85
- */
86
- async adAssetsDelete(requestParameters, initOverrides) {
87
- const response = await this.adAssetsDeleteRaw(requestParameters, initOverrides);
88
- return await response.value();
89
- }
90
- /**
91
- * Get ad-asset binding
92
- */
93
- async adAssetsGetRaw(requestParameters, initOverrides) {
94
- if (requestParameters['id'] == null) {
95
- throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling adAssetsGet().');
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", ["ads:read"]);
105
- if (tokenString) {
106
- headerParameters["Authorization"] = `Bearer ${tokenString}`;
107
- }
108
- }
109
- const response = await this.request({
110
- path: `/api/v1/ad-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 ad-asset binding
119
- */
120
- async adAssetsGet(requestParameters, initOverrides) {
121
- const response = await this.adAssetsGetRaw(requestParameters, initOverrides);
122
- return await response.value();
123
- }
124
- /**
125
- * List ad / ad-group asset bindings (filter by adId/adGroupId/campaignId)
126
- */
127
- async adAssetsListRaw(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['adId'] != null) {
136
- queryParameters['adId'] = requestParameters['adId'];
137
- }
138
- if (requestParameters['adGroupId'] != null) {
139
- queryParameters['adGroupId'] = requestParameters['adGroupId'];
140
- }
141
- if (requestParameters['campaignId'] != null) {
142
- queryParameters['campaignId'] = requestParameters['campaignId'];
143
- }
144
- if (requestParameters['role'] != null) {
145
- queryParameters['role'] = requestParameters['role'];
146
- }
147
- const headerParameters = {};
148
- if (requestParameters['xSpaceId'] != null) {
149
- headerParameters['X-Space-Id'] = String(requestParameters['xSpaceId']);
150
- }
151
- if (this.configuration && this.configuration.accessToken) {
152
- const token = this.configuration.accessToken;
153
- const tokenString = await token("ApiToken", ["ads:read"]);
154
- if (tokenString) {
155
- headerParameters["Authorization"] = `Bearer ${tokenString}`;
156
- }
157
- }
158
- const response = await this.request({
159
- path: `/api/v1/ad-assets`,
160
- method: 'GET',
161
- headers: headerParameters,
162
- query: queryParameters,
163
- }, initOverrides);
164
- return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
165
- }
166
- /**
167
- * List ad / ad-group asset bindings (filter by adId/adGroupId/campaignId)
168
- */
169
- async adAssetsList(requestParameters = {}, initOverrides) {
170
- const response = await this.adAssetsListRaw(requestParameters, initOverrides);
171
- return await response.value();
172
- }
173
- }
@@ -1,165 +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 { AdGroupCreate, AdGroupUpdate, CampaignsListCursorParameter, SuccessEnvelope } from '../models/index';
14
- export interface AdGroupsCreateRequest {
15
- adGroupCreate: AdGroupCreate;
16
- xSpaceId?: string;
17
- }
18
- export interface AdGroupsDeleteRequest {
19
- id: string;
20
- cascade?: boolean;
21
- xSpaceId?: string;
22
- }
23
- export interface AdGroupsGetRequest {
24
- id: string;
25
- xSpaceId?: string;
26
- }
27
- export interface AdGroupsListRequest {
28
- limit?: number;
29
- cursor?: CampaignsListCursorParameter;
30
- xSpaceId?: string;
31
- }
32
- export interface AdGroupsUpdateRequest {
33
- id: string;
34
- adGroupUpdate: AdGroupUpdate;
35
- xSpaceId?: string;
36
- }
37
- /**
38
- * AdGroupsApi - interface
39
- *
40
- * @export
41
- * @interface AdGroupsApiInterface
42
- */
43
- export interface AdGroupsApiInterface {
44
- /**
45
- *
46
- * @summary Create ad group
47
- * @param {AdGroupCreate} adGroupCreate
48
- * @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.
49
- * @param {*} [options] Override http request option.
50
- * @throws {RequiredError}
51
- * @memberof AdGroupsApiInterface
52
- */
53
- adGroupsCreateRaw(requestParameters: AdGroupsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
54
- /**
55
- * Create ad group
56
- */
57
- adGroupsCreate(requestParameters: AdGroupsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
58
- /**
59
- * Returns 409 CONFLICT with `details: { ads, keywords }` when the ad group still has dependent ads or keywords. Pass `?cascade=true` to delete them in the same request.
60
- * @summary Delete ad group
61
- * @param {string} id
62
- * @param {boolean} [cascade] Set to &#x60;true&#x60; to delete dependent ads and keywords along with the ad group.
63
- * @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.
64
- * @param {*} [options] Override http request option.
65
- * @throws {RequiredError}
66
- * @memberof AdGroupsApiInterface
67
- */
68
- adGroupsDeleteRaw(requestParameters: AdGroupsDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
69
- /**
70
- * Returns 409 CONFLICT with `details: { ads, keywords }` when the ad group still has dependent ads or keywords. Pass `?cascade=true` to delete them in the same request.
71
- * Delete ad group
72
- */
73
- adGroupsDelete(requestParameters: AdGroupsDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
74
- /**
75
- *
76
- * @summary Get ad group
77
- * @param {string} id
78
- * @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.
79
- * @param {*} [options] Override http request option.
80
- * @throws {RequiredError}
81
- * @memberof AdGroupsApiInterface
82
- */
83
- adGroupsGetRaw(requestParameters: AdGroupsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
84
- /**
85
- * Get ad group
86
- */
87
- adGroupsGet(requestParameters: AdGroupsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
88
- /**
89
- *
90
- * @summary List ad groups
91
- * @param {number} [limit] Maximum items to return. Default 50, max 200.
92
- * @param {CampaignsListCursorParameter} [cursor] Opaque pagination cursor returned by the previous page in &#x60;meta.nextCursor&#x60;.
93
- * @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.
94
- * @param {*} [options] Override http request option.
95
- * @throws {RequiredError}
96
- * @memberof AdGroupsApiInterface
97
- */
98
- adGroupsListRaw(requestParameters: AdGroupsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
99
- /**
100
- * List ad groups
101
- */
102
- adGroupsList(requestParameters: AdGroupsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
103
- /**
104
- *
105
- * @summary Update ad group
106
- * @param {string} id
107
- * @param {AdGroupUpdate} adGroupUpdate
108
- * @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.
109
- * @param {*} [options] Override http request option.
110
- * @throws {RequiredError}
111
- * @memberof AdGroupsApiInterface
112
- */
113
- adGroupsUpdateRaw(requestParameters: AdGroupsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
114
- /**
115
- * Update ad group
116
- */
117
- adGroupsUpdate(requestParameters: AdGroupsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
118
- }
119
- /**
120
- *
121
- */
122
- export declare class AdGroupsApi extends runtime.BaseAPI implements AdGroupsApiInterface {
123
- /**
124
- * Create ad group
125
- */
126
- adGroupsCreateRaw(requestParameters: AdGroupsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
127
- /**
128
- * Create ad group
129
- */
130
- adGroupsCreate(requestParameters: AdGroupsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
131
- /**
132
- * Returns 409 CONFLICT with `details: { ads, keywords }` when the ad group still has dependent ads or keywords. Pass `?cascade=true` to delete them in the same request.
133
- * Delete ad group
134
- */
135
- adGroupsDeleteRaw(requestParameters: AdGroupsDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
136
- /**
137
- * Returns 409 CONFLICT with `details: { ads, keywords }` when the ad group still has dependent ads or keywords. Pass `?cascade=true` to delete them in the same request.
138
- * Delete ad group
139
- */
140
- adGroupsDelete(requestParameters: AdGroupsDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
141
- /**
142
- * Get ad group
143
- */
144
- adGroupsGetRaw(requestParameters: AdGroupsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
145
- /**
146
- * Get ad group
147
- */
148
- adGroupsGet(requestParameters: AdGroupsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
149
- /**
150
- * List ad groups
151
- */
152
- adGroupsListRaw(requestParameters: AdGroupsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
153
- /**
154
- * List ad groups
155
- */
156
- adGroupsList(requestParameters?: AdGroupsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
157
- /**
158
- * Update ad group
159
- */
160
- adGroupsUpdateRaw(requestParameters: AdGroupsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
161
- /**
162
- * Update ad group
163
- */
164
- adGroupsUpdate(requestParameters: AdGroupsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
165
- }