github.com/grokify/go-ringcentral-client@v0.3.31/codegen/specs-engagedigital_v3.0.0/openapi-spec_time-sheets.json

{
  "openapi":"3.0.0",
  "info":{
    "description":"",
    "version":"1.0",
    "title":"Engage Digital API",
    "termsOfService":"https://developer.ringcentral.com"
  },
  "tags":[
    {
      "name":"Time Sheets"
    }
  ],
  "paths":{
    "/time_sheets":{
      "get":{
        "tags":[
          "Time Sheets"
        ],
        "summary":"Getting all time sheets",
        "operationId":"getAllTimeSheets",
        "description":"This method renders time sheets ordered by active and label.",
        "parameters":[
          {
            "name":"offset",
            "in":"query",
            "description":"The record index to start. Default value is 0.",
            "required":false,
            "schema":{
              "type":"integer",
              "format":"int32"
            }
          },
          {
            "name":"limit",
            "in":"query",
            "description":"The max number of records to return. Default value is 30, max value is 150.",
            "required":false,
            "schema":{
              "type":"integer",
              "format":"int32"
            }
          }
        ],
        "responses":{
          "200":{
            "description":"Success",
            "content":{
              "application/json":{
                "schema":{
                  "$ref":"#/components/schemas/GetAllTimeSheetsResponse"
                }
              }
            }
          }
        }
      },
      "post":{
        "tags":[
          "Time Sheets"
        ],
        "summary":"Creating a time sheet",
        "operationId":"createTimeSheet",
        "description":"This method creates a time sheet. In case of success it renders the time sheet, otherwise, it renders an error (422 HTTP code).\n\nAuthorization​: only users that can create time sheet.",
        "parameters":[
          {
            "name":"active",
            "in":"query",
            "required":false,
            "description":"true or false, this field is used to enable/disable a time sheet.",
            "schema":{
              "type":"boolean"
            }
          },
          {
            "name":"label",
            "in":"query",
            "required":true,
            "description":"The label of the time sheet.",
            "schema":{
              "type":"string"
            }
          },
          {
            "name":"source_ids",
            "in":"query",
            "required":false,
            "description":"An array containing id of each source using your time sheet.",
            "schema":{
              "type":"array",
              "items":{
                "type":"string"
              }
            }
          },
          {
            "name":"holidays_region",
            "in":"query",
            "required":false,
            "description":"A string containing the first two letters of your country (example: \"fr\"/\"en\"/\"es\"), useful to bootstrap default holidays following to a country.",
            "schema":{
              "type":"string",
              "enum":[
                "de",
                "es",
                "fr",
                "gb",
                "it",
                "nl",
                "us"
              ]
            }
          },
          {
            "name":"holidays",
            "in":"query",
            "required":false,
            "description":"An array containing one or more hash of holidays, a holiday must contain a name (string) and a date (string), the date must be in a valid format, a valid format is a format corresponding to your domain’s locale).",
            "schema":{
              "type":"string"
            }
          },
          {
            "name":"monday_hours",
            "in":"query",
            "required":false,
            "description":"this field define the time intervals of the day (in secs). An empty string means that there are no business hours on this day. For example: “a-b,c-d”: “a” is the beginning of the first interval of the day, “b” is the ending of the first interval of the day, “c” is the beginning of the second interval of the day, “d” is the ending of the second interval of the day",
            "schema":{
              "type":"string"
            }
          },
          {
            "name":"tuesday_hours",
            "in":"query",
            "required":false,
            "description":"this field define the time intervals of the day (in secs). An empty string means that there are no business hours on this day. See `monday_hours` for the format.",
            "schema":{
              "type":"string"
            }
          },
          {
            "name":"wednesday_hours",
            "in":"query",
            "required":false,
            "description":"this field define the time intervals of the day (in secs). An empty string means that there are no business hours on this day. See `monday_hours` for the format.",
            "schema":{
              "type":"string"
            }
          },
          {
            "name":"thursday_hours",
            "in":"query",
            "required":false,
            "description":"this field define the time intervals of the day (in secs). An empty string means that there are no business hours on this day. See `monday_hours` for the format.",
            "schema":{
              "type":"string"
            }
          },
          {
            "name":"friday_hours",
            "in":"query",
            "required":false,
            "description":"this field define the time intervals of the day (in secs). An empty string means that there are no business hours on this day. See `monday_hours` for the format.",
            "schema":{
              "type":"string"
            }
          },
          {
            "name":"saturday_hours",
            "in":"query",
            "required":false,
            "description":"this field define the time intervals of the day (in secs). An empty string means that there are no business hours on this day. See `monday_hours` for the format.",
            "schema":{
              "type":"string"
            }
          },
          {
            "name":"sunday_hours",
            "in":"query",
            "required":false,
            "description":"this field define the time intervals of the day (in secs). An empty string means that there are no business hours on this day. See `monday_hours` for the format.",
            "schema":{
              "type":"string"
            }
          }
        ],
        "responses":{
          "200":{
            "description":"Success",
            "content":{
              "application/json":{
                "schema":{
                  "$ref":"#/components/schemas/TimeSheet"
                }
              }
            }
          }
        }
      }
    },
    "/time_sheets/{timeSheetId}":{
      "get":{
        "tags":[
          "Time Sheets"
        ],
        "summary":"Getting a time sheet from its id",
        "operationId":"getTimeSheet",
        "description":"This method renders a time sheet from given id.\n\nAuthorization​: only users that can see time sheets in administration section.",
        "parameters":[
          {
            "name":"timeSheetId",
            "in":"path",
            "required":true,
            "schema":{
              "type":"string"
            }
          }
        ],
        "responses":{
          "200":{
            "description":"Success",
            "content":{
              "application/json":{
                "schema":{
                  "$ref":"#/components/schemas/TimeSheet"
                }
              }
            }
          }
        }
      },
      "put":{
        "tags":[
          "Time Sheets"
        ],
        "summary":"Updating a time sheet",
        "operationId":"updateTimeSheet",
        "description":"This method updates an existing team from given attributes and renders it in case of success.",
        "parameters":[
          {
            "name":"timeSheetId",
            "in":"path",
            "required":true,
            "schema":{
              "type":"string"
            }
          },
          {
            "name":"active",
            "in":"query",
            "required":false,
            "description":"true or false, this field is used to enable/disable a time sheet.",
            "schema":{
              "type":"boolean"
            }
          },
          {
            "name":"label",
            "in":"query",
            "required":false,
            "description":"The label of the time sheet.",
            "schema":{
              "type":"string"
            }
          },
          {
            "name":"source_ids[]",
            "in":"query",
            "required":false,
            "description":"An array containing id of each source using your time sheet.",
            "schema":{
              "type":"array",
              "items":{
                "type":"string"
              }
            }
          },
          {
            "name":"holidays",
            "in":"query",
            "required":false,
            "description":"An array containing one or more hash of holidays, a holiday must contain a name (string) and a date (string), the date must be in a valid format, a valid format is a format corresponding to your domain’s locale).",
            "schema":{
              "type":"string"
            }
          },
          {
            "name":"monday_hours",
            "in":"query",
            "required":false,
            "description":"this field define the time intervals of the day (in secs). An empty string means that there are no business hours on this day. For example: “a-b,c-d”: “a” is the beginning of the first interval of the day, “b” is the ending of the first interval of the day, “c” is the beginning of the second interval of the day, “d” is the ending of the second interval of the day",
            "schema":{
              "type":"string"
            }
          },
          {
            "name":"tuesday_hours",
            "in":"query",
            "required":false,
            "description":"this field define the time intervals of the day (in secs). An empty string means that there are no business hours on this day. See `monday_hours` for the format.",
            "schema":{
              "type":"string"
            }
          },
          {
            "name":"wednesday_hours",
            "in":"query",
            "required":false,
            "description":"this field define the time intervals of the day (in secs). An empty string means that there are no business hours on this day. See `monday_hours` for the format.",
            "schema":{
              "type":"string"
            }
          },
          {
            "name":"thursday_hours",
            "in":"query",
            "required":false,
            "description":"this field define the time intervals of the day (in secs). An empty string means that there are no business hours on this day. See `monday_hours` for the format.",
            "schema":{
              "type":"string"
            }
          },
          {
            "name":"friday_hours",
            "in":"query",
            "required":false,
            "description":"this field define the time intervals of the day (in secs). An empty string means that there are no business hours on this day. See `monday_hours` for the format.",
            "schema":{
              "type":"string"
            }
          },
          {
            "name":"saturday_hours",
            "in":"query",
            "required":false,
            "description":"this field define the time intervals of the day (in secs). An empty string means that there are no business hours on this day. See `monday_hours` for the format.",
            "schema":{
              "type":"string"
            }
          },
          {
            "name":"sunday_hours",
            "in":"query",
            "required":false,
            "description":"this field define the time intervals of the day (in secs). An empty string means that there are no business hours on this day. See `monday_hours` for the format.",
            "schema":{
              "type":"string"
            }
          }
        ],
        "responses":{
          "200":{
            "description":"Success",
            "content":{
              "application/json":{
                "schema":{
                  "$ref":"#/components/schemas/TimeSheet"
                }
              }
            }
          }
        }
      },
      "delete":{
        "tags":[
          "Time Sheets"
        ],
        "summary":"Deleting a time sheet",
        "operationId":"deleteTimeSheet",
        "description":"This method destroys an existing time sheet. It renders time sheet itself. It renders a 404 if id is invalid.",
        "parameters":[
          {
            "name":"timeSheetId",
            "in":"path",
            "required":true,
            "schema":{
              "type":"string"
            }
          }
        ],
        "responses":{
          "200":{
            "description":"Success",
            "content":{
              "application/json":{
                "schema":{
                  "$ref":"#/components/schemas/TimeSheet"
                }
              }
            }
          }
        }
      }
    }
  },
  "servers":[
    {
      "url":"https://DOMAIN.api.engagement.dimelo.com/1.0"
    }
  ],
  "components":{
    "schemas":{
      "GetAllTimeSheetsResponse":{
        "properties":{
          "count":{
            "type":"integer",
            "format":"int32"
          },
          "limit":{
            "type":"integer",
            "format":"int32"
          },
          "offset":{
            "type":"integer",
            "format":"int32"
          },
          "records":{
            "type":"array",
            "items":{
              "$ref":"#/components/schemas/TimeSheet"
            }
          }
        }
      },
      "TimeSheet":{
        "required":[
          "id"
        ],
        "properties":{
          "id":{
            "type":"string"
          },
          "created_at":{
            "type":"string",
            "format":"date-time"
          },
          "updated_at":{
            "type":"string",
            "format":"date-time"
          },
          "active":{
            "type":"boolean"
          },
          "label":{
            "type":"string"
          },
          "source_ids":{
            "type":"array",
            "items":{
              "type":"string"
            }
          },
          "timezone":{
            "type":"string"
          },
          "sunday_hours":{
            "type":"string"
          },
          "monday_hours":{
            "type":"string"
          },
          "tuesday_hours":{
            "type":"string"
          },
          "wednesday_hours":{
            "type":"string"
          },
          "thursday_hours":{
            "type":"string"
          },
          "friday_hours":{
            "type":"string"
          },
          "saturday_hours":{
            "type":"string"
          },
          "holidays[]":{
            "type":"array",
            "items":{
              "$ref":"#/components/schemas/TimeSheetHoliday"
            }
          }
        }
      },
      "TimeSheetHoliday":{
        "properties":{
          "name":{
            "type":"string"
          },
          "date":{
            "type":"string"
          }
        }
      }
    }
  }
}