Payouts endpoints

openapi/openapi.yaml

@@ -42,6 +42,16 @@ components:
       $ref: paths/customer/payout-account/_types/payout-account.yaml
     CustomerPayoutAccountType:
       $ref: paths/customer/payout-account/_types/payout-account-type.yaml
+    CustomerPayoutAccountCreateBody:
+      $ref: paths/customer/payout-account/create/body.yaml
+    CustomerPayoutAccountCreateResponse:
+      $ref: paths/customer/payout-account/create/response.yaml
+    CustomerPayoutAccountDestroy:
+      $ref: paths/customer/payout-account/destroy/destroy.yaml
+    CustomerPayoutAccountDestroyResponse:
+      $ref: paths/customer/payout-account/destroy/response.yaml
+    CustomerPayoutAccountGetResponse:
+      $ref: paths/customer/payout-account/get/response.yaml
     CustomerPayoutMobilePay:
       $ref: paths/customer/payout-account/_types/payout-account-mobile-pay.yaml
     CustomerPayoutBankAccount:
@@ -160,6 +170,22 @@ components:
     CustomerBlockedRangeResponse:
       $ref: paths/customer/blocked/range/response.yaml
 
+    # Payout
+    CustomerPayout:
+      $ref: paths/customer/payout/_types/payout.yaml
+    CustomerPayoutBalancePayload:
+      $ref: paths/customer/payout/balance/payload.yaml
+    CustomerPayoutBalanceResponse:
+      $ref: paths/customer/payout/balance/response.yaml
+    CustomerPayoutGetResponse:
+      $ref: paths/customer/payout/get/response.yaml
+    CustomerPayoutPaginateResponse:
+      $ref: paths/customer/payout/paginate/response.yaml
+
+    # Payout Log
+    CustomerPayoutLogResponse:
+      $ref: paths/customer/payout-log/paginate/response.yaml
+
     # Booking
     CustomerBooking:
       $ref: paths/customer/booking/_types/booking.yaml
@@ -347,6 +373,18 @@ paths:
   /customer/{customerId}/orders/{orderId}:
     $ref: "paths/customer/order/get/index.yaml"
 
+  # Customer Payout Management
+  /customer/{customerId}/payout:
+    $ref: "./paths/customer/payout/paginate/index.yaml"
+  /customer/{customerId}/payout/balance:
+    $ref: "./paths/customer/payout/balance/index.yaml"
+  /customer/{customerId}/payout/{payoutId}:
+    $ref: "./paths/customer/payout/get/index.yaml"
+
+  # Customer Payout Log Management
+  /customer/{customerId}/payout-log/{payoutId}:
+    $ref: "./paths/customer/payout-log/paginate/index.yaml"
+
   # Customer Payout Account Management
   /customer/{customerId}/payout-account:
     $ref: "./paths/customer/payout-account/payout-account.yaml"

openapi/paths/customer/payout-account/get/response.yaml

@@ -6,7 +6,7 @@ properties:
   payload:
     allOf:
       - $ref: "../_types/payout-account.yaml"
-    nullable: true
+        nullable: true
 required:
   - success
   - payload

openapi/paths/customer/payout-log/paginate/index.yaml

@@ -0,0 +1,53 @@
+get:
+  parameters:
+    - name: customerId
+      in: path
+      description: The ID of the customerId
+      required: true
+      schema:
+        type: string
+    - name: payoutId
+      in: path
+      description: The ID of the payoutId
+      required: true
+      schema:
+        type: string
+    - name: page
+      in: query
+      description: The page number
+      required: true
+      schema:
+        type: string
+    - name: sortOrder
+      in: query
+      description: The sort order either asc eller desc = default desc
+      schema:
+        type: string
+    - name: limit
+      in: query
+      description: The limit = default to 10
+      schema:
+        type: string
+  tags:
+    - CustomerPayoutLog
+  operationId: customerPayoutLogPaginate
+  summary: GET get all payout logs for specific payout using paginate
+  description: This endpoint get all payout logs for specific payout
+
+  responses:
+    "200":
+      description: Response with payouts payload
+      content:
+        application/json:
+          schema:
+            $ref: "./response.yaml"
+    "400":
+      $ref: "../../../../responses/bad.yaml"
+    "401":
+      $ref: "../../../../responses/unauthorized.yaml"
+    "403":
+      $ref: "../../../../responses/forbidden.yaml"
+    "404":
+      $ref: "../../../../responses/not-found.yaml"
+
+  security: []

