openapi: 3.1.0
info:
  title: Api
  version: "2"
  description: API for collecting user consent and ordering electric consumption
    data from Enedis.
paths:
  /ask:
    post:
      tags:
        - asks
      operationId: ask
      parameters:
        - name: switchgrid-test-env
          in: header
          schema:
            $ref: "#/components/schemas/BooleanFromString"
          required: false
      security:
        - bearerAuth: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - id
                  - createdAt
                  - status
                  - acceptedAt
                  - consentCollectionDetails
                  - createArgs
                  - consentIds
                  - contracts
                  - scopes
                  - purposes
                  - testEnvironment
                  - thirdPartyRecipients
                properties:
                  id:
                    type: string
                    format: uuid
                    title: UUID
                  createdAt:
                    type: string
                    format: date-time
                    description: ISO 8601 date format
                    examples:
                      - 2024-12-10T00:00:00
                      - 2024-12-10T12:00:00Z
                      - 2024-12-10T00:00:00+01:00
                      - 2024-12-10
                      - 2024-12-10T00:00:00[Europe/Paris]
                      - 2024-12-10T00:00:00[CET]
                  status:
                    anyOf:
                      - type: string
                        enum:
                          - CREATED
                        title: CREATED
                      - type: string
                        enum:
                          - PENDING_ADDRESS_CHECK
                        title: PENDING_ADDRESS_CHECK
                      - type: string
                        enum:
                          - ADDRESS_CHECK_FAILED
                        title: ADDRESS_CHECK_FAILED
                      - type: string
                        enum:
                          - PREPARING_CONSENT_COLLECTION
                        title: PREPARING_CONSENT_COLLECTION
                      - type: string
                        enum:
                          - PENDING_USER_ACTION
                        title: PENDING_USER_ACTION
                      - type: string
                        enum:
                          - ACCEPTED
                        title: ACCEPTED
                  acceptedAt:
                    type: string
                    format: date-time
                    description: ISO 8601 date format
                    examples:
                      - 2024-12-10T00:00:00
                      - 2024-12-10T12:00:00Z
                      - 2024-12-10T00:00:00+01:00
                      - 2024-12-10
                      - 2024-12-10T00:00:00[Europe/Paris]
                      - 2024-12-10T00:00:00[CET]
                    nullable: true
                  consentCollectionDetails:
                    type: object
                    required:
                      - service
                      - userUrl
                    properties:
                      service:
                        type: string
                        enum:
                          - DOCUSEAL
                          - WEB_HOSTED
                      userUrl:
                        anyOf:
                          - $ref: "#/components/schemas/Url"
                          - $ref: "#/components/schemas/Url"
                    additionalProperties: false
                    nullable: true
                  createArgs:
                    type: object
                    required:
                      - electricityContracts
                    properties:
                      electricityContracts:
                        type: array
                        items:
                          anyOf:
                            - type: Uuid
                              format: uuid
                              identifier: ElectricityContractId
                              title: Electricity Contract Id
                              description: The identifier of an electricity contract. Usually got from the
                                endpoint `GET /search_contract`.
                            - $ref: "#/components/schemas/ElectricityContract"
                        title: Electricity Contracts
                      signer:
                        type: object
                        required: []
                        properties:
                          genre:
                            type: string
                            enum:
                              - M
                              - F
                          lastName:
                            type: string
                          firstName:
                            type: string
                          organizationName:
                            $ref: "#/components/schemas/NonEmptyString"
                          phone:
                            type: string
                          email:
                            $ref: "#/components/schemas/Email"
                        additionalProperties: false
                        description: >-
                          The person signing the Consent request.

                          For WEB_CONSENT, all fields are optional (the user
                          will be able to fill their names and organization).

                          For DOCUSEAL, fields firstName & lastName are
                          required.
                      consentCollectionMedium:
                        $ref: "#/components/schemas/ConsentCollectionMedium"
                      options:
                        type: object
                        required: []
                        properties:
                          skipAddressCheck:
                            type: boolean
                        additionalProperties: false
                      scopesAndPurpose:
                        type: array
                        items:
                          type: object
                          required:
                            - purposes
                          properties:
                            scopes:
                              type: array
                              items:
                                anyOf:
                                  - anyOf:
                                      - type: object
                                        required:
                                          - service
                                          - id
                                        properties:
                                          service:
                                            type: string
                                            enum:
                                              - ENEDIS_RAW_API
                                          id:
                                            type: string
                                            enum:
                                              - DETAILS_CONTRACTUELS
                                        additionalProperties: false
                                      - type: object
                                        required:
                                          - service
                                          - id
                                          - args
                                        properties:
                                          service:
                                            type: string
                                            enum:
                                              - ENEDIS_RAW_API
                                          id:
                                            type: string
                                            enum:
                                              - CONSUMPTION_DATA
                                          args:
                                            type: object
                                            required:
                                              - types
                                              - directions
                                            properties:
                                              types:
                                                type: array
                                                items:
                                                  type: string
                                                  enum:
                                                    - CDC
                                                    - PMAX
                                                    - IDX
                                                    - ENERGIE
                                              directions:
                                                type: array
                                                items:
                                                  type: string
                                                  enum:
                                                    - SOUTIRAGE
                                                    - INJECTION
                                            additionalProperties: false
                                        additionalProperties: false
                                  - anyOf:
                                      - type: object
                                        required:
                                          - id
                                          - args
                                        properties:
                                          id:
                                            type: string
                                            enum:
                                              - ELECTRICITY_TIMESERIES
                                          args:
                                            type: object
                                            required:
                                              - types
                                              - directions
                                            properties:
                                              types:
                                                type: array
                                                items:
                                                  type: string
                                                  enum:
                                                    - LOADCURVE
                                              directions:
                                                type: array
                                                items:
                                                  type: string
                                                  enum:
                                                    - CONSUMPTION
                                                    - INJECTION
                                            additionalProperties: false
                                        additionalProperties: false
                                      - type: object
                                        required:
                                          - id
                                          - args
                                        properties:
                                          id:
                                            type: string
                                            enum:
                                              - GAS_TIMESERIES
                                          args:
                                            type: object
                                            required:
                                              - types
                                              - directions
                                            properties:
                                              types:
                                                type: array
                                                items:
                                                  type: string
                                                  enum:
                                                    - BILLING
                                                    - DAILY
                                              directions:
                                                type: array
                                                items:
                                                  type: string
                                                  enum:
                                                    - CONSUMPTION
                                                    - INJECTION
                                            additionalProperties: false
                                        additionalProperties: false
                                      - type: object
                                        required:
                                          - id
                                        properties:
                                          id:
                                            type: string
                                            enum:
                                              - GAS_CONTRACT_DETAILS
                                        additionalProperties: false
                            purposes:
                              type: array
                              items:
                                anyOf:
                                  - anyOf:
                                      - type: string
                                        enum:
                                          - SOLAR_INSTALLATION_SIZING
                                        title: Sizing of a solar installation
                                      - type: string
                                        enum:
                                          - DEMAND_RESPONSE
                                        title: Demand response
                                      - type: string
                                        enum:
                                          - ENERGY_PERFORMANCE_STUDY
                                        title: Energy performance study
                                      - type: string
                                        enum:
                                          - ENERGY_BROKERAGE
                                        title: Energy brokerage
                                      - type: string
                                        enum:
                                          - VEHICLE_CHARGE_DETECTION
                                        title: Detection of a vehicle charge
                                  - type: object
                                    required:
                                      - id
                                    properties:
                                      id:
                                        anyOf:
                                          - type: string
                                            enum:
                                              - SOLAR_INSTALLATION_SIZING
                                            title: Sizing of a solar installation
                                          - type: string
                                            enum:
                                              - DEMAND_RESPONSE
                                            title: Demand response
                                          - type: string
                                            enum:
                                              - ENERGY_PERFORMANCE_STUDY
                                            title: Energy performance study
                                          - type: string
                                            enum:
                                              - ENERGY_BROKERAGE
                                            title: Energy brokerage
                                          - type: string
                                            enum:
                                              - VEHICLE_CHARGE_DETECTION
                                            title: Detection of a vehicle charge
                                    additionalProperties: false
                          additionalProperties: false
                          description: "**❗️ DEPRECATED ❗️** => use `scopes` and `purposes` instead. This
                            field will be removed in a future version."
                      scopes:
                        type: array
                        items:
                          anyOf:
                            - anyOf:
                                - type: object
                                  required:
                                    - service
                                    - id
                                  properties:
                                    service:
                                      type: string
                                      enum:
                                        - ENEDIS_RAW_API
                                    id:
                                      type: string
                                      enum:
                                        - DETAILS_CONTRACTUELS
                                  additionalProperties: false
                                - type: object
                                  required:
                                    - service
                                    - id
                                    - args
                                  properties:
                                    service:
                                      type: string
                                      enum:
                                        - ENEDIS_RAW_API
                                    id:
                                      type: string
                                      enum:
                                        - CONSUMPTION_DATA
                                    args:
                                      type: object
                                      required:
                                        - types
                                        - directions
                                      properties:
                                        types:
                                          type: array
                                          items:
                                            type: string
                                            enum:
                                              - CDC
                                              - PMAX
                                              - IDX
                                              - ENERGIE
                                        directions:
                                          type: array
                                          items:
                                            type: string
                                            enum:
                                              - SOUTIRAGE
                                              - INJECTION
                                      additionalProperties: false
                                  additionalProperties: false
                            - anyOf:
                                - type: object
                                  required:
                                    - id
                                    - args
                                  properties:
                                    id:
                                      type: string
                                      enum:
                                        - ELECTRICITY_TIMESERIES
                                    args:
                                      type: object
                                      required:
                                        - types
                                        - directions
                                      properties:
                                        types:
                                          type: array
                                          items:
                                            type: string
                                            enum:
                                              - LOADCURVE
                                        directions:
                                          type: array
                                          items:
                                            type: string
                                            enum:
                                              - CONSUMPTION
                                              - INJECTION
                                      additionalProperties: false
                                  additionalProperties: false
                                - type: object
                                  required:
                                    - id
                                    - args
                                  properties:
                                    id:
                                      type: string
                                      enum:
                                        - GAS_TIMESERIES
                                    args:
                                      type: object
                                      required:
                                        - types
                                        - directions
                                      properties:
                                        types:
                                          type: array
                                          items:
                                            type: string
                                            enum:
                                              - BILLING
                                              - DAILY
                                        directions:
                                          type: array
                                          items:
                                            type: string
                                            enum:
                                              - CONSUMPTION
                                              - INJECTION
                                      additionalProperties: false
                                  additionalProperties: false
                                - type: object
                                  required:
                                    - id
                                  properties:
                                    id:
                                      type: string
                                      enum:
                                        - GAS_CONTRACT_DETAILS
                                  additionalProperties: false
                      purposes:
                        type: array
                        items:
                          anyOf:
                            - anyOf:
                                - type: string
                                  enum:
                                    - SOLAR_INSTALLATION_SIZING
                                  title: Sizing of a solar installation
                                - type: string
                                  enum:
                                    - DEMAND_RESPONSE
                                  title: Demand response
                                - type: string
                                  enum:
                                    - ENERGY_PERFORMANCE_STUDY
                                  title: Energy performance study
                                - type: string
                                  enum:
                                    - ENERGY_BROKERAGE
                                  title: Energy brokerage
                                - type: string
                                  enum:
                                    - VEHICLE_CHARGE_DETECTION
                                  title: Detection of a vehicle charge
                            - type: object
                              required:
                                - id
                              properties:
                                id:
                                  anyOf:
                                    - type: string
                                      enum:
                                        - SOLAR_INSTALLATION_SIZING
                                      title: Sizing of a solar installation
                                    - type: string
                                      enum:
                                        - DEMAND_RESPONSE
                                      title: Demand response
                                    - type: string
                                      enum:
                                        - ENERGY_PERFORMANCE_STUDY
                                      title: Energy performance study
                                    - type: string
                                      enum:
                                        - ENERGY_BROKERAGE
                                      title: Energy brokerage
                                    - type: string
                                      enum:
                                        - VEHICLE_CHARGE_DETECTION
                                      title: Detection of a vehicle charge
                              additionalProperties: false
                      consentDuration:
                        anyOf:
                          - type: string
                            enum:
                              - 1 day
                            title: 1 day
                          - type: string
                            enum:
                              - 2 days
                            title: 2 days
                          - type: string
                            enum:
                              - 3 days
                            title: 3 days
                          - type: string
                            enum:
                              - 4 days
                            title: 4 days
                          - type: string
                            enum:
                              - 5 days
                            title: 5 days
                          - type: string
                            enum:
                              - 6 days
                            title: 6 days
                          - type: string
                            enum:
                              - 1 week
                            title: 1 week
                          - type: string
                            enum:
                              - 2 weeks
                            title: 2 weeks
                          - type: string
                            enum:
                              - 3 weeks
                            title: 3 weeks
                          - type: string
                            enum:
                              - 4 weeks
                            title: 4 weeks
                          - type: string
                            enum:
                              - 1 month
                            title: 1 month
                          - type: string
                            enum:
                              - 2 months
                            title: 2 months
                          - type: string
                            enum:
                              - 3 months
                            title: 3 months
                          - type: string
                            enum:
                              - 4 months
                            title: 4 months
                          - type: string
                            enum:
                              - 5 months
                            title: 5 months
                          - type: string
                            enum:
                              - 6 months
                            title: 6 months
                          - type: string
                            enum:
                              - 1 year
                            title: 1 year
                          - type: string
                            enum:
                              - 2 years
                            title: 2 years
                          - type: string
                            enum:
                              - 3 years
                            title: 3 years
                          - type: string
                            enum:
                              - 4 years
                            title: 4 years
                          - type: string
                            enum:
                              - 5 years
                            title: 5 years
                          - type: string
                            enum:
                              - 6 years
                            title: 6 years
                          - type: string
                            enum:
                              - 7 years
                            title: 7 years
                          - type: string
                            enum:
                              - 8 years
                            title: 8 years
                          - type: string
                            enum:
                              - 9 years
                            title: 9 years
                          - type: string
                            enum:
                              - 10 years
                            title: 10 years
                          - type: string
                            enum:
                              - 11 years
                            title: 11 years
                          - type: string
                            enum:
                              - 12 years
                            title: 12 years
                          - type: string
                            enum:
                              - 13 years
                            title: 13 years
                          - type: string
                            enum:
                              - 14 years
                            title: 14 years
                          - type: string
                            enum:
                              - 15 years
                            title: 15 years
                          - type: string
                            enum:
                              - 16 years
                            title: 16 years
                          - type: string
                            enum:
                              - 17 years
                            title: 17 years
                          - type: string
                            enum:
                              - 18 years
                            title: 18 years
                          - type: string
                            enum:
                              - 19 years
                            title: 19 years
                          - type: string
                            enum:
                              - 20 years
                            title: 20 years
                      thirdPartyRecipients:
                        type: array
                        items:
                          type: string
                        description: Optional list of slugs identifying third parties who will get
                          access to the data after consent is given.
                      orgSlug:
                        type: string
                        description: Optional slug of the organization that will be used to create the
                          ask. If using a serviceAccount (API key) this is not
                          needed. If logged in as a user that has access to more
                          than one organization, this is needed for
                          disambiguation.
                    additionalProperties: false
                    examples:
                      - electricityContracts:
                          - 606b5149-1ef0-414a-8019-a050f64cc0ac
                      - electricityContracts:
                          - 606b5149-1ef0-414a-8019-a050f64cc0ac
                        signer:
                          lastName: lastName
                          firstName: firstName
                          email: signer-6LT0Y@domain.com
                        purposes:
                          - SOLAR_INSTALLATION_SIZING
                        consentDuration: 1 year
                  __experimentalAddressChecksResults:
                    type: object
                    required: []
                    properties: {}
                    additionalProperties:
                      type: object
                      required:
                        - status
                      properties:
                        status:
                          type: string
                          enum:
                            - SUCCESS
                            - FAILURE
                      additionalProperties: false
                  addressCheckResults:
                    type: object
                    required: []
                    properties: {}
                    additionalProperties:
                      type: object
                      required:
                        - status
                      properties:
                        status:
                          type: string
                          enum:
                            - SUCCESS
                            - FAILURE
                      additionalProperties: false
                  consentIds:
                    type: object
                    required: []
                    properties: {}
                    additionalProperties:
                      type: string
                      format: uuid
                      title: UUID
                    examples:
                      - "00052775405049": 7252fa9f-b86a-4b95-a090-1012b730004c
                        "00088663455690": 2083c06a-2793-4475-affc-acfec79d4225
                  contracts:
                    type: array
                    items:
                      $ref: "#/components/schemas/EnedisElectricityContract"
                  scopes:
                    type: array
                    items:
                      anyOf:
                        - anyOf:
                            - type: object
                              required:
                                - service
                                - id
                              properties:
                                service:
                                  type: string
                                  enum:
                                    - ENEDIS_RAW_API
                                id:
                                  type: string
                                  enum:
                                    - DETAILS_CONTRACTUELS
                              additionalProperties: false
                            - type: object
                              required:
                                - service
                                - id
                                - args
                              properties:
                                service:
                                  type: string
                                  enum:
                                    - ENEDIS_RAW_API
                                id:
                                  type: string
                                  enum:
                                    - CONSUMPTION_DATA
                                args:
                                  type: object
                                  required:
                                    - types
                                    - directions
                                  properties:
                                    types:
                                      type: array
                                      items:
                                        type: string
                                        enum:
                                          - CDC
                                          - PMAX
                                          - IDX
                                          - ENERGIE
                                    directions:
                                      type: array
                                      items:
                                        type: string
                                        enum:
                                          - SOUTIRAGE
                                          - INJECTION
                                  additionalProperties: false
                              additionalProperties: false
                        - anyOf:
                            - type: object
                              required:
                                - id
                                - args
                              properties:
                                id:
                                  type: string
                                  enum:
                                    - ELECTRICITY_TIMESERIES
                                args:
                                  type: object
                                  required:
                                    - types
                                    - directions
                                  properties:
                                    types:
                                      type: array
                                      items:
                                        type: string
                                        enum:
                                          - LOADCURVE
                                    directions:
                                      type: array
                                      items:
                                        type: string
                                        enum:
                                          - CONSUMPTION
                                          - INJECTION
                                  additionalProperties: false
                              additionalProperties: false
                            - type: object
                              required:
                                - id
                                - args
                              properties:
                                id:
                                  type: string
                                  enum:
                                    - GAS_TIMESERIES
                                args:
                                  type: object
                                  required:
                                    - types
                                    - directions
                                  properties:
                                    types:
                                      type: array
                                      items:
                                        type: string
                                        enum:
                                          - BILLING
                                          - DAILY
                                    directions:
                                      type: array
                                      items:
                                        type: string
                                        enum:
                                          - CONSUMPTION
                                          - INJECTION
                                  additionalProperties: false
                              additionalProperties: false
                            - type: object
                              required:
                                - id
                              properties:
                                id:
                                  type: string
                                  enum:
                                    - GAS_CONTRACT_DETAILS
                              additionalProperties: false
                  purposes:
                    type: array
                    items:
                      anyOf:
                        - type: string
                          enum:
                            - SOLAR_INSTALLATION_SIZING
                          title: Sizing of a solar installation
                        - type: string
                          enum:
                            - DEMAND_RESPONSE
                          title: Demand response
                        - type: string
                          enum:
                            - ENERGY_PERFORMANCE_STUDY
                          title: Energy performance study
                        - type: string
                          enum:
                            - ENERGY_BROKERAGE
                          title: Energy brokerage
                        - type: string
                          enum:
                            - VEHICLE_CHARGE_DETECTION
                          title: Detection of a vehicle charge
                  testEnvironment:
                    type: boolean
                  thirdPartyRecipients:
                    type: array
                    items:
                      type: string
                additionalProperties: false
        "400":
          description: The request did not match the expected schema
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: "#/components/schemas/HttpApiDecodeError"
                  - type: object
                    required:
                      - error
                    properties:
                      error:
                        $id: /schemas/any
                        title: any
                    additionalProperties: false
        "401":
          description: Error
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: string
                additionalProperties: false
      summary: Create an Ask
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - electricityContracts
              properties:
                electricityContracts:
                  type: array
                  items:
                    anyOf:
                      - type: Uuid
                        format: uuid
                        identifier: ElectricityContractId
                        title: Electricity Contract Id
                        description: The identifier of an electricity contract. Usually got from the
                          endpoint `GET /search_contract`.
                      - $ref: "#/components/schemas/ElectricityContract"
                  title: Electricity Contracts
                signer:
                  type: object
                  required: []
                  properties:
                    genre:
                      type: string
                      enum:
                        - M
                        - F
                    lastName:
                      type: string
                    firstName:
                      type: string
                    organizationName:
                      $ref: "#/components/schemas/NonEmptyString"
                    phone:
                      type: string
                    email:
                      $ref: "#/components/schemas/Email"
                  additionalProperties: false
                  description: >-
                    The person signing the Consent request.

                    For WEB_CONSENT, all fields are optional (the user will be
                    able to fill their names and organization).

                    For DOCUSEAL, fields firstName & lastName are required.
                consentCollectionMedium:
                  $ref: "#/components/schemas/ConsentCollectionMedium"
                options:
                  type: object
                  required: []
                  properties:
                    skipAddressCheck:
                      type: boolean
                  additionalProperties: false
                scopesAndPurpose:
                  type: array
                  items:
                    type: object
                    required:
                      - purposes
                    properties:
                      scopes:
                        type: array
                        items:
                          anyOf:
                            - anyOf:
                                - type: object
                                  required:
                                    - service
                                    - id
                                  properties:
                                    service:
                                      type: string
                                      enum:
                                        - ENEDIS_RAW_API
                                    id:
                                      type: string
                                      enum:
                                        - DETAILS_CONTRACTUELS
                                  additionalProperties: false
                                - type: object
                                  required:
                                    - service
                                    - id
                                    - args
                                  properties:
                                    service:
                                      type: string
                                      enum:
                                        - ENEDIS_RAW_API
                                    id:
                                      type: string
                                      enum:
                                        - CONSUMPTION_DATA
                                    args:
                                      type: object
                                      required:
                                        - types
                                        - directions
                                      properties:
                                        types:
                                          type: array
                                          items:
                                            type: string
                                            enum:
                                              - CDC
                                              - PMAX
                                              - IDX
                                              - ENERGIE
                                        directions:
                                          type: array
                                          items:
                                            type: string
                                            enum:
                                              - SOUTIRAGE
                                              - INJECTION
                                      additionalProperties: false
                                  additionalProperties: false
                            - anyOf:
                                - type: object
                                  required:
                                    - id
                                    - args
                                  properties:
                                    id:
                                      type: string
                                      enum:
                                        - ELECTRICITY_TIMESERIES
                                    args:
                                      type: object
                                      required:
                                        - types
                                        - directions
                                      properties:
                                        types:
                                          type: array
                                          items:
                                            type: string
                                            enum:
                                              - LOADCURVE
                                        directions:
                                          type: array
                                          items:
                                            type: string
                                            enum:
                                              - CONSUMPTION
                                              - INJECTION
                                      additionalProperties: false
                                  additionalProperties: false
                                - type: object
                                  required:
                                    - id
                                    - args
                                  properties:
                                    id:
                                      type: string
                                      enum:
                                        - GAS_TIMESERIES
                                    args:
                                      type: object
                                      required:
                                        - types
                                        - directions
                                      properties:
                                        types:
                                          type: array
                                          items:
                                            type: string
                                            enum:
                                              - BILLING
                                              - DAILY
                                        directions:
                                          type: array
                                          items:
                                            type: string
                                            enum:
                                              - CONSUMPTION
                                              - INJECTION
                                      additionalProperties: false
                                  additionalProperties: false
                                - type: object
                                  required:
                                    - id
                                  properties:
                                    id:
                                      type: string
                                      enum:
                                        - GAS_CONTRACT_DETAILS
                                  additionalProperties: false
                      purposes:
                        type: array
                        items:
                          anyOf:
                            - anyOf:
                                - type: string
                                  enum:
                                    - SOLAR_INSTALLATION_SIZING
                                  title: Sizing of a solar installation
                                - type: string
                                  enum:
                                    - DEMAND_RESPONSE
                                  title: Demand response
                                - type: string
                                  enum:
                                    - ENERGY_PERFORMANCE_STUDY
                                  title: Energy performance study
                                - type: string
                                  enum:
                                    - ENERGY_BROKERAGE
                                  title: Energy brokerage
                                - type: string
                                  enum:
                                    - VEHICLE_CHARGE_DETECTION
                                  title: Detection of a vehicle charge
                            - type: object
                              required:
                                - id
                              properties:
                                id:
                                  anyOf:
                                    - type: string
                                      enum:
                                        - SOLAR_INSTALLATION_SIZING
                                      title: Sizing of a solar installation
                                    - type: string
                                      enum:
                                        - DEMAND_RESPONSE
                                      title: Demand response
                                    - type: string
                                      enum:
                                        - ENERGY_PERFORMANCE_STUDY
                                      title: Energy performance study
                                    - type: string
                                      enum:
                                        - ENERGY_BROKERAGE
                                      title: Energy brokerage
                                    - type: string
                                      enum:
                                        - VEHICLE_CHARGE_DETECTION
                                      title: Detection of a vehicle charge
                              additionalProperties: false
                    additionalProperties: false
                    description: "**❗️ DEPRECATED ❗️** => use `scopes` and `purposes` instead. This
                      field will be removed in a future version."
                scopes:
                  type: array
                  items:
                    anyOf:
                      - anyOf:
                          - type: object
                            required:
                              - service
                              - id
                            properties:
                              service:
                                type: string
                                enum:
                                  - ENEDIS_RAW_API
                              id:
                                type: string
                                enum:
                                  - DETAILS_CONTRACTUELS
                            additionalProperties: false
                          - type: object
                            required:
                              - service
                              - id
                              - args
                            properties:
                              service:
                                type: string
                                enum:
                                  - ENEDIS_RAW_API
                              id:
                                type: string
                                enum:
                                  - CONSUMPTION_DATA
                              args:
                                type: object
                                required:
                                  - types
                                  - directions
                                properties:
                                  types:
                                    type: array
                                    items:
                                      type: string
                                      enum:
                                        - CDC
                                        - PMAX
                                        - IDX
                                        - ENERGIE
                                  directions:
                                    type: array
                                    items:
                                      type: string
                                      enum:
                                        - SOUTIRAGE
                                        - INJECTION
                                additionalProperties: false
                            additionalProperties: false
                      - anyOf:
                          - type: object
                            required:
                              - id
                              - args
                            properties:
                              id:
                                type: string
                                enum:
                                  - ELECTRICITY_TIMESERIES
                              args:
                                type: object
                                required:
                                  - types
                                  - directions
                                properties:
                                  types:
                                    type: array
                                    items:
                                      type: string
                                      enum:
                                        - LOADCURVE
                                  directions:
                                    type: array
                                    items:
                                      type: string
                                      enum:
                                        - CONSUMPTION
                                        - INJECTION
                                additionalProperties: false
                            additionalProperties: false
                          - type: object
                            required:
                              - id
                              - args
                            properties:
                              id:
                                type: string
                                enum:
                                  - GAS_TIMESERIES
                              args:
                                type: object
                                required:
                                  - types
                                  - directions
                                properties:
                                  types:
                                    type: array
                                    items:
                                      type: string
                                      enum:
                                        - BILLING
                                        - DAILY
                                  directions:
                                    type: array
                                    items:
                                      type: string
                                      enum:
                                        - CONSUMPTION
                                        - INJECTION
                                additionalProperties: false
                            additionalProperties: false
                          - type: object
                            required:
                              - id
                            properties:
                              id:
                                type: string
                                enum:
                                  - GAS_CONTRACT_DETAILS
                            additionalProperties: false
                purposes:
                  type: array
                  items:
                    anyOf:
                      - anyOf:
                          - type: string
                            enum:
                              - SOLAR_INSTALLATION_SIZING
                            title: Sizing of a solar installation
                          - type: string
                            enum:
                              - DEMAND_RESPONSE
                            title: Demand response
                          - type: string
                            enum:
                              - ENERGY_PERFORMANCE_STUDY
                            title: Energy performance study
                          - type: string
                            enum:
                              - ENERGY_BROKERAGE
                            title: Energy brokerage
                          - type: string
                            enum:
                              - VEHICLE_CHARGE_DETECTION
                            title: Detection of a vehicle charge
                      - type: object
                        required:
                          - id
                        properties:
                          id:
                            anyOf:
                              - type: string
                                enum:
                                  - SOLAR_INSTALLATION_SIZING
                                title: Sizing of a solar installation
                              - type: string
                                enum:
                                  - DEMAND_RESPONSE
                                title: Demand response
                              - type: string
                                enum:
                                  - ENERGY_PERFORMANCE_STUDY
                                title: Energy performance study
                              - type: string
                                enum:
                                  - ENERGY_BROKERAGE
                                title: Energy brokerage
                              - type: string
                                enum:
                                  - VEHICLE_CHARGE_DETECTION
                                title: Detection of a vehicle charge
                        additionalProperties: false
                consentDuration:
                  anyOf:
                    - type: string
                      enum:
                        - 1 day
                      title: 1 day
                    - type: string
                      enum:
                        - 2 days
                      title: 2 days
                    - type: string
                      enum:
                        - 3 days
                      title: 3 days
                    - type: string
                      enum:
                        - 4 days
                      title: 4 days
                    - type: string
                      enum:
                        - 5 days
                      title: 5 days
                    - type: string
                      enum:
                        - 6 days
                      title: 6 days
                    - type: string
                      enum:
                        - 1 week
                      title: 1 week
                    - type: string
                      enum:
                        - 2 weeks
                      title: 2 weeks
                    - type: string
                      enum:
                        - 3 weeks
                      title: 3 weeks
                    - type: string
                      enum:
                        - 4 weeks
                      title: 4 weeks
                    - type: string
                      enum:
                        - 1 month
                      title: 1 month
                    - type: string
                      enum:
                        - 2 months
                      title: 2 months
                    - type: string
                      enum:
                        - 3 months
                      title: 3 months
                    - type: string
                      enum:
                        - 4 months
                      title: 4 months
                    - type: string
                      enum:
                        - 5 months
                      title: 5 months
                    - type: string
                      enum:
                        - 6 months
                      title: 6 months
                    - type: string
                      enum:
                        - 1 year
                      title: 1 year
                    - type: string
                      enum:
                        - 2 years
                      title: 2 years
                    - type: string
                      enum:
                        - 3 years
                      title: 3 years
                    - type: string
                      enum:
                        - 4 years
                      title: 4 years
                    - type: string
                      enum:
                        - 5 years
                      title: 5 years
                    - type: string
                      enum:
                        - 6 years
                      title: 6 years
                    - type: string
                      enum:
                        - 7 years
                      title: 7 years
                    - type: string
                      enum:
                        - 8 years
                      title: 8 years
                    - type: string
                      enum:
                        - 9 years
                      title: 9 years
                    - type: string
                      enum:
                        - 10 years
                      title: 10 years
                    - type: string
                      enum:
                        - 11 years
                      title: 11 years
                    - type: string
                      enum:
                        - 12 years
                      title: 12 years
                    - type: string
                      enum:
                        - 13 years
                      title: 13 years
                    - type: string
                      enum:
                        - 14 years
                      title: 14 years
                    - type: string
                      enum:
                        - 15 years
                      title: 15 years
                    - type: string
                      enum:
                        - 16 years
                      title: 16 years
                    - type: string
                      enum:
                        - 17 years
                      title: 17 years
                    - type: string
                      enum:
                        - 18 years
                      title: 18 years
                    - type: string
                      enum:
                        - 19 years
                      title: 19 years
                    - type: string
                      enum:
                        - 20 years
                      title: 20 years
                thirdPartyRecipients:
                  type: array
                  items:
                    type: string
                  description: Optional list of slugs identifying third parties who will get
                    access to the data after consent is given.
                orgSlug:
                  type: string
                  description: Optional slug of the organization that will be used to create the
                    ask. If using a serviceAccount (API key) this is not needed.
                    If logged in as a user that has access to more than one
                    organization, this is needed for disambiguation.
              additionalProperties: false
              examples:
                - electricityContracts:
                    - 606b5149-1ef0-414a-8019-a050f64cc0ac
                - electricityContracts:
                    - 606b5149-1ef0-414a-8019-a050f64cc0ac
                  signer:
                    lastName: lastName
                    firstName: firstName
                    email: signer-6LT0Y@domain.com
                  purposes:
                    - SOLAR_INSTALLATION_SIZING
                  consentDuration: 1 year
        required: true
    get:
      tags:
        - asks
      operationId: getAsks
      parameters:
        - name: switchgrid-test-env
          in: header
          schema:
            $ref: "#/components/schemas/BooleanFromString"
          required: false
        - name: prm
          in: query
          schema:
            description: comma-separated list of prms, Use '!' to exclude prms.
            type: string
            examples:
              - "00056184972446"
              - 00027046521843,00077145296439
              - "!00069098505221"
          required: false
          description: comma-separated list of prms, Use '!' to exclude prms.
          examples:
            ex1:
              value: "00056184972446"
              summary: ""
            ex2:
              value: 00027046521843,00077145296439
              summary: ""
            ex3:
              value: "!00069098505221"
              summary: ""
        - name: status
          in: query
          schema:
            description: comma-separated list of statuses. Use '!' to exclude statuses. If
              multiple statuses are provided, the ask must match at least one of
              them, but not match any of the excluded statuses.
            examples:
              - ACCEPTED
              - "!ACCEPTED"
              - PENDING_USER_ACTION,ACCEPTED
          required: false
          description: comma-separated list of statuses. Use '!' to exclude statuses. If
            multiple statuses are provided, the ask must match at least one of
            them, but not match any of the excluded statuses.
          examples:
            ex1:
              value: ACCEPTED
              summary: ""
            ex2:
              value: "!ACCEPTED"
              summary: ""
            ex3:
              value: PENDING_USER_ACTION,ACCEPTED
              summary: ""
        - name: skip
          in: query
          schema:
            $ref: "#/components/schemas/NumberFromString"
          required: false
        - name: limit
          in: query
          schema:
            type: integer
            maximum: 100
            default: 10
          required: false
        - name: orderBy
          in: query
          schema:
            type: string
            title: Order By
            description: |-
              comma-separated list of fields to order by, allowed fields are:
               - status
              - createdAt
              - acceptedAt
            examples:
              - status:asc,createdAt:asc,acceptedAt:asc
          required: false
          description: |-
            comma-separated list of fields to order by, allowed fields are:
             - status
            - createdAt
            - acceptedAt
          examples:
            ex1:
              value: status:asc,createdAt:asc,acceptedAt:asc
              summary: ""
      security:
        - bearerAuth: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - skip
                  - limit
                  - totalItemsCount
                  - returnedItemsCount
                  - items
                properties:
                  skip:
                    type: number
                  limit:
                    type: number
                  totalItemsCount:
                    type: number
                  returnedItemsCount:
                    type: number
                  items:
                    type: array
                    items:
                      type: object
                      required:
                        - id
                        - createdAt
                        - status
                        - acceptedAt
                        - consentCollectionDetails
                        - createArgs
                        - consentIds
                        - contracts
                        - scopes
                        - purposes
                        - testEnvironment
                        - thirdPartyRecipients
                      properties:
                        id:
                          type: string
                          format: uuid
                          title: UUID
                        createdAt:
                          type: string
                          format: date-time
                          description: ISO 8601 date format
                          examples:
                            - 2024-12-10T00:00:00
                            - 2024-12-10T12:00:00Z
                            - 2024-12-10T00:00:00+01:00
                            - 2024-12-10
                            - 2024-12-10T00:00:00[Europe/Paris]
                            - 2024-12-10T00:00:00[CET]
                        status:
                          anyOf:
                            - type: string
                              enum:
                                - CREATED
                              title: CREATED
                            - type: string
                              enum:
                                - PENDING_ADDRESS_CHECK
                              title: PENDING_ADDRESS_CHECK
                            - type: string
                              enum:
                                - ADDRESS_CHECK_FAILED
                              title: ADDRESS_CHECK_FAILED
                            - type: string
                              enum:
                                - PREPARING_CONSENT_COLLECTION
                              title: PREPARING_CONSENT_COLLECTION
                            - type: string
                              enum:
                                - PENDING_USER_ACTION
                              title: PENDING_USER_ACTION
                            - type: string
                              enum:
                                - ACCEPTED
                              title: ACCEPTED
                        acceptedAt:
                          type: string
                          format: date-time
                          description: ISO 8601 date format
                          examples:
                            - 2024-12-10T00:00:00
                            - 2024-12-10T12:00:00Z
                            - 2024-12-10T00:00:00+01:00
                            - 2024-12-10
                            - 2024-12-10T00:00:00[Europe/Paris]
                            - 2024-12-10T00:00:00[CET]
                          nullable: true
                        consentCollectionDetails:
                          type: object
                          required:
                            - service
                            - userUrl
                          properties:
                            service:
                              type: string
                              enum:
                                - DOCUSEAL
                                - WEB_HOSTED
                            userUrl:
                              anyOf:
                                - $ref: "#/components/schemas/Url"
                                - $ref: "#/components/schemas/Url"
                          additionalProperties: false
                          nullable: true
                        createArgs:
                          type: object
                          required:
                            - electricityContracts
                          properties:
                            electricityContracts:
                              type: array
                              items:
                                anyOf:
                                  - type: Uuid
                                    format: uuid
                                    identifier: ElectricityContractId
                                    title: Electricity Contract Id
                                    description: The identifier of an electricity contract. Usually got from the
                                      endpoint `GET /search_contract`.
                                  - $ref: "#/components/schemas/ElectricityContract"
                              title: Electricity Contracts
                            signer:
                              type: object
                              required: []
                              properties:
                                genre:
                                  type: string
                                  enum:
                                    - M
                                    - F
                                lastName:
                                  type: string
                                firstName:
                                  type: string
                                organizationName:
                                  $ref: "#/components/schemas/NonEmptyString"
                                phone:
                                  type: string
                                email:
                                  $ref: "#/components/schemas/Email"
                              additionalProperties: false
                              description: >-
                                The person signing the Consent request.

                                For WEB_CONSENT, all fields are optional (the
                                user will be able to fill their names and
                                organization).

                                For DOCUSEAL, fields firstName & lastName are
                                required.
                            consentCollectionMedium:
                              $ref: "#/components/schemas/ConsentCollectionMedium"
                            options:
                              type: object
                              required: []
                              properties:
                                skipAddressCheck:
                                  type: boolean
                              additionalProperties: false
                            scopesAndPurpose:
                              type: array
                              items:
                                type: object
                                required:
                                  - purposes
                                properties:
                                  scopes:
                                    type: array
                                    items:
                                      anyOf:
                                        - anyOf:
                                            - type: object
                                              required:
                                                - service
                                                - id
                                              properties:
                                                service:
                                                  type: string
                                                  enum:
                                                    - ENEDIS_RAW_API
                                                id:
                                                  type: string
                                                  enum:
                                                    - DETAILS_CONTRACTUELS
                                              additionalProperties: false
                                            - type: object
                                              required:
                                                - service
                                                - id
                                                - args
                                              properties:
                                                service:
                                                  type: string
                                                  enum:
                                                    - ENEDIS_RAW_API
                                                id:
                                                  type: string
                                                  enum:
                                                    - CONSUMPTION_DATA
                                                args:
                                                  type: object
                                                  required:
                                                    - types
                                                    - directions
                                                  properties:
                                                    types:
                                                      type: array
                                                      items:
                                                        type: string
                                                        enum:
                                                          - CDC
                                                          - PMAX
                                                          - IDX
                                                          - ENERGIE
                                                    directions:
                                                      type: array
                                                      items:
                                                        type: string
                                                        enum:
                                                          - SOUTIRAGE
                                                          - INJECTION
                                                  additionalProperties: false
                                              additionalProperties: false
                                        - anyOf:
                                            - type: object
                                              required:
                                                - id
                                                - args
                                              properties:
                                                id:
                                                  type: string
                                                  enum:
                                                    - ELECTRICITY_TIMESERIES
                                                args:
                                                  type: object
                                                  required:
                                                    - types
                                                    - directions
                                                  properties:
                                                    types:
                                                      type: array
                                                      items:
                                                        type: string
                                                        enum:
                                                          - LOADCURVE
                                                    directions:
                                                      type: array
                                                      items:
                                                        type: string
                                                        enum:
                                                          - CONSUMPTION
                                                          - INJECTION
                                                  additionalProperties: false
                                              additionalProperties: false
                                            - type: object
                                              required:
                                                - id
                                                - args
                                              properties:
                                                id:
                                                  type: string
                                                  enum:
                                                    - GAS_TIMESERIES
                                                args:
                                                  type: object
                                                  required:
                                                    - types
                                                    - directions
                                                  properties:
                                                    types:
                                                      type: array
                                                      items:
                                                        type: string
                                                        enum:
                                                          - BILLING
                                                          - DAILY
                                                    directions:
                                                      type: array
                                                      items:
                                                        type: string
                                                        enum:
                                                          - CONSUMPTION
                                                          - INJECTION
                                                  additionalProperties: false
                                              additionalProperties: false
                                            - type: object
                                              required:
                                                - id
                                              properties:
                                                id:
                                                  type: string
                                                  enum:
                                                    - GAS_CONTRACT_DETAILS
                                              additionalProperties: false
                                  purposes:
                                    type: array
                                    items:
                                      anyOf:
                                        - anyOf:
                                            - type: string
                                              enum:
                                                - SOLAR_INSTALLATION_SIZING
                                              title: Sizing of a solar installation
                                            - type: string
                                              enum:
                                                - DEMAND_RESPONSE
                                              title: Demand response
                                            - type: string
                                              enum:
                                                - ENERGY_PERFORMANCE_STUDY
                                              title: Energy performance study
                                            - type: string
                                              enum:
                                                - ENERGY_BROKERAGE
                                              title: Energy brokerage
                                            - type: string
                                              enum:
                                                - VEHICLE_CHARGE_DETECTION
                                              title: Detection of a vehicle charge
                                        - type: object
                                          required:
                                            - id
                                          properties:
                                            id:
                                              anyOf:
                                                - type: string
                                                  enum:
                                                    - SOLAR_INSTALLATION_SIZING
                                                  title: Sizing of a solar installation
                                                - type: string
                                                  enum:
                                                    - DEMAND_RESPONSE
                                                  title: Demand response
                                                - type: string
                                                  enum:
                                                    - ENERGY_PERFORMANCE_STUDY
                                                  title: Energy performance study
                                                - type: string
                                                  enum:
                                                    - ENERGY_BROKERAGE
                                                  title: Energy brokerage
                                                - type: string
                                                  enum:
                                                    - VEHICLE_CHARGE_DETECTION
                                                  title: Detection of a vehicle charge
                                          additionalProperties: false
                                additionalProperties: false
                                description: "**❗️ DEPRECATED ❗️** => use `scopes` and `purposes` instead. This
                                  field will be removed in a future version."
                            scopes:
                              type: array
                              items:
                                anyOf:
                                  - anyOf:
                                      - type: object
                                        required:
                                          - service
                                          - id
                                        properties:
                                          service:
                                            type: string
                                            enum:
                                              - ENEDIS_RAW_API
                                          id:
                                            type: string
                                            enum:
                                              - DETAILS_CONTRACTUELS
                                        additionalProperties: false
                                      - type: object
                                        required:
                                          - service
                                          - id
                                          - args
                                        properties:
                                          service:
                                            type: string
                                            enum:
                                              - ENEDIS_RAW_API
                                          id:
                                            type: string
                                            enum:
                                              - CONSUMPTION_DATA
                                          args:
                                            type: object
                                            required:
                                              - types
                                              - directions
                                            properties:
                                              types:
                                                type: array
                                                items:
                                                  type: string
                                                  enum:
                                                    - CDC
                                                    - PMAX
                                                    - IDX
                                                    - ENERGIE
                                              directions:
                                                type: array
                                                items:
                                                  type: string
                                                  enum:
                                                    - SOUTIRAGE
                                                    - INJECTION
                                            additionalProperties: false
                                        additionalProperties: false
                                  - anyOf:
                                      - type: object
                                        required:
                                          - id
                                          - args
                                        properties:
                                          id:
                                            type: string
                                            enum:
                                              - ELECTRICITY_TIMESERIES
                                          args:
                                            type: object
                                            required:
                                              - types
                                              - directions
                                            properties:
                                              types:
                                                type: array
                                                items:
                                                  type: string
                                                  enum:
                                                    - LOADCURVE
                                              directions:
                                                type: array
                                                items:
                                                  type: string
                                                  enum:
                                                    - CONSUMPTION
                                                    - INJECTION
                                            additionalProperties: false
                                        additionalProperties: false
                                      - type: object
                                        required:
                                          - id
                                          - args
                                        properties:
                                          id:
                                            type: string
                                            enum:
                                              - GAS_TIMESERIES
                                          args:
                                            type: object
                                            required:
                                              - types
                                              - directions
                                            properties:
                                              types:
                                                type: array
                                                items:
                                                  type: string
                                                  enum:
                                                    - BILLING
                                                    - DAILY
                                              directions:
                                                type: array
                                                items:
                                                  type: string
                                                  enum:
                                                    - CONSUMPTION
                                                    - INJECTION
                                            additionalProperties: false
                                        additionalProperties: false
                                      - type: object
                                        required:
                                          - id
                                        properties:
                                          id:
                                            type: string
                                            enum:
                                              - GAS_CONTRACT_DETAILS
                                        additionalProperties: false
                            purposes:
                              type: array
                              items:
                                anyOf:
                                  - anyOf:
                                      - type: string
                                        enum:
                                          - SOLAR_INSTALLATION_SIZING
                                        title: Sizing of a solar installation
                                      - type: string
                                        enum:
                                          - DEMAND_RESPONSE
                                        title: Demand response
                                      - type: string
                                        enum:
                                          - ENERGY_PERFORMANCE_STUDY
                                        title: Energy performance study
                                      - type: string
                                        enum:
                                          - ENERGY_BROKERAGE
                                        title: Energy brokerage
                                      - type: string
                                        enum:
                                          - VEHICLE_CHARGE_DETECTION
                                        title: Detection of a vehicle charge
                                  - type: object
                                    required:
                                      - id
                                    properties:
                                      id:
                                        anyOf:
                                          - type: string
                                            enum:
                                              - SOLAR_INSTALLATION_SIZING
                                            title: Sizing of a solar installation
                                          - type: string
                                            enum:
                                              - DEMAND_RESPONSE
                                            title: Demand response
                                          - type: string
                                            enum:
                                              - ENERGY_PERFORMANCE_STUDY
                                            title: Energy performance study
                                          - type: string
                                            enum:
                                              - ENERGY_BROKERAGE
                                            title: Energy brokerage
                                          - type: string
                                            enum:
                                              - VEHICLE_CHARGE_DETECTION
                                            title: Detection of a vehicle charge
                                    additionalProperties: false
                            consentDuration:
                              anyOf:
                                - type: string
                                  enum:
                                    - 1 day
                                  title: 1 day
                                - type: string
                                  enum:
                                    - 2 days
                                  title: 2 days
                                - type: string
                                  enum:
                                    - 3 days
                                  title: 3 days
                                - type: string
                                  enum:
                                    - 4 days
                                  title: 4 days
                                - type: string
                                  enum:
                                    - 5 days
                                  title: 5 days
                                - type: string
                                  enum:
                                    - 6 days
                                  title: 6 days
                                - type: string
                                  enum:
                                    - 1 week
                                  title: 1 week
                                - type: string
                                  enum:
                                    - 2 weeks
                                  title: 2 weeks
                                - type: string
                                  enum:
                                    - 3 weeks
                                  title: 3 weeks
                                - type: string
                                  enum:
                                    - 4 weeks
                                  title: 4 weeks
                                - type: string
                                  enum:
                                    - 1 month
                                  title: 1 month
                                - type: string
                                  enum:
                                    - 2 months
                                  title: 2 months
                                - type: string
                                  enum:
                                    - 3 months
                                  title: 3 months
                                - type: string
                                  enum:
                                    - 4 months
                                  title: 4 months
                                - type: string
                                  enum:
                                    - 5 months
                                  title: 5 months
                                - type: string
                                  enum:
                                    - 6 months
                                  title: 6 months
                                - type: string
                                  enum:
                                    - 1 year
                                  title: 1 year
                                - type: string
                                  enum:
                                    - 2 years
                                  title: 2 years
                                - type: string
                                  enum:
                                    - 3 years
                                  title: 3 years
                                - type: string
                                  enum:
                                    - 4 years
                                  title: 4 years
                                - type: string
                                  enum:
                                    - 5 years
                                  title: 5 years
                                - type: string
                                  enum:
                                    - 6 years
                                  title: 6 years
                                - type: string
                                  enum:
                                    - 7 years
                                  title: 7 years
                                - type: string
                                  enum:
                                    - 8 years
                                  title: 8 years
                                - type: string
                                  enum:
                                    - 9 years
                                  title: 9 years
                                - type: string
                                  enum:
                                    - 10 years
                                  title: 10 years
                                - type: string
                                  enum:
                                    - 11 years
                                  title: 11 years
                                - type: string
                                  enum:
                                    - 12 years
                                  title: 12 years
                                - type: string
                                  enum:
                                    - 13 years
                                  title: 13 years
                                - type: string
                                  enum:
                                    - 14 years
                                  title: 14 years
                                - type: string
                                  enum:
                                    - 15 years
                                  title: 15 years
                                - type: string
                                  enum:
                                    - 16 years
                                  title: 16 years
                                - type: string
                                  enum:
                                    - 17 years
                                  title: 17 years
                                - type: string
                                  enum:
                                    - 18 years
                                  title: 18 years
                                - type: string
                                  enum:
                                    - 19 years
                                  title: 19 years
                                - type: string
                                  enum:
                                    - 20 years
                                  title: 20 years
                            thirdPartyRecipients:
                              type: array
                              items:
                                type: string
                              description: Optional list of slugs identifying third parties who will get
                                access to the data after consent is given.
                            orgSlug:
                              type: string
                              description: Optional slug of the organization that will be used to create the
                                ask. If using a serviceAccount (API key) this is
                                not needed. If logged in as a user that has
                                access to more than one organization, this is
                                needed for disambiguation.
                          additionalProperties: false
                          examples:
                            - electricityContracts:
                                - 606b5149-1ef0-414a-8019-a050f64cc0ac
                            - electricityContracts:
                                - 606b5149-1ef0-414a-8019-a050f64cc0ac
                              signer:
                                lastName: lastName
                                firstName: firstName
                                email: signer-6LT0Y@domain.com
                              purposes:
                                - SOLAR_INSTALLATION_SIZING
                              consentDuration: 1 year
                        __experimentalAddressChecksResults:
                          type: object
                          required: []
                          properties: {}
                          additionalProperties:
                            type: object
                            required:
                              - status
                            properties:
                              status:
                                type: string
                                enum:
                                  - SUCCESS
                                  - FAILURE
                            additionalProperties: false
                        addressCheckResults:
                          type: object
                          required: []
                          properties: {}
                          additionalProperties:
                            type: object
                            required:
                              - status
                            properties:
                              status:
                                type: string
                                enum:
                                  - SUCCESS
                                  - FAILURE
                            additionalProperties: false
                        consentIds:
                          type: object
                          required: []
                          properties: {}
                          additionalProperties:
                            type: string
                            format: uuid
                            title: UUID
                          examples:
                            - "00052775405049": 7252fa9f-b86a-4b95-a090-1012b730004c
                              "00088663455690": 2083c06a-2793-4475-affc-acfec79d4225
                        contracts:
                          type: array
                          items:
                            $ref: "#/components/schemas/EnedisElectricityContract"
                        scopes:
                          type: array
                          items:
                            anyOf:
                              - anyOf:
                                  - type: object
                                    required:
                                      - service
                                      - id
                                    properties:
                                      service:
                                        type: string
                                        enum:
                                          - ENEDIS_RAW_API
                                      id:
                                        type: string
                                        enum:
                                          - DETAILS_CONTRACTUELS
                                    additionalProperties: false
                                  - type: object
                                    required:
                                      - service
                                      - id
                                      - args
                                    properties:
                                      service:
                                        type: string
                                        enum:
                                          - ENEDIS_RAW_API
                                      id:
                                        type: string
                                        enum:
                                          - CONSUMPTION_DATA
                                      args:
                                        type: object
                                        required:
                                          - types
                                          - directions
                                        properties:
                                          types:
                                            type: array
                                            items:
                                              type: string
                                              enum:
                                                - CDC
                                                - PMAX
                                                - IDX
                                                - ENERGIE
                                          directions:
                                            type: array
                                            items:
                                              type: string
                                              enum:
                                                - SOUTIRAGE
                                                - INJECTION
                                        additionalProperties: false
                                    additionalProperties: false
                              - anyOf:
                                  - type: object
                                    required:
                                      - id
                                      - args
                                    properties:
                                      id:
                                        type: string
                                        enum:
                                          - ELECTRICITY_TIMESERIES
                                      args:
                                        type: object
                                        required:
                                          - types
                                          - directions
                                        properties:
                                          types:
                                            type: array
                                            items:
                                              type: string
                                              enum:
                                                - LOADCURVE
                                          directions:
                                            type: array
                                            items:
                                              type: string
                                              enum:
                                                - CONSUMPTION
                                                - INJECTION
                                        additionalProperties: false
                                    additionalProperties: false
                                  - type: object
                                    required:
                                      - id
                                      - args
                                    properties:
                                      id:
                                        type: string
                                        enum:
                                          - GAS_TIMESERIES
                                      args:
                                        type: object
                                        required:
                                          - types
                                          - directions
                                        properties:
                                          types:
                                            type: array
                                            items:
                                              type: string
                                              enum:
                                                - BILLING
                                                - DAILY
                                          directions:
                                            type: array
                                            items:
                                              type: string
                                              enum:
                                                - CONSUMPTION
                                                - INJECTION
                                        additionalProperties: false
                                    additionalProperties: false
                                  - type: object
                                    required:
                                      - id
                                    properties:
                                      id:
                                        type: string
                                        enum:
                                          - GAS_CONTRACT_DETAILS
                                    additionalProperties: false
                        purposes:
                          type: array
                          items:
                            anyOf:
                              - type: string
                                enum:
                                  - SOLAR_INSTALLATION_SIZING
                                title: Sizing of a solar installation
                              - type: string
                                enum:
                                  - DEMAND_RESPONSE
                                title: Demand response
                              - type: string
                                enum:
                                  - ENERGY_PERFORMANCE_STUDY
                                title: Energy performance study
                              - type: string
                                enum:
                                  - ENERGY_BROKERAGE
                                title: Energy brokerage
                              - type: string
                                enum:
                                  - VEHICLE_CHARGE_DETECTION
                                title: Detection of a vehicle charge
                        testEnvironment:
                          type: boolean
                        thirdPartyRecipients:
                          type: array
                          items:
                            type: string
                      additionalProperties: false
                additionalProperties: false
        "400":
          description: The request did not match the expected schema
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: "#/components/schemas/HttpApiDecodeError"
                  - type: object
                    required:
                      - error
                    properties:
                      error:
                        $id: /schemas/any
                        title: any
                    additionalProperties: false
        "401":
          description: Error
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: string
                additionalProperties: false
      summary: List Asks
  /ask/{askId}:
    get:
      tags:
        - asks
      operationId: getAsk
      parameters:
        - name: askId
          in: path
          schema:
            type: string
          required: true
      security:
        - bearerAuth: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - id
                  - createdAt
                  - status
                  - acceptedAt
                  - consentCollectionDetails
                  - createArgs
                  - consentIds
                  - contracts
                  - scopes
                  - purposes
                  - testEnvironment
                  - thirdPartyRecipients
                properties:
                  id:
                    type: string
                    format: uuid
                    title: UUID
                  createdAt:
                    type: string
                    format: date-time
                    description: ISO 8601 date format
                    examples:
                      - 2024-12-10T00:00:00
                      - 2024-12-10T12:00:00Z
                      - 2024-12-10T00:00:00+01:00
                      - 2024-12-10
                      - 2024-12-10T00:00:00[Europe/Paris]
                      - 2024-12-10T00:00:00[CET]
                  status:
                    anyOf:
                      - type: string
                        enum:
                          - CREATED
                        title: CREATED
                      - type: string
                        enum:
                          - PENDING_ADDRESS_CHECK
                        title: PENDING_ADDRESS_CHECK
                      - type: string
                        enum:
                          - ADDRESS_CHECK_FAILED
                        title: ADDRESS_CHECK_FAILED
                      - type: string
                        enum:
                          - PREPARING_CONSENT_COLLECTION
                        title: PREPARING_CONSENT_COLLECTION
                      - type: string
                        enum:
                          - PENDING_USER_ACTION
                        title: PENDING_USER_ACTION
                      - type: string
                        enum:
                          - ACCEPTED
                        title: ACCEPTED
                  acceptedAt:
                    type: string
                    format: date-time
                    description: ISO 8601 date format
                    examples:
                      - 2024-12-10T00:00:00
                      - 2024-12-10T12:00:00Z
                      - 2024-12-10T00:00:00+01:00
                      - 2024-12-10
                      - 2024-12-10T00:00:00[Europe/Paris]
                      - 2024-12-10T00:00:00[CET]
                    nullable: true
                  consentCollectionDetails:
                    type: object
                    required:
                      - service
                      - userUrl
                    properties:
                      service:
                        type: string
                        enum:
                          - DOCUSEAL
                          - WEB_HOSTED
                      userUrl:
                        anyOf:
                          - $ref: "#/components/schemas/Url"
                          - $ref: "#/components/schemas/Url"
                    additionalProperties: false
                    nullable: true
                  createArgs:
                    type: object
                    required:
                      - electricityContracts
                    properties:
                      electricityContracts:
                        type: array
                        items:
                          anyOf:
                            - type: Uuid
                              format: uuid
                              identifier: ElectricityContractId
                              title: Electricity Contract Id
                              description: The identifier of an electricity contract. Usually got from the
                                endpoint `GET /search_contract`.
                            - $ref: "#/components/schemas/ElectricityContract"
                        title: Electricity Contracts
                      signer:
                        type: object
                        required: []
                        properties:
                          genre:
                            type: string
                            enum:
                              - M
                              - F
                          lastName:
                            type: string
                          firstName:
                            type: string
                          organizationName:
                            $ref: "#/components/schemas/NonEmptyString"
                          phone:
                            type: string
                          email:
                            $ref: "#/components/schemas/Email"
                        additionalProperties: false
                        description: >-
                          The person signing the Consent request.

                          For WEB_CONSENT, all fields are optional (the user
                          will be able to fill their names and organization).

                          For DOCUSEAL, fields firstName & lastName are
                          required.
                      consentCollectionMedium:
                        $ref: "#/components/schemas/ConsentCollectionMedium"
                      options:
                        type: object
                        required: []
                        properties:
                          skipAddressCheck:
                            type: boolean
                        additionalProperties: false
                      scopesAndPurpose:
                        type: array
                        items:
                          type: object
                          required:
                            - purposes
                          properties:
                            scopes:
                              type: array
                              items:
                                anyOf:
                                  - anyOf:
                                      - type: object
                                        required:
                                          - service
                                          - id
                                        properties:
                                          service:
                                            type: string
                                            enum:
                                              - ENEDIS_RAW_API
                                          id:
                                            type: string
                                            enum:
                                              - DETAILS_CONTRACTUELS
                                        additionalProperties: false
                                      - type: object
                                        required:
                                          - service
                                          - id
                                          - args
                                        properties:
                                          service:
                                            type: string
                                            enum:
                                              - ENEDIS_RAW_API
                                          id:
                                            type: string
                                            enum:
                                              - CONSUMPTION_DATA
                                          args:
                                            type: object
                                            required:
                                              - types
                                              - directions
                                            properties:
                                              types:
                                                type: array
                                                items:
                                                  type: string
                                                  enum:
                                                    - CDC
                                                    - PMAX
                                                    - IDX
                                                    - ENERGIE
                                              directions:
                                                type: array
                                                items:
                                                  type: string
                                                  enum:
                                                    - SOUTIRAGE
                                                    - INJECTION
                                            additionalProperties: false
                                        additionalProperties: false
                                  - anyOf:
                                      - type: object
                                        required:
                                          - id
                                          - args
                                        properties:
                                          id:
                                            type: string
                                            enum:
                                              - ELECTRICITY_TIMESERIES
                                          args:
                                            type: object
                                            required:
                                              - types
                                              - directions
                                            properties:
                                              types:
                                                type: array
                                                items:
                                                  type: string
                                                  enum:
                                                    - LOADCURVE
                                              directions:
                                                type: array
                                                items:
                                                  type: string
                                                  enum:
                                                    - CONSUMPTION
                                                    - INJECTION
                                            additionalProperties: false
                                        additionalProperties: false
                                      - type: object
                                        required:
                                          - id
                                          - args
                                        properties:
                                          id:
                                            type: string
                                            enum:
                                              - GAS_TIMESERIES
                                          args:
                                            type: object
                                            required:
                                              - types
                                              - directions
                                            properties:
                                              types:
                                                type: array
                                                items:
                                                  type: string
                                                  enum:
                                                    - BILLING
                                                    - DAILY
                                              directions:
                                                type: array
                                                items:
                                                  type: string
                                                  enum:
                                                    - CONSUMPTION
                                                    - INJECTION
                                            additionalProperties: false
                                        additionalProperties: false
                                      - type: object
                                        required:
                                          - id
                                        properties:
                                          id:
                                            type: string
                                            enum:
                                              - GAS_CONTRACT_DETAILS
                                        additionalProperties: false
                            purposes:
                              type: array
                              items:
                                anyOf:
                                  - anyOf:
                                      - type: string
                                        enum:
                                          - SOLAR_INSTALLATION_SIZING
                                        title: Sizing of a solar installation
                                      - type: string
                                        enum:
                                          - DEMAND_RESPONSE
                                        title: Demand response
                                      - type: string
                                        enum:
                                          - ENERGY_PERFORMANCE_STUDY
                                        title: Energy performance study
                                      - type: string
                                        enum:
                                          - ENERGY_BROKERAGE
                                        title: Energy brokerage
                                      - type: string
                                        enum:
                                          - VEHICLE_CHARGE_DETECTION
                                        title: Detection of a vehicle charge
                                  - type: object
                                    required:
                                      - id
                                    properties:
                                      id:
                                        anyOf:
                                          - type: string
                                            enum:
                                              - SOLAR_INSTALLATION_SIZING
                                            title: Sizing of a solar installation
                                          - type: string
                                            enum:
                                              - DEMAND_RESPONSE
                                            title: Demand response
                                          - type: string
                                            enum:
                                              - ENERGY_PERFORMANCE_STUDY
                                            title: Energy performance study
                                          - type: string
                                            enum:
                                              - ENERGY_BROKERAGE
                                            title: Energy brokerage
                                          - type: string
                                            enum:
                                              - VEHICLE_CHARGE_DETECTION
                                            title: Detection of a vehicle charge
                                    additionalProperties: false
                          additionalProperties: false
                          description: "**❗️ DEPRECATED ❗️** => use `scopes` and `purposes` instead. This
                            field will be removed in a future version."
                      scopes:
                        type: array
                        items:
                          anyOf:
                            - anyOf:
                                - type: object
                                  required:
                                    - service
                                    - id
                                  properties:
                                    service:
                                      type: string
                                      enum:
                                        - ENEDIS_RAW_API
                                    id:
                                      type: string
                                      enum:
                                        - DETAILS_CONTRACTUELS
                                  additionalProperties: false
                                - type: object
                                  required:
                                    - service
                                    - id
                                    - args
                                  properties:
                                    service:
                                      type: string
                                      enum:
                                        - ENEDIS_RAW_API
                                    id:
                                      type: string
                                      enum:
                                        - CONSUMPTION_DATA
                                    args:
                                      type: object
                                      required:
                                        - types
                                        - directions
                                      properties:
                                        types:
                                          type: array
                                          items:
                                            type: string
                                            enum:
                                              - CDC
                                              - PMAX
                                              - IDX
                                              - ENERGIE
                                        directions:
                                          type: array
                                          items:
                                            type: string
                                            enum:
                                              - SOUTIRAGE
                                              - INJECTION
                                      additionalProperties: false
                                  additionalProperties: false
                            - anyOf:
                                - type: object
                                  required:
                                    - id
                                    - args
                                  properties:
                                    id:
                                      type: string
                                      enum:
                                        - ELECTRICITY_TIMESERIES
                                    args:
                                      type: object
                                      required:
                                        - types
                                        - directions
                                      properties:
                                        types:
                                          type: array
                                          items:
                                            type: string
                                            enum:
                                              - LOADCURVE
                                        directions:
                                          type: array
                                          items:
                                            type: string
                                            enum:
                                              - CONSUMPTION
                                              - INJECTION
                                      additionalProperties: false
                                  additionalProperties: false
                                - type: object
                                  required:
                                    - id
                                    - args
                                  properties:
                                    id:
                                      type: string
                                      enum:
                                        - GAS_TIMESERIES
                                    args:
                                      type: object
                                      required:
                                        - types
                                        - directions
                                      properties:
                                        types:
                                          type: array
                                          items:
                                            type: string
                                            enum:
                                              - BILLING
                                              - DAILY
                                        directions:
                                          type: array
                                          items:
                                            type: string
                                            enum:
                                              - CONSUMPTION
                                              - INJECTION
                                      additionalProperties: false
                                  additionalProperties: false
                                - type: object
                                  required:
                                    - id
                                  properties:
                                    id:
                                      type: string
                                      enum:
                                        - GAS_CONTRACT_DETAILS
                                  additionalProperties: false
                      purposes:
                        type: array
                        items:
                          anyOf:
                            - anyOf:
                                - type: string
                                  enum:
                                    - SOLAR_INSTALLATION_SIZING
                                  title: Sizing of a solar installation
                                - type: string
                                  enum:
                                    - DEMAND_RESPONSE
                                  title: Demand response
                                - type: string
                                  enum:
                                    - ENERGY_PERFORMANCE_STUDY
                                  title: Energy performance study
                                - type: string
                                  enum:
                                    - ENERGY_BROKERAGE
                                  title: Energy brokerage
                                - type: string
                                  enum:
                                    - VEHICLE_CHARGE_DETECTION
                                  title: Detection of a vehicle charge
                            - type: object
                              required:
                                - id
                              properties:
                                id:
                                  anyOf:
                                    - type: string
                                      enum:
                                        - SOLAR_INSTALLATION_SIZING
                                      title: Sizing of a solar installation
                                    - type: string
                                      enum:
                                        - DEMAND_RESPONSE
                                      title: Demand response
                                    - type: string
                                      enum:
                                        - ENERGY_PERFORMANCE_STUDY
                                      title: Energy performance study
                                    - type: string
                                      enum:
                                        - ENERGY_BROKERAGE
                                      title: Energy brokerage
                                    - type: string
                                      enum:
                                        - VEHICLE_CHARGE_DETECTION
                                      title: Detection of a vehicle charge
                              additionalProperties: false
                      consentDuration:
                        anyOf:
                          - type: string
                            enum:
                              - 1 day
                            title: 1 day
                          - type: string
                            enum:
                              - 2 days
                            title: 2 days
                          - type: string
                            enum:
                              - 3 days
                            title: 3 days
                          - type: string
                            enum:
                              - 4 days
                            title: 4 days
                          - type: string
                            enum:
                              - 5 days
                            title: 5 days
                          - type: string
                            enum:
                              - 6 days
                            title: 6 days
                          - type: string
                            enum:
                              - 1 week
                            title: 1 week
                          - type: string
                            enum:
                              - 2 weeks
                            title: 2 weeks
                          - type: string
                            enum:
                              - 3 weeks
                            title: 3 weeks
                          - type: string
                            enum:
                              - 4 weeks
                            title: 4 weeks
                          - type: string
                            enum:
                              - 1 month
                            title: 1 month
                          - type: string
                            enum:
                              - 2 months
                            title: 2 months
                          - type: string
                            enum:
                              - 3 months
                            title: 3 months
                          - type: string
                            enum:
                              - 4 months
                            title: 4 months
                          - type: string
                            enum:
                              - 5 months
                            title: 5 months
                          - type: string
                            enum:
                              - 6 months
                            title: 6 months
                          - type: string
                            enum:
                              - 1 year
                            title: 1 year
                          - type: string
                            enum:
                              - 2 years
                            title: 2 years
                          - type: string
                            enum:
                              - 3 years
                            title: 3 years
                          - type: string
                            enum:
                              - 4 years
                            title: 4 years
                          - type: string
                            enum:
                              - 5 years
                            title: 5 years
                          - type: string
                            enum:
                              - 6 years
                            title: 6 years
                          - type: string
                            enum:
                              - 7 years
                            title: 7 years
                          - type: string
                            enum:
                              - 8 years
                            title: 8 years
                          - type: string
                            enum:
                              - 9 years
                            title: 9 years
                          - type: string
                            enum:
                              - 10 years
                            title: 10 years
                          - type: string
                            enum:
                              - 11 years
                            title: 11 years
                          - type: string
                            enum:
                              - 12 years
                            title: 12 years
                          - type: string
                            enum:
                              - 13 years
                            title: 13 years
                          - type: string
                            enum:
                              - 14 years
                            title: 14 years
                          - type: string
                            enum:
                              - 15 years
                            title: 15 years
                          - type: string
                            enum:
                              - 16 years
                            title: 16 years
                          - type: string
                            enum:
                              - 17 years
                            title: 17 years
                          - type: string
                            enum:
                              - 18 years
                            title: 18 years
                          - type: string
                            enum:
                              - 19 years
                            title: 19 years
                          - type: string
                            enum:
                              - 20 years
                            title: 20 years
                      thirdPartyRecipients:
                        type: array
                        items:
                          type: string
                        description: Optional list of slugs identifying third parties who will get
                          access to the data after consent is given.
                      orgSlug:
                        type: string
                        description: Optional slug of the organization that will be used to create the
                          ask. If using a serviceAccount (API key) this is not
                          needed. If logged in as a user that has access to more
                          than one organization, this is needed for
                          disambiguation.
                    additionalProperties: false
                    examples:
                      - electricityContracts:
                          - 606b5149-1ef0-414a-8019-a050f64cc0ac
                      - electricityContracts:
                          - 606b5149-1ef0-414a-8019-a050f64cc0ac
                        signer:
                          lastName: lastName
                          firstName: firstName
                          email: signer-6LT0Y@domain.com
                        purposes:
                          - SOLAR_INSTALLATION_SIZING
                        consentDuration: 1 year
                  __experimentalAddressChecksResults:
                    type: object
                    required: []
                    properties: {}
                    additionalProperties:
                      type: object
                      required:
                        - status
                      properties:
                        status:
                          type: string
                          enum:
                            - SUCCESS
                            - FAILURE
                      additionalProperties: false
                  addressCheckResults:
                    type: object
                    required: []
                    properties: {}
                    additionalProperties:
                      type: object
                      required:
                        - status
                      properties:
                        status:
                          type: string
                          enum:
                            - SUCCESS
                            - FAILURE
                      additionalProperties: false
                  consentIds:
                    type: object
                    required: []
                    properties: {}
                    additionalProperties:
                      type: string
                      format: uuid
                      title: UUID
                    examples:
                      - "00052775405049": 7252fa9f-b86a-4b95-a090-1012b730004c
                        "00088663455690": 2083c06a-2793-4475-affc-acfec79d4225
                  contracts:
                    type: array
                    items:
                      $ref: "#/components/schemas/EnedisElectricityContract"
                  scopes:
                    type: array
                    items:
                      anyOf:
                        - anyOf:
                            - type: object
                              required:
                                - service
                                - id
                              properties:
                                service:
                                  type: string
                                  enum:
                                    - ENEDIS_RAW_API
                                id:
                                  type: string
                                  enum:
                                    - DETAILS_CONTRACTUELS
                              additionalProperties: false
                            - type: object
                              required:
                                - service
                                - id
                                - args
                              properties:
                                service:
                                  type: string
                                  enum:
                                    - ENEDIS_RAW_API
                                id:
                                  type: string
                                  enum:
                                    - CONSUMPTION_DATA
                                args:
                                  type: object
                                  required:
                                    - types
                                    - directions
                                  properties:
                                    types:
                                      type: array
                                      items:
                                        type: string
                                        enum:
                                          - CDC
                                          - PMAX
                                          - IDX
                                          - ENERGIE
                                    directions:
                                      type: array
                                      items:
                                        type: string
                                        enum:
                                          - SOUTIRAGE
                                          - INJECTION
                                  additionalProperties: false
                              additionalProperties: false
                        - anyOf:
                            - type: object
                              required:
                                - id
                                - args
                              properties:
                                id:
                                  type: string
                                  enum:
                                    - ELECTRICITY_TIMESERIES
                                args:
                                  type: object
                                  required:
                                    - types
                                    - directions
                                  properties:
                                    types:
                                      type: array
                                      items:
                                        type: string
                                        enum:
                                          - LOADCURVE
                                    directions:
                                      type: array
                                      items:
                                        type: string
                                        enum:
                                          - CONSUMPTION
                                          - INJECTION
                                  additionalProperties: false
                              additionalProperties: false
                            - type: object
                              required:
                                - id
                                - args
                              properties:
                                id:
                                  type: string
                                  enum:
                                    - GAS_TIMESERIES
                                args:
                                  type: object
                                  required:
                                    - types
                                    - directions
                                  properties:
                                    types:
                                      type: array
                                      items:
                                        type: string
                                        enum:
                                          - BILLING
                                          - DAILY
                                    directions:
                                      type: array
                                      items:
                                        type: string
                                        enum:
                                          - CONSUMPTION
                                          - INJECTION
                                  additionalProperties: false
                              additionalProperties: false
                            - type: object
                              required:
                                - id
                              properties:
                                id:
                                  type: string
                                  enum:
                                    - GAS_CONTRACT_DETAILS
                              additionalProperties: false
                  purposes:
                    type: array
                    items:
                      anyOf:
                        - type: string
                          enum:
                            - SOLAR_INSTALLATION_SIZING
                          title: Sizing of a solar installation
                        - type: string
                          enum:
                            - DEMAND_RESPONSE
                          title: Demand response
                        - type: string
                          enum:
                            - ENERGY_PERFORMANCE_STUDY
                          title: Energy performance study
                        - type: string
                          enum:
                            - ENERGY_BROKERAGE
                          title: Energy brokerage
                        - type: string
                          enum:
                            - VEHICLE_CHARGE_DETECTION
                          title: Detection of a vehicle charge
                  testEnvironment:
                    type: boolean
                  thirdPartyRecipients:
                    type: array
                    items:
                      type: string
                additionalProperties: false
        "400":
          description: The request did not match the expected schema
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: "#/components/schemas/HttpApiDecodeError"
                  - type: object
                    required:
                      - error
                    properties:
                      error:
                        $id: /schemas/any
                        title: any
                    additionalProperties: false
        "401":
          description: Error
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: string
                additionalProperties: false
      summary: Get an Ask
  /ask/{askId}/proof:
    get:
      tags:
        - asks
      operationId: getAskProof
      parameters:
        - name: askId
          in: path
          schema:
            type: string
          required: true
      security:
        - bearerAuth: []
      responses:
        "200":
          description: a string
          content:
            application/pdf:
              schema:
                type: string
        "400":
          description: The request did not match the expected schema
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: "#/components/schemas/HttpApiDecodeError"
                  - type: object
                    required:
                      - error
                    properties:
                      error:
                        $id: /schemas/any
                        title: any
                    additionalProperties: false
        "401":
          description: Error
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: string
                additionalProperties: false
      summary: Get an Ask proof as PDF, when it's accepted
  /order:
    post:
      tags:
        - orders
      operationId: order
      parameters:
        - name: switchgrid-test-env
          in: header
          schema:
            $ref: "#/components/schemas/BooleanFromString"
          required: false
      security:
        - bearerAuth: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - id
                  - status
                  - requests
                properties:
                  id:
                    type: string
                    format: uuid
                    title: UUID
                  status:
                    $comment: /schemas/enums
                    anyOf:
                      - type: string
                        title: CREATED
                        enum:
                          - CREATED
                      - type: string
                        title: PENDING_ADDRESS_CHECK
                        enum:
                          - PENDING_ADDRESS_CHECK
                      - type: string
                        title: ADDRESS_CHECK_FAILED
                        enum:
                          - ADDRESS_CHECK_FAILED
                      - type: string
                        title: PENDING_REQUESTS
                        enum:
                          - PENDING_REQUESTS
                      - type: string
                        title: SOME_REQUESTS_FAILED
                        enum:
                          - SOME_REQUESTS_FAILED
                      - type: string
                        title: SUCCESS
                        enum:
                          - SUCCESS
                  requests:
                    type: array
                    items:
                      type: object
                      required:
                        - id
                        - type
                        - status
                        - orderedAt
                        - completedAt
                        - errorMessage
                      properties:
                        id:
                          type: string
                          format: uuid
                          title: UUID
                        type:
                          type: string
                          enum:
                            - C68
                            - C68_ASYNC
                            - R63
                            - R63_SYNC
                            - R64
                            - R64_SYNC
                            - R65
                            - R65_SYNC
                            - R66
                            - R66_SYNC
                            - R67
                            - LOADCURVE
                        status:
                          anyOf:
                            - $comment: /schemas/enums
                              anyOf:
                                - type: string
                                  title: NOT_STARTED
                                  enum:
                                    - NOT_STARTED
                                - type: string
                                  title: PENDING
                                  enum:
                                    - PENDING
                                - type: string
                                  title: SUCCESS
                                  enum:
                                    - SUCCESS
                                - type: string
                                  title: FAILED
                                  enum:
                                    - FAILED
                            - type: string
                              enum:
                                - PENDING_ADDRESS_CHECK
                        orderedAt:
                          $ref: "#/components/schemas/Date"
                          nullable: true
                        completedAt:
                          $ref: "#/components/schemas/Date"
                          nullable: true
                        dataUrl:
                          type: string
                          nullable: true
                        errorMessage:
                          type: string
                          nullable: true
                        requestedTimeRange:
                          type: string
                          nullable: true
                        summaryPerContract:
                          type: array
                          items:
                            anyOf:
                              - anyOf:
                                  - type: object
                                    required:
                                      - _tag
                                      - _status
                                      - prm
                                      - timeRangeCoverageRatio
                                      - holes
                                      - errorMessage
                                    properties:
                                      _tag:
                                        type: string
                                        enum:
                                          - LoadcurveRequestContractSummary
                                      _status:
                                        type: string
                                        enum:
                                          - final
                                      prm:
                                        $ref: "#/components/schemas/Prm"
                                      timeRangeCoverageRatio:
                                        type: number
                                        description: A ratio between 0 and 1, representing the coverage of the requested
                                          time range by the returned data
                                      holes:
                                        type: array
                                        items:
                                          type: string
                                        description: An array of intervals that are **NOT** covered by the returned
                                          data. It's an array of intervals. Each
                                          interval is 2 dates separated by a
                                          slash. The dates are in ISO 8601
                                          format.
                                        examples:
                                          - - 2025-01-01T00:00:00.000Z/2025-01-01T00:00:00.000Z
                                      errorMessage:
                                        type: string
                                        nullable: true
                                    additionalProperties: false
                                  - type: object
                                    required:
                                      - _tag
                                      - _status
                                      - prm
                                      - message
                                    properties:
                                      _tag:
                                        type: string
                                        enum:
                                          - LoadcurveRequestContractSummary
                                      _status:
                                        type: string
                                        enum:
                                          - pending
                                      prm:
                                        $ref: "#/components/schemas/Prm"
                                      message:
                                        type: string
                                    additionalProperties: false
                              - type: object
                                required:
                                  - _tag
                                  - prm
                                  - fileUrl
                                  - errorMessage
                                properties:
                                  _tag:
                                    type: string
                                    enum:
                                      - RawFileContractSummary
                                  prm:
                                    $ref: "#/components/schemas/Prm"
                                  fileUrl:
                                    type: string
                                    nullable: true
                                  errorMessage:
                                    type: string
                                    nullable: true
                                additionalProperties: false
                        loadCurve:
                          type: object
                          required:
                            - period
                            - startsAt
                            - endsAt
                            - values
                          properties:
                            period:
                              type: string
                            startsAt:
                              $ref: "#/components/schemas/Date"
                            endsAt:
                              $ref: "#/components/schemas/Date"
                            values:
                              type: array
                              items:
                                type: number
                                nullable: true
                          additionalProperties: false
                          nullable: true
                      additionalProperties: false
                    examples:
                      - - id: da466b13-6904-4a5d-a108-746808686631
                          type: C68
                          status: SUCCESS
                          orderedAt: 2021-09-01T00:00:00.000Z
                          completedAt: 2021-09-01T00:02:00.000Z
                          dataUrl: https://example.com/data.json
                          errorMessage: null
                additionalProperties: false
        "400":
          description: The request did not match the expected schema
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: "#/components/schemas/HttpApiDecodeError"
                  - type: object
                    required:
                      - error
                    properties:
                      error:
                        $id: /schemas/any
                        title: any
                    additionalProperties: false
        "401":
          description: Error
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: string
                additionalProperties: false
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
                - type: object
                  required:
                    - consentId
                    - requests
                  properties:
                    consentId:
                      type: string
                      format: uuid
                      title: UUID
                    requests:
                      type: array
                      items:
                        anyOf:
                          - type: object
                            required:
                              - type
                            properties:
                              type:
                                type: string
                                enum:
                                  - C68
                            additionalProperties: false
                          - type: object
                            required:
                              - type
                            properties:
                              type:
                                type: string
                                enum:
                                  - C68_ASYNC
                              direction:
                                type: string
                                enum:
                                  - CONSUMPTION
                                  - INJECTION
                            additionalProperties: false
                          - type: object
                            required:
                              - type
                            properties:
                              type:
                                type: string
                                enum:
                                  - R63
                              direction:
                                type: string
                                enum:
                                  - SOUTIRAGE
                                  - INJECTION
                              since:
                                type: string
                                format: date-time
                                description: ISO 8601 date format
                                examples:
                                  - 2024-12-10T00:00:00
                                  - 2024-12-10T12:00:00Z
                                  - 2024-12-10T00:00:00+01:00
                                  - 2024-12-10
                                  - 2024-12-10T00:00:00[Europe/Paris]
                                  - 2024-12-10T00:00:00[CET]
                              until:
                                type: string
                                format: date-time
                                description: ISO 8601 date format
                                examples:
                                  - 2024-12-10T00:00:00
                                  - 2024-12-10T12:00:00Z
                                  - 2024-12-10T00:00:00+01:00
                                  - 2024-12-10
                                  - 2024-12-10T00:00:00[Europe/Paris]
                                  - 2024-12-10T00:00:00[CET]
                              enedisRetryAfterLoadcurveActivation:
                                type: boolean
                                description: Retry after Enedis Loadcurve Activation (Activation de la collecte
                                  de courbe de charge)
                            additionalProperties: false
                          - type: object
                            required:
                              - type
                            properties:
                              type:
                                type: string
                                enum:
                                  - R64
                              direction:
                                type: string
                                enum:
                                  - SOUTIRAGE
                                  - INJECTION
                              since:
                                type: string
                                format: date-time
                                description: ISO 8601 date format
                                examples:
                                  - 2024-12-10T00:00:00
                                  - 2024-12-10T12:00:00Z
                                  - 2024-12-10T00:00:00+01:00
                                  - 2024-12-10
                                  - 2024-12-10T00:00:00[Europe/Paris]
                                  - 2024-12-10T00:00:00[CET]
                              until:
                                type: string
                                format: date-time
                                description: ISO 8601 date format
                                examples:
                                  - 2024-12-10T00:00:00
                                  - 2024-12-10T12:00:00Z
                                  - 2024-12-10T00:00:00+01:00
                                  - 2024-12-10
                                  - 2024-12-10T00:00:00[Europe/Paris]
                                  - 2024-12-10T00:00:00[CET]
                            additionalProperties: false
                          - type: object
                            required:
                              - type
                            properties:
                              type:
                                type: string
                                enum:
                                  - R65
                              direction:
                                type: string
                                enum:
                                  - SOUTIRAGE
                                  - INJECTION
                              since:
                                type: string
                                format: date-time
                                description: ISO 8601 date format
                                examples:
                                  - 2024-12-10T00:00:00
                                  - 2024-12-10T12:00:00Z
                                  - 2024-12-10T00:00:00+01:00
                                  - 2024-12-10
                                  - 2024-12-10T00:00:00[Europe/Paris]
                                  - 2024-12-10T00:00:00[CET]
                              until:
                                type: string
                                format: date-time
                                description: ISO 8601 date format
                                examples:
                                  - 2024-12-10T00:00:00
                                  - 2024-12-10T12:00:00Z
                                  - 2024-12-10T00:00:00+01:00
                                  - 2024-12-10
                                  - 2024-12-10T00:00:00[Europe/Paris]
                                  - 2024-12-10T00:00:00[CET]
                            additionalProperties: false
                          - type: object
                            required:
                              - type
                            properties:
                              type:
                                type: string
                                enum:
                                  - R66
                              direction:
                                type: string
                                enum:
                                  - SOUTIRAGE
                                  - INJECTION
                              since:
                                type: string
                                format: date-time
                                description: ISO 8601 date format
                                examples:
                                  - 2024-12-10T00:00:00
                                  - 2024-12-10T12:00:00Z
                                  - 2024-12-10T00:00:00+01:00
                                  - 2024-12-10
                                  - 2024-12-10T00:00:00[Europe/Paris]
                                  - 2024-12-10T00:00:00[CET]
                              until:
                                type: string
                                format: date-time
                                description: ISO 8601 date format
                                examples:
                                  - 2024-12-10T00:00:00
                                  - 2024-12-10T12:00:00Z
                                  - 2024-12-10T00:00:00+01:00
                                  - 2024-12-10
                                  - 2024-12-10T00:00:00[Europe/Paris]
                                  - 2024-12-10T00:00:00[CET]
                            additionalProperties: false
                          - type: object
                            required:
                              - type
                            properties:
                              type:
                                type: string
                                enum:
                                  - R67
                              direction:
                                type: string
                                enum:
                                  - SOUTIRAGE
                                  - INJECTION
                              since:
                                type: string
                                format: date-time
                                description: ISO 8601 date format
                                examples:
                                  - 2024-12-10T00:00:00
                                  - 2024-12-10T12:00:00Z
                                  - 2024-12-10T00:00:00+01:00
                                  - 2024-12-10
                                  - 2024-12-10T00:00:00[Europe/Paris]
                                  - 2024-12-10T00:00:00[CET]
                              until:
                                type: string
                                format: date-time
                                description: ISO 8601 date format
                                examples:
                                  - 2024-12-10T00:00:00
                                  - 2024-12-10T12:00:00Z
                                  - 2024-12-10T00:00:00+01:00
                                  - 2024-12-10
                                  - 2024-12-10T00:00:00[Europe/Paris]
                                  - 2024-12-10T00:00:00[CET]
                            additionalProperties: false
                          - type: object
                            required:
                              - type
                            properties:
                              type:
                                type: string
                                enum:
                                  - R63_SYNC
                              direction:
                                type: string
                                enum:
                                  - SOUTIRAGE
                                  - INJECTION
                              since:
                                type: string
                                format: date-time
                                description: ISO 8601 date format
                                examples:
                                  - 2024-12-10T00:00:00
                                  - 2024-12-10T12:00:00Z
                                  - 2024-12-10T00:00:00+01:00
                                  - 2024-12-10
                                  - 2024-12-10T00:00:00[Europe/Paris]
                                  - 2024-12-10T00:00:00[CET]
                              until:
                                type: string
                                format: date-time
                                description: ISO 8601 date format
                                examples:
                                  - 2024-12-10T00:00:00
                                  - 2024-12-10T12:00:00Z
                                  - 2024-12-10T00:00:00+01:00
                                  - 2024-12-10
                                  - 2024-12-10T00:00:00[Europe/Paris]
                                  - 2024-12-10T00:00:00[CET]
                              enedisCorrection:
                                type: boolean
                                description: Correction Enedis (only for 'C5' segment)
                              enedisRetryAfterLoadcurveActivation:
                                type: boolean
                                description: Retry after Enedis Loadcurve Activation (Activation de la collecte
                                  de courbe de charge)
                            additionalProperties: false
                          - type: object
                            required:
                              - type
                            properties:
                              type:
                                type: string
                                enum:
                                  - R64_SYNC
                              direction:
                                type: string
                                enum:
                                  - SOUTIRAGE
                                  - INJECTION
                              since:
                                type: string
                                format: date-time
                                description: ISO 8601 date format
                                examples:
                                  - 2024-12-10T00:00:00
                                  - 2024-12-10T12:00:00Z
                                  - 2024-12-10T00:00:00+01:00
                                  - 2024-12-10
                                  - 2024-12-10T00:00:00[Europe/Paris]
                                  - 2024-12-10T00:00:00[CET]
                              until:
                                type: string
                                format: date-time
                                description: ISO 8601 date format
                                examples:
                                  - 2024-12-10T00:00:00
                                  - 2024-12-10T12:00:00Z
                                  - 2024-12-10T00:00:00+01:00
                                  - 2024-12-10
                                  - 2024-12-10T00:00:00[Europe/Paris]
                                  - 2024-12-10T00:00:00[CET]
                              enedisCorrection:
                                type: boolean
                                description: Correction Enedis (only for 'C5' segment)
                            additionalProperties: false
                          - type: object
                            required:
                              - type
                            properties:
                              type:
                                type: string
                                enum:
                                  - R65_SYNC
                              direction:
                                type: string
                                enum:
                                  - SOUTIRAGE
                                  - INJECTION
                              since:
                                type: string
                                format: date-time
                                description: ISO 8601 date format
                                examples:
                                  - 2024-12-10T00:00:00
                                  - 2024-12-10T12:00:00Z
                                  - 2024-12-10T00:00:00+01:00
                                  - 2024-12-10
                                  - 2024-12-10T00:00:00[Europe/Paris]
                                  - 2024-12-10T00:00:00[CET]
                              until:
                                type: string
                                format: date-time
                                description: ISO 8601 date format
                                examples:
                                  - 2024-12-10T00:00:00
                                  - 2024-12-10T12:00:00Z
                                  - 2024-12-10T00:00:00+01:00
                                  - 2024-12-10
                                  - 2024-12-10T00:00:00[Europe/Paris]
                                  - 2024-12-10T00:00:00[CET]
                              enedisCorrection:
                                type: boolean
                                description: Correction Enedis (only for 'C5' segment)
                            additionalProperties: false
                          - type: object
                            required:
                              - type
                            properties:
                              type:
                                type: string
                                enum:
                                  - R66_SYNC
                              direction:
                                type: string
                                enum:
                                  - SOUTIRAGE
                                  - INJECTION
                              since:
                                type: string
                                format: date-time
                                description: ISO 8601 date format
                                examples:
                                  - 2024-12-10T00:00:00
                                  - 2024-12-10T12:00:00Z
                                  - 2024-12-10T00:00:00+01:00
                                  - 2024-12-10
                                  - 2024-12-10T00:00:00[Europe/Paris]
                                  - 2024-12-10T00:00:00[CET]
                              until:
                                type: string
                                format: date-time
                                description: ISO 8601 date format
                                examples:
                                  - 2024-12-10T00:00:00
                                  - 2024-12-10T12:00:00Z
                                  - 2024-12-10T00:00:00+01:00
                                  - 2024-12-10
                                  - 2024-12-10T00:00:00[Europe/Paris]
                                  - 2024-12-10T00:00:00[CET]
                              enedisCorrection:
                                type: boolean
                                description: Correction Enedis (only for 'C5' segment)
                            additionalProperties: false
                          - type: object
                            required:
                              - type
                            properties:
                              type:
                                type: string
                                enum:
                                  - LOADCURVE
                              direction:
                                type: string
                                enum:
                                  - CONSUMPTION
                                  - INJECTION
                              since:
                                type: string
                                format: date-time
                                description: ISO 8601 date format
                                examples:
                                  - 2024-12-10T00:00:00
                                  - 2024-12-10T12:00:00Z
                                  - 2024-12-10T00:00:00+01:00
                                  - 2024-12-10
                                  - 2024-12-10T00:00:00[Europe/Paris]
                                  - 2024-12-10T00:00:00[CET]
                              until:
                                type: string
                                format: date-time
                                description: ISO 8601 date format
                                examples:
                                  - 2024-12-10T00:00:00
                                  - 2024-12-10T12:00:00Z
                                  - 2024-12-10T00:00:00+01:00
                                  - 2024-12-10
                                  - 2024-12-10T00:00:00[Europe/Paris]
                                  - 2024-12-10T00:00:00[CET]
                              enedisCorrection:
                                type: boolean
                                description: Correction Enedis (only for 'C5' segment)
                              enedisRetryAfterLoadcurveActivation:
                                type: boolean
                                description: Retry after Enedis Loadcurve Activation (Activation de la collecte
                                  de courbe de charge)
                            additionalProperties: false
                  additionalProperties: false
                - type: object
                  required:
                    - requests
                  properties:
                    requests:
                      type: array
                      items:
                        anyOf:
                          - type: object
                            required:
                              - type
                              - prms
                            properties:
                              type:
                                type: string
                                enum:
                                  - C68
                              prms:
                                type: array
                                items:
                                  $ref: "#/components/schemas/Prm"
                            additionalProperties: false
                          - type: object
                            required:
                              - type
                              - prms
                            properties:
                              type:
                                type: string
                                enum:
                                  - C68_ASYNC
                              direction:
                                type: string
                                enum:
                                  - CONSUMPTION
                                  - INJECTION
                              prms:
                                type: array
                                items:
                                  $ref: "#/components/schemas/Prm"
                            additionalProperties: false
                          - type: object
                            required:
                              - type
                              - prms
                            properties:
                              type:
                                type: string
                                enum:
                                  - R63
                              direction:
                                type: string
                                enum:
                                  - SOUTIRAGE
                                  - INJECTION
                              since:
                                type: string
                                format: date-time
                                description: ISO 8601 date format
                                examples:
                                  - 2024-12-10T00:00:00
                                  - 2024-12-10T12:00:00Z
                                  - 2024-12-10T00:00:00+01:00
                                  - 2024-12-10
                                  - 2024-12-10T00:00:00[Europe/Paris]
                                  - 2024-12-10T00:00:00[CET]
                              until:
                                type: string
                                format: date-time
                                description: ISO 8601 date format
                                examples:
                                  - 2024-12-10T00:00:00
                                  - 2024-12-10T12:00:00Z
                                  - 2024-12-10T00:00:00+01:00
                                  - 2024-12-10
                                  - 2024-12-10T00:00:00[Europe/Paris]
                                  - 2024-12-10T00:00:00[CET]
                              enedisRetryAfterLoadcurveActivation:
                                type: boolean
                                description: Retry after Enedis Loadcurve Activation (Activation de la collecte
                                  de courbe de charge)
                              prms:
                                type: array
                                items:
                                  $ref: "#/components/schemas/Prm"
                            additionalProperties: false
                          - type: object
                            required:
                              - type
                              - prms
                            properties:
                              type:
                                type: string
                                enum:
                                  - R64
                              direction:
                                type: string
                                enum:
                                  - SOUTIRAGE
                                  - INJECTION
                              since:
                                type: string
                                format: date-time
                                description: ISO 8601 date format
                                examples:
                                  - 2024-12-10T00:00:00
                                  - 2024-12-10T12:00:00Z
                                  - 2024-12-10T00:00:00+01:00
                                  - 2024-12-10
                                  - 2024-12-10T00:00:00[Europe/Paris]
                                  - 2024-12-10T00:00:00[CET]
                              until:
                                type: string
                                format: date-time
                                description: ISO 8601 date format
                                examples:
                                  - 2024-12-10T00:00:00
                                  - 2024-12-10T12:00:00Z
                                  - 2024-12-10T00:00:00+01:00
                                  - 2024-12-10
                                  - 2024-12-10T00:00:00[Europe/Paris]
                                  - 2024-12-10T00:00:00[CET]
                              prms:
                                type: array
                                items:
                                  $ref: "#/components/schemas/Prm"
                            additionalProperties: false
                          - type: object
                            required:
                              - type
                              - prms
                            properties:
                              type:
                                type: string
                                enum:
                                  - R65
                              direction:
                                type: string
                                enum:
                                  - SOUTIRAGE
                                  - INJECTION
                              since:
                                type: string
                                format: date-time
                                description: ISO 8601 date format
                                examples:
                                  - 2024-12-10T00:00:00
                                  - 2024-12-10T12:00:00Z
                                  - 2024-12-10T00:00:00+01:00
                                  - 2024-12-10
                                  - 2024-12-10T00:00:00[Europe/Paris]
                                  - 2024-12-10T00:00:00[CET]
                              until:
                                type: string
                                format: date-time
                                description: ISO 8601 date format
                                examples:
                                  - 2024-12-10T00:00:00
                                  - 2024-12-10T12:00:00Z
                                  - 2024-12-10T00:00:00+01:00
                                  - 2024-12-10
                                  - 2024-12-10T00:00:00[Europe/Paris]
                                  - 2024-12-10T00:00:00[CET]
                              prms:
                                type: array
                                items:
                                  $ref: "#/components/schemas/Prm"
                            additionalProperties: false
                          - type: object
                            required:
                              - type
                              - prms
                            properties:
                              type:
                                type: string
                                enum:
                                  - R66
                              direction:
                                type: string
                                enum:
                                  - SOUTIRAGE
                                  - INJECTION
                              since:
                                type: string
                                format: date-time
                                description: ISO 8601 date format
                                examples:
                                  - 2024-12-10T00:00:00
                                  - 2024-12-10T12:00:00Z
                                  - 2024-12-10T00:00:00+01:00
                                  - 2024-12-10
                                  - 2024-12-10T00:00:00[Europe/Paris]
                                  - 2024-12-10T00:00:00[CET]
                              until:
                                type: string
                                format: date-time
                                description: ISO 8601 date format
                                examples:
                                  - 2024-12-10T00:00:00
                                  - 2024-12-10T12:00:00Z
                                  - 2024-12-10T00:00:00+01:00
                                  - 2024-12-10
                                  - 2024-12-10T00:00:00[Europe/Paris]
                                  - 2024-12-10T00:00:00[CET]
                              prms:
                                type: array
                                items:
                                  $ref: "#/components/schemas/Prm"
                            additionalProperties: false
                          - type: object
                            required:
                              - type
                              - prms
                            properties:
                              type:
                                type: string
                                enum:
                                  - R67
                              direction:
                                type: string
                                enum:
                                  - SOUTIRAGE
                                  - INJECTION
                              since:
                                type: string
                                format: date-time
                                description: ISO 8601 date format
                                examples:
                                  - 2024-12-10T00:00:00
                                  - 2024-12-10T12:00:00Z
                                  - 2024-12-10T00:00:00+01:00
                                  - 2024-12-10
                                  - 2024-12-10T00:00:00[Europe/Paris]
                                  - 2024-12-10T00:00:00[CET]
                              until:
                                type: string
                                format: date-time
                                description: ISO 8601 date format
                                examples:
                                  - 2024-12-10T00:00:00
                                  - 2024-12-10T12:00:00Z
                                  - 2024-12-10T00:00:00+01:00
                                  - 2024-12-10
                                  - 2024-12-10T00:00:00[Europe/Paris]
                                  - 2024-12-10T00:00:00[CET]
                              prms:
                                type: array
                                items:
                                  $ref: "#/components/schemas/Prm"
                            additionalProperties: false
                          - type: object
                            required:
                              - type
                              - prms
                            properties:
                              type:
                                type: string
                                enum:
                                  - R63_SYNC
                              direction:
                                type: string
                                enum:
                                  - SOUTIRAGE
                                  - INJECTION
                              since:
                                type: string
                                format: date-time
                                description: ISO 8601 date format
                                examples:
                                  - 2024-12-10T00:00:00
                                  - 2024-12-10T12:00:00Z
                                  - 2024-12-10T00:00:00+01:00
                                  - 2024-12-10
                                  - 2024-12-10T00:00:00[Europe/Paris]
                                  - 2024-12-10T00:00:00[CET]
                              until:
                                type: string
                                format: date-time
                                description: ISO 8601 date format
                                examples:
                                  - 2024-12-10T00:00:00
                                  - 2024-12-10T12:00:00Z
                                  - 2024-12-10T00:00:00+01:00
                                  - 2024-12-10
                                  - 2024-12-10T00:00:00[Europe/Paris]
                                  - 2024-12-10T00:00:00[CET]
                              enedisCorrection:
                                type: boolean
                                description: Correction Enedis (only for 'C5' segment)
                              enedisRetryAfterLoadcurveActivation:
                                type: boolean
                                description: Retry after Enedis Loadcurve Activation (Activation de la collecte
                                  de courbe de charge)
                              prms:
                                type: array
                                items:
                                  $ref: "#/components/schemas/Prm"
                            additionalProperties: false
                          - type: object
                            required:
                              - type
                              - prms
                            properties:
                              type:
                                type: string
                                enum:
                                  - R64_SYNC
                              direction:
                                type: string
                                enum:
                                  - SOUTIRAGE
                                  - INJECTION
                              since:
                                type: string
                                format: date-time
                                description: ISO 8601 date format
                                examples:
                                  - 2024-12-10T00:00:00
                                  - 2024-12-10T12:00:00Z
                                  - 2024-12-10T00:00:00+01:00
                                  - 2024-12-10
                                  - 2024-12-10T00:00:00[Europe/Paris]
                                  - 2024-12-10T00:00:00[CET]
                              until:
                                type: string
                                format: date-time
                                description: ISO 8601 date format
                                examples:
                                  - 2024-12-10T00:00:00
                                  - 2024-12-10T12:00:00Z
                                  - 2024-12-10T00:00:00+01:00
                                  - 2024-12-10
                                  - 2024-12-10T00:00:00[Europe/Paris]
                                  - 2024-12-10T00:00:00[CET]
                              enedisCorrection:
                                type: boolean
                                description: Correction Enedis (only for 'C5' segment)
                              prms:
                                type: array
                                items:
                                  $ref: "#/components/schemas/Prm"
                            additionalProperties: false
                          - type: object
                            required:
                              - type
                              - prms
                            properties:
                              type:
                                type: string
                                enum:
                                  - R65_SYNC
                              direction:
                                type: string
                                enum:
                                  - SOUTIRAGE
                                  - INJECTION
                              since:
                                type: string
                                format: date-time
                                description: ISO 8601 date format
                                examples:
                                  - 2024-12-10T00:00:00
                                  - 2024-12-10T12:00:00Z
                                  - 2024-12-10T00:00:00+01:00
                                  - 2024-12-10
                                  - 2024-12-10T00:00:00[Europe/Paris]
                                  - 2024-12-10T00:00:00[CET]
                              until:
                                type: string
                                format: date-time
                                description: ISO 8601 date format
                                examples:
                                  - 2024-12-10T00:00:00
                                  - 2024-12-10T12:00:00Z
                                  - 2024-12-10T00:00:00+01:00
                                  - 2024-12-10
                                  - 2024-12-10T00:00:00[Europe/Paris]
                                  - 2024-12-10T00:00:00[CET]
                              enedisCorrection:
                                type: boolean
                                description: Correction Enedis (only for 'C5' segment)
                              prms:
                                type: array
                                items:
                                  $ref: "#/components/schemas/Prm"
                            additionalProperties: false
                          - type: object
                            required:
                              - type
                              - prms
                            properties:
                              type:
                                type: string
                                enum:
                                  - R66_SYNC
                              direction:
                                type: string
                                enum:
                                  - SOUTIRAGE
                                  - INJECTION
                              since:
                                type: string
                                format: date-time
                                description: ISO 8601 date format
                                examples:
                                  - 2024-12-10T00:00:00
                                  - 2024-12-10T12:00:00Z
                                  - 2024-12-10T00:00:00+01:00
                                  - 2024-12-10
                                  - 2024-12-10T00:00:00[Europe/Paris]
                                  - 2024-12-10T00:00:00[CET]
                              until:
                                type: string
                                format: date-time
                                description: ISO 8601 date format
                                examples:
                                  - 2024-12-10T00:00:00
                                  - 2024-12-10T12:00:00Z
                                  - 2024-12-10T00:00:00+01:00
                                  - 2024-12-10
                                  - 2024-12-10T00:00:00[Europe/Paris]
                                  - 2024-12-10T00:00:00[CET]
                              enedisCorrection:
                                type: boolean
                                description: Correction Enedis (only for 'C5' segment)
                              prms:
                                type: array
                                items:
                                  $ref: "#/components/schemas/Prm"
                            additionalProperties: false
                          - type: object
                            required:
                              - type
                              - prms
                            properties:
                              type:
                                type: string
                                enum:
                                  - LOADCURVE
                              direction:
                                type: string
                                enum:
                                  - CONSUMPTION
                                  - INJECTION
                              since:
                                type: string
                                format: date-time
                                description: ISO 8601 date format
                                examples:
                                  - 2024-12-10T00:00:00
                                  - 2024-12-10T12:00:00Z
                                  - 2024-12-10T00:00:00+01:00
                                  - 2024-12-10
                                  - 2024-12-10T00:00:00[Europe/Paris]
                                  - 2024-12-10T00:00:00[CET]
                              until:
                                type: string
                                format: date-time
                                description: ISO 8601 date format
                                examples:
                                  - 2024-12-10T00:00:00
                                  - 2024-12-10T12:00:00Z
                                  - 2024-12-10T00:00:00+01:00
                                  - 2024-12-10
                                  - 2024-12-10T00:00:00[Europe/Paris]
                                  - 2024-12-10T00:00:00[CET]
                              enedisCorrection:
                                type: boolean
                                description: Correction Enedis (only for 'C5' segment)
                              enedisRetryAfterLoadcurveActivation:
                                type: boolean
                                description: Retry after Enedis Loadcurve Activation (Activation de la collecte
                                  de courbe de charge)
                              prms:
                                type: array
                                items:
                                  $ref: "#/components/schemas/Prm"
                            additionalProperties: false
                  additionalProperties: false
        required: true
  /order/{orderId}:
    get:
      tags:
        - orders
      operationId: getOrder
      parameters:
        - name: orderId
          in: path
          schema:
            type: string
          required: true
      security:
        - bearerAuth: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - id
                  - status
                  - requests
                properties:
                  id:
                    type: string
                    format: uuid
                    title: UUID
                  status:
                    $comment: /schemas/enums
                    anyOf:
                      - type: string
                        title: CREATED
                        enum:
                          - CREATED
                      - type: string
                        title: PENDING_ADDRESS_CHECK
                        enum:
                          - PENDING_ADDRESS_CHECK
                      - type: string
                        title: ADDRESS_CHECK_FAILED
                        enum:
                          - ADDRESS_CHECK_FAILED
                      - type: string
                        title: PENDING_REQUESTS
                        enum:
                          - PENDING_REQUESTS
                      - type: string
                        title: SOME_REQUESTS_FAILED
                        enum:
                          - SOME_REQUESTS_FAILED
                      - type: string
                        title: SUCCESS
                        enum:
                          - SUCCESS
                  requests:
                    type: array
                    items:
                      type: object
                      required:
                        - id
                        - type
                        - status
                        - orderedAt
                        - completedAt
                        - errorMessage
                      properties:
                        id:
                          type: string
                          format: uuid
                          title: UUID
                        type:
                          type: string
                          enum:
                            - C68
                            - C68_ASYNC
                            - R63
                            - R63_SYNC
                            - R64
                            - R64_SYNC
                            - R65
                            - R65_SYNC
                            - R66
                            - R66_SYNC
                            - R67
                            - LOADCURVE
                        status:
                          anyOf:
                            - $comment: /schemas/enums
                              anyOf:
                                - type: string
                                  title: NOT_STARTED
                                  enum:
                                    - NOT_STARTED
                                - type: string
                                  title: PENDING
                                  enum:
                                    - PENDING
                                - type: string
                                  title: SUCCESS
                                  enum:
                                    - SUCCESS
                                - type: string
                                  title: FAILED
                                  enum:
                                    - FAILED
                            - type: string
                              enum:
                                - PENDING_ADDRESS_CHECK
                        orderedAt:
                          $ref: "#/components/schemas/Date"
                          nullable: true
                        completedAt:
                          $ref: "#/components/schemas/Date"
                          nullable: true
                        dataUrl:
                          type: string
                          nullable: true
                        errorMessage:
                          type: string
                          nullable: true
                        requestedTimeRange:
                          type: string
                          nullable: true
                        summaryPerContract:
                          type: array
                          items:
                            anyOf:
                              - anyOf:
                                  - type: object
                                    required:
                                      - _tag
                                      - _status
                                      - prm
                                      - timeRangeCoverageRatio
                                      - holes
                                      - errorMessage
                                    properties:
                                      _tag:
                                        type: string
                                        enum:
                                          - LoadcurveRequestContractSummary
                                      _status:
                                        type: string
                                        enum:
                                          - final
                                      prm:
                                        $ref: "#/components/schemas/Prm"
                                      timeRangeCoverageRatio:
                                        type: number
                                        description: A ratio between 0 and 1, representing the coverage of the requested
                                          time range by the returned data
                                      holes:
                                        type: array
                                        items:
                                          type: string
                                        description: An array of intervals that are **NOT** covered by the returned
                                          data. It's an array of intervals. Each
                                          interval is 2 dates separated by a
                                          slash. The dates are in ISO 8601
                                          format.
                                        examples:
                                          - - 2025-01-01T00:00:00.000Z/2025-01-01T00:00:00.000Z
                                      errorMessage:
                                        type: string
                                        nullable: true
                                    additionalProperties: false
                                  - type: object
                                    required:
                                      - _tag
                                      - _status
                                      - prm
                                      - message
                                    properties:
                                      _tag:
                                        type: string
                                        enum:
                                          - LoadcurveRequestContractSummary
                                      _status:
                                        type: string
                                        enum:
                                          - pending
                                      prm:
                                        $ref: "#/components/schemas/Prm"
                                      message:
                                        type: string
                                    additionalProperties: false
                              - type: object
                                required:
                                  - _tag
                                  - prm
                                  - fileUrl
                                  - errorMessage
                                properties:
                                  _tag:
                                    type: string
                                    enum:
                                      - RawFileContractSummary
                                  prm:
                                    $ref: "#/components/schemas/Prm"
                                  fileUrl:
                                    type: string
                                    nullable: true
                                  errorMessage:
                                    type: string
                                    nullable: true
                                additionalProperties: false
                        loadCurve:
                          type: object
                          required:
                            - period
                            - startsAt
                            - endsAt
                            - values
                          properties:
                            period:
                              type: string
                            startsAt:
                              $ref: "#/components/schemas/Date"
                            endsAt:
                              $ref: "#/components/schemas/Date"
                            values:
                              type: array
                              items:
                                type: number
                                nullable: true
                          additionalProperties: false
                          nullable: true
                      additionalProperties: false
                    examples:
                      - - id: da466b13-6904-4a5d-a108-746808686631
                          type: C68
                          status: SUCCESS
                          orderedAt: 2021-09-01T00:00:00.000Z
                          completedAt: 2021-09-01T00:02:00.000Z
                          dataUrl: https://example.com/data.json
                          errorMessage: null
                additionalProperties: false
        "400":
          description: The request did not match the expected schema
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: "#/components/schemas/HttpApiDecodeError"
                  - type: object
                    required:
                      - error
                    properties:
                      error:
                        $id: /schemas/any
                        title: any
                    additionalProperties: false
        "401":
          description: Error
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: string
                additionalProperties: false
        "404":
          description: Error
          content:
            application/json:
              schema:
                type: object
                required:
                  - message
                properties:
                  message:
                    type: string
                additionalProperties: false
      summary: Get Order status and data
  /search_contract:
    get:
      tags:
        - contracts
      operationId: searchContract
      parameters:
        - name: name
          in: query
          schema:
            type: string
            description: a string at least 3 character(s) long
            title: minLength(3)
            examples:
              - Jean Dupont
            minLength: 3
          required: true
          description: a string at least 3 character(s) long
          examples:
            ex1:
              value: Jean Dupont
              summary: ""
        - name: address
          in: query
          schema:
            type: string
            examples:
              - 1 rue de la paix 75001 Paris
          required: false
          examples:
            ex1:
              value: 1 rue de la paix 75001 Paris
              summary: ""
        - name: prm
          in: query
          schema:
            $ref: "#/components/schemas/Prm"
          required: false
        - name: asOrgSlug
          in: query
          schema:
            type: string
            description: If you are using this endpoint without a service account, and have
              access to multiple organizations, you need to specify for which
              organization you're using this endpoint
          required: false
          description: If you are using this endpoint without a service account, and have
            access to multiple organizations, you need to specify for which
            organization you're using this endpoint
      security:
        - bearerAuth: []
      responses:
        "200":
          description: SearchContractResponse
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchContractResponse"
        "400":
          description: The request did not match the expected schema
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: "#/components/schemas/HttpApiDecodeError"
                  - type: object
                    required:
                      - error
                    properties:
                      error:
                        $id: /schemas/any
                        title: any
                    additionalProperties: false
        "401":
          description: Error
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: string
                additionalProperties: false
      summary: Search for an electricity contract
  /search_contracts_from_invoices:
    post:
      tags:
        - contracts
      operationId: searchContractsFromInvoices
      parameters: []
      security:
        - bearerAuth: []
      responses:
        "200":
          description: SearchContractsFromInvoicesResponse
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchContractsFromInvoicesResponse"
        "400":
          description: The request did not match the expected schema
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: "#/components/schemas/HttpApiDecodeError"
                  - type: object
                    required:
                      - error
                    properties:
                      error:
                        $id: /schemas/any
                        title: any
                    additionalProperties: false
                  - type: object
                    required:
                      - message
                    properties:
                      message:
                        type: string
                    additionalProperties: false
        "401":
          description: Error
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: string
                additionalProperties: false
      description: Upload one or more electricity invoice files (PDF or images). We
        will run OCR on these files and search for matching contracts.
      summary: "BETA: Search for electricity contracts from uploaded electricity
        invoice files"
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              required:
                - files
              properties:
                files:
                  type: array
                  items:
                    $ref: "#/components/schemas/PersistedFile"
              additionalProperties: false
        required: true
  /data-third-party:
    post:
      tags:
        - data-third-parties
      operationId: createDataThirdParty
      parameters:
        - name: slug
          in: query
          schema:
            type: string
            description: Unique identifier (in the scope of your organization) of the
              DataThirdParty. This will be used to identify the DataThirdParty
              when creating the Ask via the API
          required: true
          description: Unique identifier (in the scope of your organization) of the
            DataThirdParty. This will be used to identify the DataThirdParty
            when creating the Ask via the API
        - name: name
          in: query
          schema:
            type: string
            description: Name ot the DataThirdParty. This name will appear in Ask consent
              forms
          required: true
          description: Name ot the DataThirdParty. This name will appear in Ask consent
            forms
        - name: websiteUrl
          in: query
          schema:
            type: string
            description: Website URL of the DataThirdParty. If specified, users will be able
              to click on it from the Ask consent form
          required: false
          description: Website URL of the DataThirdParty. If specified, users will be able
            to click on it from the Ask consent form
        - name: frSiret
          in: query
          schema:
            type: string
            description: Siret number of the DataThirdParty. This will be used to identify
              the DataThirdParty when creating the Ask via the API
          required: false
          description: Siret number of the DataThirdParty. This will be used to identify
            the DataThirdParty when creating the Ask via the API
        - name: internationalCompanyIdentificationNumber
          in: query
          schema:
            type: string
            description: For non-french third parties, international company identification
              number of the DataThirdParty. This will be used to identify the
              DataThirdParty when creating the Ask via the API
          required: false
          description: For non-french third parties, international company identification
            number of the DataThirdParty. This will be used to identify the
            DataThirdParty when creating the Ask via the API
        - name: logoBase64
          in: query
          schema:
            type: string
            description: Base64-encoded logo of the DataThirdParty. This logo will appear in
              Ask consent forms. Accepts `png`, `jpg`, and `svg`.
          required: false
          description: Base64-encoded logo of the DataThirdParty. This logo will appear in
            Ask consent forms. Accepts `png`, `jpg`, and `svg`.
      security:
        - bearerAuth: []
      responses:
        "200":
          description: DataThirdParty created successfully.
          content:
            application/json:
              schema:
                type: object
                required:
                  - name
                  - slug
                  - createdAt
                  - deletedAt
                  - websiteUrl
                  - frSiret
                  - internationalCompanyIdentificationNumber
                  - logoUrl
                properties:
                  name:
                    type: string
                    description: Name ot the DataThirdParty. This name will appear in Ask consent
                      forms
                  slug:
                    type: string
                    description: Unique identifier (in the scope of your organization) of the
                      DataThirdParty. This will be used to identify the
                      DataThirdParty when creating the Ask via the API
                  createdAt:
                    type: string
                    format: date-time
                    description: ISO 8601 date format
                    examples:
                      - 2024-12-10T00:00:00
                      - 2024-12-10T12:00:00Z
                      - 2024-12-10T00:00:00+01:00
                      - 2024-12-10
                      - 2024-12-10T00:00:00[Europe/Paris]
                      - 2024-12-10T00:00:00[CET]
                  deletedAt:
                    type: string
                    format: date-time
                    description: ISO 8601 date format
                    examples:
                      - 2024-12-10T00:00:00
                      - 2024-12-10T12:00:00Z
                      - 2024-12-10T00:00:00+01:00
                      - 2024-12-10
                      - 2024-12-10T00:00:00[Europe/Paris]
                      - 2024-12-10T00:00:00[CET]
                    nullable: true
                  websiteUrl:
                    type: string
                    description: Website URL of the DataThirdParty. If specified, users will be able
                      to click on it from the Ask consent form
                    nullable: true
                  frSiret:
                    type: string
                    description: Siret number of the DataThirdParty. This will be used to identify
                      the DataThirdParty when creating the Ask via the API
                    nullable: true
                  internationalCompanyIdentificationNumber:
                    type: string
                    description: For non-french third parties, international company identification
                      number of the DataThirdParty. This will be used to
                      identify the DataThirdParty when creating the Ask via the
                      API
                    nullable: true
                  logoUrl:
                    type: string
                    description: A public signed URL of the DataThirdParty
                    nullable: true
                additionalProperties: false
                description: DataThirdParty created successfully.
                title: DataThirdParty
                examples:
                  - name: Solaris
                    slug: solaris
                    createdAt: 2025-01-01T00:00:00.000+00:00
                    deletedAt: null
                    websiteUrl: https://solaris.fr
                    frSiret: "12345678901234"
                    internationalCompanyIdentificationNumber: null
                    logoUrl: https://switchgrid.tech/logos/solaris.png
        "400":
          description: The request did not match the expected schema
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: "#/components/schemas/HttpApiDecodeError"
                  - type: object
                    required:
                      - error
                    properties:
                      error:
                        $id: /schemas/any
                        title: any
                    additionalProperties: false
        "401":
          description: Error
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: string
                additionalProperties: false
        "409":
          description: A DataThirdParty with the same slug already exists
          content:
            application/json:
              schema:
                type: object
                required:
                  - message
                properties:
                  message:
                    type: string
                additionalProperties: false
                description: A DataThirdParty with the same slug already exists
      description: A DataThirdParty can appear in the Ask consent form as the
        recipient of the data. You may want to use this if the ultimate
        recipient of the data collected via Switchgrid is another customer of
        yours (e.g. a solar panel installer), which you are transferring data
        to.
      summary: Create a DataThirdParty
    get:
      tags:
        - data-third-parties
      operationId: listDataThirdParties
      parameters:
        - name: skip
          in: query
          schema:
            $ref: "#/components/schemas/NumberFromString"
          required: false
        - name: limit
          in: query
          schema:
            type: integer
            maximum: 100
            default: 10
            description: Use this to limit page size when paginating
          required: false
          description: Use this to limit page size when paginating
        - name: orderBy
          in: query
          schema:
            type: string
            title: Order By
            description: |-
              comma-separated list of fields to order by, allowed fields are:
               - createdAt
              - deletedAt
            examples:
              - createdAt:asc,deletedAt:asc
          required: false
          description: |-
            comma-separated list of fields to order by, allowed fields are:
             - createdAt
            - deletedAt
      security:
        - bearerAuth: []
      responses:
        "200":
          description: List of DataThirdParty instances for the current Organization
          content:
            application/json:
              schema:
                type: object
                required:
                  - skip
                  - limit
                  - totalItemsCount
                  - returnedItemsCount
                  - items
                properties:
                  skip:
                    type: number
                  limit:
                    type: number
                  totalItemsCount:
                    type: number
                  returnedItemsCount:
                    type: number
                  items:
                    type: array
                    items:
                      type: object
                      required:
                        - name
                        - slug
                        - createdAt
                        - deletedAt
                        - websiteUrl
                        - frSiret
                        - internationalCompanyIdentificationNumber
                        - logoUrl
                      properties:
                        name:
                          type: string
                          description: Name ot the DataThirdParty. This name will appear in Ask consent
                            forms
                        slug:
                          type: string
                          description: Unique identifier (in the scope of your organization) of the
                            DataThirdParty. This will be used to identify the
                            DataThirdParty when creating the Ask via the API
                        createdAt:
                          type: string
                          format: date-time
                          description: ISO 8601 date format
                          examples:
                            - 2024-12-10T00:00:00
                            - 2024-12-10T12:00:00Z
                            - 2024-12-10T00:00:00+01:00
                            - 2024-12-10
                            - 2024-12-10T00:00:00[Europe/Paris]
                            - 2024-12-10T00:00:00[CET]
                        deletedAt:
                          type: string
                          format: date-time
                          description: ISO 8601 date format
                          examples:
                            - 2024-12-10T00:00:00
                            - 2024-12-10T12:00:00Z
                            - 2024-12-10T00:00:00+01:00
                            - 2024-12-10
                            - 2024-12-10T00:00:00[Europe/Paris]
                            - 2024-12-10T00:00:00[CET]
                          nullable: true
                        websiteUrl:
                          type: string
                          description: Website URL of the DataThirdParty. If specified, users will be able
                            to click on it from the Ask consent form
                          nullable: true
                        frSiret:
                          type: string
                          description: Siret number of the DataThirdParty. This will be used to identify
                            the DataThirdParty when creating the Ask via the API
                          nullable: true
                        internationalCompanyIdentificationNumber:
                          type: string
                          description: For non-french third parties, international company identification
                            number of the DataThirdParty. This will be used to
                            identify the DataThirdParty when creating the Ask
                            via the API
                          nullable: true
                        logoUrl:
                          type: string
                          description: A public signed URL of the DataThirdParty
                          nullable: true
                      additionalProperties: false
                additionalProperties: false
                description: List of DataThirdParty instances for the current Organization
                title: DataThirdParty
                examples:
                  - skip: 0
                    limit: 10
                    totalItemsCount: 1
                    returnedItemsCount: 1
                    items:
                      - name: Solaris
                        slug: solaris
                        createdAt: 2025-01-01T00:00:00.000+00:00
                        deletedAt: null
                        websiteUrl: https://solaris.fr
                        frSiret: "12345678901234"
                        internationalCompanyIdentificationNumber: null
                        logoUrl: https://switchgrid.tech/logos/solaris.png
        "400":
          description: The request did not match the expected schema
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: "#/components/schemas/HttpApiDecodeError"
                  - type: object
                    required:
                      - error
                    properties:
                      error:
                        $id: /schemas/any
                        title: any
                    additionalProperties: false
        "401":
          description: Error
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: string
                additionalProperties: false
      summary: List data third parties
  /data-third-party/{slug}:
    put:
      tags:
        - data-third-parties
      operationId: updateDataThirdParty
      parameters:
        - name: slug
          in: path
          schema:
            type: string
            description: The current slug of the `DataThirdParty` to update
          required: true
          description: The current slug of the `DataThirdParty` to update
        - name: slug
          in: query
          schema:
            type: string
            description: Unique identifier (in the scope of your organization) of the
              DataThirdParty. This will be used to identify the DataThirdParty
              when creating the Ask via the API
          required: false
          description: Unique identifier (in the scope of your organization) of the
            DataThirdParty. This will be used to identify the DataThirdParty
            when creating the Ask via the API
        - name: name
          in: query
          schema:
            type: string
            description: Name ot the DataThirdParty. This name will appear in Ask consent
              forms
          required: false
          description: Name ot the DataThirdParty. This name will appear in Ask consent
            forms
        - name: websiteUrl
          in: query
          schema:
            type: string
            description: Website URL of the DataThirdParty. If specified, users will be able
              to click on it from the Ask consent form
          required: false
          description: Website URL of the DataThirdParty. If specified, users will be able
            to click on it from the Ask consent form
        - name: frSiret
          in: query
          schema:
            type: string
            description: Siret number of the DataThirdParty. This will be used to identify
              the DataThirdParty when creating the Ask via the API
          required: false
          description: Siret number of the DataThirdParty. This will be used to identify
            the DataThirdParty when creating the Ask via the API
        - name: internationalCompanyIdentificationNumber
          in: query
          schema:
            type: string
            description: For non-french third parties, international company identification
              number of the DataThirdParty. This will be used to identify the
              DataThirdParty when creating the Ask via the API
          required: false
          description: For non-french third parties, international company identification
            number of the DataThirdParty. This will be used to identify the
            DataThirdParty when creating the Ask via the API
        - name: logoBase64
          in: query
          schema:
            type: string
            description: Base64-encoded logo of the DataThirdParty. This logo will appear in
              Ask consent forms. Accepts `png`, `jpg`, and `svg`.
          required: false
          description: Base64-encoded logo of the DataThirdParty. This logo will appear in
            Ask consent forms. Accepts `png`, `jpg`, and `svg`.
      security:
        - bearerAuth: []
      responses:
        "200":
          description: DataThirdParty updated successfully.
          content:
            application/json:
              schema:
                type: object
                required:
                  - name
                  - slug
                  - createdAt
                  - deletedAt
                  - websiteUrl
                  - frSiret
                  - internationalCompanyIdentificationNumber
                  - logoUrl
                properties:
                  name:
                    type: string
                    description: Name ot the DataThirdParty. This name will appear in Ask consent
                      forms
                  slug:
                    type: string
                    description: Unique identifier (in the scope of your organization) of the
                      DataThirdParty. This will be used to identify the
                      DataThirdParty when creating the Ask via the API
                  createdAt:
                    type: string
                    format: date-time
                    description: ISO 8601 date format
                    examples:
                      - 2024-12-10T00:00:00
                      - 2024-12-10T12:00:00Z
                      - 2024-12-10T00:00:00+01:00
                      - 2024-12-10
                      - 2024-12-10T00:00:00[Europe/Paris]
                      - 2024-12-10T00:00:00[CET]
                  deletedAt:
                    type: string
                    format: date-time
                    description: ISO 8601 date format
                    examples:
                      - 2024-12-10T00:00:00
                      - 2024-12-10T12:00:00Z
                      - 2024-12-10T00:00:00+01:00
                      - 2024-12-10
                      - 2024-12-10T00:00:00[Europe/Paris]
                      - 2024-12-10T00:00:00[CET]
                    nullable: true
                  websiteUrl:
                    type: string
                    description: Website URL of the DataThirdParty. If specified, users will be able
                      to click on it from the Ask consent form
                    nullable: true
                  frSiret:
                    type: string
                    description: Siret number of the DataThirdParty. This will be used to identify
                      the DataThirdParty when creating the Ask via the API
                    nullable: true
                  internationalCompanyIdentificationNumber:
                    type: string
                    description: For non-french third parties, international company identification
                      number of the DataThirdParty. This will be used to
                      identify the DataThirdParty when creating the Ask via the
                      API
                    nullable: true
                  logoUrl:
                    type: string
                    description: A public signed URL of the DataThirdParty
                    nullable: true
                additionalProperties: false
                description: DataThirdParty updated successfully.
                title: DataThirdParty
                examples:
                  - name: Solaris
                    slug: solaris
                    createdAt: 2025-01-01T00:00:00.000+00:00
                    deletedAt: null
                    websiteUrl: https://solaris.fr
                    frSiret: "12345678901234"
                    internationalCompanyIdentificationNumber: null
                    logoUrl: https://switchgrid.tech/logos/solaris.png
        "400":
          description: The request did not match the expected schema
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: "#/components/schemas/HttpApiDecodeError"
                  - type: object
                    required:
                      - error
                    properties:
                      error:
                        $id: /schemas/any
                        title: any
                    additionalProperties: false
        "401":
          description: Error
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: string
                additionalProperties: false
        "404":
          description: "`DataThirdParty` for provided `slug` was not found"
          content:
            application/json:
              schema:
                type: object
                required:
                  - message
                properties:
                  message:
                    type: string
                additionalProperties: false
                description: "`DataThirdParty` for provided `slug` was not found"
        "409":
          description: A DataThirdParty with the same slug already exists, when updating
            the slug
          content:
            application/json:
              schema:
                type: object
                required:
                  - message
                properties:
                  message:
                    type: string
                additionalProperties: false
                description: A DataThirdParty with the same slug already exists, when updating
                  the slug
      description: >-
        The following things can be updated: slug, name, websiteUrl, frSiret,
        internationalCompanyIdentificationNumber, logo.
         To remove an optional property, set it to `null`.
      summary: Update a DataThirdParty
    delete:
      tags:
        - data-third-parties
      operationId: deleteDataThirdParty
      parameters:
        - name: slug
          in: path
          schema:
            type: string
            description: The slug of the `DataThirdParty` to delete
          required: true
          description: The slug of the `DataThirdParty` to delete
      security:
        - bearerAuth: []
      responses:
        "200":
          description: DataThirdParty deleted successfully.
          content:
            application/json:
              schema:
                type: object
                required:
                  - name
                  - slug
                  - createdAt
                  - deletedAt
                  - websiteUrl
                  - frSiret
                  - internationalCompanyIdentificationNumber
                  - logoUrl
                properties:
                  name:
                    type: string
                    description: Name ot the DataThirdParty. This name will appear in Ask consent
                      forms
                  slug:
                    type: string
                    description: Unique identifier (in the scope of your organization) of the
                      DataThirdParty. This will be used to identify the
                      DataThirdParty when creating the Ask via the API
                  createdAt:
                    type: string
                    format: date-time
                    description: ISO 8601 date format
                    examples:
                      - 2024-12-10T00:00:00
                      - 2024-12-10T12:00:00Z
                      - 2024-12-10T00:00:00+01:00
                      - 2024-12-10
                      - 2024-12-10T00:00:00[Europe/Paris]
                      - 2024-12-10T00:00:00[CET]
                  deletedAt:
                    type: string
                    format: date-time
                    description: ISO 8601 date format
                    examples:
                      - 2024-12-10T00:00:00
                      - 2024-12-10T12:00:00Z
                      - 2024-12-10T00:00:00+01:00
                      - 2024-12-10
                      - 2024-12-10T00:00:00[Europe/Paris]
                      - 2024-12-10T00:00:00[CET]
                    nullable: true
                  websiteUrl:
                    type: string
                    description: Website URL of the DataThirdParty. If specified, users will be able
                      to click on it from the Ask consent form
                    nullable: true
                  frSiret:
                    type: string
                    description: Siret number of the DataThirdParty. This will be used to identify
                      the DataThirdParty when creating the Ask via the API
                    nullable: true
                  internationalCompanyIdentificationNumber:
                    type: string
                    description: For non-french third parties, international company identification
                      number of the DataThirdParty. This will be used to
                      identify the DataThirdParty when creating the Ask via the
                      API
                    nullable: true
                  logoUrl:
                    type: string
                    description: A public signed URL of the DataThirdParty
                    nullable: true
                additionalProperties: false
                description: DataThirdParty deleted successfully.
                title: DataThirdParty
        "400":
          description: The request did not match the expected schema
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: "#/components/schemas/HttpApiDecodeError"
                  - type: object
                    required:
                      - error
                    properties:
                      error:
                        $id: /schemas/any
                        title: any
                    additionalProperties: false
        "401":
          description: Error
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: string
                additionalProperties: false
      description: Delete a DataThirdParty. It will no longer be possible to use it in
        a new Ask. Existing Asks can still be signed.
      summary: Delete a DataThirdParty
  /request/{requestId}/data:
    get:
      tags:
        - requests
      operationId: getRequestData
      parameters:
        - name: requestId
          in: path
          schema:
            type: string
          required: true
        - name: period
          in: query
          schema:
            type: string
            enum:
              - 5min
              - 10min
              - 15min
              - 30min
              - 1h
              - 1d
            description: The period of data to retrieve
            default: 1h
          required: false
          description: The period of data to retrieve
        - name: format
          in: query
          schema:
            type: string
            enum:
              - csv
              - json
            description: format of the data
            default: json
          required: false
          description: format of the data
        - name: since
          in: query
          schema:
            type: string
            format: date-time
            description: ISO 8601 date format
            examples:
              - 2024-12-10T00:00:00
              - 2024-12-10T12:00:00Z
              - 2024-12-10T00:00:00+01:00
              - 2024-12-10
              - 2024-12-10T00:00:00[Europe/Paris]
              - 2024-12-10T00:00:00[CET]
          required: false
          description: ISO 8601 date format
          examples:
            ex1:
              value: 2024-12-10T00:00:00
              summary: ""
            ex2:
              value: 2024-12-10T12:00:00Z
              summary: ""
            ex3:
              value: 2024-12-10T00:00:00+01:00
              summary: ""
            ex4:
              value: 2024-12-10
              summary: ""
            ex5:
              value: 2024-12-10T00:00:00[Europe/Paris]
              summary: ""
            ex6:
              value: 2024-12-10T00:00:00[CET]
              summary: ""
        - name: until
          in: query
          schema:
            type: string
            format: date-time
            description: ISO 8601 date format
            examples:
              - 2024-12-10T00:00:00
              - 2024-12-10T12:00:00Z
              - 2024-12-10T00:00:00+01:00
              - 2024-12-10
              - 2024-12-10T00:00:00[Europe/Paris]
              - 2024-12-10T00:00:00[CET]
          required: false
          description: ISO 8601 date format
          examples:
            ex1:
              value: 2024-12-10T00:00:00
              summary: ""
            ex2:
              value: 2024-12-10T12:00:00Z
              summary: ""
            ex3:
              value: 2024-12-10T00:00:00+01:00
              summary: ""
            ex4:
              value: 2024-12-10
              summary: ""
            ex5:
              value: 2024-12-10T00:00:00[Europe/Paris]
              summary: ""
            ex6:
              value: 2024-12-10T00:00:00[CET]
              summary: ""
        - name: prm
          in: query
          schema:
            type: string
          required: false
        - name: csvLocalization
          in: query
          schema:
            type: string
            enum:
              - fr
              - international
          required: false
        - name: csvColumnSeparator
          in: query
          schema:
            type: string
            enum:
              - COMMA
              - SEMICOLON
          required: false
        - name: csvDecimalSeparator
          in: query
          schema:
            type: string
            enum:
              - DOT
              - COMMA
          required: false
      security:
        - bearerAuth: []
      responses:
        "200":
          description: a string
          content:
            application/json:
              schema:
                type: string
        "400":
          description: The request did not match the expected schema
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: "#/components/schemas/HttpApiDecodeError"
                  - type: object
                    required:
                      - error
                    properties:
                      error:
                        $id: /schemas/any
                        title: any
                    additionalProperties: false
        "401":
          description: Error
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: string
                additionalProperties: false
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                required:
                  - message
                properties:
                  message:
                    type: string
                additionalProperties: false
                description: Not Found
      summary: Get data from a specific Request
