chore: update auto generated api

whitebox-co · Feb 1, 2023 · 7e775d9 · 7e775d9
1 parent 36987c7
commit 7e775d9
Show file tree

Hide file tree

Showing 23 changed files with 4,012 additions and 4,821 deletions.
diff --git a/docs/schemas/attribution.json b/docs/schemas/attribution.json
@@ -453,6 +453,18 @@
         "description": "The identifier of a publisher that does not support macros.",
         "type": "string"
       },
+      "PublishersResponse": {
+        "type": "object",
+        "properties": {
+          "publisher": {
+            "description": "A list of publishers.",
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Publisher"
+            }
+          }
+        }
+      },
       "MaaSError": {
         "description": "The error response object.",
         "type": "object",
@@ -467,30 +479,12 @@
           }
         }
       },
-      "PublishersResponse": {
-        "type": "object",
-        "properties": {
-          "publisher": {
-            "description": "A list of publishers.",
-            "type": "array",
-            "items": {
-              "$ref": "#/components/schemas/Publisher"
-            }
-          }
-        }
-      },
       "macroPublishers": {
         "type": "array",
         "items": {
           "$ref": "#/components/schemas/macroPublisher"
         }
       },
-      "nonMacroPublishers": {
-        "type": "array",
-        "items": {
-          "$ref": "#/components/schemas/nonMacroPublisher"
-        }
-      },
       "Publisher": {
         "type": "object",
         "properties": {
@@ -520,6 +514,12 @@
           }
         }
       },
+      "nonMacroPublishers": {
+        "type": "array",
+        "items": {
+          "$ref": "#/components/schemas/nonMacroPublisher"
+        }
+      },
       "attributionTagMap": {
         "description": "An object representing the association between a publisher identifier and an attribution tag.",
         "additionalProperties": {

diff --git a/docs/schemas/authorization-manager-account.json b/docs/schemas/authorization-manager-account.json
@@ -191,8 +191,8 @@
         ]
       },
       "get": {
-        "summary": "Returns all Manager accounts that a given Amazon Advertising user has access to.",
-        "description": "Returns all [Manager accounts](https://advertising.amazon.com/help?ref_=a20m_us_blog_whtsnewfb2020_040120#GU3YDB26FR7XT3C8) that a user has access to, along with metadata for all of the Amazon Advertising accounts that are linked to the Manager account.",
+        "summary": "Returns all manager accounts that a given Amazon Ads user has access to.",
+        "description": "Returns all [manager accounts](https://advertising.amazon.com/help?ref_=a20m_us_blog_whtsnewfb2020_040120#GU3YDB26FR7XT3C8) that a user has access to, along with metadata for the Amazon Ads accounts that are linked to each manager account. NOTE: A maximum of 50 linked accounts are returned for each manager account.",
         "operationId": "getManagerAccountsForUser",
         "responses": {
           "200": {
@@ -407,6 +407,7 @@
             "type": "string"
           },
           "linkedAccounts": {
+            "maxItems": 50,
             "type": "array",
             "items": {
               "$ref": "#/components/schemas/Account"
@@ -481,6 +482,19 @@
           "MARKETING_CLOUD"
         ]
       },
+      "GetManagerAccountsResponse": {
+        "description": "Response containing a list of Manager Accounts that a given user has access to.",
+        "type": "object",
+        "properties": {
+          "managerAccounts": {
+            "description": "List of Manager Accounts that the user has access to",
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ManagerAccount"
+            }
+          }
+        }
+      },
       "AccountToUpdate": {
         "description": "String identifier for an Amazon Advertising account or advertiser. `ACCOUNT_ID` is an identifier that is returned by the [Profiles resource](https://advertising.amazon.com/API/docs/en-us/reference/2/profiles#/Profiles/listProfiles), within the `AccountInfo.id` data member. `ACCOUNT_ID` may begin with the string `\"ENTITY\"`.\n`DSP_ADVERTISER_ID` is an identifier for a DSP advertiser, which is returned by the [DSP resource](https://advertising.amazon.com/API/docs/en-us/dsp-advertiser/#/Advertiser/get_dsp_advertisers).",
         "type": "object",
@@ -506,19 +520,6 @@
           }
         }
       },
