lcdp-api 1.20.2__tar.gz → 1.20.4__tar.gz

{lcdp_api-1.20.2 → lcdp_api-1.20.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lcdp-api
-Version: 1.20.2
+Version: 1.20.4
 Summary: Rest api specification for Le Comptoir Des Pharmacies
 Home-page: https://bitbucket.org/lecomptoirdespharmacies/lcdp-api
 Author: Le Comptoir Des Pharmacies

{lcdp_api-1.20.2 → lcdp_api-1.20.4}/lcdp_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lcdp-api
-Version: 1.20.2
+Version: 1.20.4
 Summary: Rest api specification for Le Comptoir Des Pharmacies
 Home-page: https://bitbucket.org/lecomptoirdespharmacies/lcdp-api
 Author: Le Comptoir Des Pharmacies

{lcdp_api-1.20.2 → lcdp_api-1.20.4}/rest/magic-cart.yaml

@@ -180,9 +180,31 @@ components:
           items:
             type: string
             maxLength: 255
+        algorithm:
+          description: 'Algorithm used by the solver to build the express order'
+          default: 'STRICT_FRANCO'
+          allOf:
+            - $ref: '#/components/schemas/ExpressOrderAlgorithm'
       required:
         - buyerId
 
+    ExpressOrderAlgorithm:
+      type: string
+      description: |
+        Strategy used by the solver to build the express order :
+          * `STRICT_FRANCO` : the historical algorithm. Covering every requested product comes
+            first, then the smallest number of sellers. Those two settled, the solver reaches as
+            many free carriage thresholds as it can, and buys at the lowest price among the carts
+            reaching the same ones.
+          * `LAX_FOCUS` : the same arbitration, plus a minimum per sub cart. A sub cart is only
+            proposed when it carries at least 100 EUR of the request. That amount values every line
+            at the reference price of its product, its cheapest offer anywhere, so buying dearer
+            never helps reach it. The minimum binds every seller at once : as soon as one sub cart
+            reaches it, every seller kept has to. When none can, the rule lifts. The lines of a sub
+            cart left out move onto a seller which is kept, or are given up, in which case the
+            proposal covers only part of the request.
+      enum: ['STRICT_FRANCO', 'LAX_FOCUS']
+
     ExpressOrderNeed:
       type: object
       properties:

{lcdp_api-1.20.2 → lcdp_api-1.20.4}/rest/user.yaml

@@ -43,6 +43,8 @@ tags:
     description: Manage in user restrictions (restricted features)
   - name: searchUserIdvSession
     description: Retrieve users identity verification (IDV) sessions
+  - name: manageUserIdvDocument
+    description: Manage users identity verification (IDV) documents
 paths:
   /users:
     get:
@@ -862,6 +864,7 @@ paths:
       description: |
         Restrictions:
           - If DocumentType is in ('ID', 'KBIS', 'SHARE_HOLDER', 'STATUS') then user 'sca.enrollmentStatus' should be in 'ACTIVE'
+          - If the 'hosted_idv' feature is enabled then only the 'CGV' DocumentType is accepted
       operationId: createOrUpdateCurrentUserDocument
       security:
         - bearerAuth: []
@@ -987,8 +990,9 @@ paths:
         - manageUserDocument
       summary: Upload document associated to given user
       description: |
-        Restrictions :
+        Restrictions:
           - If DocumentType is in ('ID', 'KBIS', 'SHARE_HOLDER', 'STATUS') then user 'sca.enrollmentStatus' should be in 'ACTIVE'
+          - If the 'hosted_idv' feature is enabled then only the 'CGV' DocumentType is accepted
       operationId: createOrUpdateUserDocument
       security:
         - bearerAuth: []
@@ -1265,6 +1269,45 @@ paths:
           description: Access denied
         '404':
           description: User not found
+  '/users/{userId}/idv-documents':
+    post:
+      tags:
+        - manageUserIdvDocument
+      summary: Send a document to Mangopay for given user
+      description: |
+        Send a document requested by Mangopay for given user, one file per page, without storing it
+        Restrictions:
+          - Rejected while the 'hosted_idv' feature is disabled
+      operationId: createUserIdvDocument
+      security:
+        - bearerAuth: []
+        - apiKeyAuth: []
+      x-restrict:
+        roles:
+          - ADMINISTRATOR
+      parameters:
+        - $ref: '#/components/parameters/UserIdParameter'
+      requestBody:
+        required: true
+        content:
+          multipart/form-data:
+            schema:
+              $ref: '#/components/schemas/IdvDocumentCreationParameters'
+      responses:
+        '204':
+          description: Document sent to Mangopay
+        '400':
+          description: Invalid document type or number of files
+        '403':
+          description: Access denied
+        '404':
+          description: User not found
+        '413':
+          description: File over 7 MB or request over 10 MB
+        '415':
+          description: File type other than PDF, JPEG or PNG
+        '501':
+          description: The 'hosted_idv' feature is disabled
   /users/me/forbidden-sellers:
     get:
       tags:
@@ -2940,6 +2983,18 @@ components:
               nullable: true
               allOf:
                 - $ref: '#/components/schemas/IdvBusinessInsightsMatchCheck'
+            pscRoleCheck:
+              nullable: true
+              allOf:
+                - $ref: '#/components/schemas/IdvPscRoleCheck'
+            pscConsistencyCheck:
+              nullable: true
+              allOf:
+                - $ref: '#/components/schemas/IdvPscConsistencyCheck'
+            pscBusinessNatureCheck:
+              nullable: true
+              allOf:
+                - $ref: '#/components/schemas/IdvPscBusinessNatureCheck'
 
     IdvSessionStatus:
       type: string
@@ -3123,6 +3178,112 @@ components:
           type: string
           description: 'Human-readable reason, in English'
 
+    IdvPscRoleCheck:
+      type: object
+      description: 'Result of the PSC role check. Null if the check was not performed.'
+      properties:
+        status:
+          $ref: '#/components/schemas/IdvCheckStatus'
+        reasons:
+          type: array
+          description: 'Refusal reasons. Empty unless the check is REFUSED.'
+          items:
+            $ref: '#/components/schemas/IdvPscRoleCheckReason'
+
+    IdvPscRoleCheckReason:
+      type: object
+      properties:
+        type:
+          type: string
+          description: 'Reason code'
+          enum:
+            - PSC_MISSING
+            - UNKNOWN
+        value:
+          type: string
+          description: 'Human-readable reason, in English'
+
+    IdvPscConsistencyCheck:
+      type: object
+      description: 'Result of the PSC consistency check. Null if the check was not performed.'
+      properties:
+        status:
+          $ref: '#/components/schemas/IdvCheckStatus'
+        reasons:
+          type: array
+          description: 'Refusal reasons. Empty unless the check is REFUSED.'
+          items:
+            $ref: '#/components/schemas/IdvPscConsistencyCheckReason'
+
+    IdvPscConsistencyCheckReason:
+      type: object
+      properties:
+        type:
+          type: string
+          description: 'Reason code'
+          enum:
+            - PSC_FORM_ALTERED
+            - UNVERIFIED_BUSINESS_PSC
+            - UNKNOWN
+        value:
+          type: string
+          description: 'Human-readable reason, in English'
+
+    IdvPscBusinessNatureCheck:
+      type: object
+      description: 'Result of the PSC business nature check. Null if the check was not performed.'
+      properties:
+        status:
+          $ref: '#/components/schemas/IdvCheckStatus'
+        reasons:
+          type: array
+          description: 'Refusal reasons. Empty unless the check is REFUSED.'
+          items:
+            $ref: '#/components/schemas/IdvPscBusinessNatureCheckReason'
+
+    IdvPscBusinessNatureCheckReason:
+      type: object
+      properties:
+        type:
+          type: string
+          description: 'Reason code'
+          enum:
+            - UNKNOWN
+        value:
+          type: string
+          description: 'Human-readable reason, in English'
+
+    IdvDocumentCreationParameters:
+      type: object
+      required:
+        - type
+        - upload
+      properties:
+        type:
+          $ref: '#/components/schemas/IdvDocumentType'
+        upload:
+          description: List of files to upload. Each file becomes a page of the Mangopay document.
+          type: array
+          minItems: 1
+          maxItems: 5
+          items:
+            type: string
+            format: binary
+
+    IdvDocumentType:
+      type: string
+      description: |
+        Type of document to send, as named by Mangopay
+          - IDENTITY_PROOF: an identity document
+          - REGISTRATION_PROOF: a company registration proof
+          - ARTICLES_OF_ASSOCIATION: the articles of association
+          - SHAREHOLDER_DECLARATION: the shareholder declaration, or any other non-identity document requested by Mangopay
+      enum:
+        - IDENTITY_PROOF
+        - REGISTRATION_PROOF
+        - ARTICLES_OF_ASSOCIATION
+        - SHAREHOLDER_DECLARATION
+
   securitySchemes:
     bearerAuth:
       type: http