Skip to content

Commit

Permalink
feat: convert description to tsdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
@solufa
solufa committed Mar 15, 2021
1 parent ccbe8f3 commit 1e5aef7
Show file tree
Hide file tree
Showing 266 changed files with 25,290 additions and 56 deletions.
84 changes: 84 additions & 0 deletions samples/externals/$api.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,47 +33,103 @@ const api = <T>({ baseURL, fetch }: AspidaClient<T>) => {
const prefix3 = `${prefix1}${PATH1}/${val3}`

return {
/**
* Get info of an order by order_id
* @returns Ok
*/
get: (option?: { config?: T }) =>
fetch<Methods1['get']['resBody'], Methods1['get']['resHeaders'], Methods1['get']['status']>(prefix, prefix3, GET, option).json(),
/**
* Get info of an order by order_id
* @returns Ok
*/
$get: (option?: { config?: T }) =>
fetch<Methods1['get']['resBody'], Methods1['get']['resHeaders'], Methods1['get']['status']>(prefix, prefix3, GET, option).json().then(r => r.body),
$path: () => `${prefix}${prefix3}`
}
},
purchase: {
invoice: {
/**
* Creates an purchase order for an offer by its offer_id and using invoice as payment method
* @param option.body - Body to create a purchase order
* @returns Created
*/
post: (option: { body: Methods2['post']['reqBody'], config?: T }) =>
fetch<Methods2['post']['resBody'], Methods2['post']['resHeaders'], Methods2['post']['status']>(prefix, `${prefix1}${PATH2}`, POST, option).json(),
/**
* Creates an purchase order for an offer by its offer_id and using invoice as payment method
* @param option.body - Body to create a purchase order
* @returns Created
*/
$post: (option: { body: Methods2['post']['reqBody'], config?: T }) =>
fetch<Methods2['post']['resBody'], Methods2['post']['resHeaders'], Methods2['post']['status']>(prefix, `${prefix1}${PATH2}`, POST, option).json().then(r => r.body),
$path: () => `${prefix}${prefix1}${PATH2}`
},
wallet: {
/**
* Creates an purchase order for an offer by its offer_id using wallet as payment method
* @param option.body - Body to create a purchase order
* @returns Created
*/
post: (option: { body: Methods3['post']['reqBody'], config?: T }) =>
fetch<Methods3['post']['resBody'], Methods3['post']['resHeaders'], Methods3['post']['status']>(prefix, `${prefix1}${PATH3}`, POST, option).json(),
/**
* Creates an purchase order for an offer by its offer_id using wallet as payment method
* @param option.body - Body to create a purchase order
* @returns Created
*/
$post: (option: { body: Methods3['post']['reqBody'], config?: T }) =>
fetch<Methods3['post']['resBody'], Methods3['post']['resHeaders'], Methods3['post']['status']>(prefix, `${prefix1}${PATH3}`, POST, option).json().then(r => r.body),
$path: () => `${prefix}${prefix1}${PATH3}`
}
},
unsubscribe: {
/**
* Creates an unsubscribe order for a product_id
* @param option.body - Body to create a purchase order
* @returns Created
*/
post: (option: { body: Methods4['post']['reqBody'], config?: T }) =>
fetch<Methods4['post']['resBody'], Methods4['post']['resHeaders'], Methods4['post']['status']>(prefix, `${prefix1}${PATH4}`, POST, option).json(),
/**
* Creates an unsubscribe order for a product_id
* @param option.body - Body to create a purchase order
* @returns Created
*/
$post: (option: { body: Methods4['post']['reqBody'], config?: T }) =>
fetch<Methods4['post']['resBody'], Methods4['post']['resHeaders'], Methods4['post']['status']>(prefix, `${prefix1}${PATH4}`, POST, option).json().then(r => r.body),
$path: () => `${prefix}${prefix1}${PATH4}`
},
update: {
renew: {
/**
* Creates an update order for a product_id
* @param option.body - Body to create a update order
* @returns Created
*/
post: (option: { body: Methods5['post']['reqBody'], config?: T }) =>
fetch<Methods5['post']['resBody'], Methods5['post']['resHeaders'], Methods5['post']['status']>(prefix, `${prefix1}${PATH5}`, POST, option).json(),
/**
* Creates an update order for a product_id
* @param option.body - Body to create a update order
* @returns Created
*/
$post: (option: { body: Methods5['post']['reqBody'], config?: T }) =>
fetch<Methods5['post']['resBody'], Methods5['post']['resHeaders'], Methods5['post']['status']>(prefix, `${prefix1}${PATH5}`, POST, option).json().then(r => r.body),
$path: () => `${prefix}${prefix1}${PATH5}`
}
},
/**
* List orders for a user
* @returns Ok
*/
get: (option?: { query?: Methods0['get']['query'], config?: T }) =>
fetch<Methods0['get']['resBody'], Methods0['get']['resHeaders'], Methods0['get']['status']>(prefix, `${prefix1}${PATH1}`, GET, option).json(),
/**
* List orders for a user
* @returns Ok
*/
$get: (option?: { query?: Methods0['get']['query'], config?: T }) =>
fetch<Methods0['get']['resBody'], Methods0['get']['resHeaders'], Methods0['get']['status']>(prefix, `${prefix1}${PATH1}`, GET, option).json().then(r => r.body),
$path: (option?: { method?: 'get'; query: Methods0['get']['query'] }) =>
Expand All @@ -87,22 +143,50 @@ const api = <T>({ baseURL, fetch }: AspidaClient<T>) => {
orders: {
purchase: {
invoice: {
/**
* Creates an purchase order for an offer by its offer_id using invoice has payment method
* @param option.body - Body to create a purchase order
* @returns Created
*/
post: (option: { body: Methods7['post']['reqBody'], config?: T }) =>
fetch<Methods7['post']['resBody'], Methods7['post']['resHeaders'], Methods7['post']['status']>(prefix, `${prefix3}${PATH2}`, POST, option).json(),
/**
* Creates an purchase order for an offer by its offer_id using invoice has payment method
* @param option.body - Body to create a purchase order
* @returns Created
*/
$post: (option: { body: Methods7['post']['reqBody'], config?: T }) =>
fetch<Methods7['post']['resBody'], Methods7['post']['resHeaders'], Methods7['post']['status']>(prefix, `${prefix3}${PATH2}`, POST, option).json().then(r => r.body),
$path: () => `${prefix}${prefix3}${PATH2}`
},
wallet: {
/**
* Creates an purchase order for an offer by its offer_id using a wallet has payment method
* @param option.body - Body to create a purchase order
* @returns Created
*/
post: (option: { body: Methods8['post']['reqBody'], config?: T }) =>
fetch<Methods8['post']['resBody'], Methods8['post']['resHeaders'], Methods8['post']['status']>(prefix, `${prefix3}${PATH3}`, POST, option).json(),
/**
* Creates an purchase order for an offer by its offer_id using a wallet has payment method
* @param option.body - Body to create a purchase order
* @returns Created
*/
$post: (option: { body: Methods8['post']['reqBody'], config?: T }) =>
fetch<Methods8['post']['resBody'], Methods8['post']['resHeaders'], Methods8['post']['status']>(prefix, `${prefix3}${PATH3}`, POST, option).json().then(r => r.body),
$path: () => `${prefix}${prefix3}${PATH3}`
}
},
/**
* List orders for a phone number
* @returns Ok
*/
get: (option?: { config?: T }) =>
fetch<Methods6['get']['resBody'], Methods6['get']['resHeaders'], Methods6['get']['status']>(prefix, `${prefix3}${PATH1}`, GET, option).json(),
/**
* List orders for a phone number
* @returns Ok
*/
$get: (option?: { config?: T }) =>
fetch<Methods6['get']['resBody'], Methods6['get']['resHeaders'], Methods6['get']['status']>(prefix, `${prefix3}${PATH1}`, GET, option).json().then(r => r.body),
$path: () => `${prefix}${prefix3}${PATH1}`
Expand Down
Loading

0 comments on commit 1e5aef7

Please sign in to comment.