Skip to content

Commit 87c8581

Browse files
authored
Feature release/0.2.1 (#107)
* Generate docs 0.2.1 * Update doc versioning
1 parent 5140ce5 commit 87c8581

16 files changed

Lines changed: 687 additions & 93 deletions

docs/pinterest/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010
- [`ads.ads`](./ads.ads.md#module-adsads): Ads high level model
1111
- [`ads.audiences`](./ads.audiences.md#module-adsaudiences): High level module class for Audience object
1212
- [`ads.campaigns`](./ads.campaigns.md#module-adscampaigns): Campaign Class for Pinterest Python SDK
13+
- [`ads.conversion_events`](./ads.conversion_events.md#module-adsconversion_events): Conversion Event Class for Pinterest Python SDK
14+
- [`ads.conversion_tags`](./ads.conversion_tags.md#module-adsconversion_tags): Conversion Class for Pinterest Python SDK
1315
- [`ads.customer_lists`](./ads.customer_lists.md#module-adscustomer_lists): High level module class for Customer List object
1416
- [`ads.keywords`](./ads.keywords.md#module-adskeywords): High level module class for Keyword object
1517
- [`client`](./client.md#module-client): Pinterest Client
@@ -31,6 +33,8 @@
3133
- [`ads.Ad`](./ads.ads.md#class-ad): Ad model used to view, create, update its attributes
3234
- [`audiences.Audience`](./ads.audiences.md#class-audience): High level model class to manage audiences for an AdAccount
3335
- [`campaigns.Campaign`](./ads.campaigns.md#class-campaign): Campaign model used to view, create, update its attributes and list its different entities.
36+
- [`conversion_events.Conversion`](./ads.conversion_events.md#class-conversion): Conversion Event Model used to send conversion events to Pinterest API
37+
- [`conversion_tags.ConversionTag`](./ads.conversion_tags.md#class-conversiontag): Conversion Tag model used to view, create, update its attributes and list its different entities
3438
- [`customer_lists.CustomerList`](./ads.customer_lists.md#class-customerlist): High level model class to manage customer_lists for an CustomerList
3539
- [`keywords.Keyword`](./ads.keywords.md#class-keyword): High level model class to manage keywords
3640
- [`client.PinterestSDKClient`](./client.md#class-pinterestsdkclient): Wrapper API client for SDK high level models
@@ -45,4 +49,5 @@
4549

4650
- [`error_handling.verify_api_response`](./utils.error_handling.md#function-verify_api_response): Verify that there are no errors in `response` received from api
4751
- [`load_json_config.load_json_config`](./utils.load_json_config.md#function-load_json_config): Parse a config.json file and then load all the variables found as environment variables.
52+
- [`load_json_config.load_json_config_from_single_env_var`](./utils.load_json_config.md#function-load_json_config_from_single_env_var): Parse PINTEREST_JSON_ENV_VARIABLES environment variable to split long JSON string into
4853
- [`refresh_access_token.get_new_access_token`](./utils.refresh_access_token.md#function-get_new_access_token): Function used to retrieve a new access token for a user using the refresh token.

docs/pinterest/ads.ad_accounts.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,14 @@ Initialize an object of an AdAccount.
4040

4141

4242

43+
---
44+
45+
#### <kbd>property</kbd> created_time
46+
47+
48+
49+
50+
4351
---
4452

4553
#### <kbd>property</kbd> currency
@@ -80,11 +88,19 @@ Initialize an object of an AdAccount.
8088

8189

8290

91+
---
92+
93+
#### <kbd>property</kbd> updated_time
94+
95+
96+
97+
98+
8399

84100

85101
---
86102

87-
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/ad_accounts.py#L89"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
103+
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/ad_accounts.py#L101"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
88104

89105
### <kbd>classmethod</kbd> `create`
90106

@@ -119,7 +135,7 @@ Keyword Args: Any valid keyword arguments or query parameters for endpoint.
119135

120136
---
121137

122-
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/ad_accounts.py#L181"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
138+
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/ad_accounts.py#L193"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
123139

124140
### <kbd>method</kbd> `list_audiences`
125141

@@ -153,7 +169,7 @@ Get a list of the audiences in the AdAccount, filtered by the specified argument
153169

154170
---
155171

156-
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/ad_accounts.py#L134"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
172+
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/ad_accounts.py#L146"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
157173

158174
### <kbd>method</kbd> `list_campaigns`
159175

@@ -192,7 +208,7 @@ Keyword Args: Any valid keyword arguments or query parameters for endpoint.
192208

193209
---
194210

195-
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/ad_accounts.py#L218"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
211+
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/ad_accounts.py#L230"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
196212

197213
### <kbd>method</kbd> `list_customer_lists`
198214

docs/pinterest/ads.ad_groups.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,14 @@ Initialize an AdGroup object.
161161

162162

163163

164+
---
165+
166+
#### <kbd>property</kbd> optimization_goal_metadata
167+
168+
169+
170+
171+
164172
---
165173

166174
#### <kbd>property</kbd> pacing_delivery_type
@@ -237,7 +245,7 @@ Initialize an AdGroup object.
237245

238246
---
239247

240-
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/ad_groups.py#L205"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
248+
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/ad_groups.py#L211"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
241249

242250
### <kbd>classmethod</kbd> `create`
243251

@@ -329,7 +337,7 @@ to ad campaigns. Some types of campaigns (e.g. budget optimization) have limits
329337

330338
---
331339

332-
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/ad_groups.py#L471"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
340+
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/ad_groups.py#L477"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
333341

334342
### <kbd>method</kbd> `disable_auto_targeting`
335343

@@ -347,7 +355,7 @@ Disable auto-targeting for ad group. Also known as <a href='https://help.pintere
347355

348356
---
349357

350-
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/ad_groups.py#L461"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
358+
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/ad_groups.py#L467"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
351359

352360
### <kbd>method</kbd> `enable_auto_targeting`
353361

@@ -365,7 +373,7 @@ Enable auto-targeting for ad group. Also known as <a href='https://help.pinteres
365373

366374
---
367375

368-
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/ad_groups.py#L362"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
376+
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/ad_groups.py#L368"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
369377

370378
### <kbd>classmethod</kbd> `get_all`
371379

@@ -405,7 +413,7 @@ List ad groups based on provided campaign IDs or ad group IDs.(campaign_ids or a
405413

406414
---
407415

408-
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/ad_groups.py#L422"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
416+
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/ad_groups.py#L428"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
409417

410418
### <kbd>method</kbd> `list_ads`
411419

@@ -441,7 +449,7 @@ Get list of ads under current AdGroup with specified arguments
441449

442450
---
443451

444-
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/ad_groups.py#L336"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
452+
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/ad_groups.py#L342"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
445453

446454
### <kbd>method</kbd> `update_fields`
447455

docs/pinterest/ads.ads.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,7 @@ Initialize an Ad object.
258258

259259
---
260260

261-
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/ads.py#L213"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
261+
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/ads.py#L214"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
262262

263263
### <kbd>classmethod</kbd> `create`
264264

@@ -323,7 +323,7 @@ Create a new ad. Request must contain ad_group_id, creative_type, and the source
323323

324324
---
325325

326-
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/ads.py#L315"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
326+
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/ads.py#L316"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
327327

328328
### <kbd>classmethod</kbd> `get_all`
329329

@@ -374,7 +374,7 @@ List ads that meet the filters provided:
374374

375375
---
376376

377-
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/ads.py#L394"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
377+
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/ads.py#L395"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
378378

379379
### <kbd>method</kbd> `update_fields`
380380

docs/pinterest/ads.campaigns.md

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,14 @@ Initialize a Campaign object.
142142

143143

144144

145+
---
146+
147+
#### <kbd>property</kbd> summary_status
148+
149+
150+
151+
152+
145153
---
146154

147155
#### <kbd>property</kbd> tracking_urls
@@ -170,7 +178,7 @@ Initialize a Campaign object.
170178

171179
---
172180

173-
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/campaigns.py#L463"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
181+
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/campaigns.py#L469"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
174182

175183
### <kbd>method</kbd> `activate`
176184

@@ -188,7 +196,7 @@ Activate a paused or archived campaign
188196

189197
---
190198

191-
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/campaigns.py#L472"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
199+
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/campaigns.py#L478"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
192200

193201
### <kbd>method</kbd> `archive`
194202

@@ -206,7 +214,7 @@ Archive an active or paused campaign
206214

207215
---
208216

209-
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/campaigns.py#L152"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
217+
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/campaigns.py#L158"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
210218

211219
### <kbd>classmethod</kbd> `create`
212220

@@ -298,7 +306,7 @@ Keyword Args: Any valid keyword arguments or query parameters for endpoint.
298306

299307
---
300308

301-
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/campaigns.py#L295"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
309+
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/campaigns.py#L301"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
302310

303311
### <kbd>classmethod</kbd> `get_all`
304312

@@ -340,7 +348,7 @@ Keyword Args: Any valid keyword arguments or query parameters for endpoint.
340348

341349
---
342350

343-
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/campaigns.py#L417"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
351+
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/campaigns.py#L423"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
344352

345353
### <kbd>method</kbd> `get_daily_budget`
346354

@@ -358,7 +366,7 @@ Get the current daily spend cap budget of the campaign.
358366

359367
---
360368

361-
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/campaigns.py#L408"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
369+
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/campaigns.py#L414"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
362370

363371
### <kbd>method</kbd> `get_lifetime_budget`
364372

@@ -376,7 +384,7 @@ Get the current life time spend cap budget of the campaign.
376384

377385
---
378386

379-
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/campaigns.py#L507"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
387+
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/campaigns.py#L513"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
380388

381389
### <kbd>method</kbd> `list_ad_groups`
382390

@@ -407,7 +415,7 @@ List ad groups directed related to campaign. This method makes a synchronous HTT
407415

408416
---
409417

410-
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/campaigns.py#L454"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
418+
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/campaigns.py#L460"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
411419

412420
### <kbd>method</kbd> `pause`
413421

@@ -425,7 +433,7 @@ Pause an active or archived campaign
425433

426434
---
427435

428-
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/campaigns.py#L384"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
436+
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/campaigns.py#L390"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
429437

430438
### <kbd>method</kbd> `set_daily_budget`
431439

@@ -449,7 +457,7 @@ Set new daily spend cap budget for the campaign.
449457

450458
---
451459

452-
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/campaigns.py#L360"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
460+
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/campaigns.py#L366"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
453461

454462
### <kbd>method</kbd> `set_lifetime_budget`
455463

@@ -473,7 +481,7 @@ Set new life time spend cap budget for the campaign.
473481

474482
---
475483

476-
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/campaigns.py#L481"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
484+
<a href="https://github.com/pinterest/pinterest-python-sdk/blob/main/pinterest/ads/campaigns.py#L487"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
477485

478486
### <kbd>method</kbd> `update_fields`
479487

0 commit comments

Comments
 (0)