{"id":18023145,"url":"https://github.com/rustyconover/webservice-intercom","last_synced_at":"2025-06-20T09:06:57.548Z","repository":{"id":26441305,"uuid":"29892129","full_name":"rustyconover/WebService-Intercom","owner":"rustyconover","description":"a perl interface to Intercom.io","archived":false,"fork":false,"pushed_at":"2015-03-13T19:46:50.000Z","size":168,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-20T09:06:50.710Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Perl","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rustyconover.png","metadata":{"files":{"readme":"README.pod","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-01-27T01:53:13.000Z","updated_at":"2015-03-13T19:46:50.000Z","dependencies_parsed_at":"2022-09-24T06:01:41.556Z","dependency_job_id":null,"html_url":"https://github.com/rustyconover/WebService-Intercom","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/rustyconover/WebService-Intercom","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rustyconover%2FWebService-Intercom","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rustyconover%2FWebService-Intercom/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rustyconover%2FWebService-Intercom/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rustyconover%2FWebService-Intercom/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rustyconover","download_url":"https://codeload.github.com/rustyconover/WebService-Intercom/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rustyconover%2FWebService-Intercom/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260915901,"owners_count":23082040,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-30T07:07:34.074Z","updated_at":"2025-06-20T09:06:52.531Z","avatar_url":"https://github.com/rustyconover.png","language":"Perl","funding_links":[],"categories":[],"sub_categories":[],"readme":"=pod\n\n=head1 NAME\n\nWebService::Intercom - interact with the Intercom.io API\n\n=head1 SYNOPSIS\n\n  my $intercom = WebService::Intercom-\u003enew(app_id =\u003e '[APP ID]',\n                                           api_key =\u003e '[API KEY]');\n\n  # Create a user\n  my $user = $intercom-\u003euser_create_or_update(\n     email =\u003e 'test@example.com', \n     name =\u003e 'test user');\n  \n  # Retrieve an existing user.\n  my $existing_user = $intercom-\u003euser_get(email =\u003e 'test2@example.com');\n\n  # Add a tag to a user\n  $user-\u003etag('test tag');\n  $intercom-\u003etag_create_or_update(name =\u003e \"test tag\");\n  $intercom-\u003etag_items(name =\u003e \"test tag\", users =\u003e [{ email =\u003e 'test@example.com'}]);\n  $user-\u003euntag('test tag');\n\n  # Change the user's name\n  $user-\u003ename = 'new name';\n  $user-\u003esave();\n\n  # Delete the user\n  $user-\u003edelete();\n  $intercom-\u003euser_delete(email =\u003e 'test@example.com');\n\n  # Add a note\n  $user-\u003eadd_note(body =\u003e \"This is a test note\");\n  $intercom-\u003enote_create(email =\u003e 'test@example.com',\n                         body =\u003e \"This is a test note\");\n \n  # Add an event\n  $user-\u003eadd_event(event_name =\u003e 'test event');\n  $intercom-\u003eevent_create(email =\u003e 'test@example.com',\n                          event_name =\u003e 'test event',\n                          metadata =\u003e {\n                             \"article\" =\u003e  {\"url\" =\u003e  \"https://example.org/\",\n                                            \"value\" =\u003e \"link text\"},\n                          });\n\n=head1 DESCRIPTION\n\nProvides a nice API for Intercom.io rather than making raw requests.\n\n=head1 IMPLEMENTATION PHILOSOPHY\n\nThis module attempts to stick as close to the API as possible.\n\nDocumentation for the v2 API:\n\nL\u003chttp://doc.intercom.io/api/\u003e\n\nFor examples see the test cases, most functionality is well exercised\nvia tests.\n\n=head1 FUNCTIONS\n\n=head2 user_get\n\nRetrieves an existing user.\n\n  $intercom-\u003euser_get(Maybe[Str] :$user_id?,\n                      Maybe[Str] :$email?,\n                      Maybe[Str] :$id?);\n\nOnly one of user_id, email or id are required to retrieve a user.\n\nReturns a L\u003cWebService::Intercom::User\u003e.\n\n=head2 user_create_or_update\n\nCreates or updates a user.\n\n  # When you have an existing WebService::Intercom::User\n  $intercom-\u003euser_create_or_update(WebService::Intercom::User $user);\n\n  or\n\n  $intercom-\u003euser_create_or_update(Maybe[Str] :$user_id?,\n                                   Maybe[Str] :$email?,\n                                   Maybe[Str] :$id?,\n                                   Maybe[Int] :$signed_up_at?,\n                                   Str :$name?,\n                                   Maybe[IPAddressType] :$last_seen_ip?,\n                                   CustomAttributesType :$custom_attributes?,\n                                   Maybe[Str] :$last_seen_user_agent?,\n                                   HashRef :$companies?,\n                                   Maybe[Int] :$last_request_at?,\n                                   Maybe[Bool] :$unsubscribed_from_emails?,\n                                   Maybe[Bool] :$update_last_request_at?,\n                                   Maybe[Bool] :$new_session?);\n  \nReturns a L\u003cWebService::Intercom::User\u003e that represents the new or updated user.\n\n=head2 user_delete\n\nDeletes a user\n\n  # When you have an existing WebService::Intercom::User\n  $intercom-\u003euser_delete(WebService::Intercom::User $user);\n\n  or\n\n  $intercom-\u003euser_delete(Maybe[Str] :$user_id?,\n                         Maybe[Str] :$email?,\n                         Maybe[Str] :$id?);\n\nOnly one of user_id, email or id is required.\n  \nReturns a L\u003cWebService::Intercom::User\u003e that represents the deleted user.\n\n=head2 tag_create_or_update\n\nCreates or updates a tag.\n\n  # When you have an existing WebService::Intercom::User\n  $intercom-\u003etag_create_or_update(WebService::Intercom::Tag $tag);\n\n  or\n\n  $intercom-\u003etag_create_or_update(Str :$name,\n                                  Maybe[Str] :$id?);\n\nReturns a L\u003cWebService::Intercom::Tag\u003e that represents the tag.\n\n=head2 tag_items\n\nApplies or removes a tag to users or companies\n\n  # When you have an existing WebService::Intercom::User\n  $intercom-\u003etag_items(Str :$name,\n                       ArrayRef[TagUserIdentifierType] :$users?,\n                       ArrayRef[TagCompanyIdentifierType] :$companies?);\n\n=head2 tag_delete\n\nDeletes a tag\n\n  # When you have an existing WebService::Intercom::User\n  $intercom-\u003etag_delete(WebService::Intercom::Tag $tag);\n\n  or\n\n  $intercom-\u003etag_delete(Str :$id);\n\nReturns undef\n\n=head2 note_create\n\nCreates a note for a user\n\n  # When you have an existing WebService::Intercom::User\n  $intercom-\u003enote_create(Maybe[Str] :$user_id?,\n                         Maybe[Str] :$email?,\n                         Maybe[Str] :$id?,\n                         Maybe[Str] :$admin_id?,\n                         Str :$body);\n\nReturns a L\u003cWebService::Intercom::Note\u003e that represents the note.\n\n=head2 event_create\n\nCreates an event for a user\n\n  # When you have an existing WebService::Intercom::User\n  $intercom-\u003eevent_create(Maybe[Str] :$user_id?,\n                          Maybe[Str] :$email?,\n                          EventNameType :$event_name,\n                          Maybe[Int] :$created_at?,\n                          Maybe[EventMetadataType] :$metadata?);\n\nReturns undef.\n\n=head2 create_message\n\nCreate a message, can be user or admin initiated.\n\n  # When you have an existing WebService::Intercom::User\n  $intercom-\u003ecreate_message(MessagePersonType :$from,\n                          Maybe[MessagePersonType] :$to,\n                          Str :$body,\n                          Maybe[Str] :$subject?,\n                          Maybe[StrMatch[qr/^(plain|personal)$/]] :$template,\n                          StrMatch[qr/^(inapp|email)$/] :$message_type);\n\nReturns a L\u003cWebService::Intercom::Message\u003e.\n\n=head1 SEE ALSO\n\nSee L\u003cMoops\u003e and L\u003cKavorka\u003e to understand parameter signatures.\n\nAlso of course Intercom at L\u003chttp://www.intercom.io\u003e.\n\n=head1 AUTHOR\n\nRusty Conover \u003crusty+cpan@luckydinosaur.com\u003e\n\n=head1 COPYRIGHT\n\nThis software is copyright (c) 2015 by Lucky Dinosaur LLC. L\u003chttp://www.luckydinosaur.com\u003e\n\nThis is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.\n\n=head1 DISCLAIMER OF WARRANTIES\n\nTHIS PACKAGE IS PROVIDED \"AS IS\" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.\n\n=cut\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frustyconover%2Fwebservice-intercom","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frustyconover%2Fwebservice-intercom","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frustyconover%2Fwebservice-intercom/lists"}