-      "GetManagerAccountsResponse": {
-        "description": "Response containing a list of Manager Accounts that a given user has access to.",
-        "type": "object",
-        "properties": {
-          "managerAccounts": {
-            "description": "List of Manager Accounts that the user has access to",
-            "type": "array",
-            "items": {
-              "$ref": "#/components/schemas/ManagerAccount"
-            }
-          }
-        }
-      },
       "UpdateAdvertisingAccountsInManagerAccountResponse": {
         "description": "Link/Unlink Advertising account or advertiser Response",
         "type": "object",

diff --git a/docs/schemas/common-audiences.json b/docs/schemas/common-audiences.json
@@ -8,6 +8,10 @@
     "/audiences/list": {
       "post": {
         "summary": "Gets audience segments based on filters",
+        "description": "Returns a list of audience segments for an advertiser. The result set can be filtered by providing an array of Filter objects. Each item in the resulting set will match all specified filters.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]",
+        "tags": [
+          "Discovery"
+        ],
         "requestBody": {
           "content": {
             "application/json": {
@@ -18,7 +22,6 @@
           },
           "required": false
         },
-        "description": "Returns a list of audience segments for an advertiser. The result set can be filtered by providing an array of Filter objects. Each item in the resulting set will match all specified filters.\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]",
         "operationId": "listAudiences",
         "responses": {
           "200": {
@@ -127,15 +130,16 @@
             "name": "maxResults",
             "description": "Sets the maximum number of audiences in the returned array. Use in conjunction with the `nextToken` parameter to control pagination. For example, supplying maxResults=20 with a previously returned token will fetch up to the next 20 items. In some cases, fewer items may be returned."
           }
-        ],
-        "tags": [
-          "Discovery"
         ]
       }
     },
     "/audiences/taxonomy/list": {
       "post": {
         "summary": "Browse the taxonomy of audience categories",
+        "description": "Returns a list of audience categories for a given category path\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]",
+        "tags": [
+          "Discovery"
+        ],
         "requestBody": {
           "content": {
             "application/json": {
@@ -146,7 +150,6 @@
           },
           "required": true
         },
-        "description": "Returns a list of audience categories for a given category path\n\n**Requires one of these permissions**:\n[\"advertiser_campaign_edit\",\"advertiser_campaign_view\"]",
         "operationId": "fetchTaxonomy",
         "responses": {
           "200": {
@@ -246,9 +249,6 @@
             "name": "maxResults",
             "description": "Sets the maximum number of categories in the returned array. Use in conjunction with the `nextToken` parameter to control pagination. For example, supplying maxResults=20 with a previously returned token will fetch up to the next 20 items. In some cases, fewer items may be returned."
           }
-        ],
-        "tags": [
-          "Discovery"
         ]
       }
     }
@@ -291,33 +291,33 @@
           }
         }
       },
