Skip to content

Commit

Permalink
feature: add regenerated files (#26)
Browse files Browse the repository at this point in the history
  • Loading branch information
dfana01 authored Mar 1, 2023
1 parent 50f3f06 commit 462c43c
Show file tree
Hide file tree
Showing 59 changed files with 1,643 additions and 303 deletions.
3 changes: 3 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -295,6 +295,7 @@ docs/OauthAccessTokenRequestRefreshAllOf.md
docs/OauthAccessTokenResponse.md
docs/OauthAccessTokenResponseCode.md
docs/OauthAccessTokenResponseCodeAllOf.md
docs/OauthAccessTokenResponseIntegrationRefresh.md
docs/OauthAccessTokenResponseRefresh.md
docs/OauthApi.md
docs/ObjectiveType.md
Expand Down Expand Up @@ -702,6 +703,7 @@ openapi_generated/pinterest_client/model/oauth_access_token_request_refresh_all_
openapi_generated/pinterest_client/model/oauth_access_token_response.py
openapi_generated/pinterest_client/model/oauth_access_token_response_code.py
openapi_generated/pinterest_client/model/oauth_access_token_response_code_all_of.py
openapi_generated/pinterest_client/model/oauth_access_token_response_integration_refresh.py
openapi_generated/pinterest_client/model/oauth_access_token_response_refresh.py
openapi_generated/pinterest_client/model/objective_type.py
openapi_generated/pinterest_client/model/optimization_goal_metadata.py
Expand Down Expand Up @@ -1088,6 +1090,7 @@ test/test_oauth_access_token_request_refresh_all_of.py
test/test_oauth_access_token_response.py
test/test_oauth_access_token_response_code.py
test/test_oauth_access_token_response_code_all_of.py
test/test_oauth_access_token_response_integration_refresh.py
test/test_oauth_access_token_response_refresh.py
test/test_oauth_api.py
test/test_objective_type.py
Expand Down
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Pinterest's REST API
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 5.8.0
- Package version: 0.1.6
- Package version: 0.1.7
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://developers.pinterest.com/](https://developers.pinterest.com/)

Expand Down Expand Up @@ -242,11 +242,15 @@ Class | Method | HTTP request | Description
*UserAccountApi* | [**follow_user_update**](https://github.com/pinterest/pinterest-python-generated-api-client/blob/main/docs/UserAccountApi.md#follow_user_update) | **POST** /user_account/following/{username} | Follow user
*UserAccountApi* | [**followers_list**](https://github.com/pinterest/pinterest-python-generated-api-client/blob/main/docs/UserAccountApi.md#followers_list) | **GET** /user_account/followers | List followers
*UserAccountApi* | [**linked_business_accounts_get**](https://github.com/pinterest/pinterest-python-generated-api-client/blob/main/docs/UserAccountApi.md#linked_business_accounts_get) | **GET** /user_account/businesses | List linked businesses
*UserAccountApi* | [**unverify_website_delete**](https://github.com/pinterest/pinterest-python-generated-api-client/blob/main/docs/UserAccountApi.md#unverify_website_delete) | **DELETE** /user_account/websites | Unverify website
*UserAccountApi* | [**user_account_analytics**](https://github.com/pinterest/pinterest-python-generated-api-client/blob/main/docs/UserAccountApi.md#user_account_analytics) | **GET** /user_account/analytics | Get user account analytics
*UserAccountApi* | [**user_account_analytics_top_pins**](https://github.com/pinterest/pinterest-python-generated-api-client/blob/main/docs/UserAccountApi.md#user_account_analytics_top_pins) | **GET** /user_account/analytics/top_pins | Get user account top pins analytics
*UserAccountApi* | [**user_account_analytics_top_video_pins**](https://github.com/pinterest/pinterest-python-generated-api-client/blob/main/docs/UserAccountApi.md#user_account_analytics_top_video_pins) | **GET** /user_account/analytics/top_video_pins | Get user account top video pins analytics
*UserAccountApi* | [**user_account_get**](https://github.com/pinterest/pinterest-python-generated-api-client/blob/main/docs/UserAccountApi.md#user_account_get) | **GET** /user_account | Get user account
*UserAccountApi* | [**user_following_get**](https://github.com/pinterest/pinterest-python-generated-api-client/blob/main/docs/UserAccountApi.md#user_following_get) | **GET** /user_account/following | List following
*UserAccountApi* | [**user_websites_get**](https://github.com/pinterest/pinterest-python-generated-api-client/blob/main/docs/UserAccountApi.md#user_websites_get) | **GET** /user_account/websites | Get user websites
*UserAccountApi* | [**verify_website_update**](https://github.com/pinterest/pinterest-python-generated-api-client/blob/main/docs/UserAccountApi.md#verify_website_update) | **POST** /user_account/websites | Verify website
*UserAccountApi* | [**website_verification_get**](https://github.com/pinterest/pinterest-python-generated-api-client/blob/main/docs/UserAccountApi.md#website_verification_get) | **GET** /user_account/websites/verification | Get user verification code for website claiming


## Documentation For Models
Expand Down Expand Up @@ -528,6 +532,7 @@ Class | Method | HTTP request | Description
- [OauthAccessTokenResponse](https://github.com/pinterest/pinterest-python-generated-api-client/blob/main/docs/OauthAccessTokenResponse.md)
- [OauthAccessTokenResponseCode](https://github.com/pinterest/pinterest-python-generated-api-client/blob/main/docs/OauthAccessTokenResponseCode.md)
- [OauthAccessTokenResponseCodeAllOf](https://github.com/pinterest/pinterest-python-generated-api-client/blob/main/docs/OauthAccessTokenResponseCodeAllOf.md)
- [OauthAccessTokenResponseIntegrationRefresh](https://github.com/pinterest/pinterest-python-generated-api-client/blob/main/docs/OauthAccessTokenResponseIntegrationRefresh.md)
- [OauthAccessTokenResponseRefresh](https://github.com/pinterest/pinterest-python-generated-api-client/blob/main/docs/OauthAccessTokenResponseRefresh.md)
- [ObjectiveType](https://github.com/pinterest/pinterest-python-generated-api-client/blob/main/docs/ObjectiveType.md)
- [OptimizationGoalMetadata](https://github.com/pinterest/pinterest-python-generated-api-client/blob/main/docs/OptimizationGoalMetadata.md)
Expand Down
6 changes: 3 additions & 3 deletions docs/AdGroupCommon.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,16 @@ Name | Type | Description | Notes
**status** | **str** | Ad group/entity status. | [optional]
**budget_in_micro_currency** | **int, none_type** | Budget in micro currency. This field is **REQUIRED** for non-CBO (campaign budget optimization) campaigns. A CBO campaign automatically generates ad group budgets from its campaign budget to maximize campaign outcome. A CBO campaign is limited to 70 or less ad groups. | [optional]
**bid_in_micro_currency** | **int, none_type** | Bid price in micro currency. This field is **REQUIRED** for the following campaign objective_type/billable_event combinations: AWARENESS/IMPRESSION, CONSIDERATION/CLICKTHROUGH, CATALOG_SALES/CLICKTHROUGH, VIDEO_VIEW/VIDEO_V_50_MRC. | [optional]
**optimization_goal_metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | Optimization goals for objective-based performance campaigns. | [optional]
**budget_type** | [**BudgetType**](BudgetType.md) | | [optional]
**optimization_goal_metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | Optimization goals for objective-based performance campaigns. **REQUIRED** when campaign's `objective_type` is set to `\"WEB_CONVERSION\"`. | [optional]
**budget_type** | **str** | | [optional]
**start_time** | **int, none_type** | Ad group start time. Unix timestamp in seconds. Defaults to current time. | [optional]
**end_time** | **int, none_type** | Ad group end time. Unix timestamp in seconds. | [optional]
**targeting_spec** | **{str: ([str],)}** | Ad group targeting specification defining the ad group target audience. For example, '{\"APPTYPE\":[\"iphone\"], \"GENDER\":[\"male\"], \"LOCALE\":[\"en-US\"], \"LOCATION\":[\"501\"], \"AGE_BUCKET\":[\"25-34\"]}' | [optional]
**lifetime_frequency_cap** | **int** | Set a limit to the number of times a promoted pin from this campaign can be impressed by a pinner within the past rolling 30 days. Only available for CPM (cost per mille (1000 impressions)) ad groups. A CPM ad group has an IMPRESSION <a href=\"https://developers.pinterest.com/docs/redoc/#section/Billable-event\">billable_event</a> value. This field **REQUIRES** the `end_time` field. | [optional]
**tracking_urls** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | Third-party tracking URLs.<br> JSON object with the format: {\"<a href=\"https://developers.pinterest.com/docs/redoc/#section/Tracking-URL-event\">Tracking event enum</a>\":[URL string array],...}<br> For example: {\"impression\": [\"URL1\", \"URL2\"], \"click\": [\"URL1\", \"URL2\", \"URL3\"]}.<br>Up to three tracking URLs are supported for each event type. Tracking URLs set at the ad group or ad level can override those set at the campaign level. May be null. Pass in an empty object - {} - to remove tracking URLs.<br><br> For more information, see <a href=\"https://help.pinterest.com/en/business/article/third-party-and-dynamic-tracking\" target=\"_blank\">Third-party and dynamic tracking</a>. | [optional]
**auto_targeting_enabled** | **bool, none_type** | Enable auto-targeting for ad group. Also known as <a href=\"https://help.pinterest.com/en/business/article/expanded-targeting\" target=\"_blank\">\"expanded targeting\"</a>. | [optional]
**placement_group** | **str** | <a href=\"https://developers.pinterest.com/docs/redoc/#section/Placement-group\">Placement group</a>. | [optional]
**pacing_delivery_type** | **str** | Pacing delivery type. With ACCELERATED, an ad group budget is spent as fast as possible. With STANDARD, an ad group budget is spent smoothly over a day. | [optional]
**pacing_delivery_type** | **str** | | [optional]
**campaign_id** | **str** | Campaign ID of the ad group. | [optional]
**billable_event** | [**ActionType**](ActionType.md) | | [optional]
**bid_strategy_type** | **str, none_type** | Bid strategy type | [optional]
Expand Down
8 changes: 4 additions & 4 deletions docs/AdGroupCreateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,16 @@ Name | Type | Description | Notes
**status** | **str** | Ad group/entity status. | [optional]
**budget_in_micro_currency** | **int, none_type** | Budget in micro currency. This field is **REQUIRED** for non-CBO (campaign budget optimization) campaigns. A CBO campaign automatically generates ad group budgets from its campaign budget to maximize campaign outcome. A CBO campaign is limited to 70 or less ad groups. | [optional]
**bid_in_micro_currency** | **int, none_type** | Bid price in micro currency. This field is **REQUIRED** for the following campaign objective_type/billable_event combinations: AWARENESS/IMPRESSION, CONSIDERATION/CLICKTHROUGH, CATALOG_SALES/CLICKTHROUGH, VIDEO_VIEW/VIDEO_V_50_MRC. | [optional]
**optimization_goal_metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | Optimization goals for objective-based performance campaigns. | [optional]
**budget_type** | [**BudgetType**](BudgetType.md) | | [optional]
**optimization_goal_metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | Optimization goals for objective-based performance campaigns. **REQUIRED** when campaign's `objective_type` is set to `\"WEB_CONVERSION\"`. | [optional]
**budget_type** | **str** | | [optional] if omitted the server will use the default value of "DAILY"
**start_time** | **int, none_type** | Ad group start time. Unix timestamp in seconds. Defaults to current time. | [optional]
**end_time** | **int, none_type** | Ad group end time. Unix timestamp in seconds. | [optional]
**targeting_spec** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | | [optional]
**lifetime_frequency_cap** | **int** | Set a limit to the number of times a promoted pin from this campaign can be impressed by a pinner within the past rolling 30 days. Only available for CPM (cost per mille (1000 impressions)) ad groups. A CPM ad group has an IMPRESSION <a href=\"https://developers.pinterest.com/docs/redoc/#section/Billable-event\">billable_event</a> value. This field **REQUIRES** the `end_time` field. | [optional]
**tracking_urls** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | Third-party tracking URLs.<br> JSON object with the format: {\"<a href=\"https://developers.pinterest.com/docs/redoc/#section/Tracking-URL-event\">Tracking event enum</a>\":[URL string array],...}<br> For example: {\"impression\": [\"URL1\", \"URL2\"], \"click\": [\"URL1\", \"URL2\", \"URL3\"]}.<br>Up to three tracking URLs are supported for each event type. Tracking URLs set at the ad group or ad level can override those set at the campaign level. May be null. Pass in an empty object - {} - to remove tracking URLs.<br><br> For more information, see <a href=\"https://help.pinterest.com/en/business/article/third-party-and-dynamic-tracking\" target=\"_blank\">Third-party and dynamic tracking</a>. | [optional]
**auto_targeting_enabled** | **bool, none_type** | Enable auto-targeting for ad group. Also known as <a href=\"https://help.pinterest.com/en/business/article/expanded-targeting\" target=\"_blank\">\"expanded targeting\"</a>. | [optional]
**auto_targeting_enabled** | **bool** | | [optional] if omitted the server will use the default value of True
**placement_group** | **str** | <a href=\"https://developers.pinterest.com/docs/redoc/#section/Placement-group\">Placement group</a>. | [optional]
**pacing_delivery_type** | **str** | Pacing delivery type. With ACCELERATED, an ad group budget is spent as fast as possible. With STANDARD, an ad group budget is spent smoothly over a day. | [optional]
**pacing_delivery_type** | **str** | | [optional] if omitted the server will use the default value of "STANDARD"
**bid_strategy_type** | **str, none_type** | Bid strategy type | [optional]
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

Expand Down
3 changes: 3 additions & 0 deletions docs/AdGroupCreateRequestAllOf.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**targeting_spec** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | | [optional]
**pacing_delivery_type** | **str** | | [optional] if omitted the server will use the default value of "STANDARD"
**auto_targeting_enabled** | **bool** | | [optional] if omitted the server will use the default value of True
**budget_type** | **str** | | [optional] if omitted the server will use the default value of "DAILY"
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
Expand Down
6 changes: 3 additions & 3 deletions docs/AdGroupResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,16 @@ Name | Type | Description | Notes
**status** | **str** | Ad group/entity status. | [optional]
**budget_in_micro_currency** | **int, none_type** | Budget in micro currency. This field is **REQUIRED** for non-CBO (campaign budget optimization) campaigns. A CBO campaign automatically generates ad group budgets from its campaign budget to maximize campaign outcome. A CBO campaign is limited to 70 or less ad groups. | [optional]
**bid_in_micro_currency** | **int, none_type** | Bid price in micro currency. This field is **REQUIRED** for the following campaign objective_type/billable_event combinations: AWARENESS/IMPRESSION, CONSIDERATION/CLICKTHROUGH, CATALOG_SALES/CLICKTHROUGH, VIDEO_VIEW/VIDEO_V_50_MRC. | [optional]
**optimization_goal_metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | Optimization goals for objective-based performance campaigns. | [optional]
**budget_type** | [**BudgetType**](BudgetType.md) | | [optional]
**optimization_goal_metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | Optimization goals for objective-based performance campaigns. **REQUIRED** when campaign's `objective_type` is set to `\"WEB_CONVERSION\"`. | [optional]
**budget_type** | **str** | | [optional]
**start_time** | **int, none_type** | Ad group start time. Unix timestamp in seconds. Defaults to current time. | [optional]
**end_time** | **int, none_type** | Ad group end time. Unix timestamp in seconds. | [optional]
**targeting_spec** | **{str: ([str],)}** | Ad group targeting specification defining the ad group target audience. For example, '{\"APPTYPE\":[\"iphone\"], \"GENDER\":[\"male\"], \"LOCALE\":[\"en-US\"], \"LOCATION\":[\"501\"], \"AGE_BUCKET\":[\"25-34\"]}' | [optional]
**lifetime_frequency_cap** | **int** | Set a limit to the number of times a promoted pin from this campaign can be impressed by a pinner within the past rolling 30 days. Only available for CPM (cost per mille (1000 impressions)) ad groups. A CPM ad group has an IMPRESSION <a href=\"https://developers.pinterest.com/docs/redoc/#section/Billable-event\">billable_event</a> value. This field **REQUIRES** the `end_time` field. | [optional]
**tracking_urls** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | Third-party tracking URLs.<br> JSON object with the format: {\"<a href=\"https://developers.pinterest.com/docs/redoc/#section/Tracking-URL-event\">Tracking event enum</a>\":[URL string array],...}<br> For example: {\"impression\": [\"URL1\", \"URL2\"], \"click\": [\"URL1\", \"URL2\", \"URL3\"]}.<br>Up to three tracking URLs are supported for each event type. Tracking URLs set at the ad group or ad level can override those set at the campaign level. May be null. Pass in an empty object - {} - to remove tracking URLs.<br><br> For more information, see <a href=\"https://help.pinterest.com/en/business/article/third-party-and-dynamic-tracking\" target=\"_blank\">Third-party and dynamic tracking</a>. | [optional]
**auto_targeting_enabled** | **bool, none_type** | Enable auto-targeting for ad group. Also known as <a href=\"https://help.pinterest.com/en/business/article/expanded-targeting\" target=\"_blank\">\"expanded targeting\"</a>. | [optional]
**placement_group** | **str** | <a href=\"https://developers.pinterest.com/docs/redoc/#section/Placement-group\">Placement group</a>. | [optional]
**pacing_delivery_type** | **str** | Pacing delivery type. With ACCELERATED, an ad group budget is spent as fast as possible. With STANDARD, an ad group budget is spent smoothly over a day. | [optional]
**pacing_delivery_type** | **str** | | [optional]
**campaign_id** | **str** | Campaign ID of the ad group. | [optional]
**billable_event** | [**ActionType**](ActionType.md) | | [optional]
**bid_strategy_type** | **str, none_type** | Bid strategy type | [optional]
Expand Down
Loading

0 comments on commit 462c43c

Please sign in to comment.