@things-factory/operato-hub 4.3.81 → 4.3.82

package/openapi/v1/bizplace.yaml

@@ -0,0 +1,72 @@
+definitions:
+  Bizplace:
+    type: 'object'
+    properties:
+      data:
+        type: 'object'
+        properties:
+          bizplace:
+            type: 'object'
+            properties:
+              id:
+                type: 'string'
+                example: 'ed2cd631-ac50-44aa-b798-6567d7acde63'
+              name:
+                type: 'string'
+                example: 'XYZ'
+              description:
+                type: 'string'
+                example: 'XYZ'
+              address:
+                type: 'string'
+                example: 'xxxxxx'
+              postalCode:
+                type: 'string'
+                example: 'xxxxx'
+          extType:
+            type: 'string'
+            example: 'warehouse'
+      limit:
+        type: 'integer'
+        example: 1
+      offset:
+        type: 'integer'
+        example: 3
+      totalCount:
+        type: 'integer'
+        example: 76
+    xml:
+      name: 'Bizplace'
+
+paths:
+  #get-bizlace-list
+  api/v1/company/get-bizplace-list: 
+    get:
+      tags:
+        - 'Bizplace'
+      summary: 'Get list of bizplaces for that company.'
+      description: 'Get list of bizplaces for that company.'
+      operationId: 'getBizplaceList'
+      consumes:
+        - 'application/json'
+      produces:
+        - 'application/json'
+      parameters:
+        - in: 'query'
+          name: 'limit'
+          type: 'integer'
+          default: 50
+          max: 100
+        - in: 'query'
+          name: 'offset'
+          type: 'integer'
+          default: 0
+      responses:
+        '200':
+          description: 'successful operation'
+          content:
+            application/json:
+              schema:
+                type: 'array'
+                items:
+                  $ref: '#/definitions/Bizplace'

package/openapi/v1/contact-point.yaml

@@ -1,106 +1,278 @@
 definitions:
-  ContactPoint:
+# AddContactPointList
+  AddContactPoint:
     type: 'object'
-    properties:
-      name:
-        type: 'string'
-        example: 'ABC Trading Sdn Bhd'
-      companyName:
-        type: 'string'
-        example: 'ABC Trading Sdn Bhd'
-      email:
-        type: 'string'
-        example: 'abc@hatio.my'
-      fax:
-        type: 'string'
-      phone:
-        type: 'string'
-        example: '011-11020304'
-      accountNo:
-        type: 'string'
-      address:
-        type: 'string'
-      address2:
-        type: 'string'
-      city:
-        type: 'string'
-      postCode:
-        type: 'string'
-      type:
-        type: 'string'
-        enum:
-          - 'WAREHOUSE'
-          - 'SUPPLIER'
-          - 'CUSTOMER'
+    properties: 
+      data:
+        type: 'object'
+        properties:
+          name:
+            type: 'string'
+            required: true
+            example: 'ABC Trading Sdn Bhd'
+          description:
+            type: 'string'
+            example:  'desc'
+          companyName:
+            type: 'string'
+            example: 'ABC Trading Sdn Bhd'     
+          email: 
+            type: 'string'
+            required: true 
+            example: 'abc@hatio.my'
+          fax:
+            type: 'string'
+            example: 'true'
+          phone:
+            type: 'string'
+            required: true
+            example: '011-11020304'
+          billingAddress:
+            type: 'string'
+            example: 'address'
+          accountNo:
+            type: 'string'
+            example: 'string'
+          address:
+            type: 'string'
+            required: true
+            example: 'string'
+          address2:
+            type: 'string'
+            example: 'string'
+          city:
+            type: 'string'
+            example: 'string'
+          state:
+            type: 'string'
+            example: 'string'
+          postCode:
+            type: 'string'
+            required: true
+            example: 'string'
+          type:
+            type: 'string'
+            required: true
+            enum: 
+              - 'WAREHOUSE'
+              - 'SUPPLIER'
+              - 'CUSTOMER'
+          createdAt:
+            type: 'datetime'
+            example: '2022-08-17 04:47:14.228'
+          updatedAt:
+            type: 'datetime'
+            example: '2022-08-17 04:47:14.228'
+          domain:
+            type: 'object'
+            properties:
+              name:
+                type: 'string'
+                example: 'some name'
+          bizplace:
+            type: 'object'
+            properties:
+              name:
+                type: 'string'
+                example: 'some name 2'  
+          creator:
+            type: 'object'
+            properties:
+              name:
+                type: 'string'
+                example: 'some name'
+          updater:
+            type: 'object'
+            properties:
+              name:
+                type: 'string'
+                example: 'updater name'
     xml:
-      name: 'ContactPoint'
+      name: 'AddContactPoint'
+
+# GetContactPointList
+  GetContactPointList:
+    type: 'object'
+    properties:
+      data:
+        type: 'object'
+        properties:
+          bizplace: 
+            type: 'object'
+            properties:
+              id:
+                type: 'string'
+                example: 'ed2cd631-ac50-44aa-b798-6567d7acde63'
+              name: 
+                type: 'string'
+                example: 'XYZ'
+          name:
+            type: 'string'
+            example: 'ABC Trading Sdn Bhd'
+          companyName:
+            type: 'string'
+            example: 'ABC Trading Sdn Bhd'     
+          email: 
+            type: 'string'
+            example: 'abc@hatio.my'
+          fax:
+            type: 'string'
+            example: 'true'
+          phone:
+            type: 'string'
+            example: '011-11020304'
+          accountNo:
+            type: 'string'
+            example: 'string'
+          address:
+            type: 'string'
+            example: 'string'
+          address2:
+            type: 'string'
+            example: 'string'
+          city:
+            type: 'string'
+            example: 'string'
+          postCode:
+            type: 'string'
+            example: 'string'
+          type:
+            type: 'string'
+            enum: 
+              - 'WAREHOUSE'
+              - 'SUPPLIER'
+              - 'CUSTOMER'
+      totalCount:
+        type: 'integer'
+        example: 1
+      limit: 
+        type: 'integer'
+        example: 100
+      offset:
+        type: 'integer'
+        example: 0
+  xml:
+    name: 'GetContactPointList'
+    
 paths:
