repzo 1.0.155 → 1.0.156

package/src/oas/activity-storecheck.yaml

@@ -0,0 +1,379 @@
+openapi: 3.0.0
+info:
+  title: Activity Storecheck API
+  description: API for managing activity storecheck records
+  version: 1.0.0
+  contact:
+    name: Repzo
+    url: https://repzo.com
+
+servers:
+  - url: https://sv.api.repzo.me
+    description: Production server
+  - url: https://staging.sv.api.repzo.me
+    description: Staging server
+
+tags:
+  - name: Activity Storecheck
+    description: Operations related to activity storecheck management
+
+paths:
+  /activity-storecheck:
+    get:
+      tags:
+        - Activity Storecheck
+      summary: Get all activity storecheck records
+      description: Retrieve a list of all activity storecheck records with optional filtering and pagination
+      parameters:
+        - name: limit
+          in: query
+          description: Maximum number of records to return
+          required: false
+          schema:
+            type: integer
+            minimum: 1
+            maximum: 100
+            default: 50
+        - name: offset
+          in: query
+          description: Number of records to skip for pagination
+          required: false
+          schema:
+            type: integer
+            minimum: 0
+            default: 0
+        - name: sort
+          in: query
+          description: Field to sort by
+          required: false
+          schema:
+            type: string
+        - name: order
+          in: query
+          description: Sort order (asc or desc)
+          required: false
+          schema:
+            type: string
+            enum: [asc, desc]
+            default: desc
+        - name: filter
+          in: query
+          description: Filter conditions in JSON format
+          required: false
+          schema:
+            type: string
+        - name: search
+          in: query
+          description: Search term for text fields
+          required: false
+          schema:
+            type: string
+      responses:
+        "200":
+          description: List of activity storecheck records retrieved successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    example: true
+                  data:
+                    type: array
+                    items:
+                      $ref: "#/components/schemas/ActivityStorecheck"
+                  total:
+                    type: integer
+                    description: Total number of records
+        "400":
+          description: Bad request
+        "401":
+          description: Unauthorized
+        "500":
+          description: Internal server error
+    post:
+      tags:
+        - Activity Storecheck
+      summary: Create a new activity storecheck record
+      description: Create a new activity storecheck record with the provided data
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/ActivityStorecheckInput"
+      responses:
+        "201":
+          description: Activity storecheck record created successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    example: true
+                  data:
+                    $ref: "#/components/schemas/ActivityStorecheck"
+        "400":
+          description: Bad request
+        "401":
+          description: Unauthorized
+        "500":
+          description: Internal server error
+
+  /activity-storecheck/{id}:
+    get:
+      tags:
+        - Activity Storecheck
+      summary: Get activity storecheck record by ID
+      description: Retrieve a specific activity storecheck record by its ID
+      parameters:
+        - name: id
+          in: path
+          required: true
+          description: Activity storecheck record ID
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Activity storecheck record retrieved successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    example: true
+                  data:
+                    $ref: "#/components/schemas/ActivityStorecheck"
+        "404":
+          description: Activity storecheck record not found
+        "401":
+          description: Unauthorized
+        "500":
+          description: Internal server error
+    put:
+      tags:
+        - Activity Storecheck
+      summary: Update activity storecheck record
+      description: Update an existing activity storecheck record with new data
+      parameters:
+        - name: id
+          in: path
+          required: true
+          description: Activity storecheck record ID
+          schema:
+            type: string
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/ActivityStorecheckInput"
+      responses:
+        "200":
+          description: Activity storecheck record updated successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    example: true
+                  data:
+                    $ref: "#/components/schemas/ActivityStorecheck"
+        "400":
+          description: Bad request
+        "404":
+          description: Activity storecheck record not found
+        "401":
+          description: Unauthorized
+        "500":
+          description: Internal server error
+    delete:
+      tags:
+        - Activity Storecheck
+      summary: Delete activity storecheck record
+      description: Delete an existing activity storecheck record
+      parameters:
+        - name: id
+          in: path
+          required: true
+          description: Activity storecheck record ID
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Activity storecheck record deleted successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    example: true
+                  message:
+                    type: string
+                    example: Activity storecheck record deleted successfully
+        "404":
+          description: Activity storecheck record not found
+        "401":
+          description: Unauthorized
+        "500":
+          description: Internal server error
+
+components:
+  schemas:
+    ActivityStorecheck:
+      type: object
+      properties:
+        _id:
+          type: string
+          description: Unique identifier for the activity storecheck record
+          example: "60f7b1b3e4b0e8b3f8b3f8b3"
+        client:
+          type: string
+          description: Client identifier
+          example: "60f7b1b3e4b0e8b3f8b3f8b4"
+        rep:
+          type: string
+          description: Sales representative identifier
+          example: "60f7b1b3e4b0e8b3f8b3f8b5"
+        template:
+          type: string
+          description: Storecheck template identifier
+          example: "60f7b1b3e4b0e8b3f8b3f8b6"
+        date:
+          type: string
+          format: date-time
+          description: Date and time of the storecheck activity
+          example: "2023-01-15T10:30:00Z"
+        location:
+          type: object
+          properties:
+            latitude:
+              type: number
+              format: double
+              description: Latitude coordinate
+              example: 40.7128
+            longitude:
+              type: number
+              format: double
+              description: Longitude coordinate
+              example: -74.0060
+        responses:
+          type: array
+          items:
+            type: object
+            properties:
+              questionId:
+                type: string
+                description: Question identifier
+              answer:
+                type: string
+                description: Answer to the question
+              photos:
+                type: array
+                items:
+                  type: string
+                  description: Photo URLs
+        status:
+          type: string
+          enum: [draft, submitted, approved, rejected]
+          default: draft
+          description: Status of the storecheck activity
+        notes:
+          type: string
+          description: Additional notes
+        createdAt:
+          type: string
+          format: date-time
+          description: Record creation timestamp
+          example: "2023-01-15T08:00:00Z"
+        updatedAt:
+          type: string
+          format: date-time
+          description: Record last update timestamp
+          example: "2023-01-15T10:30:00Z"
+      required:
+        - client
+        - rep
+        - template
+        - date
+
+    ActivityStorecheckInput:
+      type: object
+      properties:
+        client:
+          type: string
+          description: Client identifier
+          example: "60f7b1b3e4b0e8b3f8b3f8b4"
+        rep:
+          type: string
+          description: Sales representative identifier
+          example: "60f7b1b3e4b0e8b3f8b3f8b5"
+        template:
+          type: string
+          description: Storecheck template identifier
+          example: "60f7b1b3e4b0e8b3f8b3f8b6"
+        date:
+          type: string
+          format: date-time
+          description: Date and time of the storecheck activity
+          example: "2023-01-15T10:30:00Z"
+        location:
+          type: object
+          properties:
+            latitude:
+              type: number
+              format: double
+              description: Latitude coordinate
+              example: 40.7128
+            longitude:
+              type: number
+              format: double
+              description: Longitude coordinate
+              example: -74.0060
+        responses:
+          type: array
+          items:
+            type: object
+            properties:
+              questionId:
+                type: string
+                description: Question identifier
+              answer:
+                type: string
+                description: Answer to the question
+              photos:
+                type: array
+                items:
+                  type: string
+                  description: Photo URLs
+        status:
+          type: string
+          enum: [draft, submitted, approved, rejected]
+          default: draft
+          description: Status of the storecheck activity
+        notes:
+          type: string
+          description: Additional notes
+      required:
+        - client
+        - rep
+        - template
+        - date
+
+  securitySchemes:
+    ApiKeyAuth:
+      type: apiKey
+      in: header
+      name: api-key
+
+security:
+  - ApiKeyAuth: []

