Skip to content

Commit

Permalink
Feature release/0.2.1 (#107)
Browse files Browse the repository at this point in the history
* Generate docs 0.2.1

* Update doc versioning
  • Loading branch information
thucngyyen committed Apr 5, 2023
1 parent 5140ce5 commit 87c8581
Show file tree
Hide file tree
Showing 16 changed files with 687 additions and 93 deletions.
5 changes: 5 additions & 0 deletions docs/pinterest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
- [`ads.ads`](./ads.ads.md#module-adsads): Ads high level model
- [`ads.audiences`](./ads.audiences.md#module-adsaudiences): High level module class for Audience object
- [`ads.campaigns`](./ads.campaigns.md#module-adscampaigns): Campaign Class for Pinterest Python SDK
- [`ads.conversion_events`](./ads.conversion_events.md#module-adsconversion_events): Conversion Event Class for Pinterest Python SDK
- [`ads.conversion_tags`](./ads.conversion_tags.md#module-adsconversion_tags): Conversion Class for Pinterest Python SDK
- [`ads.customer_lists`](./ads.customer_lists.md#module-adscustomer_lists): High level module class for Customer List object
- [`ads.keywords`](./ads.keywords.md#module-adskeywords): High level module class for Keyword object
- [`client`](./client.md#module-client): Pinterest Client
Expand All @@ -31,6 +33,8 @@
- [`ads.Ad`](./ads.ads.md#class-ad): Ad model used to view, create, update its attributes
- [`audiences.Audience`](./ads.audiences.md#class-audience): High level model class to manage audiences for an AdAccount
- [`campaigns.Campaign`](./ads.campaigns.md#class-campaign): Campaign model used to view, create, update its attributes and list its different entities.
- [`conversion_events.Conversion`](./ads.conversion_events.md#class-conversion): Conversion Event Model used to send conversion events to Pinterest API
- [`conversion_tags.ConversionTag`](./ads.conversion_tags.md#class-conversiontag): Conversion Tag model used to view, create, update its attributes and list its different entities
- [`customer_lists.CustomerList`](./ads.customer_lists.md#class-customerlist): High level model class to manage customer_lists for an CustomerList
- [`keywords.Keyword`](./ads.keywords.md#class-keyword): High level model class to manage keywords
- [`client.PinterestSDKClient`](./client.md#class-pinterestsdkclient): Wrapper API client for SDK high level models
Expand All @@ -45,4 +49,5 @@

- [`error_handling.verify_api_response`](./utils.error_handling.md#function-verify_api_response): Verify that there are no errors in `response` received from api
- [`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.
- [`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
- [`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.
24 changes: 20 additions & 4 deletions docs/pinterest/ads.ad_accounts.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,14 @@ Initialize an object of an AdAccount.



---

#### <kbd>property</kbd> created_time





---

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



---

#### <kbd>property</kbd> updated_time







---

<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>
<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>

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

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

---

<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>
<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>

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

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

---

<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>
<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>

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

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

---

<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>
<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>

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

Expand Down
20 changes: 14 additions & 6 deletions docs/pinterest/ads.ad_groups.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,14 @@ Initialize an AdGroup object.



---

#### <kbd>property</kbd> optimization_goal_metadata





---

#### <kbd>property</kbd> pacing_delivery_type
Expand Down Expand Up @@ -237,7 +245,7 @@ Initialize an AdGroup object.

---

<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>
<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>

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

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

---

<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>
<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>

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

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

---

<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>
<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>

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

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

---

<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>
<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>

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

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

---

<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>
<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>

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

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

---

<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>
<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>

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

Expand Down
6 changes: 3 additions & 3 deletions docs/pinterest/ads.ads.md
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,7 @@ Initialize an Ad object.

---

<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>
<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>

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

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

---

<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>
<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>

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

Expand Down Expand Up @@ -374,7 +374,7 @@ List ads that meet the filters provided:

---

<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>
<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>

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

Expand Down
30 changes: 19 additions & 11 deletions docs/pinterest/ads.campaigns.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,14 @@ Initialize a Campaign object.



---

#### <kbd>property</kbd> summary_status





---

#### <kbd>property</kbd> tracking_urls
Expand Down Expand Up @@ -170,7 +178,7 @@ Initialize a Campaign object.

---

<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>
<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>

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

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

---

<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>
<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>

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

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

---

<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>
<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>

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

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

---

<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>
<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>

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

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

---

<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>
<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>

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

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

---

<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>
<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>

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

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

---

<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>
<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>

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

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

---

<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>
<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>

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

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

---

<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>
<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>

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

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

---

<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>
<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>

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

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

---

<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>
<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>

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

Expand Down
Loading

0 comments on commit 87c8581

Please sign in to comment.