@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,169 +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 { CampaignCreate, CampaignUpdate, CampaignsListCursorParameter, SuccessEnvelope } from '../models/index';
14
- export interface CampaignsCreateRequest {
15
- campaignCreate: CampaignCreate;
16
- xSpaceId?: string;
17
- }
18
- export interface CampaignsDeleteRequest {
19
- id: string;
20
- xSpaceId?: string;
21
- }
22
- export interface CampaignsGetRequest {
23
- id: string;
24
- xSpaceId?: string;
25
- }
26
- export interface CampaignsListRequest {
27
- limit?: number;
28
- cursor?: CampaignsListCursorParameter;
29
- xSpaceId?: string;
30
- }
31
- export interface CampaignsUpdateRequest {
32
- id: string;
33
- campaignUpdate: CampaignUpdate;
34
- xSpaceId?: string;
35
- }
36
- /**
37
- * CampaignsApi - interface
38
- *
39
- * @export
40
- * @interface CampaignsApiInterface
41
- */
42
- export interface CampaignsApiInterface {
43
- /**
44
- * Body accepts a Campaign object. The `adSchedule` field (US-ADS-133) follows the CampaignAdScheduleField shape — see components.schemas.
45
- * @summary Create campaign
46
- * @param {CampaignCreate} campaignCreate
47
- * @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.
48
- * @param {*} [options] Override http request option.
49
- * @throws {RequiredError}
50
- * @memberof CampaignsApiInterface
51
- */
52
- campaignsCreateRaw(requestParameters: CampaignsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
53
- /**
54
- * Body accepts a Campaign object. The `adSchedule` field (US-ADS-133) follows the CampaignAdScheduleField shape — see components.schemas.
55
- * Create campaign
56
- */
57
- campaignsCreate(requestParameters: CampaignsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
58
- /**
59
- *
60
- * @summary Delete campaign
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 CampaignsApiInterface
66
- */
67
- campaignsDeleteRaw(requestParameters: CampaignsDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
68
- /**
69
- * Delete campaign
70
- */
71
- campaignsDelete(requestParameters: CampaignsDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
72
- /**
73
- * Response carries both `adSchedule` (legacy enum echo when set as such) and `adScheduleStructured` (canonical StructuredSchedule).
74
- * @summary Get campaign
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 CampaignsApiInterface
80
- */
81
- campaignsGetRaw(requestParameters: CampaignsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
82
- /**
83
- * Response carries both `adSchedule` (legacy enum echo when set as such) and `adScheduleStructured` (canonical StructuredSchedule).
84
- * Get campaign
85
- */
86
- campaignsGet(requestParameters: CampaignsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
87
- /**
88
- *
89
- * @summary List campaigns
90
- * @param {number} [limit] Maximum items to return. Default 50, max 200.
91
- * @param {CampaignsListCursorParameter} [cursor] Opaque pagination cursor returned by the previous page in &#x60;meta.nextCursor&#x60;.
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 CampaignsApiInterface
96
- */
97
- campaignsListRaw(requestParameters: CampaignsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
98
- /**
99
- * List campaigns
100
- */
101
- campaignsList(requestParameters: CampaignsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
102
- /**
103
- * Body fields are merged into the existing campaign. `adSchedule` can be the legacy enum or a StructuredSchedule; the canonical form is recomputed each write.
104
- * @summary Update campaign
105
- * @param {string} id
106
- * @param {CampaignUpdate} campaignUpdate
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 CampaignsApiInterface
111
- */
112
- campaignsUpdateRaw(requestParameters: CampaignsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
113
- /**
114
- * Body fields are merged into the existing campaign. `adSchedule` can be the legacy enum or a StructuredSchedule; the canonical form is recomputed each write.
115
- * Update campaign
116
- */
117
- campaignsUpdate(requestParameters: CampaignsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
118
- }
119
- /**
120
- *
121
- */
122
- export declare class CampaignsApi extends runtime.BaseAPI implements CampaignsApiInterface {
123
- /**
124
- * Body accepts a Campaign object. The `adSchedule` field (US-ADS-133) follows the CampaignAdScheduleField shape — see components.schemas.
125
- * Create campaign
126
- */
127
- campaignsCreateRaw(requestParameters: CampaignsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
128
- /**
129
- * Body accepts a Campaign object. The `adSchedule` field (US-ADS-133) follows the CampaignAdScheduleField shape — see components.schemas.
130
- * Create campaign
131
- */
132
- campaignsCreate(requestParameters: CampaignsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
133
- /**
134
- * Delete campaign
135
- */
136
- campaignsDeleteRaw(requestParameters: CampaignsDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
137
- /**
138
- * Delete campaign
139
- */
140
- campaignsDelete(requestParameters: CampaignsDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
141
- /**
142
- * Response carries both `adSchedule` (legacy enum echo when set as such) and `adScheduleStructured` (canonical StructuredSchedule).
143
- * Get campaign
144
- */
145
- campaignsGetRaw(requestParameters: CampaignsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
146
- /**
147
- * Response carries both `adSchedule` (legacy enum echo when set as such) and `adScheduleStructured` (canonical StructuredSchedule).
148
- * Get campaign
149
- */
150
- campaignsGet(requestParameters: CampaignsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
151
- /**
152
- * List campaigns
153
- */
154
- campaignsListRaw(requestParameters: CampaignsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
155
- /**
156
- * List campaigns
157
- */
158
- campaignsList(requestParameters?: CampaignsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
159
- /**
160
- * Body fields are merged into the existing campaign. `adSchedule` can be the legacy enum or a StructuredSchedule; the canonical form is recomputed each write.
161
- * Update campaign
162
- */
163
- campaignsUpdateRaw(requestParameters: CampaignsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
164
- /**
165
- * Body fields are merged into the existing campaign. `adSchedule` can be the legacy enum or a StructuredSchedule; the canonical form is recomputed each write.
166
- * Update campaign
167
- */
168
- campaignsUpdate(requestParameters: CampaignsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
169
- }
@@ -1,206 +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 { CampaignCreateToJSON, CampaignUpdateToJSON, SuccessEnvelopeFromJSON, } from '../models/index';
16
- /**
17
- *
18
- */
19
- export class CampaignsApi extends runtime.BaseAPI {
20
- /**
21
- * Body accepts a Campaign object. The `adSchedule` field (US-ADS-133) follows the CampaignAdScheduleField shape — see components.schemas.
22
- * Create campaign
23
- */
24
- async campaignsCreateRaw(requestParameters, initOverrides) {
25
- if (requestParameters['campaignCreate'] == null) {
26
- throw new runtime.RequiredError('campaignCreate', 'Required parameter "campaignCreate" was null or undefined when calling campaignsCreate().');
27
- }
28
- const queryParameters = {};
29
- const headerParameters = {};
30
- headerParameters['Content-Type'] = 'application/json';
31
- if (requestParameters['xSpaceId'] != null) {
32
- headerParameters['X-Space-Id'] = String(requestParameters['xSpaceId']);
33
- }
34
- if (this.configuration && this.configuration.accessToken) {
35
- const token = this.configuration.accessToken;
36
- const tokenString = await token("ApiToken", ["campaigns:write"]);
37
- if (tokenString) {
38
- headerParameters["Authorization"] = `Bearer ${tokenString}`;
39
- }
40
- }
41
- const response = await this.request({
42
- path: `/api/v1/campaigns`,
43
- method: 'POST',
44
- headers: headerParameters,
45
- query: queryParameters,
46
- body: CampaignCreateToJSON(requestParameters['campaignCreate']),
47
- }, initOverrides);
48
- return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
49
- }
50
- /**
51
- * Body accepts a Campaign object. The `adSchedule` field (US-ADS-133) follows the CampaignAdScheduleField shape — see components.schemas.
52
- * Create campaign
53
- */
54
- async campaignsCreate(requestParameters, initOverrides) {
55
- const response = await this.campaignsCreateRaw(requestParameters, initOverrides);
56
- return await response.value();
57
- }
58
- /**
59
- * Delete campaign
60
- */
61
- async campaignsDeleteRaw(requestParameters, initOverrides) {
62
- if (requestParameters['id'] == null) {
63
- throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling campaignsDelete().');
64
- }
65
- const queryParameters = {};
66
- const headerParameters = {};
67
- if (requestParameters['xSpaceId'] != null) {
68
- headerParameters['X-Space-Id'] = String(requestParameters['xSpaceId']);
69
- }
70
- if (this.configuration && this.configuration.accessToken) {
71
- const token = this.configuration.accessToken;
72
- const tokenString = await token("ApiToken", ["campaigns:write"]);
73
- if (tokenString) {
74
- headerParameters["Authorization"] = `Bearer ${tokenString}`;
75
- }
76
- }
77
- const response = await this.request({
78
- path: `/api/v1/campaigns/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
79
- method: 'DELETE',
80
- headers: headerParameters,
81
- query: queryParameters,
82
- }, initOverrides);
83
- return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
84
- }
85
- /**
86
- * Delete campaign
87
- */
88
- async campaignsDelete(requestParameters, initOverrides) {
89
- const response = await this.campaignsDeleteRaw(requestParameters, initOverrides);
90
- return await response.value();
91
- }
92
- /**
93
- * Response carries both `adSchedule` (legacy enum echo when set as such) and `adScheduleStructured` (canonical StructuredSchedule).
94
- * Get campaign
95
- */
96
- async campaignsGetRaw(requestParameters, initOverrides) {
97
- if (requestParameters['id'] == null) {
98
- throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling campaignsGet().');
99
- }
100
- const queryParameters = {};
101
- const headerParameters = {};
102
- if (requestParameters['xSpaceId'] != null) {
103
- headerParameters['X-Space-Id'] = String(requestParameters['xSpaceId']);
104
- }
105
- if (this.configuration && this.configuration.accessToken) {
106
- const token = this.configuration.accessToken;
107
- const tokenString = await token("ApiToken", ["campaigns:read"]);
108
- if (tokenString) {
109
- headerParameters["Authorization"] = `Bearer ${tokenString}`;
110
- }
111
- }
112
- const response = await this.request({
113
- path: `/api/v1/campaigns/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
114
- method: 'GET',
115
- headers: headerParameters,
116
- query: queryParameters,
117
- }, initOverrides);
118
- return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
119
- }
120
- /**
121
- * Response carries both `adSchedule` (legacy enum echo when set as such) and `adScheduleStructured` (canonical StructuredSchedule).
122
- * Get campaign
123
- */
124
- async campaignsGet(requestParameters, initOverrides) {
125
- const response = await this.campaignsGetRaw(requestParameters, initOverrides);
126
- return await response.value();
127
- }
128
- /**
129
- * List campaigns
130
- */
131
- async campaignsListRaw(requestParameters, initOverrides) {
132
- const queryParameters = {};
133
- if (requestParameters['limit'] != null) {
134
- queryParameters['limit'] = requestParameters['limit'];
135
- }
136
- if (requestParameters['cursor'] != null) {
137
- queryParameters['cursor'] = requestParameters['cursor'];
138
- }
139
- const headerParameters = {};
140
- if (requestParameters['xSpaceId'] != null) {
141
- headerParameters['X-Space-Id'] = String(requestParameters['xSpaceId']);
142
- }
143
- if (this.configuration && this.configuration.accessToken) {
144
- const token = this.configuration.accessToken;
145
- const tokenString = await token("ApiToken", ["campaigns:read"]);
146
- if (tokenString) {
147
- headerParameters["Authorization"] = `Bearer ${tokenString}`;
148
- }
149
- }
150
- const response = await this.request({
151
- path: `/api/v1/campaigns`,
152
- method: 'GET',
153
- headers: headerParameters,
154
- query: queryParameters,
155
- }, initOverrides);
156
- return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
157
- }
158
- /**
159
- * List campaigns
160
- */
161
- async campaignsList(requestParameters = {}, initOverrides) {
162
- const response = await this.campaignsListRaw(requestParameters, initOverrides);
163
- return await response.value();
164
- }
165
- /**
166
- * Body fields are merged into the existing campaign. `adSchedule` can be the legacy enum or a StructuredSchedule; the canonical form is recomputed each write.
167
- * Update campaign
168
- */
169
- async campaignsUpdateRaw(requestParameters, initOverrides) {
170
- if (requestParameters['id'] == null) {
171
- throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling campaignsUpdate().');
172
- }
173
- if (requestParameters['campaignUpdate'] == null) {
174
- throw new runtime.RequiredError('campaignUpdate', 'Required parameter "campaignUpdate" was null or undefined when calling campaignsUpdate().');
175
- }
176
- const queryParameters = {};
177
- const headerParameters = {};
178
- headerParameters['Content-Type'] = 'application/json';
179
- if (requestParameters['xSpaceId'] != null) {
180
- headerParameters['X-Space-Id'] = String(requestParameters['xSpaceId']);
181
- }
182
- if (this.configuration && this.configuration.accessToken) {
183
- const token = this.configuration.accessToken;
184
- const tokenString = await token("ApiToken", ["campaigns:write"]);
185
- if (tokenString) {
186
- headerParameters["Authorization"] = `Bearer ${tokenString}`;
187
- }
188
- }
189
- const response = await this.request({
190
- path: `/api/v1/campaigns/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
191
- method: 'PUT',
192
- headers: headerParameters,
193
- query: queryParameters,
194
- body: CampaignUpdateToJSON(requestParameters['campaignUpdate']),
195
- }, initOverrides);
196
- return new runtime.JSONApiResponse(response, (jsonValue) => SuccessEnvelopeFromJSON(jsonValue));
197
- }
198
- /**
199
- * Body fields are merged into the existing campaign. `adSchedule` can be the legacy enum or a StructuredSchedule; the canonical form is recomputed each write.
200
- * Update campaign
201
- */
202
- async campaignsUpdate(requestParameters, initOverrides) {
203
- const response = await this.campaignsUpdateRaw(requestParameters, initOverrides);
204
- return await response.value();
205
- }
206
- }
@@ -1,160 +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 { CampaignsListCursorParameter, KeywordCreate, KeywordUpdate, SuccessEnvelope } from '../models/index';
14
- export interface KeywordsCreateRequest {
15
- keywordCreate: KeywordCreate;
16
- xSpaceId?: string;
17
- }
18
- export interface KeywordsDeleteRequest {
19
- id: string;
20
- xSpaceId?: string;
21
- }
22
- export interface KeywordsGetRequest {
23
- id: string;
24
- xSpaceId?: string;
25
- }
26
- export interface KeywordsListRequest {
27
- limit?: number;
28
- cursor?: CampaignsListCursorParameter;
29
- xSpaceId?: string;
30
- }
31
- export interface KeywordsUpdateRequest {
32
- id: string;
33
- keywordUpdate: KeywordUpdate;
34
- xSpaceId?: string;
35
- }
36
- /**
37
- * KeywordsApi - interface
38
- *
39
- * @export
40
- * @interface KeywordsApiInterface
41
- */
42
- export interface KeywordsApiInterface {
43
- /**
44
- *
45
- * @summary Create keyword
46
- * @param {KeywordCreate} keywordCreate
47
- * @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.
48
- * @param {*} [options] Override http request option.
49
- * @throws {RequiredError}
50
- * @memberof KeywordsApiInterface
51
- */
52
- keywordsCreateRaw(requestParameters: KeywordsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
53
- /**
54
- * Create keyword
55
- */
56
- keywordsCreate(requestParameters: KeywordsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
57
- /**
58
- *
59
- * @summary Delete keyword
60
- * @param {string} id
61
- * @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.
62
- * @param {*} [options] Override http request option.
63
- * @throws {RequiredError}
64
- * @memberof KeywordsApiInterface
65
- */
66
- keywordsDeleteRaw(requestParameters: KeywordsDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
67
- /**
68
- * Delete keyword
69
- */
70
- keywordsDelete(requestParameters: KeywordsDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
71
- /**
72
- *
73
- * @summary Get keyword
74
- * @param {string} id
75
- * @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.
76
- * @param {*} [options] Override http request option.
77
- * @throws {RequiredError}
78
- * @memberof KeywordsApiInterface
79
- */
80
- keywordsGetRaw(requestParameters: KeywordsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
81
- /**
82
- * Get keyword
83
- */
84
- keywordsGet(requestParameters: KeywordsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
85
- /**
86
- *
87
- * @summary List keywords
88
- * @param {number} [limit] Maximum items to return. Default 50, max 200.
89
- * @param {CampaignsListCursorParameter} [cursor] Opaque pagination cursor returned by the previous page in &#x60;meta.nextCursor&#x60;.
90
- * @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.
91
- * @param {*} [options] Override http request option.
92
- * @throws {RequiredError}
93
- * @memberof KeywordsApiInterface
94
- */
95
- keywordsListRaw(requestParameters: KeywordsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
96
- /**
97
- * List keywords
98
- */
99
- keywordsList(requestParameters: KeywordsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
100
- /**
101
- *
102
- * @summary Update keyword
103
- * @param {string} id
104
- * @param {KeywordUpdate} keywordUpdate
105
- * @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.
106
- * @param {*} [options] Override http request option.
107
- * @throws {RequiredError}
108
- * @memberof KeywordsApiInterface
109
- */
110
- keywordsUpdateRaw(requestParameters: KeywordsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
111
- /**
112
- * Update keyword
113
- */
114
- keywordsUpdate(requestParameters: KeywordsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
115
- }
116
- /**
117
- *
118
- */
119
- export declare class KeywordsApi extends runtime.BaseAPI implements KeywordsApiInterface {
120
- /**
121
- * Create keyword
122
- */
123
- keywordsCreateRaw(requestParameters: KeywordsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
124
- /**
125
- * Create keyword
126
- */
127
- keywordsCreate(requestParameters: KeywordsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
128
- /**
129
- * Delete keyword
130
- */
131
- keywordsDeleteRaw(requestParameters: KeywordsDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
132
- /**
133
- * Delete keyword
134
- */
135
- keywordsDelete(requestParameters: KeywordsDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
136
- /**
137
- * Get keyword
138
- */
139
- keywordsGetRaw(requestParameters: KeywordsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
140
- /**
141
- * Get keyword
142
- */
143
- keywordsGet(requestParameters: KeywordsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
144
- /**
145
- * List keywords
146
- */
147
- keywordsListRaw(requestParameters: KeywordsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
148
- /**
149
- * List keywords
150
- */
151
- keywordsList(requestParameters?: KeywordsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
152
- /**
153
- * Update keyword
154
- */
155
- keywordsUpdateRaw(requestParameters: KeywordsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SuccessEnvelope>>;
156
- /**
157
- * Update keyword
158
- */
159
- keywordsUpdate(requestParameters: KeywordsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SuccessEnvelope>;
160
- }