{
  "opencollection": "1.0.0",
  "info": {
    "name": "Square ApplePay Labor API",
    "version": "2.0"
  },
  "items": [
    {
      "info": {
        "name": "Labor",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Square List Break Types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://connect.squareup.com/v2/labor/break-types",
            "params": [
              {
                "name": "location_id",
                "value": "",
                "type": "query",
                "description": "Filter the returned `BreakType` results to only those that are associated with the\nspecified location."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of `BreakType` results to return per page. The number can range between 1\nand 200. The default is 200."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "A pointer to the next page of `BreakType` results to fetch."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Returns a paginated list of `BreakType` instances for a business."
        },
        {
          "info": {
            "name": "Square Create Break Type",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://connect.squareup.com/v2/labor/break-types",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Creates a new `BreakType`.\n\nA `BreakType` is a template for creating `Break` objects.\nYou must provide the following values in your request to this\nendpoint:\n\n- `location_id`\n- `break_name`\n- `expected_duration`\n- `is_paid`\n\nYou can only have three `BreakType` instances per location. If you attempt to add a fourth\n`BreakType` for a location, an `INVALID_REQUEST_ERROR` \"Exceeded limit of 3 breaks per location.\"\nis returned."
        },
        {
          "info": {
            "name": "Square Get Break Type",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://connect.squareup.com/v2/labor/break-types/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The UUID for the `BreakType` being retrieved."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Returns a single `BreakType` specified by `id`."
        },
        {
          "info": {
            "name": "Square Update Break Type",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://connect.squareup.com/v2/labor/break-types/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": " The UUID for the `BreakType` being updated."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Updates an existing `BreakType`."
        },
        {
          "info": {
            "name": "Square Delete Break Type",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://connect.squareup.com/v2/labor/break-types/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The UUID for the `BreakType` being deleted."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Deletes an existing `BreakType`.\n\nA `BreakType` can be deleted even if it is referenced from a `Shift`."
        },
        {
          "info": {
            "name": "Square List Employee Wages",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://connect.squareup.com/v2/labor/employee-wages",
            "params": [
              {
                "name": "employee_id",
                "value": "",
                "type": "query",
                "description": "Filter the returned wages to only those that are associated with the specified employee."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of `EmployeeWage` results to return per page. The number can range between\n1 and 200. The default is 200."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "A pointer to the next page of `EmployeeWage` results to fetch."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Returns a paginated list of `EmployeeWage` instances for a business."
        },
        {
          "info": {
            "name": "Square Get Employee Wage",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://connect.squareup.com/v2/labor/employee-wages/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The UUID for the `EmployeeWage` being retrieved."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Returns a single `EmployeeWage` specified by `id`."
        },
        {
          "info": {
            "name": "Square Create Shift",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://connect.squareup.com/v2/labor/shifts",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Creates a new `Shift`.\n\nA `Shift` represents a complete workday for a single team member.\nYou must provide the following values in your request to this\nendpoint:\n\n- `location_id`\n- `team_member_id`\n- `start_at`\n\nAn attempt to create a new `Shift` can result in a `BAD_REQUEST` error when:\n- The `status` of the new `Shift` is `OPEN` and the team member has another\nshift with an `OPEN` status.\n- The `start_at` date is in the future.\n- The `start_at` or `end_at` date overlaps another shift for the s"
        },
        {
          "info": {
            "name": "Square Search Shifts",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://connect.squareup.com/v2/labor/shifts/search",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Returns a paginated list of `Shift` records for a business.\nThe list to be returned can be filtered by:\n- Location IDs\n- Team member IDs\n- Shift status (`OPEN` or `CLOSED`)\n- Shift start\n- Shift end\n- Workday details\n\nThe list can be sorted by:\n- `START_AT`\n- `END_AT`\n- `CREATED_AT`\n- `UPDATED_AT`"
        },
        {
          "info": {
            "name": "Square Get Shift",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://connect.squareup.com/v2/labor/shifts/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The UUID for the `Shift` being retrieved."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Returns a single `Shift` specified by `id`."
        },
        {
          "info": {
            "name": "Square Update Shift",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://connect.squareup.com/v2/labor/shifts/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the object being updated."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Updates an existing `Shift`.\n\nWhen adding a `Break` to a `Shift`, any earlier `Break` instances in the `Shift` have\nthe `end_at` property set to a valid RFC-3339 datetime string.\n\nWhen closing a `Shift`, all `Break` instances in the `Shift` must be complete with `end_at`\nset on each `Break`."
        },
        {
          "info": {
            "name": "Square Delete Shift",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://connect.squareup.com/v2/labor/shifts/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The UUID for the `Shift` being deleted."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Deletes a `Shift`."
        },
        {
          "info": {
            "name": "Square List Team Member Wages",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://connect.squareup.com/v2/labor/team-member-wages",
            "params": [
              {
                "name": "team_member_id",
                "value": "",
                "type": "query",
                "description": "Filter the returned wages to only those that are associated with the\nspecified team member."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of `TeamMemberWage` results to return per page. The number can range between\n1 and 200. The default is 200."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "A pointer to the next page of `EmployeeWage` results to fetch."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Returns a paginated list of `TeamMemberWage` instances for a business."
        },
        {
          "info": {
            "name": "Square Get Team Member Wage",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://connect.squareup.com/v2/labor/team-member-wages/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The UUID for the `TeamMemberWage` being retrieved."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Returns a single `TeamMemberWage` specified by `id`."
        },
        {
          "info": {
            "name": "Square List Workweek Configs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://connect.squareup.com/v2/labor/workweek-configs",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of `WorkweekConfigs` results to return per page."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "A pointer to the next page of `WorkweekConfig` results to fetch."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Returns a list of `WorkweekConfig` instances for a business."
        },
        {
          "info": {
            "name": "Square Update Workweek Config",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://connect.squareup.com/v2/labor/workweek-configs/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The UUID for the `WorkweekConfig` object being updated."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://connect.squareup.com/oauth2/authorize",
              "accessTokenUrl": "https://connect.squareup.com/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Updates a `WorkweekConfig`."
        }
      ]
    }
  ],
  "bundled": true
}