-  /warehouse/{warehouseId}/get-contact-point-list:
+  # add-contact-point
+  /api/v1/company/add-contact-points:         
+    post:
+      tags:
+        - 'Contact Point'
+      summary: 'Add Contact Point(s).'
+      description: 'Add multiple contact point. (From Scope we should be able to determine this is for which company, from here API has to specify this is for which bizplace within the company to add).'
+      operationId: 'addContactPoint'
+      produces:
+        - 'application/json'
+      parameters:
+        - in: 'body'
+          name: 'body'
+          schema: 
+            type: 'object'
+            properties:
+              bizplaceId:
+                type: 'string'
+                required: true
+                example: 'ed2cd631-ac50-44aa-b798-6567d7acde63'
+              data:
+                type: 'object'
+                properties:
+                  name: 
+                    type: 'string'
+                    required: true
+                    example: 'ABC Trading Sdn Bhd'
+                  description:
+                    type: 'string'
+                    example: 'desc'
+                  companyName:
+                    type: 'string'
+                    example: 'ABC Trading Sdn Bhd'
+                  email:
+                    type: 'string'
+                    required: true
+                    example: 'abc@hatio.my'
+                  fax:
+                    type: 'string'
+                    example: 'string'
+                  phone:
+                    type: 'string'
+                    required: true
+                    example: '011-11020304'
+                  billingAddress:
+                    type: 'string'
+                    example: 'address'
+                  accountNo:
+                    type: 'string'
+                    example: 'string'
+                  address:
+                    type: 'string'
+                    required: true
+                    example: 'string'
+                  address2:
+                    type: 'string'
+                    example: 'string'
+                  city:
+                    type: 'string'
+                    example: 'string'
+                  state:
+                    type: 'string'
+                    example: 'string'
+                  postCode:
+                    type: 'string'
+                    example: 'string'
+                  type:
+                    type: 'string'
+                    required: true
+                    enum:
+                    - 'WAREHOUSE'
+                    - 'SUPPLIER'
+                    - 'CUSTOMER'
+      responses:
+        '200':
+          description: 'success'
+          content:
+            application/json:
+              schema:
+                type: 'array'
+                items:
+                  $ref: '#/definitions/AddContactPoint'
+  # get-contact-point-list
+  /api/v1/company/get-contact-point-list: 
     get:
       tags:
-        - 'contactPoint'
-      description: 'Use this API to get contact points in WMS.'
-      operationId: 'getContactPointList'
+        - 'Contact Point'
+      summary: 'Get list of Contact Point(s).'
+      description: 'get list of contact point. Specify bizplace that is within this company.'
+      operationId: 'getContactPoint'
+      consumes:
+        - 'application/json'
       produces:
         - 'application/json'
       parameters:
-        - in: 'path'
-          name: 'warehouseId'
-          required: true
+        - in: 'query'
+          name: 'bizplaceId'
           type: 'string'
+          description: 'Required to specify the bizplace to search.'
+          required: true
         - in: 'query'
           name: 'companyName'
-          required: false
           type: 'string'
         - in: 'query'
           name: 'name'
-          required: false
           type: 'string'
         - in: 'query'
           name: 'email'
-          required: false
           type: 'string'
         - in: 'query'
-          name: 'paginationEntriesPerPage'
-          description: 'This integer value is used to specify the maximum number of entries to return in a single "page" of data. Max entries per page is 100.'
+          name: 'limit'
           type: 'integer'
-          format: 'uint32'
+          default: 100
+          max: 100
         - in: 'query'
-          name: 'paginationOffset'
-          description: 'Specifies the starting entry of data to return in the current call. Default is 1. if data is more than one page, the offset can be some entry to start next call.'
+          name: 'offset'
           type: 'integer'
-          format: 'uint32'
-      responses:
-        '200':
-          description: 'successful operation'
-          content:
-            application/json:
-              schema:
-                type: 'array'
-                items:
-                  $ref: '#/definitions/ContactPoint'
-        '400':
-          description: 'Bad request is sent'
-        '401':
-          description: 'Authentication Error'
-        '404':
-          description: 'Resource not found'
-        '500':
-          description: 'Server error'
-      deprecated: false
-  /warehouse/{warehouseId}/add-contact-point:
-    post:
-      tags:
-        - 'contactPoint'
-      description: 'Use this API to create new contact points in WMS.'
-      operationId: 'addContactPoint'
-      produces:
-        - 'application/json'
-      parameters:
-        - in: 'path'
-          name: 'warehouseId'
-          required: true
-          type: 'string'
+          default: 0
       responses:
         '200':
           description: 'successful operation'
@@ -109,13 +281,4 @@ paths:
               schema:
                 type: 'array'
                 items:
-                  $ref: '#/definitions/ContactPoint'
-        '400':
-          description: 'Bad request is sent'
-        '401':
-          description: 'Authentication Error'
-        '404':
-          description: 'Resource not found'
-        '500':
-          description: 'Server error'
-      deprecated: false
+                  $ref: '#/definitions/GetContactPointList'