Skip to content

Commit

Permalink
fix md tables
Browse files Browse the repository at this point in the history
  • Loading branch information
p-zielinski committed Jan 23, 2024
1 parent 0bc66f4 commit f64fd74
Show file tree
Hide file tree
Showing 28 changed files with 367 additions and 364 deletions.
69 changes: 46 additions & 23 deletions docs/reference-docs/ASYNC-ACTIONS-API-Async-Action-Object.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ order: 1
---

## Async Action Object
#### This is an object representing an asynchronous action.
<p>This is an object representing an asynchronous action.</p>


| Attributes | Description |
|:-----|:--------|
Expand All @@ -25,7 +26,8 @@ order: 1
| object</br>`string` | <p>The type of object represented by JSON. This object stores information about the <code>async_action</code>.</p> |

## CAMPAIGN.VOUCHERS_IMPORT
#### Result schema for a CAMPAIGN.VOUCHERS_IMPORT async action type.
<p>Result schema for a CAMPAIGN.VOUCHERS_IMPORT async action type.</p>


| Attributes | Description |
|:-----|:--------|
Expand All @@ -35,7 +37,8 @@ order: 1
| failed_count</br>`integer` | <p>Number of resources failed to process.</p> |

## CAMPAIGN.VOUCHERS_IMPORT_CSV
#### Result schema for a CAMPAIGN.VOUCHERS_IMPORT_CSV async action type.
<p>Result schema for a CAMPAIGN.VOUCHERS_IMPORT_CSV async action type.</p>


| Attributes | Description |
|:-----|:--------|
Expand All @@ -45,39 +48,44 @@ order: 1
| failed_count</br>`integer` | <p>Number of resources failed to process.</p> |

## CAMPAIGN.VOUCHERS_UPDATE
#### Result schema for a CAMPAIGN.VOUCHERS_UPDATE async action type.
<p>Result schema for a CAMPAIGN.VOUCHERS_UPDATE async action type.</p>


| Attributes | Description |
|:-----|:--------|
| message</br>`string` | <p>A human-readable message providing a short description about the result.</p> |
| done_count</br>`integer` | <p>Number of resources processed successfully.</p> |

## CAMPAIGN.VOUCHERS_DELETE
#### Result schema for a CAMPAIGN.VOUCHERS_DELETE async action type.
<p>Result schema for a CAMPAIGN.VOUCHERS_DELETE async action type.</p>


| Attributes | Description |
|:-----|:--------|
| message</br>`string` | <p>A human-readable message providing a short description about the result.</p> |
| done_count</br>`integer` | <p>Number of resources processed successfully.</p> |

## CAMPAIGN.VOUCHERS_GENERATE
#### Result schema for a CAMPAIGN.VOUCHERS_GENERATE async action type.
<p>Result schema for a CAMPAIGN.VOUCHERS_GENERATE async action type.</p>


| Attributes | Description |
|:-----|:--------|
| message</br>`string` | <p>A human-readable message providing a short description about the result.</p> |
| done_count</br>`integer` | <p>Number of resources processed successfully.</p> |

## CAMPAIGNS.METADATA_KEY_PURGE
#### Result schema for a CAMPAIGNS.METADATA_KEY_PURGE async action type.
<p>Result schema for a CAMPAIGNS.METADATA_KEY_PURGE async action type.</p>


| Attributes | Description |
|:-----|:--------|
| message</br>`string` | <p>A human-readable message providing a short description about the result.</p> |
| done_count</br>`integer` | <p>Number of resources processed successfully.</p> |

## CUSTOMERS.IMPORT_CSV
#### Result schema for a CUSTOMERS.IMPORT_CSV async action type.
<p>Result schema for a CUSTOMERS.IMPORT_CSV async action type.</p>


| Attributes | Description |
|:-----|:--------|
Expand All @@ -87,47 +95,53 @@ order: 1
| failed_count</br>`integer` | <p>Number of resources failed to process.</p> |

## CUSTOMERS.BULK_UPDATE
#### Result schema for a CUSTOMERS.BULK_UPDATE async action type.
<p>Result schema for a CUSTOMERS.BULK_UPDATE async action type.</p>


