calendlyr 0.6.0 → 0.7.0

data/docs/resources/events/invitee.md

@@ -0,0 +1,28 @@
+# Invitee Calendlyr::Events::Invitee
+
+An individual who has been invited to meet with a Calendly member.
+
+Visit official [API Doc](https://developer.calendly.com/api-docs/decca36cf717f-invitee)
+
+## Client requests
+
+### Retrieve
+
+Returns information about a specified Invitee (person invited to an event).
+
+Visit official [API Doc](https://developer.calendly.com/api-docs/8305c0ccfac70-get-event-invitee)
+
+```ruby
+client.events.retrieve_invitee(event_uuid: event_uuid, invitee_uuid: invitee_uuid)
+#=> #<Calendlyr::Events::Invitee>
+```
+### List
+
+Returns a list of Invitees for an event.
+
+Visit official [API Doc](https://developer.calendly.com/api-docs/eb8ee72701f99-list-event-invitees)
+
+```ruby
+client.events.list_invitees(uuid: uuid)
+#=> #<Calendlyr::Collection @data=[#<Calendlyr::Events::Invitee>, ...], @count=nil, @next_page=nil, @next_page_token=nil, @client=#<Calendlyr::Client>>
+```

data/docs/resources/events/invitee_no_show.md

@@ -0,0 +1,49 @@
+# Invitee No Show Calendlyr::Events::InviteeNoShow
+
+Information about an invitees no show.
+
+Visit official [API Doc](https://developer.calendly.com/api-docs/753a78b938d75-invitee-no-show)
+
+## Client requests
+
+### Retrieve
+
+Returns information about a specified Invitee No Show.
+
+Visit official [API Doc](https://developer.calendly.com/api-docs/49cf0c87ee6f4-get-invitee-no-show)
+
+```ruby
+client.events.retrieve_invitee_no_show(uuid: uuid)
+#=> #<Calendlyr::Events::InviteeNoShow>
+```
+
+### Create
+
+Marks an Invitee as a No Show.
+
+Visit official [API Doc](https://developer.calendly.com/api-docs/cebd8c3170790-create-invitee-no-show)
+
+```ruby
+client.events.create_invitee_no_show(invitee: invitee_uri)
+#=> #<Calendlyr::Events::InviteeNoShow>
+```
+
+### Delete
+
+Undoes marking an Invitee as a No Show.
+
+Visit official [API Doc](https://developer.calendly.com/api-docs/eb599c64c95ea-delete-invitee-no-show)
+
+```ruby
+client.events.delete_invitee_no_show(uuid: uuid)
+#=>
+```
+
+## Object methods
+
+### Delete
+
+```ruby
+invitee_no_show.delete
+#=>
+```

data/docs/resources/groups/group.md

@@ -0,0 +1,56 @@
+# Group Calendlyr::Group
+
+The Group resource that was requested. Represents groupings of Users within an Organization.
+
+Visit official [API Doc](https://developer.calendly.com/api-docs/15c7951a86b40-group)
+
+## Client requests
+
+### Retrieve
+
+Returns information about a specified Group.
+
+Visit official [API Doc](https://developer.calendly.com/api-docs/beaf147a3bc34-get-group)
+
+```ruby
+client.groups.retrieve(uuid: uuid)
+#=> #<Calendlyr::Group>
+```
+
+### List
+
+Returns a list of groups.
+
+Visit official [API Doc](https://developer.calendly.com/api-docs/6rb6dtdln74sy-list-groups)
+
+```ruby
+client.groups.list(organization: organization_uri)
+#=> #<Calendlyr::Collection @data=[#<Calendlyr::Group>, ...], @count=nil, @next_page=nil, @next_page_token=nil, @client=#<Calendlyr::Client>>
+```
+
+## Object methods
+
+### Associated Organization
+
+```ruby
+group.associated_organization
+#=> #<Calendlyr::Organization>
+```
+
+### Events
+
+For the example bellow we will use not parameters, but you can use the allowed parameters in Calendly docs.
+
+```ruby
+group.events
+#=> #<Calendlyr::Collection @data=[#<Calendlyr::Event>, ...], @count=nil, @next_page=nil, @next_page_token=nil, @client=#<Calendlyr::Client>>
+```
+
+### Group Relationships
+
+For the example bellow we will use not parameters, but you can use the allowed parameters in Calendly docs.
+
+```ruby
+group.group_relationships
+#=> #<Calendlyr::Collection @data=[#<Calendlyr::Groups::Relationship>, ...], @count=nil, @next_page=nil, @next_page_token=nil, @client=#<Calendlyr::Client>>
+```

data/docs/resources/groups/relationship.md

@@ -0,0 +1,54 @@
+# Group Relationship Calendlyr::Groups::Relationship
+
+A group relationship record for an individual. A given individual may have more than one admin relationship to multiple groups, but only one member relationship to a single group.
+
+Visit official [API Doc](https://developer.calendly.com/api-docs/a82d8ee79eb82-group-relationship)
+
+## Client requests
+
+### Retrieve
+
+Returns a group relationship by uuid.
+
+Visit official [API Doc](https://developer.calendly.com/api-docs/91925872af92a-get-group-relationship)
+
+```ruby
+client.groups.retrieve_relationship(uuid: uuid)
+#=> #<Calendlyr::Groups::Relationship>
+```
+
+### List
+
+Returns a list of group relationships - a given owner can have one membership record, but multiple admin records.
+
+Visit official [API Doc](https://developer.calendly.com/api-docs/4674a12f55f82-list-group-relationships)
+
+For the example bellow we will use not parameters, but you can use the allowed parameters in Calendly docs.
+
+```ruby
+client.groups.list_relationships
+#=> #<Calendlyr::Collection @data=[#<Calendlyr::Groups::Relationship>, ...], @count=nil, @next_page=nil, @next_page_token=nil, @client=#<Calendlyr::Client>>
+```
+
+## Object methods
+
+### Associated Organization
+
+```ruby
+group_relationship.associated_organization
+#=> #<Calendlyr::Organization>
+```
+
+### Associated Group
+
+```ruby
+group_relationship.associated_group
+#=> #<Calendlyr::Group>
+```
+
+### Associated Owner
+
+```ruby
+group_relationship.associated_owner
+#=> #<Calendlyr::Organizations::Membership>
+```

data/docs/resources/organizations/invitation.md

@@ -0,0 +1,65 @@
+# Organization Invitation Calendlyr::Organizations::Invitation
+
+Organization Invitation object.
+
+Visit official [API Doc](https://developer.calendly.com/api-docs/736b3f42c9586-organization-invitation)
+
+## Client requests
+
+### Retrieve
+
+Returns an Organization Invitation that was sent to the organization's members.
+
+Visit official [API Doc](https://developer.calendly.com/api-docs/f3f0b6c2a95c7-get-organization-invitation)
+
+```ruby
+client.organizations.retrieve_invitation(org_uuid: organization_uuid, uuid: invitation_uuid)
+#=> #<Calendlyr::Organizations::Invitation>
+```
+
+### Invite
+
+Invites a user to an organization.
+
+Visit official [API Doc](https://developer.calendly.com/api-docs/094d15d2cd4ab-invite-user-to-organization)
+
+```ruby
+client.organizations.invite(organization_uuid: organization_uuid, email: "email@example.com")
+#=> #<Calendlyr::Organizations::Invitation>
+```
+
+### List
+
+Returns a list of Organization Invitations that were sent to the organization's members.
+
+Visit official [API Doc](https://developer.calendly.com/api-docs/3ad68ee2cc606-list-organization-invitations)
+
+For the example bellow we will use not parameters, but you can use the allowed parameters in Calendly docs.
+
+```ruby
+client.organizations.list_invitations(uuid: organization_uuid)
+#=> #<Calendlyr::Collection @data=[#<Calendlyr::Organizations::Invitation>, ...], @count=nil, @next_page=nil, @next_page_token=nil, @client=#<Calendlyr::Client>>
+```
+
+## Object methods
+
+### Associated Organization
+
+```ruby
+organization_invitation.associated_organization
+#=> #<Calendlyr::Organization>
+```
+
+### Associated User
+
+```ruby
+organization_invitation.associated_user
+#=> #<Calendlyr::User>
+```
+
+### Revoke
+
+```ruby
+organization_invitation.revoke
+#=>
+```

data/docs/resources/organizations/membership.md

@@ -0,0 +1,58 @@
+# Organization Membership Calendlyr::Organizations::Membership
+
+Organization Membership object.
+
+Visit official [API Doc](https://developer.calendly.com/api-docs/ae30b41b52a54-organization-membership)
+
+## Client requests
+
+### Retrieve
+
+Returns information about a user's Organization Membership.
+
+Visit official [API Doc](https://developer.calendly.com/api-docs/8c3baa79a5883-get-organization-membership)
+
+```ruby
+client.organizations.retrieve_membership(uuid: uuid)
+#=> #<Calendlyr::Organizations::Membership>
+```
+
+### List
+
+Use this to list the Organization Memberships for all users belonging to an organization.
+
+Visit official [API Doc](https://developer.calendly.com/api-docs/eaed2e61a6bc3-list-organization-memberships)
+
+For the example bellow we will use only required parameters, but you can use any other parameter as well.
+
+```ruby
+client.organizations.list_memberships(user: user)
+#=> #<Calendlyr::Collection @data=[#<Calendlyr::Organizations::Membership>, ...], @count=nil, @next_page=nil, @next_page_token=nil, @client=#<Calendlyr::Client>>
+
+client.organizations.list_memberships(organization: organization)
+#=> #<Calendlyr::Collection @data=[#<Calendlyr::Organizations::Membership>, ...], @count=nil, @next_page=nil, @next_page_token=nil, @client=#<Calendlyr::Client>>
+```
+
+## Object methods
+
+### Associated Organization
+
+```ruby
+organization_membership.associated_organization
+#=> #<Calendlyr::Organization>
+```
+
+### Associated User
+
+```ruby
+organization_membership.associated_user
+#=> #<Calendlyr::User>
+```
+
+### Group Relationships
+For the example bellow we will use not parameters, but you can use the allowed parameters in Calendly docs.
+
+```ruby
+organization_membership.group_relationships
+#=> #<Calendlyr::Collection @data=[#<Calendlyr::Groups::Relationship>, ...], @count=nil, @next_page=nil, @next_page_token=nil, @client=#<Calendlyr::Client>>
+```

data/docs/resources/organizations/organization.md

@@ -0,0 +1,149 @@
+# Organization Calendlyr::Organization
+
+Organization object.
+
+Visit official [API Doc](https://developer.calendly.com/api-docs/848e5e20591ee-organization)
+
+## Me
+
+We can access your organization information by calling `organization` method on the client object.
+
+```ruby
+organization = client.organization
+#=> #<Calendlyr::Organization>
+```
+
+## Object methods
+
+### Activity Logs
+
+For the example bellow we will use not parameters, but you can use the allowed parameters in Calendly docs.
+
+```ruby
+organization.activity_logs
+#=> #<Calendlyr::Collection @data=[#<Calendlyr::ActivityLog>, ...], @count=nil, @next_page=nil, @next_page_token=nil, @client=#<Calendlyr::Client>>
+```
+
+### Events
+
+For the example bellow we will use not parameters, but you can use the allowed parameters in Calendly docs.
+
+```ruby
+organization.events
+#=> #<Calendlyr::Collection @data=[#<Calendlyr::Event>, ...], @count=nil, @next_page=nil, @next_page_token=nil, @client=#<Calendlyr::Client>>
+```
+
+### Event Types
+
+For the example bellow we will use not parameters, but you can use the allowed parameters in Calendly docs.
+
+```ruby
+organization.event_types
+#=> #<Calendlyr::Collection @data=[#<Calendlyr::Event>, ...], @count=nil, @next_page=nil, @next_page_token=nil, @client=#<Calendlyr::Client>>
+```
+
+### Routing Forms
+
+For the example bellow we will use not parameters, but you can use the allowed parameters in Calendly docs.
+
+```ruby
+organization.routing_forms
+#=> #<Calendlyr::Collection @data=[#<Calendlyr::RoutingForm>, ...], @count=nil, @next_page=nil, @next_page_token=nil, @client=#<Calendlyr::Client>>
+```
+
+### Groups
+
+For the example bellow we will use not parameters, but you can use the allowed parameters in Calendly docs.
+
+```ruby
+organization.groups
+#=> #<Calendlyr::Collection @data=[#<Calendlyr::Group>, ...], @count=nil, @next_page=nil, @next_page_token=nil, @client=#<Calendlyr::Client>>
+```
+
+### Group Relationships
+
+For the example bellow we will use not parameters, but you can use the allowed parameters in Calendly docs.
+
+```ruby
+organization.group_relationships
+#=> #<Calendlyr::Collection @data=[#<Calendlyr::Groups::Relationship>, ...], @count=nil, @next_page=nil, @next_page_token=nil, @client=#<Calendlyr::Client>>
+```
+
+### Memberships
+
+For the example bellow we will use not parameters, but you can use the allowed parameters in Calendly docs.
+
+```ruby
+organization.memberships
+#=> #<Calendlyr::Collection @data=[#<Calendlyr::Organizations::Membership>, ...], @count=nil, @next_page=nil, @next_page_token=nil, @client=#<Calendlyr::Client>>
+```
+
+### Membership
+
+```ruby
+organization.membership(uuid: uuid)
+#=> #<Organizations::Membership>
+```
+
+### Webhooks
+
+For the example bellow we will use only required parameters, but you can use any other parameter as well.
+
+```ruby
+organization.webhooks(scope: scope)
+#=> #<Calendlyr::Collection @data=[#<Calendlyr::Webhooks::Subscription>, ...], @count=nil, @next_page=nil, @next_page_token=nil, @client=#<Calendlyr::Client>>
+```
+
+### Create a Webhook
+
+For the example bellow we will use only required parameters, but you can use any other parameter as well.
+
+```ruby
+organization.create_webhook(url:, url, events: events, scope: scope)
+#=> #<Calendlyr::Webhooks::Subscription>
+```
+
+### Sample Webhook Data
+
+For the example bellow we will use only required parameters, but you can use any other parameter as well.
+
+```ruby
+organization.sample_webhook_data(event: event, scope: scope)
+#=> #<Calendlyr::Object>
+```
+
+### Invite user
+
+For the example bellow we will use only required parameters, but you can use any other parameter as well.
+
+```ruby
+organization.invite_user(email: 'email@example.com')
+#=> #<Calendlyr::Organizations::Invitation>
+```
+
+### Invitations
+
+For the example bellow we will use not parameters, but you can use the allowed parameters in Calendly docs.
+
+```ruby
+organization.invitations
+#=> #<Calendlyr::Collection @data=[#<Calendlyr::Organizations::Invitation>, ...], @count=nil, @next_page=nil, @next_page_token=nil, @client=#<Calendlyr::Client>>
+```
+
+### Invitation
+
+For the example bellow we will use only required parameters, but you can use any other parameter as well.
+
+```ruby
+organization.invitation(invitation_uuid: invitation_uuid)
+#=> #<Calendlyr::Organizations::Invitation>
+```
+
+### Revoke an invitation
+
+For the example bellow we will use only required parameters, but you can use any other parameter as well.
+
+```ruby
+organization.revoke_invitation(invitation_uuid: invitation_uuid)
+#=>
+```

data/docs/resources/pagination.md

@@ -0,0 +1,21 @@
+# Pagination
+
+`collection` endpoints return pages of results. The result object will have a `data` key to access the results, as well as pagination like `next_page` for retrieving the next pages. You may also specify the
+
+```ruby
+results = client.me.events(count: 5)
+#=> Calendlyr::Collection
+
+results.count
+#=> 5
+
+results.data
+#=> [#<Calendlyr::Event>, #<Calendlyr::Event>]
+
+results.next_page_token
+#=> "KfKBetd7bS0wsFINjYky9mp8ZJXv76aL"
+
+# Retrieve the next page
+client.me.events(count: 5, next_page_token: results.next_page_token)
+#=> Calendlyr::Collection
+```

data/docs/resources/routing_forms/routing_form.md

@@ -0,0 +1,48 @@
+# Routing Form Calendlyr::RoutingForm
+
+Information about a routing form.
+
+Visit official [API Doc](https://developer.calendly.com/api-docs/20e016678903c-routing-form)
+
+## Client requests
+
+### Retrieve
+
+Get a specified Routing Form.
+
+Visit official [API Doc](https://developer.calendly.com/api-docs/910a7e2f573e8-get-routing-form)
+
+```ruby
+client.routing_forms.retrieve(uuid: form_uuid)
+#=> #<Calendlyr::RoutingForm>
+```
+
+### List
+
+Get a list of Routing Forms for a specified Organization.
+
+Visit official [API Doc](https://developer.calendly.com/api-docs/9fe7334bec6ad-list-routing-forms)
+
+For the example bellow we will use only required parameters, but you can use any other parameter as well.
+
+```ruby
+client.routing_forms.list(organization: organization_uri)
+#=> #<Calendlyr::Collection @data=[#<Calendlyr::RoutingForm>, ...], @count=nil, @next_page=nil, @next_page_token=nil, @client=#<Calendlyr::Client>>
+```
+
+## Object methods
+
+### Associated Organization
+
+```ruby
+routing_form.associated_organization
+#=> #<Calendlyr::Organization>
+```
+
+### Submissions
+For the example bellow we will use not parameters, but you can use the allowed parameters in Calendly docs.
+
+```ruby
+routing_form.submissions
+#=> #<Calendlyr::Collection @data=[#<Calendlyr::RoutingForms::Submission>, ...], @count=nil, @next_page=nil, @next_page_token=nil, @client=#<Calendlyr::Client>>
+```

data/docs/resources/routing_forms/submission.md

@@ -0,0 +1,40 @@
+# Routing Form Submission Calendlyr::RoutingForms::Submission
+
+Information about a Routing Form Submission.
+
+Visit official [API Doc](https://developer.calendly.com/api-docs/09b54c4d45b62-routing-form-submission)
+
+## Client requests
+
+### Retrieve
+
+Get a specified Routing Form Submission.
+
+Visit official [API Doc](https://developer.calendly.com/api-docs/f4ccebf48e5b5-get-routing-form-submission)
+
+```ruby
+client.routing_forms.retrieve_submission(uuid: submission_uuid)
+#=> #<Calendlyr::RoutingForms::Submission>
+```
+
+### List
+
+Get a list of Routing Form Submissions for a specified Routing Form.
+
+Visit official [API Doc](https://developer.calendly.com/api-docs/17db5cb915a57-list-routing-form-submissions)
+
+For the example bellow we will use only required parameters, but you can use any other parameter as well.
+
+```ruby
+client.routing_forms.list_submissions(form: routing_form_uri)
+#=> #<Calendlyr::Collection @data=[#<Calendlyr::RoutingForms::Submission>, ...], @count=nil, @next_page=nil, @next_page_token=nil, @client=#<Calendlyr::Client>>
+```
+
+## Object methods
+
+### Associated Routing Form
+
+```ruby
+routing_form_submission.associated_routing_form
+#=> #<Calendlyr::RoutingForm>
+```

data/docs/resources/scheduling_link.md

@@ -0,0 +1,26 @@
+# Scheduling Link Calendlyr::SchedulingLink
+
+Scheduling Link Object.
+
+
+## Client requests
+
+### Create
+
+Creates a single-use scheduling link.
+
+Visit official [API Doc](https://developer.calendly.com/api-docs/4b8195084e287-create-single-use-scheduling-link)
+
+```ruby
+client.scheduling_links.create(owner: event_type_uri, max_event_count: 1)
+#=> #<Calendlyr::SchedulingLink>
+```
+
+## Object methods
+
+### Event Type
+
+```ruby
+scheduling_link.event_type
+#=> #<Calendlyr::EventType>
+```

data/docs/resources/share.md

@@ -0,0 +1,28 @@
+# Share Calendlyr::Schare
+
+Schare Object.
+
+Visit official [API Doc](https://developer.calendly.com/api-docs/0069948603238-share)
+
+
+## Client requests
+
+### Create
+
+Endpoint for our Customize Once and Share feature. This allows you to customize events for a specific invitee without needing to make an entirely new event type. This feature is only available for one-on-one event types. Note: Any parameter which is not provided in the request body will be copied from the target event type.
+
+Visit official [API Doc](https://developer.calendly.com/api-docs/fdcac06abfc8c-create-share)
+
+```ruby
+client.shares.create(create: event_type_uri, name: "15 minute meeting", duration: ...)
+#=> #<Calendlyr::Share>
+```
+
+## Object methods
+
+### Associated Scheduling Links
+
+```ruby
+share.associated_scheduling_links
+#=> [#<Calendlyr::SchedulingLink>]
+```