Skip to content

Commit

Permalink
Remove changes to References directory
Browse files Browse the repository at this point in the history
  • Loading branch information
seskritt committed Jul 10, 2023
1 parent 3c21389 commit df47cc2
Show file tree
Hide file tree
Showing 8 changed files with 19 additions and 19 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ ___

**`Description`**

remove a country from a region's list of countries
remove a country from a region's list of coutnries

#### Parameters

Expand Down
4 changes: 2 additions & 2 deletions docs/content/references/js-client/classes/CartsResource.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Adds a shipping method to cart
| Name | Type | Description |
| :------ | :------ | :------ |
| `cart_id` | `string` | Id of cart |
| `payload` | [`StorePostCartsCartShippingMethodReq`](internal-35.StorePostCartsCartShippingMethodReq.md) | Containing id of shipping option and optional data |
| `payload` | [`StorePostCartsCartShippingMethodReq`](internal-35.StorePostCartsCartShippingMethodReq.md) | Containg id of shipping option and optional data |
| `customHeaders` | `Record`<`string`, `any`\> | |

#### Returns
Expand All @@ -50,7 +50,7 @@ Completes a cart.
Payment authorization is attempted and if more work is required, we simply return the cart for further updates.
If payment is authorized and order is not yet created, we make sure to do so.
The completion of a cart can be performed idempotently with a provided header Idempotency-Key.
If not provided, we will generate one for the request.
If not provuided, we will generate one for the request.

#### Parameters

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

**`Description`**

Lists shipping options available
Lists shiping options available

#### Parameters

Expand All @@ -39,7 +39,7 @@ ___

**`Description`**

Lists shipping options available for a cart
Lists shiping options available for a cart

#### Parameters

Expand Down
6 changes: 3 additions & 3 deletions docs/content/references/services/classes/AuthService.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ scrypt to match password with hashed value.
`Promise`<`AuthenticateResult`\>

success: whether authentication succeeded
user: the user document if authentication succeeded
user: the user document if authentication succeded
error: a string with the error message

#### Defined in
Expand All @@ -222,7 +222,7 @@ Authenticates a given user with an API token
`Promise`<`AuthenticateResult`\>

success: whether authentication succeeded
user: the user document if authentication succeeded
user: the user document if authentication succeded
error: a string with the error message

#### Defined in
Expand Down Expand Up @@ -250,7 +250,7 @@ scrypt to match password with hashed value.
`Promise`<`AuthenticateResult`\>

success: whether authentication succeeded
user: the user document if authentication succeeded
user: the user document if authentication succeded
error: a string with the error message

#### Defined in
Expand Down
8 changes: 4 additions & 4 deletions docs/content/references/services/classes/CartService.md
Original file line number Diff line number Diff line change
Expand Up @@ -459,7 +459,7 @@ shop.
| :------ | :------ | :------ |
| `cartOrId` | `string` \| `Cart` | the id of the cart to add shipping method to |
| `optionId` | `string` | id of shipping option to add as valid method |
| `data` | `Record`<`string`, `unknown`\> | the fulfillment data for the method |
| `data` | `Record`<`string`, `unknown`\> | the fulmillment data for the method |

#### Returns

Expand Down Expand Up @@ -682,7 +682,7 @@ Creates or fetches a user based on an email.

`Promise`<`Customer`\>

the resulting customer object
the resultign customer object

#### Defined in

Expand Down Expand Up @@ -792,7 +792,7 @@ Removes a payment session from the cart.
| Name | Type | Description |
| :------ | :------ | :------ |
| `cartId` | `string` | the id of the cart to remove from |
| `providerId` | `string` | the id of the provider whose payment session should be removed. |
| `providerId` | `string` | the id of the provider whoose payment session should be removed. |

#### Returns

Expand Down Expand Up @@ -971,7 +971,7 @@ Refreshes a payment session on a cart
| Name | Type | Description |
| :------ | :------ | :------ |
| `cartId` | `string` | the id of the cart to remove from |
| `providerId` | `string` | the id of the provider whose payment session should be removed. |
| `providerId` | `string` | the id of the provider whoose payment session should be removed. |

#### Returns

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Class: FulfillmentProviderService

Helps retrieve fulfillment providers
Helps retrive fulfillment providers

## Hierarchy

Expand Down
8 changes: 4 additions & 4 deletions docs/content/references/services/classes/OrderService.md
Original file line number Diff line number Diff line change
Expand Up @@ -384,7 +384,7 @@ ___

**archive**(`orderId`): `Promise`<`Order`\>

Archives an order. It only allowed, if the order has been fulfilled
Archives an order. It only alloved, if the order has been fulfilled
and payment has been captured.

#### Parameters
Expand Down Expand Up @@ -661,7 +661,7 @@ have been created in regards to the shipment.
| :------ | :------ | :------ |
| `orderId` | `string` | the id of the order that has been shipped |
| `fulfillmentId` | `string` | the fulfillment that has now been shipped |
| `trackingLinks?` | `TrackingLink`[] | array of tracking numbers associated with the shipment |
| `trackingLinks?` | `TrackingLink`[] | array of tracking numebers associated with the shipment |
| `config` | `Object` | the config of the order that has been shipped |
| `config.metadata` | `Record`<`string`, `unknown`\> | - |
| `config.no_notification?` | `boolean` | - |
Expand Down Expand Up @@ -840,8 +840,8 @@ ___
Handles receiving a return. This will create a
refund to the customer. If the returned items don't match the requested
items the return status will be updated to requires_action. This behaviour
is useful in situations where a custom refund amount is requested, but the
returned items are not matching the requested items. Setting the
is useful in sitautions where a custom refund amount is requested, but the
retuned items are not matching the requested items. Setting the
allowMismatch argument to true, will process the return, ignoring any
mismatches.

Expand Down
4 changes: 2 additions & 2 deletions docs/content/references/services/classes/ReturnService.md
Original file line number Diff line number Diff line change
Expand Up @@ -381,8 +381,8 @@ ___
Registers a previously requested return as received. This will create a
refund to the customer. If the returned items don't match the requested
items the return status will be updated to requires_action. This behaviour
is useful in situations where a custom refund amount is requested, but the
returned items are not matching the requested items. Setting the
is useful in sitautions where a custom refund amount is requested, but the
retuned items are not matching the requested items. Setting the
allowMismatch argument to true, will process the return, ignoring any
mismatches.

Expand Down

0 comments on commit df47cc2

Please sign in to comment.