admin-valentin/arcade-mcp
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
arcade-mcp/toolkits/squareup_api/arcade_squareup_api/wrapper_tools/CreateBooking.json
jottakka f2332a7682
[Moar][Rewrapping] Rewrapping tools (#653) 
## Rewrapping

- Calendly
- Airtable
- Squareup
- PagerDuty
- Trello
- Miro

---------

Co-authored-by: Francisco Liberal <francisco@arcade.dev>
2025-10-24 18:05:33 -03:00

1347 lines
116 KiB
JSON
Raw Blame History

{
"name": "CreateBooking",
"fully_qualified_name": "SquareupApi.CreateBooking@2.0.0",
"description": "Create a new booking for a service.\n\nThis tool creates a booking using specified details like location, start time, team member, and service variation. Ideal for scheduling appointments with buyer or seller permissions, ensuring necessary subscriptions are met.",
"toolkit": {
"name": "ArcadeSquareupApi",
"description": null,
"version": "2.0.0"
},
"input": {
"parameters": [
{
"name": "booking_details",
"required": true,
"description": "A JSON object containing all the necessary fields for creating a booking, including idempotency key, location, time, customer details, and appointment segments.",
"value_schema": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"idempotency_key": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A unique key to make this request an idempotent operation."
},
"booking": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"id": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A unique ID of this object representing a booking."
},
"version": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The revision number for the booking used for optimistic concurrency."
},
"status": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"PENDING",
"CANCELLED_BY_CUSTOMER",
"CANCELLED_BY_SELLER",
"DECLINED",
"ACCEPTED",
"NO_SHOW"
],
"properties": null,
"inner_properties": null,
"description": "Supported booking statuses."
},
"created_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The RFC 3339 timestamp specifying the creation time of this booking."
},
"updated_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The RFC 3339 timestamp specifying the most recent update time of this booking."
},
"start_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The RFC 3339 timestamp specifying the starting time of this booking."
},
"location_id": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The ID of the [Location](entity:Location) object representing the location where the booked service is provided. Once set when the booking is created, its value cannot be changed."
},
"customer_id": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The ID of the [Customer](entity:Customer) object representing the customer receiving the booked service."
},
"customer_note": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The free-text field for the customer to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a relevant [CatalogObject](entity:CatalogObject) instance."
},
"seller_note": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The free-text field for the seller to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a specific [CatalogObject](entity:CatalogObject) instance.\nThis field should not be visible to customers."
},
"appointment_segments": {
"val_type": "array",
"inner_val_type": "json",
"enum": null,
"properties": null,
"inner_properties": {
"duration_minutes": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The time span in minutes of an appointment segment."
},
"service_variation_id": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The ID of the [CatalogItemVariation](entity:CatalogItemVariation) object representing the service booked in this segment."
},
"team_member_id": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The ID of the [TeamMember](entity:TeamMember) object representing the team member booked in this segment."
},
"service_variation_version": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The current version of the item variation representing the service booked in this segment."
},
"intermission_minutes": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Time between the end of this segment and the beginning of the subsequent segment."
},
"any_team_member": {
"val_type": "boolean",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Whether the customer accepts any team member, instead of a specific one, to serve this segment."
},
"resource_ids": {
"val_type": "array",
"inner_val_type": "string",
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The IDs of the seller-accessible resources used for this appointment segment."
}
},
"description": "A list of appointment segments for this booking."
},
"transition_time_minutes": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Additional time at the end of a booking.\nApplications should not make this field visible to customers of a seller."
},
"all_day": {
"val_type": "boolean",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Whether the booking is of a full business day."
},
"location_type": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"BUSINESS_LOCATION",
"CUSTOMER_LOCATION",
"PHONE"
],
"properties": null,
"inner_properties": null,
"description": "Supported types of location where service is provided."
},
"creator_details": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"creator_type": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"TEAM_MEMBER",
"CUSTOMER"
],
"properties": null,
"inner_properties": null,
"description": "Supported types of a booking creator."
},
"team_member_id": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The ID of the team member who created the booking, when the booking creator is of the `TEAM_MEMBER` type.\nAccess to this field requires seller-level permissions."
},
"customer_id": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The ID of the customer who created the booking, when the booking creator is of the `CUSTOMER` type.\nAccess to this field requires seller-level permissions."
}
},
"inner_properties": null,
"description": "Information about a booking creator."
},
"source": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"FIRST_PARTY_MERCHANT",
"FIRST_PARTY_BUYER",
"THIRD_PARTY_BUYER",
"API"
],
"properties": null,
"inner_properties": null,
"description": "Supported sources a booking was created from."
},
"address": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"address_line_1": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The first line of the address.\n\nFields that start with `address_line` provide the address's most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields)."
},
"address_line_2": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The second line of the address, if any."
},
"address_line_3": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The third line of the address, if any."
},
"locality": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses)."
},
"sublocality": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A civil region within the address's `locality`, if any."
},
"sublocality_2": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A civil region within the address's `sublocality`, if any."
},
"sublocality_3": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A civil region within the address's `sublocality_2`, if any."
},
"administrative_district_level_1": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A civil entity within the address's country. In the US, this\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses)."
},
"administrative_district_level_2": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A civil entity within the address's `administrative_district_level_1`.\nIn the US, this is the county."
},
"administrative_district_level_3": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A civil entity within the address's `administrative_district_level_2`,\nif any."
},
"postal_code": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The address's postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses)."
},
"country": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"ZZ",
"AD",
"AE",
"AF",
"AG",
"AI",
"AL",
"AM",
"AO",
"AQ",
"AR",
"AS",
"AT",
"AU",
"AW",
"AX",
"AZ",
"BA",
"BB",
"BD",
"BE",
"BF",
"BG",
"BH",
"BI",
"BJ",
"BL",
"BM",
"BN",
"BO",
"BQ",
"BR",
"BS",
"BT",
"BV",
"BW",
"BY",
"BZ",
"CA",
"CC",
"CD",
"CF",
"CG",
"CH",
"CI",
"CK",
"CL",
"CM",
"CN",
"CO",
"CR",
"CU",
"CV",
"CW",
"CX",
"CY",
"CZ",
"DE",
"DJ",
"DK",
"DM",
"DO",
"DZ",
"EC",
"EE",
"EG",
"EH",
"ER",
"ES",
"ET",
"FI",
"FJ",
"FK",
"FM",
"FO",
"FR",
"GA",
"GB",
"GD",
"GE",
"GF",
"GG",
"GH",
"GI",
"GL",
"GM",
"GN",
"GP",
"GQ",
"GR",
"GS",
"GT",
"GU",
"GW",
"GY",
"HK",
"HM",
"HN",
"HR",
"HT",
"HU",
"ID",
"IE",
"IL",
"IM",
"IN",
"IO",
"IQ",
"IR",
"IS",
"IT",
"JE",
"JM",
"JO",
"JP",
"KE",
"KG",
"KH",
"KI",
"KM",
"KN",
"KP",
"KR",
"KW",
"KY",
"KZ",
"LA",
"LB",
"LC",
"LI",
"LK",
"LR",
"LS",
"LT",
"LU",
"LV",
"LY",
"MA",
"MC",
"MD",
"ME",
"MF",
"MG",
"MH",
"MK",
"ML",
"MM",
"MN",
"MO",
"MP",
"MQ",
"MR",
"MS",
"MT",
"MU",
"MV",
"MW",
"MX",
"MY",
"MZ",
"NA",
"NC",
"NE",
"NF",
"NG",
"NI",
"NL",
"NO",
"NP",
"NR",
"NU",
"NZ",
"OM",
"PA",
"PE",
"PF",
"PG",
"PH",
"PK",
"PL",
"PM",
"PN",
"PR",
"PS",
"PT",
"PW",
"PY",
"QA",
"RE",
"RO",
"RS",
"RU",
"RW",
"SA",
"SB",
"SC",
"SD",
"SE",
"SG",
"SH",
"SI",
"SJ",
"SK",
"SL",
"SM",
"SN",
"SO",
"SR",
"SS",
"ST",
"SV",
"SX",
"SY",
"SZ",
"TC",
"TD",
"TF",
"TG",
"TH",
"TJ",
"TK",
"TL",
"TM",
"TN",
"TO",
"TR",
"TT",
"TV",
"TW",
"TZ",
"UA",
"UG",
"UM",
"US",
"UY",
"UZ",
"VA",
"VC",
"VE",
"VG",
"VI",
"VN",
"VU",
"WF",
"WS",
"YE",
"YT",
"ZA",
"ZM",
"ZW"
],
"properties": null,
"inner_properties": null,
"description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm)."
},
"first_name": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Optional first name when it's representing recipient."
},
"last_name": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Optional last name when it's representing recipient."
}
},
"inner_properties": null,
"description": "Represents a postal address in a country. \nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses)."
}
},
"inner_properties": null,
"description": "Represents a booking as a time-bound service contract for a seller's staff member to provide a specified service\nat a given location to a requesting customer in one or more appointment segments."
}
},
"inner_properties": null,
"description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details."
},
"inferrable": true,
"http_endpoint_parameter_name": "requestBody"
}
]
},
"output": {
"description": "Response from the API endpoint 'CreateBooking'.",
"available_modes": [
"value",
"error",
"null"
],
"value_schema": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
}
},
"requirements": {
"authorization": {
"provider_id": "arcade-squareup",
"provider_type": "oauth2",
"id": null,
"oauth2": {
"scopes": [
"APPOINTMENTS_WRITE"
]
}
},
"secrets": null,
"metadata": null
},
"deprecation_message": null,
"metadata": {
"object_type": "api_wrapper_tool",
"version": "1.1.0",
"description": "Tools that enable LLMs to interact directly with the squareup API."
},
"http_endpoint": {
"metadata": {
"object_type": "http_endpoint",
"version": "1.2.0",
"description": ""
},
"url": "https://connect.squareup.com/v2/bookings",
"http_method": "POST",
"headers": {},
"parameters": [
{
"name": "requestBody",
"tool_parameter_name": "booking_details",
"description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.",
"value_schema": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"idempotency_key": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A unique key to make this request an idempotent operation."
},
"booking": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"id": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A unique ID of this object representing a booking."
},
"version": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The revision number for the booking used for optimistic concurrency."
},
"status": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"PENDING",
"CANCELLED_BY_CUSTOMER",
"CANCELLED_BY_SELLER",
"DECLINED",
"ACCEPTED",
"NO_SHOW"
],
"properties": null,
"inner_properties": null,
"description": "Supported booking statuses."
},
"created_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The RFC 3339 timestamp specifying the creation time of this booking."
},
"updated_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The RFC 3339 timestamp specifying the most recent update time of this booking."
},
"start_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The RFC 3339 timestamp specifying the starting time of this booking."
},
"location_id": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The ID of the [Location](entity:Location) object representing the location where the booked service is provided. Once set when the booking is created, its value cannot be changed."
},
"customer_id": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The ID of the [Customer](entity:Customer) object representing the customer receiving the booked service."
},
"customer_note": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The free-text field for the customer to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a relevant [CatalogObject](entity:CatalogObject) instance."
},
"seller_note": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The free-text field for the seller to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a specific [CatalogObject](entity:CatalogObject) instance.\nThis field should not be visible to customers."
},
"appointment_segments": {
"val_type": "array",
"inner_val_type": "json",
"enum": null,
"properties": null,
"inner_properties": {
"duration_minutes": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The time span in minutes of an appointment segment."
},
"service_variation_id": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The ID of the [CatalogItemVariation](entity:CatalogItemVariation) object representing the service booked in this segment."
},
"team_member_id": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The ID of the [TeamMember](entity:TeamMember) object representing the team member booked in this segment."
},
"service_variation_version": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The current version of the item variation representing the service booked in this segment."
},
"intermission_minutes": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Time between the end of this segment and the beginning of the subsequent segment."
},
"any_team_member": {
"val_type": "boolean",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Whether the customer accepts any team member, instead of a specific one, to serve this segment."
},
"resource_ids": {
"val_type": "array",
"inner_val_type": "string",
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The IDs of the seller-accessible resources used for this appointment segment."
}
},
"description": "A list of appointment segments for this booking."
},
"transition_time_minutes": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Additional time at the end of a booking.\nApplications should not make this field visible to customers of a seller."
},
"all_day": {
"val_type": "boolean",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Whether the booking is of a full business day."
},
"location_type": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"BUSINESS_LOCATION",
"CUSTOMER_LOCATION",
"PHONE"
],
"properties": null,
"inner_properties": null,
"description": "Supported types of location where service is provided."
},
"creator_details": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"creator_type": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"TEAM_MEMBER",
"CUSTOMER"
],
"properties": null,
"inner_properties": null,
"description": "Supported types of a booking creator."
},
"team_member_id": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The ID of the team member who created the booking, when the booking creator is of the `TEAM_MEMBER` type.\nAccess to this field requires seller-level permissions."
},
"customer_id": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The ID of the customer who created the booking, when the booking creator is of the `CUSTOMER` type.\nAccess to this field requires seller-level permissions."
}
},
"inner_properties": null,
"description": "Information about a booking creator."
},
"source": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"FIRST_PARTY_MERCHANT",
"FIRST_PARTY_BUYER",
"THIRD_PARTY_BUYER",
"API"
],
"properties": null,
"inner_properties": null,
"description": "Supported sources a booking was created from."
},
"address": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"address_line_1": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The first line of the address.\n\nFields that start with `address_line` provide the address's most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields)."
},
"address_line_2": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The second line of the address, if any."
},
"address_line_3": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The third line of the address, if any."
},
"locality": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses)."
},
"sublocality": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A civil region within the address's `locality`, if any."
},
"sublocality_2": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A civil region within the address's `sublocality`, if any."
},
"sublocality_3": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A civil region within the address's `sublocality_2`, if any."
},
"administrative_district_level_1": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A civil entity within the address's country. In the US, this\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses)."
},
"administrative_district_level_2": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A civil entity within the address's `administrative_district_level_1`.\nIn the US, this is the county."
},
"administrative_district_level_3": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A civil entity within the address's `administrative_district_level_2`,\nif any."
},
"postal_code": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The address's postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses)."
},
"country": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"ZZ",
"AD",
"AE",
"AF",
"AG",
"AI",
"AL",
"AM",
"AO",
"AQ",
"AR",
"AS",
"AT",
"AU",
"AW",
"AX",
"AZ",
"BA",
"BB",
"BD",
"BE",
"BF",
"BG",
"BH",
"BI",
"BJ",
"BL",
"BM",
"BN",
"BO",
"BQ",
"BR",
"BS",
"BT",
"BV",
"BW",
"BY",
"BZ",
"CA",
"CC",
"CD",
"CF",
"CG",
"CH",
"CI",
"CK",
"CL",
"CM",
"CN",
"CO",
"CR",
"CU",
"CV",
"CW",
"CX",
"CY",
"CZ",
"DE",
"DJ",
"DK",
"DM",
"DO",
"DZ",
"EC",
"EE",
"EG",
"EH",
"ER",
"ES",
"ET",
"FI",
"FJ",
"FK",
"FM",
"FO",
"FR",
"GA",
"GB",
"GD",
"GE",
"GF",
"GG",
"GH",
"GI",
"GL",
"GM",
"GN",
"GP",
"GQ",
"GR",
"GS",
"GT",
"GU",
"GW",
"GY",
"HK",
"HM",
"HN",
"HR",
"HT",
"HU",
"ID",
"IE",
"IL",
"IM",
"IN",
"IO",
"IQ",
"IR",
"IS",
"IT",
"JE",
"JM",
"JO",
"JP",
"KE",
"KG",
"KH",
"KI",
"KM",
"KN",
"KP",
"KR",
"KW",
"KY",
"KZ",
"LA",
"LB",
"LC",
"LI",
"LK",
"LR",
"LS",
"LT",
"LU",
"LV",
"LY",
"MA",
"MC",
"MD",
"ME",
"MF",
"MG",
"MH",
"MK",
"ML",
"MM",
"MN",
"MO",
"MP",
"MQ",
"MR",
"MS",
"MT",
"MU",
"MV",
"MW",
"MX",
"MY",
"MZ",
"NA",
"NC",
"NE",
"NF",
"NG",
"NI",
"NL",
"NO",
"NP",
"NR",
"NU",
"NZ",
"OM",
"PA",
"PE",
"PF",
"PG",
"PH",
"PK",
"PL",
"PM",
"PN",
"PR",
"PS",
"PT",
"PW",
"PY",
"QA",
"RE",
"RO",
"RS",
"RU",
"RW",
"SA",
"SB",
"SC",
"SD",
"SE",
"SG",
"SH",
"SI",
"SJ",
"SK",
"SL",
"SM",
"SN",
"SO",
"SR",
"SS",
"ST",
"SV",
"SX",
"SY",
"SZ",
"TC",
"TD",
"TF",
"TG",
"TH",
"TJ",
"TK",
"TL",
"TM",
"TN",
"TO",
"TR",
"TT",
"TV",
"TW",
"TZ",
"UA",
"UG",
"UM",
"US",
"UY",
"UZ",
"VA",
"VC",
"VE",
"VG",
"VI",
"VN",
"VU",
"WF",
"WS",
"YE",
"YT",
"ZA",
"ZM",
"ZW"
],
"properties": null,
"inner_properties": null,
"description": "Indicates the country associated with another entity, such as a business.\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm)."
},
"first_name": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Optional first name when it's representing recipient."
},
"last_name": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Optional last name when it's representing recipient."
}
},
"inner_properties": null,
"description": "Represents a postal address in a country. \nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses)."
}
},
"inner_properties": null,
"description": "Represents a booking as a time-bound service contract for a seller's staff member to provide a specified service\nat a given location to a requesting customer in one or more appointment segments."
}
},
"inner_properties": null,
"description": "An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details."
},
"accepted_as": "body",
"required": true,
"deprecated": false,
"default": null,
"documentation_urls": []
}
],
"documentation_urls": [],
"secrets": [
{
"arcade_key": "auth_token",
"parameter_name": "Authorization",
"accepted_as": "header",
"formatted_value": "Bearer {authorization}",
"description": "The OAuth token to use for authentication.",
"is_auth_token": true
}
],
"request_body_spec": "{\n \"required\": true,\n \"description\": \"An object containing the fields to POST for the request.\\n\\nSee the corresponding object definition for field details.\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"x-release-status\": \"PUBLIC\",\n \"required\": [\n \"booking\"\n ],\n \"properties\": {\n \"idempotency_key\": {\n \"type\": \"string\",\n \"description\": \"A unique key to make this request an idempotent operation.\",\n \"maxLength\": 255\n },\n \"booking\": {\n \"type\": \"object\",\n \"description\": \"Represents a booking as a time-bound service contract for a seller's staff member to provide a specified service\\nat a given location to a requesting customer in one or more appointment segments.\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"description\": \"A unique ID of this object representing a booking.\",\n \"maxLength\": 36,\n \"readOnly\": true\n },\n \"version\": {\n \"type\": \"integer\",\n \"description\": \"The revision number for the booking used for optimistic concurrency.\"\n },\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"PENDING\",\n \"CANCELLED_BY_CUSTOMER\",\n \"CANCELLED_BY_SELLER\",\n \"DECLINED\",\n \"ACCEPTED\",\n \"NO_SHOW\"\n ],\n \"x-enum-elements\": [\n {\n \"name\": \"PENDING\",\n \"description\": \"An unaccepted booking. It is visible to both sellers and customers.\"\n },\n {\n \"name\": \"CANCELLED_BY_CUSTOMER\",\n \"description\": \"A customer-cancelled booking. It is visible to both the seller and the customer.\"\n },\n {\n \"name\": \"CANCELLED_BY_SELLER\",\n \"description\": \"A seller-cancelled booking. It is visible to both the seller and the customer.\"\n },\n {\n \"name\": \"DECLINED\",\n \"description\": \"A declined booking. It had once been pending, but was then declined by the seller.\"\n },\n {\n \"name\": \"ACCEPTED\",\n \"description\": \"An accepted booking agreed to or accepted by the seller.\"\n },\n {\n \"name\": \"NO_SHOW\",\n \"description\": \"A no-show booking. The booking was accepted at one time, but have now been marked as a no-show by\\nthe seller because the client either missed the booking or cancelled it without enough notice.\"\n }\n ],\n \"description\": \"Supported booking statuses.\",\n \"x-release-status\": \"PUBLIC\"\n },\n \"created_at\": {\n \"type\": \"string\",\n \"description\": \"The RFC 3339 timestamp specifying the creation time of this booking.\",\n \"readOnly\": true\n },\n \"updated_at\": {\n \"type\": \"string\",\n \"description\": \"The RFC 3339 timestamp specifying the most recent update time of this booking.\",\n \"readOnly\": true\n },\n \"start_at\": {\n \"type\": \"string\",\n \"description\": \"The RFC 3339 timestamp specifying the starting time of this booking.\",\n \"nullable\": true\n },\n \"location_id\": {\n \"type\": \"string\",\n \"description\": \"The ID of the [Location](entity:Location) object representing the location where the booked service is provided. Once set when the booking is created, its value cannot be changed.\",\n \"maxLength\": 32,\n \"nullable\": true\n },\n \"customer_id\": {\n \"type\": \"string\",\n \"description\": \"The ID of the [Customer](entity:Customer) object representing the customer receiving the booked service.\",\n \"maxLength\": 192,\n \"nullable\": true\n },\n \"customer_note\": {\n \"type\": \"string\",\n \"description\": \"The free-text field for the customer to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a relevant [CatalogObject](entity:CatalogObject) instance.\",\n \"maxLength\": 4096,\n \"nullable\": true\n },\n \"seller_note\": {\n \"type\": \"string\",\n \"description\": \"The free-text field for the seller to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a specific [CatalogObject](entity:CatalogObject) instance.\\nThis field should not be visible to customers.\",\n \"maxLength\": 4096,\n \"nullable\": true\n },\n \"appointment_segments\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"description\": \"Defines an appointment segment of a booking.\",\n \"x-release-status\": \"PUBLIC\",\n \"required\": [\n \"team_member_id\"\n ],\n \"properties\": {\n \"duration_minutes\": {\n \"type\": \"integer\",\n \"description\": \"The time span in minutes of an appointment segment.\",\n \"maximum\": 1500,\n \"nullable\": true\n },\n \"service_variation_id\": {\n \"type\": \"string\",\n \"description\": \"The ID of the [CatalogItemVariation](entity:CatalogItemVariation) object representing the service booked in this segment.\",\n \"maxLength\": 36,\n \"nullable\": true\n },\n \"team_member_id\": {\n \"type\": \"string\",\n \"description\": \"The ID of the [TeamMember](entity:TeamMember) object representing the team member booked in this segment.\",\n \"minLength\": 1,\n \"maxLength\": 32\n },\n \"service_variation_version\": {\n \"type\": \"integer\",\n \"description\": \"The current version of the item variation representing the service booked in this segment.\",\n \"format\": \"int64\",\n \"nullable\": true\n },\n \"intermission_minutes\": {\n \"type\": \"integer\",\n \"description\": \"Time between the end of this segment and the beginning of the subsequent segment.\",\n \"readOnly\": true\n },\n \"any_team_member\": {\n \"type\": \"boolean\",\n \"description\": \"Whether the customer accepts any team member, instead of a specific one, to serve this segment.\",\n \"readOnly\": true\n },\n \"resource_ids\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"description\": \"The IDs of the seller-accessible resources used for this appointment segment.\",\n \"readOnly\": true\n }\n }\n },\n \"description\": \"A list of appointment segments for this booking.\",\n \"nullable\": true\n },\n \"transition_time_minutes\": {\n \"type\": \"integer\",\n \"description\": \"Additional time at the end of a booking.\\nApplications should not make this field visible to customers of a seller.\",\n \"readOnly\": true\n },\n \"all_day\": {\n \"type\": \"boolean\",\n \"description\": \"Whether the booking is of a full business day.\",\n \"readOnly\": true\n },\n \"location_type\": {\n \"type\": \"string\",\n \"enum\": [\n \"BUSINESS_LOCATION\",\n \"CUSTOMER_LOCATION\",\n \"PHONE\"\n ],\n \"x-enum-elements\": [\n {\n \"name\": \"BUSINESS_LOCATION\",\n \"description\": \"The service is provided at a seller location.\"\n },\n {\n \"name\": \"CUSTOMER_LOCATION\",\n \"description\": \"The service is provided at a customer location.\"\n },\n {\n \"name\": \"PHONE\",\n \"description\": \"The service is provided over the phone.\"\n }\n ],\n \"description\": \"Supported types of location where service is provided.\",\n \"x-release-status\": \"PUBLIC\"\n },\n \"creator_details\": {\n \"type\": \"object\",\n \"description\": \"Information about a booking creator.\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"creator_type\": {\n \"type\": \"string\",\n \"enum\": [\n \"TEAM_MEMBER\",\n \"CUSTOMER\"\n ],\n \"x-enum-elements\": [\n {\n \"name\": \"TEAM_MEMBER\",\n \"description\": \"The creator is of the seller type.\"\n },\n {\n \"name\": \"CUSTOMER\",\n \"description\": \"The creator is of the buyer type.\"\n }\n ],\n \"description\": \"Supported types of a booking creator.\",\n \"x-release-status\": \"PUBLIC\"\n },\n \"team_member_id\": {\n \"type\": \"string\",\n \"description\": \"The ID of the team member who created the booking, when the booking creator is of the `TEAM_MEMBER` type.\\nAccess to this field requires seller-level permissions.\",\n \"maxLength\": 32,\n \"readOnly\": true\n },\n \"customer_id\": {\n \"type\": \"string\",\n \"description\": \"The ID of the customer who created the booking, when the booking creator is of the `CUSTOMER` type.\\nAccess to this field requires seller-level permissions.\",\n \"maxLength\": 192,\n \"readOnly\": true\n }\n }\n },\n \"source\": {\n \"type\": \"string\",\n \"enum\": [\n \"FIRST_PARTY_MERCHANT\",\n \"FIRST_PARTY_BUYER\",\n \"THIRD_PARTY_BUYER\",\n \"API\"\n ],\n \"x-enum-elements\": [\n {\n \"name\": \"FIRST_PARTY_MERCHANT\",\n \"description\": \"The booking was created by a seller from a Square Appointments application, such as the Square Appointments Dashboard or a Square Appointments mobile app.\"\n },\n {\n \"name\": \"FIRST_PARTY_BUYER\",\n \"description\": \"The booking was created by a buyer from a Square Appointments application, such as Square Online Booking Site.\"\n },\n {\n \"name\": \"THIRD_PARTY_BUYER\",\n \"description\": \"The booking was created by a buyer created from a third-party application.\"\n },\n {\n \"name\": \"API\",\n \"description\": \"The booking was created by a seller or a buyer from the Square Bookings API.\"\n }\n ],\n \"description\": \"Supported sources a booking was created from.\",\n \"x-release-status\": \"PUBLIC\"\n },\n \"address\": {\n \"type\": \"object\",\n \"description\": \"Represents a postal address in a country. \\nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).\",\n \"x-release-status\": \"PUBLIC\",\n \"properties\": {\n \"address_line_1\": {\n \"type\": \"string\",\n \"description\": \"The first line of the address.\\n\\nFields that start with `address_line` provide the address's most specific\\ndetails, like street number, street name, and building name. They do *not*\\nprovide less specific details like city, state/province, or country (these\\ndetails are provided in other fields).\",\n \"nullable\": true\n },\n \"address_line_2\": {\n \"type\": \"string\",\n \"description\": \"The second line of the address, if any.\",\n \"nullable\": true\n },\n \"address_line_3\": {\n \"type\": \"string\",\n \"description\": \"The third line of the address, if any.\",\n \"nullable\": true\n },\n \"locality\": {\n \"type\": \"string\",\n \"description\": \"The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).\",\n \"nullable\": true\n },\n \"sublocality\": {\n \"type\": \"string\",\n \"description\": \"A civil region within the address's `locality`, if any.\",\n \"nullable\": true\n },\n \"sublocality_2\": {\n \"type\": \"string\",\n \"description\": \"A civil region within the address's `sublocality`, if any.\",\n \"nullable\": true\n },\n \"sublocality_3\": {\n \"type\": \"string\",\n \"description\": \"A civil region within the address's `sublocality_2`, if any.\",\n \"nullable\": true\n },\n \"administrative_district_level_1\": {\n \"type\": \"string\",\n \"description\": \"A civil entity within the address's country. In the US, this\\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).\",\n \"nullable\": true\n },\n \"administrative_district_level_2\": {\n \"type\": \"string\",\n \"description\": \"A civil entity within the address's `administrative_district_level_1`.\\nIn the US, this is the county.\",\n \"nullable\": true\n },\n \"administrative_district_level_3\": {\n \"type\": \"string\",\n \"description\": \"A civil entity within the address's `administrative_district_level_2`,\\nif any.\",\n \"nullable\": true\n },\n \"postal_code\": {\n \"type\": \"string\",\n \"description\": \"The address's postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).\",\n \"nullable\": true\n },\n \"country\": {\n \"type\": \"string\",\n \"enum\": [\n \"ZZ\",\n \"AD\",\n \"AE\",\n \"AF\",\n \"AG\",\n \"AI\",\n \"AL\",\n \"AM\",\n \"AO\",\n \"AQ\",\n \"AR\",\n \"AS\",\n \"AT\",\n \"AU\",\n \"AW\",\n \"AX\",\n \"AZ\",\n \"BA\",\n \"BB\",\n \"BD\",\n \"BE\",\n \"BF\",\n \"BG\",\n \"BH\",\n \"BI\",\n \"BJ\",\n \"BL\",\n \"BM\",\n \"BN\",\n \"BO\",\n \"BQ\",\n \"BR\",\n \"BS\",\n \"BT\",\n \"BV\",\n \"BW\",\n \"BY\",\n \"BZ\",\n \"CA\",\n \"CC\",\n \"CD\",\n \"CF\",\n \"CG\",\n \"CH\",\n \"CI\",\n \"CK\",\n \"CL\",\n \"CM\",\n \"CN\",\n \"CO\",\n \"CR\",\n \"CU\",\n \"CV\",\n \"CW\",\n \"CX\",\n \"CY\",\n \"CZ\",\n \"DE\",\n \"DJ\",\n \"DK\",\n \"DM\",\n \"DO\",\n \"DZ\",\n \"EC\",\n \"EE\",\n \"EG\",\n \"EH\",\n \"ER\",\n \"ES\",\n \"ET\",\n \"FI\",\n \"FJ\",\n \"FK\",\n \"FM\",\n \"FO\",\n \"FR\",\n \"GA\",\n \"GB\",\n \"GD\",\n \"GE\",\n \"GF\",\n \"GG\",\n \"GH\",\n \"GI\",\n \"GL\",\n \"GM\",\n \"GN\",\n \"GP\",\n \"GQ\",\n \"GR\",\n \"GS\",\n \"GT\",\n \"GU\",\n \"GW\",\n \"GY\",\n \"HK\",\n \"HM\",\n \"HN\",\n \"HR\",\n \"HT\",\n \"HU\",\n \"ID\",\n \"IE\",\n \"IL\",\n \"IM\",\n \"IN\",\n \"IO\",\n \"IQ\",\n \"IR\",\n \"IS\",\n \"IT\",\n \"JE\",\n \"JM\",\n \"JO\",\n \"JP\",\n \"KE\",\n \"KG\",\n \"KH\",\n \"KI\",\n \"KM\",\n \"KN\",\n \"KP\",\n \"KR\",\n \"KW\",\n \"KY\",\n \"KZ\",\n \"LA\",\n \"LB\",\n \"LC\",\n \"LI\",\n \"LK\",\n \"LR\",\n \"LS\",\n \"LT\",\n \"LU\",\n \"LV\",\n \"LY\",\n \"MA\",\n \"MC\",\n \"MD\",\n \"ME\",\n \"MF\",\n \"MG\",\n \"MH\",\n \"MK\",\n \"ML\",\n \"MM\",\n \"MN\",\n \"MO\",\n \"MP\",\n \"MQ\",\n \"MR\",\n \"MS\",\n \"MT\",\n \"MU\",\n \"MV\",\n \"MW\",\n \"MX\",\n \"MY\",\n \"MZ\",\n \"NA\",\n \"NC\",\n \"NE\",\n \"NF\",\n \"NG\",\n \"NI\",\n \"NL\",\n \"NO\",\n \"NP\",\n \"NR\",\n \"NU\",\n \"NZ\",\n \"OM\",\n \"PA\",\n \"PE\",\n \"PF\",\n \"PG\",\n \"PH\",\n \"PK\",\n \"PL\",\n \"PM\",\n \"PN\",\n \"PR\",\n \"PS\",\n \"PT\",\n \"PW\",\n \"PY\",\n \"QA\",\n \"RE\",\n \"RO\",\n \"RS\",\n \"RU\",\n \"RW\",\n \"SA\",\n \"SB\",\n \"SC\",\n \"SD\",\n \"SE\",\n \"SG\",\n \"SH\",\n \"SI\",\n \"SJ\",\n \"SK\",\n \"SL\",\n \"SM\",\n \"SN\",\n \"SO\",\n \"SR\",\n \"SS\",\n \"ST\",\n \"SV\",\n \"SX\",\n \"SY\",\n \"SZ\",\n \"TC\",\n \"TD\",\n \"TF\",\n \"TG\",\n \"TH\",\n \"TJ\",\n \"TK\",\n \"TL\",\n \"TM\",\n \"TN\",\n \"TO\",\n \"TR\",\n \"TT\",\n \"TV\",\n \"TW\",\n \"TZ\",\n \"UA\",\n \"UG\",\n \"UM\",\n \"US\",\n \"UY\",\n \"UZ\",\n \"VA\",\n \"VC\",\n \"VE\",\n \"VG\",\n \"VI\",\n \"VN\",\n \"VU\",\n \"WF\",\n \"WS\",\n \"YE\",\n \"YT\",\n \"ZA\",\n \"ZM\",\n \"ZW\"\n ],\n \"x-enum-elements\": [\n {\n \"name\": \"ZZ\",\n \"description\": \"Unknown\"\n },\n {\n \"name\": \"AD\",\n \"description\": \"Andorra\"\n },\n {\n \"name\": \"AE\",\n \"description\": \"United Arab Emirates\"\n },\n {\n \"name\": \"AF\",\n \"description\": \"Afghanistan\"\n },\n {\n \"name\": \"AG\",\n \"description\": \"Antigua and Barbuda\"\n },\n {\n \"name\": \"AI\",\n \"description\": \"Anguilla\"\n },\n {\n \"name\": \"AL\",\n \"description\": \"Albania\"\n },\n {\n \"name\": \"AM\",\n \"description\": \"Armenia\"\n },\n {\n \"name\": \"AO\",\n \"description\": \"Angola\"\n },\n {\n \"name\": \"AQ\",\n \"description\": \"Antartica\"\n },\n {\n \"name\": \"AR\",\n \"description\": \"Argentina\"\n },\n {\n \"name\": \"AS\",\n \"description\": \"American Samoa\"\n },\n {\n \"name\": \"AT\",\n \"description\": \"Austria\"\n },\n {\n \"name\": \"AU\",\n \"description\": \"Australia\"\n },\n {\n \"name\": \"AW\",\n \"description\": \"Aruba\"\n },\n {\n \"name\": \"AX\",\n \"description\": \"\\u00c5land Islands\"\n },\n {\n \"name\": \"AZ\",\n \"description\": \"Azerbaijan\"\n },\n {\n \"name\": \"BA\",\n \"description\": \"Bosnia and Herzegovina\"\n },\n {\n \"name\": \"BB\",\n \"description\": \"Barbados\"\n },\n {\n \"name\": \"BD\",\n \"description\": \"Bangladesh\"\n },\n {\n \"name\": \"BE\",\n \"description\": \"Belgium\"\n },\n {\n \"name\": \"BF\",\n \"description\": \"Burkina Faso\"\n },\n {\n \"name\": \"BG\",\n \"description\": \"Bulgaria\"\n },\n {\n \"name\": \"BH\",\n \"description\": \"Bahrain\"\n },\n {\n \"name\": \"BI\",\n \"description\": \"Burundi\"\n },\n {\n \"name\": \"BJ\",\n \"description\": \"Benin\"\n },\n {\n \"name\": \"BL\",\n \"description\": \"Saint Barth\\u00e9lemy\"\n },\n {\n \"name\": \"BM\",\n \"description\": \"Bermuda\"\n },\n {\n \"name\": \"BN\",\n \"description\": \"Brunei\"\n },\n {\n \"name\": \"BO\",\n \"description\": \"Bolivia\"\n },\n {\n \"name\": \"BQ\",\n \"description\": \"Bonaire\"\n },\n {\n \"name\": \"BR\",\n \"description\": \"Brazil\"\n },\n {\n \"name\": \"BS\",\n \"description\": \"Bahamas\"\n },\n {\n \"name\": \"BT\",\n \"description\": \"Bhutan\"\n },\n {\n \"name\": \"BV\",\n \"description\": \"Bouvet Island\"\n },\n {\n \"name\": \"BW\",\n \"description\": \"Botswana\"\n },\n {\n \"name\": \"BY\",\n \"description\": \"Belarus\"\n },\n {\n \"name\": \"BZ\",\n \"description\": \"Belize\"\n },\n {\n \"name\": \"CA\",\n \"description\": \"Canada\"\n },\n {\n \"name\": \"CC\",\n \"description\": \"Cocos Islands\"\n },\n {\n \"name\": \"CD\",\n \"description\": \"Democratic Republic of the Congo\"\n },\n {\n \"name\": \"CF\",\n \"description\": \"Central African Republic\"\n },\n {\n \"name\": \"CG\",\n \"description\": \"Congo\"\n },\n {\n \"name\": \"CH\",\n \"description\": \"Switzerland\"\n },\n {\n \"name\": \"CI\",\n \"description\": \"Ivory Coast\"\n },\n {\n \"name\": \"CK\",\n \"description\": \"Cook Islands\"\n },\n {\n \"name\": \"CL\",\n \"description\": \"Chile\"\n },\n {\n \"name\": \"CM\",\n \"description\": \"Cameroon\"\n },\n {\n \"name\": \"CN\",\n \"description\": \"China\"\n },\n {\n \"name\": \"CO\",\n \"description\": \"Colombia\"\n },\n {\n \"name\": \"CR\",\n \"description\": \"Costa Rica\"\n },\n {\n \"name\": \"CU\",\n \"description\": \"Cuba\"\n },\n {\n \"name\": \"CV\",\n \"description\": \"Cabo Verde\"\n },\n {\n \"name\": \"CW\",\n \"description\": \"Cura\\u00e7ao\"\n },\n {\n \"name\": \"CX\",\n \"description\": \"Christmas Island\"\n },\n {\n \"name\": \"CY\",\n \"description\": \"Cyprus\"\n },\n {\n \"name\": \"CZ\",\n \"description\": \"Czechia\"\n },\n {\n \"name\": \"DE\",\n \"description\": \"Germany\"\n },\n {\n \"name\": \"DJ\",\n \"description\": \"Djibouti\"\n },\n {\n \"name\": \"DK\",\n \"description\": \"Denmark\"\n },\n {\n \"name\": \"DM\",\n \"description\": \"Dominica\"\n },\n {\n \"name\": \"DO\",\n \"description\": \"Dominican Republic\"\n },\n {\n \"name\": \"DZ\",\n \"description\": \"Algeria\"\n },\n {\n \"name\": \"EC\",\n \"description\": \"Ecuador\"\n },\n {\n \"name\": \"EE\",\n \"description\": \"Estonia\"\n },\n {\n \"name\": \"EG\",\n \"description\": \"Egypt\"\n },\n {\n \"name\": \"EH\",\n \"description\": \"Western Sahara\"\n },\n {\n \"name\": \"ER\",\n \"description\": \"Eritrea\"\n },\n {\n \"name\": \"ES\",\n \"description\": \"Spain\"\n },\n {\n \"name\": \"ET\",\n \"description\": \"Ethiopia\"\n },\n {\n \"name\": \"FI\",\n \"description\": \"Finland\"\n },\n {\n \"name\": \"FJ\",\n \"description\": \"Fiji\"\n },\n {\n \"name\": \"FK\",\n \"description\": \"Falkland Islands\"\n },\n {\n \"name\": \"FM\",\n \"description\": \"Federated States of Micronesia\"\n },\n {\n \"name\": \"FO\",\n \"description\": \"Faroe Islands\"\n },\n {\n \"name\": \"FR\",\n \"description\": \"France\"\n },\n {\n \"name\": \"GA\",\n \"description\": \"Gabon\"\n },\n {\n \"name\": \"GB\",\n \"description\": \"United Kingdom\"\n },\n {\n \"name\": \"GD\",\n \"description\": \"Grenada\"\n },\n {\n \"name\": \"GE\",\n \"description\": \"Georgia\"\n },\n {\n \"name\": \"GF\",\n \"description\": \"French Guiana\"\n },\n {\n \"name\": \"GG\",\n \"description\": \"Guernsey\"\n },\n {\n \"name\": \"GH\",\n \"description\": \"Ghana\"\n },\n {\n \"name\": \"GI\",\n \"description\": \"Gibraltar\"\n },\n {\n \"name\": \"GL\",\n \"description\": \"Greenland\"\n },\n {\n \"name\": \"GM\",\n \"description\": \"Gambia\"\n },\n {\n \"name\": \"GN\",\n \"description\": \"Guinea\"\n },\n {\n \"name\": \"GP\",\n \"description\": \"Guadeloupe\"\n },\n {\n \"name\": \"GQ\",\n \"description\": \"Equatorial Guinea\"\n },\n {\n \"name\": \"GR\",\n \"description\": \"Greece\"\n },\n {\n \"name\": \"GS\",\n \"description\": \"South Georgia and the South Sandwich Islands\"\n },\n {\n \"name\": \"GT\",\n \"description\": \"Guatemala\"\n },\n {\n \"name\": \"GU\",\n \"description\": \"Guam\"\n },\n {\n \"name\": \"GW\",\n \"description\": \"Guinea-Bissau\"\n },\n {\n \"name\": \"GY\",\n \"description\": \"Guyana\"\n },\n {\n \"name\": \"HK\",\n \"description\": \"Hong Kong\"\n },\n {\n \"name\": \"HM\",\n \"description\": \"Heard Island and McDonald Islands\"\n },\n {\n \"name\": \"HN\",\n \"description\": \"Honduras\"\n },\n {\n \"name\": \"HR\",\n \"description\": \"Croatia\"\n },\n {\n \"name\": \"HT\",\n \"description\": \"Haiti\"\n },\n {\n \"name\": \"HU\",\n \"description\": \"Hungary\"\n },\n {\n \"name\": \"ID\",\n \"description\": \"Indonesia\"\n },\n {\n \"name\": \"IE\",\n \"description\": \"Ireland\"\n },\n {\n \"name\": \"IL\",\n \"description\": \"Israel\"\n },\n {\n \"name\": \"IM\",\n \"description\": \"Isle of Man\"\n },\n {\n \"name\": \"IN\",\n \"description\": \"India\"\n },\n {\n \"name\": \"IO\",\n \"description\": \"British Indian Ocean Territory\"\n },\n {\n \"name\": \"IQ\",\n \"description\": \"Iraq\"\n },\n {\n \"name\": \"IR\",\n \"description\": \"Iran\"\n },\n {\n \"name\": \"IS\",\n \"description\": \"Iceland\"\n },\n {\n \"name\": \"IT\",\n \"description\": \"Italy\"\n },\n {\n \"name\": \"JE\",\n \"description\": \"Jersey\"\n },\n {\n \"name\": \"JM\",\n \"description\": \"Jamaica\"\n },\n {\n \"name\": \"JO\",\n \"description\": \"Jordan\"\n },\n {\n \"name\": \"JP\",\n \"description\": \"Japan\"\n },\n {\n \"name\": \"KE\",\n \"description\": \"Kenya\"\n },\n {\n \"name\": \"KG\",\n \"description\": \"Kyrgyzstan\"\n },\n {\n \"name\": \"KH\",\n \"description\": \"Cambodia\"\n },\n {\n \"name\": \"KI\",\n \"description\": \"Kiribati\"\n },\n {\n \"name\": \"KM\",\n \"description\": \"Comoros\"\n },\n {\n \"name\": \"KN\",\n \"description\": \"Saint Kitts and Nevis\"\n },\n {\n \"name\": \"KP\",\n \"description\": \"Democratic People's Republic of Korea\"\n },\n {\n \"name\": \"KR\",\n \"description\": \"Republic of Korea\"\n },\n {\n \"name\": \"KW\",\n \"description\": \"Kuwait\"\n },\n {\n \"name\": \"KY\",\n \"description\": \"Cayman Islands\"\n },\n {\n \"name\": \"KZ\",\n \"description\": \"Kazakhstan\"\n },\n {\n \"name\": \"LA\",\n \"description\": \"Lao People's Democratic Republic\"\n },\n {\n \"name\": \"LB\",\n \"description\": \"Lebanon\"\n },\n {\n \"name\": \"LC\",\n \"description\": \"Saint Lucia\"\n },\n {\n \"name\": \"LI\",\n \"description\": \"Liechtenstein\"\n },\n {\n \"name\": \"LK\",\n \"description\": \"Sri Lanka\"\n },\n {\n \"name\": \"LR\",\n \"description\": \"Liberia\"\n },\n {\n \"name\": \"LS\",\n \"description\": \"Lesotho\"\n },\n {\n \"name\": \"LT\",\n \"description\": \"Lithuania\"\n },\n {\n \"name\": \"LU\",\n \"description\": \"Luxembourg\"\n },\n {\n \"name\": \"LV\",\n \"description\": \"Latvia\"\n },\n {\n \"name\": \"LY\",\n \"description\": \"Libya\"\n },\n {\n \"name\": \"MA\",\n \"description\": \"Morocco\"\n },\n {\n \"name\": \"MC\",\n \"description\": \"Monaco\"\n },\n {\n \"name\": \"MD\",\n \"description\": \"Moldova\"\n },\n {\n \"name\": \"ME\",\n \"description\": \"Montenegro\"\n },\n {\n \"name\": \"MF\",\n \"description\": \"Saint Martin\"\n },\n {\n \"name\": \"MG\",\n \"description\": \"Madagascar\"\n },\n {\n \"name\": \"MH\",\n \"description\": \"Marshall Islands\"\n },\n {\n \"name\": \"MK\",\n \"description\": \"North Macedonia\"\n },\n {\n \"name\": \"ML\",\n \"description\": \"Mali\"\n },\n {\n \"name\": \"MM\",\n \"description\": \"Myanmar\"\n },\n {\n \"name\": \"MN\",\n \"description\": \"Mongolia\"\n },\n {\n \"name\": \"MO\",\n \"description\": \"Macao\"\n },\n {\n \"name\": \"MP\",\n \"description\": \"Northern Mariana Islands\"\n },\n {\n \"name\": \"MQ\",\n \"description\": \"Martinique\"\n },\n {\n \"name\": \"MR\",\n \"description\": \"Mauritania\"\n },\n {\n \"name\": \"MS\",\n \"description\": \"Montserrat\"\n },\n {\n \"name\": \"MT\",\n \"description\": \"Malta\"\n },\n {\n \"name\": \"MU\",\n \"description\": \"Mauritius\"\n },\n {\n \"name\": \"MV\",\n \"description\": \"Maldives\"\n },\n {\n \"name\": \"MW\",\n \"description\": \"Malawi\"\n },\n {\n \"name\": \"MX\",\n \"description\": \"Mexico\"\n },\n {\n \"name\": \"MY\",\n \"description\": \"Malaysia\"\n },\n {\n \"name\": \"MZ\",\n \"description\": \"Mozambique\"\n },\n {\n \"name\": \"NA\",\n \"description\": \"Namibia\"\n },\n {\n \"name\": \"NC\",\n \"description\": \"New Caledonia\"\n },\n {\n \"name\": \"NE\",\n \"description\": \"Niger\"\n },\n {\n \"name\": \"NF\",\n \"description\": \"Norfolk Island\"\n },\n {\n \"name\": \"NG\",\n \"description\": \"Nigeria\"\n },\n {\n \"name\": \"NI\",\n \"description\": \"Nicaragua\"\n },\n {\n \"name\": \"NL\",\n \"description\": \"Netherlands\"\n },\n {\n \"name\": \"NO\",\n \"description\": \"Norway\"\n },\n {\n \"name\": \"NP\",\n \"description\": \"Nepal\"\n },\n {\n \"name\": \"NR\",\n \"description\": \"Nauru\"\n },\n {\n \"name\": \"NU\",\n \"description\": \"Niue\"\n },\n {\n \"name\": \"NZ\",\n \"description\": \"New Zealand\"\n },\n {\n \"name\": \"OM\",\n \"description\": \"Oman\"\n },\n {\n \"name\": \"PA\",\n \"description\": \"Panama\"\n },\n {\n \"name\": \"PE\",\n \"description\": \"Peru\"\n },\n {\n \"name\": \"PF\",\n \"description\": \"French Polynesia\"\n },\n {\n \"name\": \"PG\",\n \"description\": \"Papua New Guinea\"\n },\n {\n \"name\": \"PH\",\n \"description\": \"Philippines\"\n },\n {\n \"name\": \"PK\",\n \"description\": \"Pakistan\"\n },\n {\n \"name\": \"PL\",\n \"description\": \"Poland\"\n },\n {\n \"name\": \"PM\",\n \"description\": \"Saint Pierre and Miquelon\"\n },\n {\n \"name\": \"PN\",\n \"description\": \"Pitcairn\"\n },\n {\n \"name\": \"PR\",\n \"description\": \"Puerto Rico\"\n },\n {\n \"name\": \"PS\",\n \"description\": \"Palestine\"\n },\n {\n \"name\": \"PT\",\n \"description\": \"Portugal\"\n },\n {\n \"name\": \"PW\",\n \"description\": \"Palau\"\n },\n {\n \"name\": \"PY\",\n \"description\": \"Paraguay\"\n },\n {\n \"name\": \"QA\",\n \"description\": \"Qatar\"\n },\n {\n \"name\": \"RE\",\n \"description\": \"R\\u00e9union\"\n },\n {\n \"name\": \"RO\",\n \"description\": \"Romania\"\n },\n {\n \"name\": \"RS\",\n \"description\": \"Serbia\"\n },\n {\n \"name\": \"RU\",\n \"description\": \"Russia\"\n },\n {\n \"name\": \"RW\",\n \"description\": \"Rwanda\"\n },\n {\n \"name\": \"SA\",\n \"description\": \"Saudi Arabia\"\n },\n {\n \"name\": \"SB\",\n \"description\": \"Solomon Islands\"\n },\n {\n \"name\": \"SC\",\n \"description\": \"Seychelles\"\n },\n {\n \"name\": \"SD\",\n \"description\": \"Sudan\"\n },\n {\n \"name\": \"SE\",\n \"description\": \"Sweden\"\n },\n {\n \"name\": \"SG\",\n \"description\": \"Singapore\"\n },\n {\n \"name\": \"SH\",\n \"description\": \"Saint Helena, Ascension and Tristan da Cunha\"\n },\n {\n \"name\": \"SI\",\n \"description\": \"Slovenia\"\n },\n {\n \"name\": \"SJ\",\n \"description\": \"Svalbard and Jan Mayen\"\n },\n {\n \"name\": \"SK\",\n \"description\": \"Slovakia\"\n },\n {\n \"name\": \"SL\",\n \"description\": \"Sierra Leone\"\n },\n {\n \"name\": \"SM\",\n \"description\": \"San Marino\"\n },\n {\n \"name\": \"SN\",\n \"description\": \"Senegal\"\n },\n {\n \"name\": \"SO\",\n \"description\": \"Somalia\"\n },\n {\n \"name\": \"SR\",\n \"description\": \"Suriname\"\n },\n {\n \"name\": \"SS\",\n \"description\": \"South Sudan\"\n },\n {\n \"name\": \"ST\",\n \"description\": \"Sao Tome and Principe\"\n },\n {\n \"name\": \"SV\",\n \"description\": \"El Salvador\"\n },\n {\n \"name\": \"SX\",\n \"description\": \"Sint Maarten\"\n },\n {\n \"name\": \"SY\",\n \"description\": \"Syrian Arab Republic\"\n },\n {\n \"name\": \"SZ\",\n \"description\": \"Eswatini\"\n },\n {\n \"name\": \"TC\",\n \"description\": \"Turks and Caicos Islands\"\n },\n {\n \"name\": \"TD\",\n \"description\": \"Chad\"\n },\n {\n \"name\": \"TF\",\n \"description\": \"French Southern Territories\"\n },\n {\n \"name\": \"TG\",\n \"description\": \"Togo\"\n },\n {\n \"name\": \"TH\",\n \"description\": \"Thailand\"\n },\n {\n \"name\": \"TJ\",\n \"description\": \"Tajikistan\"\n },\n {\n \"name\": \"TK\",\n \"description\": \"Tokelau\"\n },\n {\n \"name\": \"TL\",\n \"description\": \"Timor-Leste\"\n },\n {\n \"name\": \"TM\",\n \"description\": \"Turkmenistan\"\n },\n {\n \"name\": \"TN\",\n \"description\": \"Tunisia\"\n },\n {\n \"name\": \"TO\",\n \"description\": \"Tonga\"\n },\n {\n \"name\": \"TR\",\n \"description\": \"Turkey\"\n },\n {\n \"name\": \"TT\",\n \"description\": \"Trinidad and Tobago\"\n },\n {\n \"name\": \"TV\",\n \"description\": \"Tuvalu\"\n },\n {\n \"name\": \"TW\",\n \"description\": \"Taiwan\"\n },\n {\n \"name\": \"TZ\",\n \"description\": \"Tanzania\"\n },\n {\n \"name\": \"UA\",\n \"description\": \"Ukraine\"\n },\n {\n \"name\": \"UG\",\n \"description\": \"Uganda\"\n },\n {\n \"name\": \"UM\",\n \"description\": \"United States Minor Outlying Islands\"\n },\n {\n \"name\": \"US\",\n \"description\": \"United States of America\"\n },\n {\n \"name\": \"UY\",\n \"description\": \"Uruguay\"\n },\n {\n \"name\": \"UZ\",\n \"description\": \"Uzbekistan\"\n },\n {\n \"name\": \"VA\",\n \"description\": \"Vatican City\"\n },\n {\n \"name\": \"VC\",\n \"description\": \"Saint Vincent and the Grenadines\"\n },\n {\n \"name\": \"VE\",\n \"description\": \"Venezuela\"\n },\n {\n \"name\": \"VG\",\n \"description\": \"British Virgin Islands\"\n },\n {\n \"name\": \"VI\",\n \"description\": \"U.S. Virgin Islands\"\n },\n {\n \"name\": \"VN\",\n \"description\": \"Vietnam\"\n },\n {\n \"name\": \"VU\",\n \"description\": \"Vanuatu\"\n },\n {\n \"name\": \"WF\",\n \"description\": \"Wallis and Futuna\"\n },\n {\n \"name\": \"WS\",\n \"description\": \"Samoa\"\n },\n {\n \"name\": \"YE\",\n \"description\": \"Yemen\"\n },\n {\n \"name\": \"YT\",\n \"description\": \"Mayotte\"\n },\n {\n \"name\": \"ZA\",\n \"description\": \"South Africa\"\n },\n {\n \"name\": \"ZM\",\n \"description\": \"Zambia\"\n },\n {\n \"name\": \"ZW\",\n \"description\": \"Zimbabwe\"\n }\n ],\n \"description\": \"Indicates the country associated with another entity, such as a business.\\nValues are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).\",\n \"x-release-status\": \"PUBLIC\"\n },\n \"first_name\": {\n \"type\": \"string\",\n \"description\": \"Optional first name when it's representing recipient.\",\n \"nullable\": true\n },\n \"last_name\": {\n \"type\": \"string\",\n \"description\": \"Optional last name when it's representing recipient.\",\n \"nullable\": true\n }\n }\n }\n }\n }\n }\n }\n }\n }\n}",
"use_request_body_schema_mode": true,
"validate_request_body_schema": true
}
}
Reference in a new issue View git blame Copy permalink