Od 1049 amazon advertising service calls

CHANGELOG.md

@@ -2,6 +2,14 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.0.3] - 2023-10-11
+
+### Added
+- API endpoints for Amazon Advertising Profile lists and Amazon Advertising Profile Brand list
+
+### Fixed
+- Fixed typos and html formatting bugs.
+
 ## [0.0.2] - 2023-10-11
 
 ### Added

README.md

@@ -22,6 +22,8 @@ Welcome to the Openbridge API documentation. This guide is designed to help deve
   - [Authorization API](#authorization-api)
   - [Account API](#account-api)
   - [Service API](#service-api)
+    - [Amazon Advertising Profiles](#amazon-advertising-profiles)
+    - [Amazon Advertising Profile Brands](#amazon-advertising-profiles-brands)
     - [History](#history-transaction-creation)
   - [Remote Identity API](#remote-identity-api)
   - [Subscription API](#subscription-api)
@@ -364,12 +366,149 @@ From the example response, the `accountId` is `data.id` and the `userId` is `dat
 
 ## Service API
 
-### History Transaction Creatio
+### Amazon Advertising Profiles
 
 <details>
- <summary><code>POST</code> <code><b>https://service.api.openbridge.io/service/history/production/history/{{subscriptionId}}</b></code></summary>
 
-The History endpoint is used for generating history requests for subscriptions where history is allowed.  Not all products can generate history requests.
+  <summary><code>GET</code> <code><b>https://service.api.openbridge.io/service/amzadv/profiles-only/{{remoteIdentityId}}?profile_types={{profileType(s)}}</b></code></summary>
+
+  The Amazon Advertising Profiles service endpoint is use to get a list of profiles based on type(s) of profile that you need.
+
+
+
+  The request endpoint of the AmazonAdvertisingProfile will require the remote identity id, and the profile types you are quering.  Depending on the product you are creating a subscription for you will need to request the correct profile types.  The profile types parameter is comma separated list of valid types.  The table below will show what types for which products.
+
+> | product name | profile types |
+> |-|-|
+> | `Amazon Advertising (SB/SD)` | seller,vendor |
+> | `Amazon Advertising (SP)` | seller,vendor |
+> | `Amazon Advertising Ads Recommendations` | seller,vendor |
+> | `Amazon Advertising Brand Metrics` | seller,vendor |
+> | `Amazon Attribution` | attribution |
+> | `Amazon DSP` | dsp |
+
+##### Headers
+
+> | name | data type | description                                                           |
+> |-|-|-|
+> | Content-Type | string | application/json
+> | Authorization | string | Openbridge JWT, passed as a  authorization bearer type
+
+
+##### Parameters
+> | name | data type | description                                                           |
+> |-|-|-|
+> | profile_types | string | Amazon advertising profile type(s). (see the list above) 
+
+
+##### Responses
+
+> | http code | content-type | response |
+> |-|-|-|
+> | `200` | `application/json` | `OK` |
+
+##### Example cURL
+
+This example is for retrieving Amazon Advertising Profiles.
+
+> ```curl
+>  curl -H "Content-Type: application/json" -X GET https://service.api.openbridge.io/service/amzadv/profiles-only/{{remoteIdentityId}}?profile_types={{profileTypes}}
+> ```
+
+###### Example Response
+
+> ```json
+> {
+>   data: {
+>     id: number
+>     type: 'AmazonAdvertisingProfile',
+>     attributes: {
+>       country_code: string;
+>       currency_code: string,
+>       daily_budget: number,
+>       timezone: string,
+>       account_info: {
+>         id: string,
+>         type: string,
+>         attributes: {
+>           marketplace_country: string,
+>           marketplace_string_id: string,
+>           name: string,
+>           type: string,
+>           subType: string,
+>           valid_payment_method: boolean
+>         }  
+>       }
+>     }
+>   }
+> }
+> ```
+
+
+</details>
+
+### Amazon Advertising Profile Brands
+
+<details>
+
+  <summary><code>GET</code> <code><b>https://service.api.openbridge.io/service/amzadv/brands/{{remoteIdentityId}}?profiles={{profileIds}}</b></code></summary>
+
+The Amazon Advertising Profile Brands service endpoint is use to get additional meta data about Amazon Advertising profiles.  
+
+The request endpoint of the AmazonAdvertisingProfile will require the remote identity id, and the profile types you are quering.  Depending on the product you are creating a subscription for you will need to request the correct profile types.  The profile types parameter is comma separated list of valid types.  The table below will show what types for which products.
+
+##### Headers
+
+> | name | data type | description                                                           |
+> |-|-|-|
+> | Content-Type | string | application/json
+> | Authorization | string | Openbridge JWT, passed as a  authorization bearer type
+
+
+##### Parameters
+> | name | data type | description                                                           |
+> |-|-|-|
+> | profiles | string | A csv list of profile IDs valid for the provided remote identity id. 
+
+
+##### Responses
+
+> | http code | content-type | response |
+> |-|-|-|
+> | `200` | `application/json` | `OK` |
+
+##### Example cURL
+
+This example is for retrieving Amazon Advertising Profile Brands.
+
+> ```curl
+>  curl -H "Content-Type: application/json" -X GET https://service.api.openbridge.io/service/amzadv/brands/{{remoteIdentityId}}?profiles={{profileIds}}
+> ```
+
+###### Example Response
+
+> ```json
+> {
+>   data: {
+>     id: number
+>     type: 'AmazonAdvertisingProfileBrand',
+>     attributes: {
+>       brand_entity_id: string;
+>       brand_registry_name: string,
+>       profile_id: string,
+>     }
+>   }
+> }
+> ```
+
+</details>
+
+### History Transaction Creation
+
+<details>
+  <summary><code>POST</code> <code><b>https://service.api.openbridge.io/service/history/production/history/{{subscriptionId}}</b></code></summary>
+
+  The History endpoint is used for generating history requests for subscriptions where history is allowed.  Not all products can generate history requests.
 
 ###### Payload Schema