components:
  schemas:
    ElectricityContract:
      type: object
      required:
        - prm
        - heldBy
        - address
      properties:
        prm:
          $ref: "#/components/schemas/Prm"
        heldBy:
          anyOf:
            - $ref: "#/components/schemas/PersonnePhysique"
            - $ref: "#/components/schemas/PersonneMorale"
          description: The person or company that holds the contract
        address:
          type: object
          required:
            - street
            - postalCode
            - city
            - country
          properties:
            street:
              type: string
            postalCode:
              type: string
            city:
              type: string
            country:
              type: string
          additionalProperties: false
          description: The address where the electricity is consumed
      additionalProperties: false
      description: Details of an electricity contract.
      title: Electricity Contract Details
    Prm:
      type: string
      pattern: ^[0-9]{14}$
      examples:
        - "00059461297239"
    PersonnePhysique:
      type: object
      required:
        - genre
        - firstName
        - lastName
      properties:
        genre:
          type: string
          enum:
            - M
            - F
        firstName:
          type: string
        lastName:
          type: string
      additionalProperties: false
      description: An Individual, as opposed to a legal entity.
      title: Individual
    PersonneMorale:
      type: object
      required:
        - name
        - siret
      properties:
        name:
          type: string
        siret:
          type: string
        otherNames:
          type: array
          items:
            type: string
          description: Other names of the company. Max 2 names.
          title: maxItems(2)
          maxItems: 2
      additionalProperties: false
      description: A legal entity, as opposed to an individual.
      title: Legal Entity
    NonEmptyString:
      type: string
      description: a non empty string
      title: nonEmptyString
      minLength: 1
    Email:
      type: string
    ConsentCollectionMedium:
      anyOf:
        - type: object
          required:
            - service
          properties:
            service:
              type: string
              enum:
                - DOCUSEAL
          additionalProperties: false
          description: The Docuseal consent collection medium, prefer the web hosted one.
          title: DOCUSEAL
        - type: object
          required:
            - service
          properties:
            service:
              type: string
              enum:
                - WEB_HOSTED
          additionalProperties: false
          description: The web hosted consent collection medium, allowing interactions
            like changing Signer name.
          title: WEB_HOSTED
    BooleanFromString:
      type: string
      enum:
        - "true"
        - "false"
      description: a string to be decoded into a boolean
    Url:
      type: string
      description: The URL to the document that the user needs to sign.
      examples:
        - https://docuseal.co/s/x1uPBSwot114QM
    EnedisElectricityContract:
      type: object
      required:
        - id
        - prm
        - categorieClientFinalCode
        - nomClientFinalOuDenominationSociale
        - adresseInstallationNormalisee
      properties:
        id:
          type: string
          format: uuid
          title: UUID
        prm:
          $ref: "#/components/schemas/Prm"
        categorieClientFinalCode:
          type: string
          enum:
            - RES
            - PRO
        nomClientFinalOuDenominationSociale:
          type: string
          examples:
            - DUPONT Marie
            - SARL DUPONT ET FILS
        adresseInstallationNormalisee:
          type: object
          required:
            - ligne6
          properties:
            ligne1:
              type: string
              description: "Ligne 1 de l’adresse postale.

                \  Cette ligne identifie le destinataire.

                \  Cette donnée ne sera pas renseignée car

                \  redondante avec la donnée « Nom ou

                \  dénomination sociale du client »

                \  "
              title: Ligne 1 de l’adresse postale.
            ligne2:
              type: string
              description: "

                \  Ligne 2 de l’adresse postale.

                \  Cette ligne identifie généralement le

                \  complément d’identification du destinataire ou

                \  du point de remise (escalier, étage,

                \  appartement, boîte aux lettres…).

                \        "
              examples:
                - 03 D
                - COLLINE DE VELAUX VI
                - A
            ligne3:
              type: string
              description: "

                \  Ligne 3 de l’adresse postale.

                \  Cette ligne identifie généralement le

                \  complément d’identification du point

                \  géographique (entrée, tour, immeuble,

                \  bâtiment, résidence, zone industrielle…).

                \        "
              examples:
                - QUARTIER LES CAIRADES
                - VILLA CHANTE LA MER
                - VILLA B LOTISSEMENT ACHBARI
                - QUARTIER LE PEGOUY
                - CHEMIN DE LA CHABOTT
            ligne4:
              type: string
              description: "

                \  Ligne 4 de l’adresse postale.

                \  Cette ligne identifie le numéro et le libellé de la

                \  voie.

                \        "
              examples:
                - 70 ALLEE DU BOIS
                - 11 IMPASSE DES SENTEURS
                - 27 CHEMIN DES COUSTELLINES
            ligne5:
              type: string
              description: "

                \  Ligne 5 de l’adresse postale.

                \  Cette ligne identifie généralement :

                \  - le lieu-dit ou le service particulier de

                \  distribution dans le cas d’un client

                \  résidentiel,

                \  - les mentions spéciales de distribution et

                \  commune d’implantation de l’entreprise (si

                \  différente du bureau distributeur CEDEX)

                \  dans le cas d’un client professionnel.

                \        "
              examples:
                - HELLEMMES LILLE
                - BP 4
            ligne6:
              type: string
              description: "

                \  Ligne 6 de l’adresse postale.

                \  Cette ligne identifie :

                \  - le code postal et la localité de destination

                \  dans le cas d’un client résidentiel,

                \  - le code postal et bureau distributeur ou

                \  code cedex et bureau distributeur cedex

                \  dans le cas d’un client professionnel.

                \        "
              examples:
                - 84190 BEAUMES DE VENISE
            ligne7:
              type: string
              description: "

                \  Ligne 7 de l’adresse postale.

                \  Cette ligne identifie le pays.

                \  Cette donnée ne sera pas renseignée.

                \        "
          additionalProperties: false
          examples:
            - ligne4: 70 ALLEE DU BOIS
              ligne6: 84190 BEAUMES DE VENISE
      additionalProperties: false
    HttpApiDecodeError:
      type: object
      required:
        - issues
        - message
        - _tag
      properties:
        issues:
          type: array
          items:
            $ref: "#/components/schemas/Issue"
        message:
          type: string
        _tag:
          type: string
          enum:
            - HttpApiDecodeError
      additionalProperties: false
      description: The request did not match the expected schema
    Issue:
      type: object
      required:
        - _tag
        - path
        - message
      properties:
        _tag:
          type: string
          enum:
            - Pointer
            - Unexpected
            - Missing
            - Composite
            - Refinement
            - Transformation
            - Type
            - Forbidden
          description: The tag identifying the type of parse issue
        path:
          type: array
          items:
            $ref: "#/components/schemas/PropertyKey"
          description: The path to the property where the issue occurred
        message:
          type: string
          description: A descriptive message explaining the issue
      additionalProperties: false
      description: Represents an error encountered while parsing a value to match the schema
    PropertyKey:
      anyOf:
        - type: string
        - type: number
        - type: object
          required:
            - _tag
            - key
          properties:
            _tag:
              type: string
              enum:
                - symbol
            key:
              type: string
          additionalProperties: false
          description: an object to be decoded into a globally shared symbol
    NumberFromString:
      type: integer
      minimum: 0
      default: 0
    Date:
      type: string
      description: a string to be decoded into a Date
    SearchContractResponse:
      type: object
      required:
        - results
      properties:
        results:
          type: array
          items:
            $ref: "#/components/schemas/EnedisElectricityContract"
      additionalProperties: false
    PersistedFile:
      type: string
      format: binary
    SearchContractsFromInvoicesResponse:
      type: object
      required:
        - resultsByFile
      properties:
        resultsByFile:
          type: array
          items:
            type: object
            required:
              - fileName
              - contracts
              - others
            properties:
              fileName:
                type: string
                examples:
                  - invoice-edf.pdf
                  - invoice-engie.jpg
                  - invoice-totalenergies.png
              contracts:
                type: array
                items:
                  $ref: "#/components/schemas/EnedisElectricityContract"
              others:
                type: array
                items:
                  $ref: "#/components/schemas/OtherResult"
            additionalProperties: false
      additionalProperties: false
    OtherResult:
      type: object
      required:
        - prm
        - nomClientFinalOuDenominationSociale
        - adresseInstallationNormalisee
      properties:
        prm:
          $ref: "#/components/schemas/Prm"
        nomClientFinalOuDenominationSociale:
          type: string
          examples:
            - DUPONT Marie
            - SARL DUPONT ET FILS
        adresseInstallationNormalisee:
          type: object
          required:
            - ligne6
          properties:
            ligne1:
              type: string
              description: "Ligne 1 de l’adresse postale.

                \  Cette ligne identifie le destinataire.

                \  Cette donnée ne sera pas renseignée car

                \  redondante avec la donnée « Nom ou

                \  dénomination sociale du client »

                \  "
              title: Ligne 1 de l’adresse postale.
            ligne2:
              type: string
              description: "

                \  Ligne 2 de l’adresse postale.

                \  Cette ligne identifie généralement le

                \  complément d’identification du destinataire ou

                \  du point de remise (escalier, étage,

                \  appartement, boîte aux lettres…).

                \        "
              examples:
                - 03 D
                - COLLINE DE VELAUX VI
                - A
            ligne3:
              type: string
              description: "

                \  Ligne 3 de l’adresse postale.

                \  Cette ligne identifie généralement le

                \  complément d’identification du point

                \  géographique (entrée, tour, immeuble,

                \  bâtiment, résidence, zone industrielle…).

                \        "
              examples:
                - QUARTIER LES CAIRADES
                - VILLA CHANTE LA MER
                - VILLA B LOTISSEMENT ACHBARI
                - QUARTIER LE PEGOUY
                - CHEMIN DE LA CHABOTT
            ligne4:
              type: string
              description: "

                \  Ligne 4 de l’adresse postale.

                \  Cette ligne identifie le numéro et le libellé de la

                \  voie.

                \        "
              examples:
                - 70 ALLEE DU BOIS
                - 11 IMPASSE DES SENTEURS
                - 27 CHEMIN DES COUSTELLINES
            ligne5:
              type: string
              description: "

                \  Ligne 5 de l’adresse postale.

                \  Cette ligne identifie généralement :

                \  - le lieu-dit ou le service particulier de

                \  distribution dans le cas d’un client

                \  résidentiel,

                \  - les mentions spéciales de distribution et

                \  commune d’implantation de l’entreprise (si

                \  différente du bureau distributeur CEDEX)

                \  dans le cas d’un client professionnel.

                \        "
              examples:
                - HELLEMMES LILLE
                - BP 4
            ligne6:
              type: string
              description: "

                \  Ligne 6 de l’adresse postale.

                \  Cette ligne identifie :

                \  - le code postal et la localité de destination

                \  dans le cas d’un client résidentiel,

                \  - le code postal et bureau distributeur ou

                \  code cedex et bureau distributeur cedex

                \  dans le cas d’un client professionnel.

                \        "
              examples:
                - 84190 BEAUMES DE VENISE
            ligne7:
              type: string
              description: "

                \  Ligne 7 de l’adresse postale.

                \  Cette ligne identifie le pays.

                \  Cette donnée ne sera pas renseignée.

                \        "
          additionalProperties: false
          examples:
            - ligne4: 70 ALLEE DU BOIS
              ligne6: 84190 BEAUMES DE VENISE
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
security: []
tags:
  - name: asks
    description: Operations related to asks
  - name: orders
  - name: contracts
  - name: data-third-parties
  - name: requests
servers: []