openapi/paths/customer/payout-log/paginate/response.yaml

@@ -0,0 +1,14 @@
+type: object
+properties:
+  success:
+    type: boolean
+    example: true
+  payload:
+    type: array
+    items:
+      oneOf:
+        - $ref: "../../_types/order/line-item.yaml"
+        - $ref: ../../../shipping/_types/shipping.yaml
+required:
+  - success
+  - payload

openapi/paths/customer/payout/_types/payout.yaml

@@ -0,0 +1,31 @@
+type: object
+properties:
+  customerId:
+    type: number
+  date:
+    type: string
+    format: date-time
+  amount:
+    type: number
+    format: double
+  currencyCode:
+    type: string
+    example: "DKK"
+  status:
+    type: string
+    enum:
+      - "Pending"
+      - "Processed"
+      - "Failed"
+  payoutType:
+    $ref: ../../payout-account/_types/payout-account-type.yaml
+  payoutDetails:
+    oneOf:
+      - $ref: ../../payout-account/_types/payout-account-mobile-pay.yaml
+      - $ref: ../../payout-account/_types/payout-account-bank-account.yaml
+required:
+  - customerId
+  - date
+  - amount
+  - currencyCode
+  - status

openapi/paths/customer/payout/balance/index.yaml

@@ -0,0 +1,31 @@
+get:
+  parameters:
+    - name: customerId
+      in: path
+      description: The ID of the customerId
+      required: true
+      schema:
+        type: string
+  tags:
+    - CustomerPayout
+  operationId: customerPayoutBalance
+  summary: GET get payout balance
+  description: This endpoint get payout balance
+
+  responses:
+    "200":
+      description: Response with payout balance payload
+      content:
+        application/json:
+          schema:
+            $ref: "./response.yaml"
+    "400":
+      $ref: "../../../../responses/bad.yaml"
+    "401":
+      $ref: "../../../../responses/unauthorized.yaml"
+    "403":
+      $ref: "../../../../responses/forbidden.yaml"
+    "404":
+      $ref: "../../../../responses/not-found.yaml"
+
+  security: []

openapi/paths/customer/payout/balance/payload.yaml

@@ -0,0 +1,12 @@
+type: object
+properties:
+  totalAmount:
+    type: number
+  totalLineItems:
+    type: number
+  totalShippingAmount:
+    type: number
+required:
+  - totalAmount
+  - totalLineItems
+  - totalShippingAmount

openapi/paths/customer/payout/balance/response.yaml

@@ -0,0 +1,10 @@
+type: object
+properties:
+  success:
+    type: boolean
+    example: true
+  payload:
+    $ref: payload.yaml
+required:
+  - success
+  - payload

openapi/paths/customer/payout/get/index.yaml

@@ -0,0 +1,37 @@
+get:
+  parameters:
+    - name: customerId
+      in: path
+      description: The ID of the customerId
+      required: true
+      schema:
+        type: string
+    - name: payoutId
+      in: path
+      description: The ID of the payoudId
+      required: true
+      schema:
+        type: string
+  tags:
+    - CustomerPayout
+  operationId: customerPayoutGet
+  summary: GET get payout
+  description: This endpoint get payout
+
+  responses:
+    "200":
+      description: Response with payout payload
+      content:
+        application/json:
+          schema:
+            $ref: "./response.yaml"
+    "400":
+      $ref: "../../../../responses/bad.yaml"
+    "401":
+      $ref: "../../../../responses/unauthorized.yaml"
+    "403":
+      $ref: "../../../../responses/forbidden.yaml"
+    "404":
+      $ref: "../../../../responses/not-found.yaml"
+
+  security: []