| Attributes | Description |
|:-----|:--------|
| results</br>`array` | <p>An array of statuses for each record.</p> Array of: <table><thead><tr><th style="text-align:left">Attributes</th><th style="text-align:left">Description</th></tr></thead><tbody><tr><td style="text-align:left">source_id</br><code>string</code></td><td style="text-align:left"><p>Unique customer <code>source_id</code>.</p></td></tr><tr><td style="text-align:left">updated</br><code>boolean</code></td><td style="text-align:left"><p>Indicates whether the record was updated.</p></td></tr><tr><td style="text-align:left">found</br><code>boolean</code></td><td style="text-align:left"><p>Indicates whether the record was found.</p></td></tr></tbody></table> |
| done_count</br>`integer` | <p>Number or resources processed successfully.</p> |

## CUSTOMERS.METADATA_UPDATE
#### Result schema for a CUSTOMERS.METADATA_UPDATE async action type.
<p>Result schema for a CUSTOMERS.METADATA_UPDATE async action type.</p>


| Attributes | Description |
|:-----|:--------|
| results</br>`array` | <p>An array of statuses for each record.</p> Array of: <table><thead><tr><th style="text-align:left">Attributes</th><th style="text-align:left">Description</th></tr></thead><tbody><tr><td style="text-align:left">source_id</br><code>string</code></td><td style="text-align:left"><p>Unique customer <code>source_id</code>.</p></td></tr><tr><td style="text-align:left">updated</br><code>boolean</code></td><td style="text-align:left"><p>Indicates whether the record was updated.</p></td></tr><tr><td style="text-align:left">found</br><code>boolean</code></td><td style="text-align:left"><p>Indicates whether the record was found.</p></td></tr></tbody></table> |
| done_count</br>`integer` | <p>Number of resources processed successfully.</p> |

## CUSTOMERS.METADATA_KEY_PURGE
#### Result schema for a CUSTOMERS.METADATA_KEY_PURGE async action type.
<p>Result schema for a CUSTOMERS.METADATA_KEY_PURGE async action type.</p>


| Attributes | Description |
|:-----|:--------|
| message</br>`string` | <p>A human-readable message providing a short description about the result.</p> |
| done_count</br>`integer` | <p>Number of resources processed successfully.</p> |

## PRODUCTS.BULK_UPDATE
#### Result schema for a PRODUCTS.BULK_UPDATE async action type.
<p>Result schema for a PRODUCTS.BULK_UPDATE async action type.</p>


| Attributes | Description |
|:-----|:--------|
| results</br>`array` | <p>An array of statuses for each record.</p> Array of: <table><thead><tr><th style="text-align:left">Attributes</th><th style="text-align:left">Description</th></tr></thead><tbody><tr><td style="text-align:left">source_id</br><code>string</code></td><td style="text-align:left"><p>Unique product <code>source_id</code>.</p></td></tr><tr><td style="text-align:left">updated</br><code>boolean</code></td><td style="text-align:left"><p>Indicates whether the record was updated.</p></td></tr><tr><td style="text-align:left">found</br><code>boolean</code></td><td style="text-align:left"><p>Indicates whether the record was found.</p></td></tr></tbody></table> |
| done_count</br>`integer` | <p>Number of resources processed successfully.</p> |

## PRODUCTS.METADATA_UPDATE
#### Result schema for a PRODUCTS.METADATA_UPDATE async action type.
<p>Result schema for a PRODUCTS.METADATA_UPDATE async action type.</p>


| Attributes | Description |
|:-----|:--------|
| results</br>`array` | <p>An array of statuses for each record.</p> Array of: <table><thead><tr><th style="text-align:left">Attributes</th><th style="text-align:left">Description</th></tr></thead><tbody><tr><td style="text-align:left">source_id</br><code>string</code></td><td style="text-align:left"><p>Unique product <code>source_id</code>.</p></td></tr><tr><td style="text-align:left">updated</br><code>boolean</code></td><td style="text-align:left"><p>Indicates whether the record was updated.</p></td></tr><tr><td style="text-align:left">found</br><code>boolean</code></td><td style="text-align:left"><p>Indicates whether the record was found.</p></td></tr></tbody></table> |
| done_count</br>`integer` | <p>Number of resources processed successfully.</p> |

## PRODUCTS.IMPORT_CSV
#### Result schema for a PRODUCTS.IMPORT_CSV async action type.
<p>Result schema for a PRODUCTS.IMPORT_CSV async action type.</p>


| Attributes | Description |
|:-----|:--------|
Expand All @@ -137,7 +151,8 @@ order: 1
| failed_count</br>`integer` | <p>Number of resources failed to process.</p> |

## SKUS.IMPORT_CSV
#### Result schema for a SKUS.IMPORT_CSV async action type.
<p>Result schema for a SKUS.IMPORT_CSV async action type.</p>


