Skip to content
This repository has been archived by the owner on Feb 6, 2024. It is now read-only.

Commit

Permalink
feat: update examples with links
Browse files Browse the repository at this point in the history
  • Loading branch information
@justinemmanuelmercado
justinemmanuelmercado committed Jun 26, 2020
1 parent b8ffaa9 commit a4bd3ec
Showing 1 changed file with 51 additions and 44 deletions.
95 changes: 51 additions & 44 deletions docs/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,10 @@
+ [getReportScheduleCount](#getreportschedulecount)
+ [updateReportAcknowledgements](#updatereportacknowledgements)
* [Subscriptions](#subscriptions)
+ [Types used in this section](#types-used-in-this-section)
+ [Types used in Subscriptions](#types-used-in-subscriptions)
- [Subscription](#subscription)
- [Destination](#destination)
- [AttribueKeyValue](#attribuekeyvalue)
+ [registerDestination](#registerdestination)
+ [deregisterDestination](#deregisterdestination)
+ [listRegisteredDestinations](#listregistereddestinations)
Expand All @@ -48,6 +51,9 @@
<small><i><a href='http://ecotrust-canada.github.io/markdown-toc/'>Table of contents generated with markdown-toc</a></i></small>


<small><i><a href='http://ecotrust-canada.github.io/markdown-toc/'>Table of contents generated with markdown-toc</a></i></small>



# Basics

Expand Down Expand Up @@ -269,28 +275,28 @@ Under each section are methods that perform "actions" on the MWS API parses the

## Subscriptions

### Types used in this section
### Types used in Subscriptions

**Subscription**
#### Subscription

| Name | Type | Example | Required |
|------------------ |------------- |------------------- |---------- |
| NotificationType | string | 'AnyOfferChanged' | Yes |
| Destination | Destination | | Yes |
| IsEnabled | boolean | true | Yes |
| Name | Type | Example | Required |
|------------------ |------------- |------------------- |---------- |
| NotificationType | string | 'AnyOfferChanged' | Yes |
| Destination | Destination | [Destination](#destination) | Yes |
| IsEnabled | boolean | true | Yes |

* [Possible values for NotificationType](http://docs.developer.amazonservices.com/en_CA/subscriptions/Subscriptions_NotificationType.html)

**Destination**
#### Destination

| Name | Type | Example | Required |
|----------------- |------------------- |--------- |---------- |
| DeliveryChannel | string | 'SQS' | Yes |
| AttributeList | AttributeKeyValue | | Yes |
| Name | Type | Example | Required |
|----------------- |------------------- |------------------------------------ |---------- |
| DeliveryChannel | string | 'SQS' | Yes |
| AttributeList | AttributeKeyValue | [AttribueKeyValue](#attribuekeyvalue) | Yes |

* [Possible values for DeliveryChannel](http://docs.developer.amazonservices.com/en_CA/subscriptions/Subscriptions_Datatypes.html#Destination)

**AttributeKeyValue**
#### AttribueKeyValue

| Name | Type | Example | Required |
|------- |-------- |-------------------------------------------------------------------------------- |---------- |
Expand All @@ -302,18 +308,18 @@ Under each section are methods that perform "actions" on the MWS API parses the
### registerDestination
**Parameters**

| Name | Type | Example | Required |
|--------------- |------------- |------------------ |---------- |
| MarketplaceId | string | 'A2EUQ1WTGCTBG2' | Yes |
| Destination | Destination | | Yes |
| Name | Type | Example | Required |
|--------------- |------------- |-----------------------------|-------------|
| MarketplaceId | string | 'A2EUQ1WTGCTBG2' | Yes |
| Destination | Destination | [Destination](#destination) | Yes |

### deregisterDestination
**Parameters**

| Name | Type | Example | Required |
|--------------- |------------- |------------------ |---------- |
| MarketplaceId | string | 'A2EUQ1WTGCTBG2' | Yes |
| Destination | Destination | | Yes |
| Name | Type | Example | Required |
|--------------- |------------- |-----------------------------|-------------|
| MarketplaceId | string | 'A2EUQ1WTGCTBG2' | Yes |
| Destination | Destination | [Destination](#destination) | Yes |

### listRegisteredDestinations
**Parameters**
Expand All @@ -324,37 +330,38 @@ Under each section are methods that perform "actions" on the MWS API parses the
### sendTestNotificationToDestination
**Parameters**

| Name | Type | Example | Required |
|--------------- |------------- |------------------ |---------- |
| MarketplaceId | string | 'A2EUQ1WTGCTBG2' | Yes |
| Destination | Destination | | Yes |
| Name | Type | Example | Required |
|--------------- |------------- |-----------------------------|-------------|
| MarketplaceId | string | 'A2EUQ1WTGCTBG2' | Yes |
| Destination | Destination | [Destination](#destination) | Yes |

### createSubscription
**Parameters**
| Name | Type | Example | Required |
|--------------- |------------- |------------------ |---------- |
| MarketplaceId | string | 'A2EUQ1WTGCTBG2' | Yes |
| Subscription | Subscription | | Yes |
| Name | Type | Example | Required |
|--------------- |------------- |--------------------------- |---------- |
| MarketplaceId | string | 'A2EUQ1WTGCTBG2' | Yes |
| Subscription | Subscription | [Subscription](#subscription) | Yes |

### getSubscription
**Parameters**

| Name | Type | Example | Required |
|--------------- |------------- |------------------ |---------- |
| MarketplaceId | string | 'A2EUQ1WTGCTBG2' | Yes |
| NotificationType | string | 'AnyOfferChanged' | Yes |
| Destination | Destination | | Yes |
| Name | Type | Example | Required |
|--------------- |------------- |------------------ |---------- |
| MarketplaceId | string | 'A2EUQ1WTGCTBG2' | Yes |
| NotificationType | string | 'AnyOfferChanged' | Yes |
| Destination | Destination | [Destination](#destination) | Yes |


* [Possible values for NotificationType](http://docs.developer.amazonservices.com/en_CA/subscriptions/Subscriptions_NotificationType.html)

### deleteSubscription
**Parameters**

| Name | Type | Example | Required |
|--------------- |------------- |------------------ |---------- |
| MarketplaceId | string | 'A2EUQ1WTGCTBG2' | Yes |
| NotificationType | string | 'AnyOfferChanged' | Yes |
| Destination | Destination | | Yes |
| Name | Type | Example | Required |
|--------------- |------------- |------------------ |---------- |
| MarketplaceId | string | 'A2EUQ1WTGCTBG2' | Yes |
| NotificationType | string | 'AnyOfferChanged' | Yes |
| Destination | Destination | [Destination](#destination) | Yes |

* [Possible values for NotificationType](http://docs.developer.amazonservices.com/en_CA/subscriptions/Subscriptions_NotificationType.html)

Expand All @@ -366,10 +373,10 @@ Under each section are methods that perform "actions" on the MWS API parses the

### updateSubscription
**Parameters**
| Name | Type | Example | Required |
|--------------- |------------- |------------------ |---------- |
| MarketplaceId | string | 'A2EUQ1WTGCTBG2' | Yes |
| Subscription | Subscription | | Yes |
| Name | Type | Example | Required |
|--------------- |------------- |--------------------------- |---------- |
| MarketplaceId | string | 'A2EUQ1WTGCTBG2' | Yes |
| Subscription | Subscription | [Subscription](#subscription) | Yes |


### getServiceStatus
Expand Down

0 comments on commit a4bd3ec

Please sign in to comment.