github.com/optim-corp/cios-golang-sdk@v0.5.1/openapi/components/contract-component.openapi.yml (about)

     1  openapi: 3.0.3
     2  info:
     3    title: Contract Component
     4    description: Component
     5    version: 1.0.1
     6  
     7  paths: {}
     8  
     9  components:
    10    schemas:
    11      MultipleContract:
    12        type: object
    13        required:
    14          - total
    15          - contracts
    16        properties:
    17          total:
    18            type: integer
    19            format: int64
    20          contracts:
    21            type: array
    22            items:
    23              $ref: '#/components/schemas/Contract'
    24      Contract:
    25        type: object
    26        properties:
    27          id:
    28            type: string
    29            format: uuid
    30          provider_id:
    31            type: string
    32            format: uuid
    33          quantity:
    34            type: integer
    35          unit:
    36            type: string
    37          license_type:
    38            type: string
    39            enum: [ Corporation, User ]
    40          contract_type:
    41            type: string
    42            enum: [ outright, prepaid, automatic_updating_flat_rate, automatic_updating_measured_rate ]
    43          span_type:
    44            type: string
    45            enum: [ daily, weekly, monthly, yearly ]
    46          span_number:
    47            type: integer
    48          status:
    49            type: string
    50            enum: [ active, inactive, owner_absent, suspend ]
    51          purchased_at:
    52            type: string
    53            description: ISO8601
    54          issued_at:
    55            type: string
    56            description: ISO8601
    57          expires_at:
    58            type: string
    59            description: ISO8601
    60          status_change_at:
    61            type: string
    62            description: ISO8601
    63          items:
    64            type: array
    65            items:
    66              $ref: '#/components/schemas/ContractItem'
    67          owner:
    68            $ref: '#/components/schemas/ContractOwner'
    69      ContractItem:
    70        type: object
    71        properties:
    72          item_id:
    73            type: string
    74          plan_id:
    75            type: string
    76      ContractOwner:
    77        type: object
    78        properties:
    79          id:
    80            type: string
    81            format: uuid
    82          name:
    83            type: string
    84          phone_number:
    85            type: string
    86          phone_number_2:
    87            type: string
    88          address:
    89            $ref: '#/components/schemas/ContractOwnerAddress'
    90      ContractOwnerAddress:
    91        type: object
    92        properties:
    93          country:
    94            type: string
    95            description: ISO 3166-1 alpha-2
    96          zip_code:
    97            type: string
    98          state:
    99            type: string
   100          city:
   101            type: string
   102          address_1:
   103            type: string
   104          address_2:
   105            type: string
   106          tags:
   107            type: array
   108            items:
   109              type: string
   110          custom_fields:
   111            type: object
   112      MultipleContractUser:
   113        type: object
   114        properties:
   115          total:
   116            type: integer
   117            format: int64
   118          users:
   119            $ref: '#/components/schemas/ContractUser'
   120      ContractUser:
   121        type: object
   122        properties:
   123          id:
   124            type: string
   125            format: uuid
   126          type:
   127            type: string
   128          name:
   129            type: string
   130          family_name:
   131            type: string
   132          given_name:
   133            type: string
   134          phonetic_family_name:
   135            type: string
   136          phonetic_given_name:
   137            type: string
   138          phone_number:
   139            type: string
   140          phone_number_2:
   141            type: string
   142          language:
   143            type: string
   144            enum: [ ja, en, en-US, de-DE, fr-FR, es-ES ]
   145            description: ISO639
   146          picture:
   147            type: string
   148            description: uri
   149          email:
   150            type: string
   151          emails:
   152            type: array
   153            items:
   154              type: string
   155          role:
   156            type: string
   157            enum: [ super_admin, staff ]
   158          category:
   159            type: string
   160            enum: [ member, guest ]
   161          address:
   162            $ref: '#/components/schemas/ContractOwnerAddress'
   163          license:
   164            $ref: '#/components/schemas/ContractUserLicense'
   165      ContractUserLicense:
   166        type: object
   167        properties:
   168          issued_at:
   169            type: string
   170            description: ISO8601
   171          expires_at:
   172            type: string
   173            description: ISO8601