| Attributes | Description |
|:-----|:--------|
Expand All @@ -147,15 +162,17 @@ order: 1
| failed_count</br>`integer` | <p>Number of resources failed to process.</p> |

## PRODUCTS.METADATA_KEY_PURGE
#### Result schema for a PRODUCTS.METADATA_KEY_PURGE async action type.
<p>Result schema for a PRODUCTS.METADATA_KEY_PURGE async action type.</p>


| Attributes | Description |
|:-----|:--------|
| message</br>`string` | <p>A human-readable message providing a short description about the result.</p> |
| done_count</br>`integer` | <p>Number of resources updated successfully.</p> |

## VOUCHERS.IMPORT
#### Result schema for a VOUCHERS.IMPORT async action type.
<p>Result schema for a VOUCHERS.IMPORT async action type.</p>


| Attributes | Description |
|:-----|:--------|
Expand All @@ -165,7 +182,8 @@ order: 1
| failed_count</br>`integer` | <p>Number of resources failed to process.</p> |

## VOUCHERS.IMPORT_CSV
#### Result schema for a VOUCHERS.IMPORT_CSV async action type.
<p>Result schema for a VOUCHERS.IMPORT_CSV async action type.</p>


| Attributes | Description |
|:-----|:--------|
Expand All @@ -175,31 +193,35 @@ order: 1
| failed_count</br>`integer` | <p>Number of resources failed to process.</p> |

## VOUCHERS.BULK_UPDATE
#### Result schema for a VOUCHERS.BULK_UPDATE async action type.
<p>Result schema for a VOUCHERS.BULK_UPDATE async action type.</p>


| Attributes | Description |
|:-----|:--------|
| results</br>`array` | <p>An array of statuses for each record.</p> Array of: <table><thead><tr><th style="text-align:left">Attributes</th><th style="text-align:left">Description</th></tr></thead><tbody><tr><td style="text-align:left">code</br><code>string</code></td><td style="text-align:left"><p>Unique voucher code.</p></td></tr><tr><td style="text-align:left">updated</br><code>boolean</code></td><td style="text-align:left"><p>Indicates whether the record was updated.</p></td></tr><tr><td style="text-align:left">found</br><code>boolean</code></td><td style="text-align:left"><p>Indicates whether the record was found.</p></td></tr></tbody></table> |
| done_count</br>`integer` | <p>Number of resources processed successfully.</p> |

## VOUCHERS.METADATA_UPDATE
#### Result schema for a VOUCHERS.METADATA_UPDATE async action type.
<p>Result schema for a VOUCHERS.METADATA_UPDATE async action type.</p>


| Attributes | Description |
|:-----|:--------|
| results</br>`array` | <p>An array of statuses for each record.</p> Array of: <table><thead><tr><th style="text-align:left">Attributes</th><th style="text-align:left">Description</th></tr></thead><tbody><tr><td style="text-align:left">code</br><code>string</code></td><td style="text-align:left"><p>Unique voucher code.</p></td></tr><tr><td style="text-align:left">updated</br><code>boolean</code></td><td style="text-align:left"><p>Indicates whether the record was updated.</p></td></tr><tr><td style="text-align:left">found</br><code>boolean</code></td><td style="text-align:left"><p>Indicates whether the record was found.</p></td></tr></tbody></table> |
| done_count</br>`integer` | <p>Number of resources processed successfully.</p> |

## VOUCHERS.METADATA_KEY_PURGE
#### Result schema for a VOUCHERS.METADATA_KEY_PURGE async action type.
<p>Result schema for a VOUCHERS.METADATA_KEY_PURGE async action type.</p>


| Attributes | Description |
|:-----|:--------|
| message</br>`string` | <p>A human-readable message providing a short description about the result.</p> |
| done_count</br>`integer` | <p>Number of resources processed successfully.</p> |

## ORDERS.IMPORT
#### Result schema for a ORDERS.IMPORT async action type.
<p>Result schema for a ORDERS.IMPORT async action type.</p>


| Attributes | Description |
|:-----|:--------|
Expand All @@ -209,7 +231,8 @@ order: 1
| failed_count</br>`integer` | <p>Number of resources failed to process.</p> |

## ORDERS.METADATA_KEY_PURGE
#### Result schema for a ORDERS.METADATA_KEY_PURGE async action type.
<p>Result schema for a ORDERS.METADATA_KEY_PURGE async action type.</p>


| Attributes | Description |
|:-----|:--------|
Expand Down
Loading

0 comments on commit f64fd74

Please sign in to comment.