pinterest · gilderlane · Feb 16, 2023 · Mar 6, 2023 · Mar 23, 2023 · Mar 23, 2023
diff --git a/.github/workflows/cron_integrationtests.yml b/.github/workflows/cron_integrationtests.yml
@@ -0,0 +1,37 @@
+name: Cron Integration Tests
+
+on:
+  schedule:
+    - cron: "0 17 * * *"
+
+jobs:
+  build:
+    environment: integ
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8"]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Run all integration tests
+        env:
+          PINTEREST_REFRESH_ACCESS_TOKEN: ${{ secrets.CI_REFRESH_ACCESS_TOKEN }}
+          PINTEREST_APP_SECRET: ${{ secrets.CI_APP_SECRET }}
+          PINTEREST_APP_ID: ${{ secrets.CI_APP_ID }}
+          PINTEREST_API_URI: ${{ secrets.CI_HOST_URI }}
+          CONVERSION_ACCESS_TOKEN: ${{ secrets.CI_CONVERSION_ACCESS_TOKEN }}
+          DEFAULT_BOARD_ID: ${{ secrets.CI_DEFAULT_BOARD_ID }}
+          DEFAULT_BOARD_NAME: ${{ secrets.CI_DEFAULT_BOARD_NAME }}
+          DEFAULT_PIN_ID: ${{ secrets.CI_DEFAULT_PIN_ID }}
+          DEFAULT_BOARD_SECTION_ID: ${{ secrets.CI_DEFAULT_BOARD_SECTION_ID }}
+          OWNER_USER_ID: ${{ secrets.CI_OWNER_USER_ID }}
+          DEFAULT_AD_ACCOUNT_ID: ${{ secrets.CI_DEFAULT_AD_ACCOUNT_ID }}
+        run: |
+          python -m pip install --upgrade pip
+          make install_dev
+          make integration_tests
diff --git a/.github/workflows/integrationtests.yml b/.github/workflows/integrationtests.yml
@@ -18,17 +18,7 @@ jobs:
           python-version: ${{ matrix.python-version }}
       - name: Run all integration tests
         env:
-          PINTEREST_REFRESH_ACCESS_TOKEN: ${{ secrets.CI_REFRESH_ACCESS_TOKEN }}
-          PINTEREST_APP_SECRET: ${{ secrets.CI_APP_SECRET }}
-          PINTEREST_APP_ID: ${{ secrets.CI_APP_ID }}
-          PINTEREST_API_URI: ${{ secrets.CI_HOST_URI }}
-          CONVERSION_ACCESS_TOKEN: ${{ secrets.CI_CONVERSION_ACCESS_TOKEN }}
-          DEFAULT_BOARD_ID: ${{ secrets.CI_DEFAULT_BOARD_ID }}
-          DEFAULT_BOARD_NAME: ${{ secrets.CI_DEFAULT_BOARD_NAME }}
-          DEFAULT_PIN_ID: ${{ secrets.CI_DEFAULT_PIN_ID }}
-          DEFAULT_BOARD_SECTION_ID: ${{ secrets.CI_DEFAULT_BOARD_SECTION_ID }}
-          OWNER_USER_ID: ${{ secrets.CI_OWNER_USER_ID }}
-          DEFAULT_AD_ACCOUNT_ID: ${{ secrets.CI_DEFAULT_AD_ACCOUNT_ID }}
+          PINTEREST_JSON_ENV_VARIABLES: ${{ secrets.CI_INTEG_TEST_JSON }}
         run: |
           python -m pip install --upgrade pip
           make install_dev

diff --git a/.gitignore b/.gitignore
@@ -69,4 +69,5 @@ target/
 .idea
 
 # Config files
-.env
+.env
+http_logs.txt
diff --git a/Makefile b/Makefile
@@ -1,3 +1,5 @@
+.PHONY: integration_tests lint unit_tests clean_organic_data
+
 install:
 	@echo pip install
 	pip install -r requirements.txt
@@ -13,9 +15,13 @@ unit_tests:
 package_test:
 	./package_test/run.sh
 
-integration_tests:
+clean_organic_data:
+	@echo cleaning organic data...
+	python -m pytest ./integration_tests/clean_organic_data.py
+
+integration_tests: clean_organic_data
 	@echo integration tests...
-	python -m pytest --cov ./pinterest/ --cov-branch ./integration_tests/ --cov-report term-missing
+	python -m pytest --ignore=clean_organic_data.py --cov ./pinterest/ --cov-branch ./integration_tests/ --cov-report term-missing
 
 clean: clean-build clean-pyc ## Clean
 
@@ -55,4 +61,4 @@ flake:
 	flake8 . --count --show-source --statistics
 	flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
 
-lint: pylint flake
+lint: pylint flake
diff --git a/docs/pinterest/README.md b/docs/pinterest/README.md
@@ -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
@@ -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
@@ -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.
diff --git a/docs/pinterest/ads.ad_accounts.md b/docs/pinterest/ads.ad_accounts.md
@@ -40,6 +40,14 @@ Initialize an object of an AdAccount.
 
 
 
+---
+
+#### <kbd>property</kbd> created_time
+
+
+
+
+
 ---
 
 #### <kbd>property</kbd> currency
@@ -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`
 
@@ -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`
 
@@ -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`
 
@@ -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`
 

diff --git a/docs/pinterest/ads.ad_groups.md b/docs/pinterest/ads.ad_groups.md
@@ -161,6 +161,14 @@ Initialize an AdGroup object.
 
 
 
+---
+
+#### <kbd>property</kbd> optimization_goal_metadata
+
+
+
+
+
 ---
 
 #### <kbd>property</kbd> pacing_delivery_type
@@ -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`
 
@@ -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`
 
@@ -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`
 
@@ -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`
 
@@ -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`
 
@@ -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`
 

diff --git a/docs/pinterest/ads.ads.md b/docs/pinterest/ads.ads.md
@@ -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`
 
@@ -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`
 
@@ -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`
 

diff --git a/docs/pinterest/ads.campaigns.md b/docs/pinterest/ads.campaigns.md
@@ -142,6 +142,14 @@ Initialize a Campaign object.
 
 
 
+---
+
+#### <kbd>property</kbd> summary_status
+
+
+
+
+
 ---
 
 #### <kbd>property</kbd> tracking_urls
@@ -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`
 
@@ -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`
 
@@ -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`
 
@@ -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`
 
@@ -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`
 
@@ -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`
 
@@ -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`
 
@@ -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`
 
@@ -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`
 
@@ -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`
 
@@ -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`
-Original file line number
+Diff line change
@@ Expand Up / @@ -69,4 +69,5 @@ target/ @@
     .idea
     # Config files
-    .env
+    .env
+    http_logs.txt