-      "FetchTaxonomyRequestBodyV1": {
-        "description": "The response data will have the categories that are under the given path, and main categories will be returned if no path is specified. The response data also depends on the adType specified here since ad programs may support targeting audiences in certain categories.",
+      "AudienceFilterV1": {
         "type": "object",
         "properties": {
-          "adType": {
-            "type": "string",
-            "enum": [
-              "DSP",
-              "SD"
-            ]
+          "field": {
+            "description": "Field to filter by. Supported enums are 'audienceName', 'category', 'categoryPath', 'audienceId' and 'status'. The 'category' enum returns all audiences under a high-level category, whereas the 'categoryPath' enum expects a path of nodes in the taxonomy tree and returns audiences attached directly to the node at the specified path.",
+            "type": "string"
           },
-          "categoryPath": {
+          "values": {
             "type": "array",
             "items": {
               "type": "string"
             }
           }
         }
       },
-      "AudienceFilterV1": {
+      "FetchTaxonomyRequestBodyV1": {
+        "description": "The response data will have the categories that are under the given path, and main categories will be returned if no path is specified. The response data also depends on the adType specified here since ad programs may support targeting audiences in certain categories.",
         "type": "object",
         "properties": {
-          "field": {
-            "description": "Field to filter by. Supported enums are 'audienceName', 'category', 'categoryPath' and 'audienceId'. The 'category' enum returns all audiences under a high-level category, whereas the 'categoryPath' enum expects a path of nodes in the taxonomy tree and returns audiences attached directly to the node at the specified path.",
-            "type": "string"
+          "adType": {
+            "type": "string",
+            "enum": [
+              "DSP",
+              "SD"
+            ]
           },
-          "values": {
+          "categoryPath": {
             "type": "array",
             "items": {
               "type": "string"
@@ -495,25 +495,6 @@
           }
         }
       },
-      "AudienceSubErrorV1": {
-        "description": "The sub error object.",
-        "type": "object",
-        "required": [
-          "errorType",
-          "message"
-        ],
-        "properties": {
-          "fieldName": {
-            "type": "string"
-          },
-          "errorType": {
-            "type": "string"
-          },
-          "message": {
-            "type": "string"
-          }
-        }
-      },
       "FetchTaxonomyResponseV1": {
         "type": "object",
         "properties": {
@@ -534,6 +515,25 @@
           }
         }
       },
+      "AudienceSubErrorV1": {
+        "description": "The sub error object.",
+        "type": "object",
+        "required": [
+          "errorType",
+          "message"
+        ],
+        "properties": {
+          "fieldName": {
+            "type": "string"
+          },
+          "errorType": {
+            "type": "string"
+          },
+          "message": {
+            "type": "string"
+          }
+        }
+      },
       "FetchTaxonomyNodeV1": {
         "type": "object",
         "properties": {

diff --git a/docs/schemas/common-billing.json b/docs/schemas/common-billing.json
@@ -437,12 +437,9 @@
         "type": "object",
         "required": [
           "amountDue",
-          "dueDate",
           "fromDate",
           "id",
           "invoiceDate",
-          "paymentMethod",
-          "purchaseOrderNumber",
           "remainingAmountDue",
           "status",
           "toDate"
@@ -1249,27 +1246,6 @@
           "INTERNAL_ERROR"
         ]
       },
-      "governmentInvoiceInformation": {
-        "description": "Government invoice data is provided in marketplaces (such as Italy or India) that require a government-assigned invoice ID. This object contains this identifier, along with the type of transaction from a government standpoint (which will always be a debit in the case of an invoice).\n",
-        "title": "Government Invoice Information",
-        "type": "object",
-        "properties": {
-          "transactionType": {
-            "type": "string",
-            "enum": [
-              "DEBIT",
-              "CREDIT"
-            ]
-          },
-          "countryCode": {
-            "$ref": "#/components/schemas/countryCode"
-          },
-          "governmentInvoiceId": {
-            "description": "Government generated ID",
-            "type": "string"
-          }
-        }
-      },
       "address": {
         "title": "Address",
         "type": "object",
@@ -1321,6 +1297,27 @@
           }
         }
       },
+      "governmentInvoiceInformation": {
+        "description": "Government invoice data is provided in marketplaces (such as Italy or India) that require a government-assigned invoice ID. This object contains this identifier, along with the type of transaction from a government standpoint (which will always be a debit in the case of an invoice).\n",
+        "title": "Government Invoice Information",
+        "type": "object",
+        "properties": {
+          "transactionType": {
+            "type": "string",
+            "enum": [
+              "DEBIT",
+              "CREDIT"
+            ]
+          },
+          "countryCode": {
+            "$ref": "#/components/schemas/countryCode"
+          },
+          "governmentInvoiceId": {
+            "description": "Government generated ID",
+            "type": "string"
+          }
+        }
+      },
       "advertiserMarketplace": {
         "type": "object",
         "title": "Advertiser Marketplace",

diff --git a/docs/schemas/common-eligibility.json b/docs/schemas/common-eligibility.json
@@ -455,7 +455,7 @@
         ]
       },
       "ProgramEligibilityRequestContent": {
-        "description": "A request to evaluate account level eligibility for Amazon ad programs (Sponsored Products, Sponsored Brands, Sponsored Display, Stores, etc).",
+        "description": "A request to evaluate account level eligibility for Amazon ad programs (Sponsored Products, Sponsored Brands, Sponsored Display, Stores, DirectToConsumer, Amazon Attribution, etc).",
         "type": "object",
         "properties": {
           "skipChecks": {
@@ -640,7 +640,7 @@
         }
       },
       "EligibilityStatusMap": {
-        "description": "This is a map that will be key'd on the ad program (SB/SD); the value will be an eligibility object.",
+        "description": "This is a map that will be key'd on the ad program (SB/SD/DTC/MAAS); the value will be an eligibility object.",
         "additionalProperties": {
           "$ref": "#/components/schemas/EligibilityStatusDetail"
         },

diff --git a/docs/schemas/common-localization.json b/docs/schemas/common-localization.json
@@ -486,6 +486,10 @@
     "/targetingExpression/localize": {
       "post": {
         "summary": "Localizes targeting expressions used for advertising targeting.",
+        "description": "Localizes (maps) targeting expressions from a source marketplace to one or more target marketplaces. V3: Providing locales in your request's source details or target details, will now return in &lt;sourceField&gt; and &lt;targetField&gt; respectively the translations of your targeting expressions.",
+        "tags": [
+          "Targeting Expression Localization"
+        ],
         "requestBody": {
           "description": "Contains a list of targeting expressions to localize.",
           "content": {
@@ -502,7 +506,6 @@
           },
           "required": true
         },
-        "description": "Localizes (maps) targeting expressions from a source marketplace to one or more target marketplaces. V3: Providing locales in your request's source details or target details, will now return in &lt;sourceField&gt; and &lt;targetField&gt; respectively the translations of your targeting expressions.",
         "operationId": "getLocalizedTargetingExpression",
         "responses": {
           "200": {
@@ -743,9 +746,6 @@
             "description": "The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header and choose profile id `profileId` from the response to pass it as input.",
             "required": true
           }
-        ],
-        "tags": [
-          "Targeting Expression Localization"
         ]
       }
     }