package/src/oas/adjust-account.yaml

@@ -0,0 +1,241 @@
+openapi: 3.0.3
+info:
+  title: Repzo API - Adjust Account
+  version: 1.0.0
+  description: OpenAPI specification for Repzo Adjust Account endpoints.
+servers:
+  - url: https://sv.api.repzo.me
+paths:
+  /adjust-account:
+    get:
+      summary: Find account adjustments
+      operationId: findAccountAdjustments
+      parameters:
+        - in: query
+          name: params
+          schema:
+            type: object
+            properties:
+              _id:
+                oneOf:
+                  - type: array
+                    items:
+                      type: string
+                  - type: string
+              search:
+                type: string
+              client:
+                oneOf:
+                  - type: array
+                    items:
+                      type: string
+                  - type: string
+              rep:
+                oneOf:
+                  - type: array
+                    items:
+                      type: string
+                  - type: string
+              type:
+                type: string
+                enum: [credit, debit]
+              from_date:
+                type: string
+                format: date-time
+              to_date:
+                type: string
+                format: date-time
+              from_updatedAt:
+                type: number
+              from__id:
+                type: string
+              to__id:
+                type: string
+              sortBy:
+                type: array
+                items:
+                  type: object
+                  properties:
+                    field:
+                      type: string
+                      enum: [_id, createdAt, updatedAt, amount]
+                    type:
+                      type: string
+                      enum: [asc, desc]
+          description: Query parameters for filtering account adjustments
+      responses:
+        "200":
+          description: A list of account adjustments
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/AdjustAccountFindResult"
+    post:
+      summary: Create an account adjustment
+      operationId: createAccountAdjustment
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/AdjustAccountCreateBody"
+      responses:
+        "201":
+          description: Account adjustment created
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/AdjustAccountCreateResult"
+  /adjust-account/{id}:
+    get:
+      summary: Get an account adjustment by ID
+      operationId: getAccountAdjustment
+      parameters:
+        - in: path
+          name: id
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Account adjustment details
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/AdjustAccountGetResult"
+components:
+  schemas:
+    AdjustAccountFindResult:
+      type: object
+      description: Result of finding account adjustments
+      properties:
+        data:
+          type: array
+          items:
+            $ref: "#/components/schemas/AdjustAccountSchema"
+        total_result:
+          type: number
+          description: Total number of account adjustments
+        current_count:
+          type: number
+          description: Count of account adjustments in current page
+        total_pages:
+          type: number
+          description: Total number of pages
+        current_page:
+          type: number
+          description: Current page number
+        per_page:
+          type: number
+          description: Number of account adjustments per page
+    AdjustAccountSchema:
+      type: object
+      description: Account adjustment schema
+      properties:
+        _id:
+          type: string
+          description: Unique identifier for the account adjustment
+        client:
+          type: string
+          description: Client ID whose account is being adjusted
+        rep:
+          type: string
+          description: Representative ID who made the adjustment
+        type:
+          type: string
+          enum: [credit, debit]
+          description: Type of adjustment (credit increases balance, debit decreases)
+        amount:
+          type: number
+          description: Adjustment amount
+        reason:
+          type: string
+          description: Reason for the adjustment
+        reference:
+          type: string
+          description: Reference number or document
+        description:
+          type: string
+          description: Detailed description of the adjustment
+        previousBalance:
+          type: number
+          description: Account balance before adjustment
+        newBalance:
+          type: number
+          description: Account balance after adjustment
+        adjustmentDate:
+          type: string
+          format: date-time
+          description: Date when adjustment was made
+        approvedBy:
+          type: string
+          description: ID of user who approved the adjustment
+        approvalDate:
+          type: string
+          format: date-time
+          description: Date when adjustment was approved
+        integration_meta:
+          type: object
+          additionalProperties: true
+          description: Integration metadata
+        company_namespace:
+          type: array
+          items:
+            type: string
+          description: Company namespaces
+        createdAt:
+          type: string
+          format: date-time
+          description: Creation timestamp
+        updatedAt:
+          type: string
+          format: date-time
+          description: Last update timestamp
+        __v:
+          type: number
+          description: Version number
+    AdjustAccountCreateBody:
+      type: object
+      description: Body for creating an account adjustment
+      required:
+        - client
+        - type
+        - amount
+        - reason
+      properties:
+        client:
+          type: string
+          description: Client ID whose account is being adjusted
+        rep:
+          type: string
+          description: Representative ID who made the adjustment
+        type:
+          type: string
+          enum: [credit, debit]
+          description: Type of adjustment (credit increases balance, debit decreases)
+        amount:
+          type: number
+          description: Adjustment amount
+        reason:
+          type: string
+          description: Reason for the adjustment
+        reference:
+          type: string
+          description: Reference number or document
+        description:
+          type: string
+          description: Detailed description of the adjustment
+        adjustmentDate:
+          type: string
+          format: date-time
+          description: Date when adjustment was made
+        integration_meta:
+          type: object
+          additionalProperties: true
+          description: Integration metadata
+    AdjustAccountCreateResult:
+      $ref: "#/components/schemas/AdjustAccountSchema"
+      description: Result of creating an account adjustment
+    AdjustAccountGetResult:
+      $ref: "#/components/schemas/AdjustAccountSchema"
+      description: Result of getting an account adjustment