Skip to content

Commit

Permalink
reformat tables and correct the typos
Browse files Browse the repository at this point in the history
  • Loading branch information
@manas-tank
manas-tank committed May 7, 2023
1 parent 914b865 commit 7d2c175
Show file tree
Hide file tree
Showing 13 changed files with 326 additions and 325 deletions.
6 changes: 3 additions & 3 deletions apis/booking.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ List all bookings.

### <a name="GET-/booking/{id}"></a>GET `/booking/{id}`

Get a booking by it's ID.
Get a booking by its ID.

#### Request

Expand Down Expand Up @@ -137,7 +137,7 @@ Get a booking by it's ID.

Create a new booking object in `UNCAPTURED` state.

The booking creation and acceptance flow is a 2 step flow. Calling this API creates the initial booking in `UNCAPTURED` state and returns back the same booking along with the new booking id. You should call this API before fulfilling the booking flow on your end. Once you get a response, you can then fulfill the booking flow on your end and then call [`PUT /booking`](#PUT-/booking) to capture the booking and start the fulfillment process of the booking on our end.
The booking creation and acceptance flow is a 2-step flow. Calling this API creates the initial booking in `UNCAPTURED` state and returns back the same booking along with the new booking id. You should call this API before fulfilling the booking flow on your end. Once you get a response, you can then fulfill the booking flow on your end and then call [`PUT /booking`](#PUT-/booking) to capture the booking and start the fulfillment process of the booking on our end.

If the booking capturing doesn't happen within an hour then the booking status is automatically changed to `CAPTURE_TIMEOUT`.

Expand Down Expand Up @@ -222,7 +222,7 @@ If the booking capturing doesn't happen within an hour then the booking status i

### <a name="PUT-/booking"></a>PUT `/booking/{id}`

Used to modify a booking. Currently this is only used for capturing the booking and assigning a `partnerReferenceId`. Use this method to capture the booking by specifying the status as `PENDING`. The booking will be fulfilled on our end only once you capture it.
Used to modify a booking. Currently, this is only used for capturing the booking and assigning a `partnerReferenceId`. Use this method to capture the booking by specifying the status as `PENDING`. The booking will be fulfilled on our end only once you capture it.

#### Request

Expand Down
18 changes: 9 additions & 9 deletions apis/category.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,27 @@

## APIs

METHOD | URL | AUTH | USAGE
--- | --- | --- | ---
GET | [`/category/list-by/city`](#GET-/category/list-by/city) | no | List all categories by city.
| METHOD | URL | AUTH | USAGE |
|--------|---------------------------------------------------------|------|------------------------------|
| GET | [`/category/list-by/city`](#GET /category/list-by/city) | no | List all categories by city. |

### <a name="GET-/category/list-by/city"></a>GET `/category/list-by/city`

List all categories by city.

#### Request

MODE | KEY | TYPE | OPTIONAL | DESCRIPTION
--- | --- | --- | --- | ---
QUERY | cityCode | string | no | The city code. Eg: `NEW_YORK`, `DUBAI`
QUERY | offset | string | yes | The offset for pagination. *Ref: [Pagination - Request Params](/conventions/basics.md#Pagination--Request-Params)*
QUERY | limit | int | yes | The limit for pagination. *Ref: [Pagination - Request Params](/conventions/basics.md#Pagination--Request-Params)*
| MODE | KEY | TYPE | OPTIONAL | DESCRIPTION |
|-------|----------|--------|----------|--------------------------------------------------------------------------------------------------------------------|
| QUERY | cityCode | string | no | The city code. Eg: `NEW_YORK`, `DUBAI` |
| QUERY | offset | string | yes | The offset for pagination. *Ref: [Pagination - Request Params](/conventions/basics.md#Pagination--Request-Params)* |
| QUERY | limit | int | yes | The limit for pagination. *Ref: [Pagination - Request Params](/conventions/basics.md#Pagination--Request-Params)* |

#### Response

**Object:** [`category`](/object-models/category-models.md#category)

```javascript
```json
{
"items": [
{
Expand Down
16 changes: 8 additions & 8 deletions apis/city.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,26 @@

## APIs

METHOD | URL | AUTH | USAGE
--- | --- | --- | ---
GET | [`/city`](#GET-/city) | no | List all the active cities.
| METHOD | URL | AUTH | USAGE |
|--------|-----------------------|------|-----------------------------|
| GET | [`/city`](#GET~/city) | no | List all the active cities. |

### <a name="GET-/city"></a>GET `/city`

List all the active cities.

#### Request

MODE | KEY | TYPE | OPTIONAL | DESCRIPTION
--- | --- | --- | --- | ---
QUERY | offset | string | yes | The offset for pagination. *Ref: [Pagination - Request Params](/conventions/basics.md#Pagination--Request-Params)*
QUERY | limit | int | yes | The limit for pagination. *Ref: [Pagination - Request Params](/conventions/basics.md#Pagination--Request-Params)*
| MODE | KEY | TYPE | OPTIONAL | DESCRIPTION |
|-------|--------|--------|----------|--------------------------------------------------------------------------------------------------------------------|
| QUERY | offset | string | yes | The offset for pagination. *Ref: [Pagination - Request Params](/conventions/basics.md#Pagination--Request-Params)* |
| QUERY | limit | int | yes | The limit for pagination. *Ref: [Pagination - Request Params](/conventions/basics.md#Pagination--Request-Params)* |

#### Response

**Object:** [`city`](/object-models/common-models.md#city)

```javascript
```json
{
"items": [
{
Expand Down
26 changes: 13 additions & 13 deletions apis/inventory-pricing.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,34 +4,34 @@

## APIs

METHOD | URL | AUTH | USAGE
--- | --- | --- | ---
GET | [`/inventory/list-by/variant`](#GET-/inventory/list-by/variant) | no | Get the available inventory for a variant.
| METHOD | URL | AUTH | USAGE |
|--------|-----------------------------------------------------------------|------|--------------------------------------------|
| GET | [`/inventory/list-by/variant`](#GET-/inventory/list-by/variant) | no | Get the available inventory for a variant. |

### <a name="GET-/inventory/list-by/variant"></a>GET `/inventory/list-by/variant`

Get the available inventory for a variant.

#### Request

MODE | KEY | TYPE | OPTIONAL | DESCRIPTION
--- | --- | --- | --- | ---
QUERY | variantId | string | no | The ID of the variant for which the inventory needs to be fetched.
QUERY | startDateTime | string | yes | The start date time from which the inventory needs to be fetched. If unspecified then the current timestamp is taken into consideration. *Format: [fm-date-time](/conventions/formats.md#fm-date-time)*. *Ref: [`inventory.startDateTime`](#inventory.startDateTime)*
QUERY | endDateTime | string | yes | The end date time till which the inventory needs to be fetched. If unspecified then this is taken as infinity. *Format: [fm-date-time](/conventions/formats.md#fm-date-time)*. *Ref: [`inventory.startDateTime`](#inventory.startDateTime)*
QUERY | offset | string | yes | The offset for pagination. *Ref: [Pagination - Request Params](/conventions/basics.md#Pagination--Request-Params)*
QUERY | limit | int | yes | The limit for pagination. *Ref: [Pagination - Request Params](/conventions/basics.md#Pagination--Request-Params)*
QUERY | currencyCode | string | yes | The currency in which pricing information will be returned. Eg: `USD`, `AED`. *Ref: [https://en.wikipedia.org/wiki/ISO_4217](https://en.wikipedia.org/wiki/ISO_4217)*
| MODE | KEY | TYPE | OPTIONAL | DESCRIPTION |
|-------|---------------|--------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| QUERY | variantId | string | no | The ID of the variant for which the inventory needs to be fetched. |
| QUERY | startDateTime | string | yes | The start date time from which the inventory needs to be fetched. If unspecified then the current timestamp is taken into consideration. *Format: [fm-date-time](/conventions/formats.md#fm-date-time)*. *Ref: [`inventory.startDateTime`](#inventory.startDateTime)* |
| QUERY | endDateTime | string | yes | The end date time till which the inventory needs to be fetched. If unspecified then this is taken as infinity. *Format: [fm-date-time](/conventions/formats.md#fm-date-time)*. *Ref: [`inventory.startDateTime`](#inventory.startDateTime)* |
| QUERY | offset | string | yes | The offset for pagination. *Ref: [Pagination - Request Params](/conventions/basics.md#Pagination--Request-Params)* |
| QUERY | limit | int | yes | The limit for pagination. *Ref: [Pagination - Request Params](/conventions/basics.md#Pagination--Request-Params)* |
| QUERY | currencyCode | string | yes | The currency in which pricing information will be returned. Eg: `USD`, `AED`. *Ref: [https://en.wikipedia.org/wiki/ISO_4217](https://en.wikipedia.org/wiki/ISO_4217)* |

#### Response

**Object:** [`pagination-wrapper`](/object-models/common-models.md#pagination-wrapper)`<`[`inventory`](/object-models/inventory-pricing-models.md#inventory)`>`

```javascript
```json
{
"items": [
{
"id": "1212121"
"id": "1212121",
"startDateTime": "2017-03-30T15:30:00",
"endDateTime": "2017-03-30T15:30:00",
"availability": "LIMITED/UNLIMITED/CLOSED",
Expand Down
80 changes: 40 additions & 40 deletions apis/product.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,32 +4,32 @@

## APIs

METHOD | URL | AUTH | USAGE
--- | --- | --- | ---
GET | [`/product/get/{product_id}`](#GET-/product/get/{product_id}) | no | Get product by `id`.
GET | [`/product/listing/list-by/city`](#GET-/product/listing/list-by/city) | no | List product listing by city
GET | [`/product/listing/list-by/category`](#GET-/product/listing/list-by/category) | no | List product listing by category
| METHOD | URL | AUTH | USAGE |
|--------|-------------------------------------------------------------------------------|------|----------------------------------|
| GET | [`/product/get/{product_id}`](#GET-/product/get/{product_id}) | no | Get product by `id`. |
| GET | [`/product/listing/list-by/city`](#GET-/product/listing/list-by/city) | no | List product listing by city |
| GET | [`/product/listing/list-by/category`](#GET-/product/listing/list-by/category) | no | List product listing by category |

### <a name="GET-/product/get/{product_id}"></a>GET `/product/get/{product_id}`

Gets a product by `productId`.

#### Request

MODE | KEY | TYPE | OPTIONAL | DESCRIPTION
--- | --- | --- | --- | ---
PATH | product-id | string | no | Product id
| MODE | KEY | TYPE | OPTIONAL | DESCRIPTION |
|------|------------|--------|----------|-------------|
| PATH | product-id | string | no | Product id |

#### Response

**Object:** [`product`](/object-models/product-models.md#product)

```javascript
```json
{
"id": 512,
"name": "Wicked",
"neighbourhood": "Theatre District",
"city": {
"neighbourhood" : "Theatre District",
"city" : {
"code": "NEW_YORK",
"name": "New York"
},
Expand All @@ -38,7 +38,7 @@ PATH | product-id | string | no | Product id
"name": "United States Dollar",
"symbol": "US$",
"localSymbol": "$",
"precision": 2,
"precision": 2
},
"images": [
{
Expand Down Expand Up @@ -70,15 +70,15 @@ PATH | product-id | string | no | Product id
"endLocation": {
"geo": {
"latitude": 40.762393951416016,
"longitude": -73.9851303100586,
}
"longitude": -73.9851303100586
},
"address": {
"line1": "The Gershwin Theatre",
"ine2": "222 W 51st Street",
"cityName": "New York",
"stateName": "New York",
"countryName": "United States",
"postalCode": "10036",
"postalCode": "10036"
}
},
"productType": "EVENT",
Expand All @@ -98,11 +98,11 @@ PATH | product-id | string | no | Product id
"priceType": "PER_PERSON",
"pax": {
"min": 1,
"max": 9,
"max": 9
},
"cashback": {
"value": 10,
"type": "PERCENTAGE",
"type": "PERCENTAGE"
},
"ticketDeliveryInfoHtml": "<p>Your booking confirmation will be emailed to you shortly.</p>",
"inputFields": [
Expand All @@ -111,19 +111,19 @@ PATH | product-id | string | no | Product id
"name": "Name",
"dataType": "STRING",
"level": "PRIMARY_CUSTOMER",
"validation": [
"required": true,
"validation": {
"required" : true,
"regex": "\\s*[^\\s]+\\s+[^\\s]+.*",
"minLength": 3,
"maxLength": 80,
"minValue": null,
"maxValue": null,
"values": [
"values" : [
"Vegetarian",
"Non-vegeratian",
"Non-vegetarian",
"Diabetic"
]
]
}
}
]
}
Expand All @@ -137,18 +137,18 @@ List product listing using city.

#### Request

MODE | KEY | TYPE | OPTIONAL | DESCRIPTION
--- | --- | --- | --- | ---
QUERY | cityCode | string | no | The city code. Eg: `NEW_YORK`, `DUBAI`
QUERY | offset | string | yes | The offset for pagination. *Ref: [Pagination - Request Params](/conventions/basics.md#Pagination--Request-Params)*
QUERY | limit | int | yes | The limit for pagination. *Ref: [Pagination - Request Params](/conventions/basics.md#Pagination--Request-Params)*
QUERY | currencyCode | string | yes | The currency in which pricing information will be returned. Eg: `USD`, `AED`. *Ref: [https://en.wikipedia.org/wiki/ISO_4217](https://en.wikipedia.org/wiki/ISO_4217)*
| MODE | KEY | TYPE | OPTIONAL | DESCRIPTION |
|-------|--------------|--------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| QUERY | cityCode | string | no | The city code. Eg: `NEW_YORK`, `DUBAI` |
| QUERY | offset | string | yes | The offset for pagination. *Ref: [Pagination - Request Params](/conventions/basics.md#Pagination--Request-Params)* |
| QUERY | limit | int | yes | The limit for pagination. *Ref: [Pagination - Request Params](/conventions/basics.md#Pagination--Request-Params)* |
| QUERY | currencyCode | string | yes | The currency in which pricing information will be returned. Eg: `USD`, `AED`. *Ref: [https://en.wikipedia.org/wiki/ISO_4217](https://en.wikipedia.org/wiki/ISO_4217)* |

#### Response

**Object:** [`pagination-wrapper`](/object-models/common-models.md#pagination-wrapper)`<`[`product-listing`](/object-models/product-models.md#product-listing)`>`

```javascript
```json
{
"items": [
{
Expand Down Expand Up @@ -182,8 +182,8 @@ QUERY | currencyCode | string | yes | The currency in which pricing information
"currencyCode": "AED",
"minimumPrice": {
"originalPrice": 551,
"finalPrice": 518,
}
"finalPrice": 518
},
"bestDiscount": 28
}
}
Expand All @@ -201,18 +201,18 @@ List product listing using category.

#### Request

MODE | KEY | TYPE | OPTIONAL | DESCRIPTION
--- | --- | --- | --- | ---
QUERY | categoryId | string | no | The id of the category.
QUERY | offset | string | yes | The offset for pagination. *Ref: [Pagination - Request Params](/conventions/basics.md#Pagination--Request-Params)*
QUERY | limit | int | yes | The limit for pagination. *Ref: [Pagination - Request Params](/conventions/basics.md#Pagination--Request-Params)*
QUERY | currencyCode | string | yes | The currency in which pricing information will be returned. Eg: `USD`, `AED`. *Ref: [https://en.wikipedia.org/wiki/ISO_4217](https://en.wikipedia.org/wiki/ISO_4217)*
| MODE | KEY | TYPE | OPTIONAL | DESCRIPTION |
|-------|--------------|--------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| QUERY | categoryId | string | no | The id of the category. |
| QUERY | offset | string | yes | The offset for pagination. *Ref: [Pagination - Request Params](/conventions/basics.md#Pagination--Request-Params)* |
| QUERY | limit | int | yes | The limit for pagination. *Ref: [Pagination - Request Params](/conventions/basics.md#Pagination--Request-Params)* |
| QUERY | currencyCode | string | yes | The currency in which pricing information will be returned. Eg: `USD`, `AED`. *Ref: [https://en.wikipedia.org/wiki/ISO_4217](https://en.wikipedia.org/wiki/ISO_4217)* |

#### Response

**Object:** [`pagination-wrapper`](/object-models/common-models.md#pagination-wrapper)`<`[`product-listing`](/object-models/product-models.md#product-listing)`>`

```javascript
```json
{
"items": [
{
Expand Down Expand Up @@ -246,8 +246,8 @@ QUERY | currencyCode | string | yes | The currency in which pricing information
"currencyCode": "AED",
"minimumPrice": {
"originalPrice": 551,
"finalPrice": 518,
}
"finalPrice": 518
},
"bestDiscount": 28
}
}
Expand Down
Loading

0 comments on commit 7d2c175

Please sign in to comment.