openapi/paths/customer/payout/get/response.yaml

@@ -0,0 +1,10 @@
+type: object
+properties:
+  success:
+    type: boolean
+    example: true
+  payload:
+    $ref: "../_types/payout.yaml"
+required:
+  - success
+  - payload

openapi/paths/customer/payout/paginate/index.yaml

@@ -0,0 +1,47 @@
+get:
+  parameters:
+    - name: customerId
+      in: path
+      description: The ID of the customerId
+      required: true
+      schema:
+        type: string
+    - name: page
+      in: query
+      description: The page number
+      required: true
+      schema:
+        type: string
+    - name: sortOrder
+      in: query
+      description: The sort order either asc eller desc = default desc
+      schema:
+        type: string
+    - name: limit
+      in: query
+      description: The limit = default to 10
+      schema:
+        type: string
+  tags:
+    - CustomerPayout
+  operationId: customerPayoutPaginate
+  summary: GET get all payouts using paginate
+  description: This endpoint get all payouts
+
+  responses:
+    "200":
+      description: Response with payouts payload
+      content:
+        application/json:
+          schema:
+            $ref: "./response.yaml"
+    "400":
+      $ref: "../../../../responses/bad.yaml"
+    "401":
+      $ref: "../../../../responses/unauthorized.yaml"
+    "403":
+      $ref: "../../../../responses/forbidden.yaml"
+    "404":
+      $ref: "../../../../responses/not-found.yaml"
+
+  security: []

openapi/paths/customer/payout/paginate/response.yaml

@@ -0,0 +1,12 @@
+type: object
+properties:
+  success:
+    type: boolean
+    example: true
+  payload:
+    type: array
+    items:
+      $ref: ../_types/payout.yaml
+required:
+  - success
+  - payload

openapi/paths/user/list/response.yaml

@@ -12,7 +12,7 @@ properties:
         type: array
         items:
           $ref: "../_types/user.yaml"
-      total:
+      totalCount:
         type: number
     required:
       - results

src/functions/customer-payout-log.function.ts

@@ -0,0 +1,12 @@
+import "module-alias/register";
+
+import { app } from "@azure/functions";
+
+import { CustomerPayoutLogControllerPaginate } from "./customer/controllers/payout-log/paginate";
+
+app.http("customerPayoutLogPaginate", {
+  methods: ["GET"],
+  authLevel: "anonymous",
+  route: "customer/{customerId?}/payout-log/{payoutId}",
+  handler: CustomerPayoutLogControllerPaginate,
+});

src/functions/customer-payout.functions.ts

@@ -0,0 +1,28 @@
+import "module-alias/register";
+
+import { app } from "@azure/functions";
+
+import { CustomerPayoutControllerBalance } from "./customer/controllers/payout/balance";
+import { CustomerPayoutControllerGet } from "./customer/controllers/payout/get";
+import { CustomerPayoutControllerPaginate } from "./customer/controllers/payout/paginate";
+
+app.http("customerPayoutGet", {
+  methods: ["GET"],
+  authLevel: "anonymous",
+  route: "customer/{customerId?}/payout/{payoutId?}",
+  handler: CustomerPayoutControllerGet,
+});
+
+app.http("customerPayoutBalance", {
+  methods: ["GET"],
+  authLevel: "anonymous",
+  route: "customer/{customerId?}/payout/balance",
+  handler: CustomerPayoutControllerBalance,
+});
+
+app.http("customerPayoutPaginate", {
+  methods: ["GET"],
+  authLevel: "anonymous",
+  route: "customer/{customerId?}/payout",
+  handler: CustomerPayoutControllerPaginate,
+});